Request for help in documentation

[dkocher]

There are several users who argue that the documentation/help for Cyberduck is not good enough. Because I am not very good at these things myself and don't have currently the time to improve it myself I would be very glad if someone else could step in. Technically, this could be
# a rewrite/extension of the currently distributed 'Cyberduck FAQ'
# a help page in html to put on the web.
# a html help to be distributed with cyberduck accessible through the Help Viewer application in OS X

Please get in touch with me or reply to this post if you are interested.

[zaudragon]

Cyberduck should have a trac, like Growl or Adium. That way, bug reports, source changes, and documentation will all be together. Extremely helpful

[biglittledragoon]

Hello,

if this documentation is "localizable", I'll be glad to help you, to translate it and/or to write it.

If you've kept my e-mail, send me one. Otherwise, if you're interested, send me a pm.

Take care,

BLD

[dkocher]

Yes, the documentation can be translated.

[pbx]

I put out the word on my blog: http://e-scribe.com/news/49

[dkocher]

The new help using the Apple Help.app with an initial minimal english version is now available and can be checked out with

Code: Select all

cvs -d:pserver:anonymous@cvs.cyberduck.ch/home/cvsroot login

Press <Enter>

Code: Select all

cvs -d:pserver:anonymous@cvs.cyberduck.ch/home/cvsroot co www/cyberduck/help

Alternatively, it is available through the web interface at:
http://cvs.cyberduck.ch/www/cyberduck/help/

[Rubel]

I'm interested in helping out with the docs. They do look like they could use some reorganization and fleshing out.

I'm new to documentation; are there any areas which folks feel are currently especially neglected? Also, is there an example of what the developer and/or the user community regard as excellent documentation for a project similar in scope to CyberDuck?

I've checked out the files from CVS and am currently building the app.

[dkocher]

Every localization in Cyberduck (*.lproj) contains a Help Book with just the "Cyberduck Help.html" index page and a index for the Apple Help.app. The "Cyberduck Help.html" page can be localized as every other resource in the application bundle. The helpindex is made automatically in the build for every localization to point to the correct content: E.g. when running the french version of cyberduck the Help Viewer will load the pages from:
http://cyberduck.ch/help/fr/

The "Cyberduck Help.html" page distributed with the application is layouted through the css file at
http://cyberduck.ch/help/css/index.css

which enables us to even change the help index page without releasing a new version of the application.

The actual help content can be checked out in the CVS repository mentioned above. (Localized) Help content can be added as it becomes available without the need for a new release of the application itself.

[dkocher]

Everyone please post questions and topics where there should be some help content about that is currently missing or ambiguous.

[dkocher]

I have moved all help pages to the Subversion repository to make it easier for contributors to find the sources; you can find it all at http://svn.cyberduck.ch/trunk/www/help/