It's very modern to write the documentation in a Wiki. It's easy to edit, nice to structure etc. But I hate it. I really hate it. It's never well structured and easy to read. There's much effort you have to put into a wiki to make it good.
So I recommend to use a simple CMS. No overkill, just text edit with links. You have the option to integrate it into your webapp and there's the possibility to extract a PDF from it. This is neat for offering an offline help for printing etc.
当我查看 Google 帮助页面时，我确实注意到的一件事是搜索（没有惊喜），这可能有点棘手 - 如果您的网站面向外部，那么我可以使用“site:您的网站>”来实现此功能 关键字并使用 Google 搜索。 如果您的网站是内部的，您将必须进行自己的搜索，但这应该不会太难，并且可能是一个非常有趣的子项目。
I'd just use good old HTML/CSS - this will maintain the behavior users already know in a browser and you should already have the style-sheet for the application so you'll maintain the L&F through the help pages with little additional effort.
One thing I did notice when I looked at the Google help pages was the search (no surprises there), which might be a little trickier - if your site is external facing then I'd implement this with the 'site:<your site>' keyword and use Google search. If your site is internal you'll have to roll your own search, but that shouldn't be too hard and would probably be quite a fun sub-project.
If you are looking at producing a user manual illustrating what each button does, I've found using something like Debugmode Wink or Adobe Captivate useful for recording the screen interaction and then converting it to either a Flash movie or PDF.
发布评论
评论（8）
我发现构建引擎 Hudson 中的帮助非常优雅和离散。
您有一个帮助图标，单击它，帮助文本会在页面内展开，再次单击它就会消失。
尝试启动 https://hudson.dev.java.net/hudson.jnlp 并转到 http://localhost:8080/configure 并单击右侧的许多 (?) 按钮。
I have found the help in the build engine Hudson to be very elegant and discrete.
You have a help icon, you click on it, the help text is expaned inline the page, you click again it disappears.
Try starting https://hudson.dev.java.net/hudson.jnlp and go tohttp://localhost:8080/configure and click the many (?) buttons in the right side.
Java Doc 可用于提取 java 代码文件中包含的所有注释
Java Doc can be used to extract all the comments incorporated inside the java code file
查看 Java 帮助。 模拟旧版本 Windows 中的帮助系统
Have a look at JavaHelp. Emulates the help system found in older versions of Windows
在 Wiki 中编写文档是非常现代的做法。 它易于编辑，结构良好等。
但我讨厌它。 我真的很讨厌它。 它从来都不是结构良好且易于阅读的。 要使 wiki 变得更好，您必须付出很多努力。
所以我建议使用简单的CMS。 没有矫枉过正，只需用链接进行文本编辑。 您可以选择将其集成到您的网络应用程序中，并且可以从中提取 PDF。
这非常适合为打印等提供离线帮助。
It's very modern to write the documentation in a Wiki. It's easy to edit, nice to structure etc.
But I hate it. I really hate it. It's never well structured and easy to read. There's much effort you have to put into a wiki to make it good.
So I recommend to use a simple CMS. No overkill, just text edit with links. You have the option to integrate it into your webapp and there's the possibility to extract a PDF from it.
This is neat for offering an offline help for printing etc.
我只使用旧的 HTML/CSS - 这将保持用户在浏览器中已经知道的行为，并且您应该已经拥有应用程序的样式表，这样您就可以通过帮助页面维护 L&F，只需很少的额外操作努力。
查看 Google 地图上的帮助 (http://maps.google.co.uk/support /） - 对于布局想法等。
当我查看 Google 帮助页面时，我确实注意到的一件事是搜索（没有惊喜），这可能有点棘手 - 如果您的网站面向外部，那么我可以使用“site:您的网站>”来实现此功能 关键字并使用 Google 搜索。 如果您的网站是内部的，您将必须进行自己的搜索，但这应该不会太难，并且可能是一个非常有趣的子项目。
I'd just use good old HTML/CSS - this will maintain the behavior users already know in a browser and you should already have the style-sheet for the application so you'll maintain the L&F through the help pages with little additional effort.
Take a look at the help on Google Maps (http://maps.google.co.uk/support/) - for layout ideas, etc.
One thing I did notice when I looked at the Google help pages was the search (no surprises there), which might be a little trickier - if your site is external facing then I'd implement this with the 'site:<your site>' keyword and use Google search. If your site is internal you'll have to roll your own search, but that shouldn't be too hard and would probably be quite a fun sub-project.
如果您使用 PHP，请查看 phpDocumentor。
If you're using PHP, take a look at phpDocumentor.
如果您正在考虑制作一份用户手册来说明每个按钮的功能，我发现使用类似 Debugmode Wink< /a> 或 Adobe Captivate 对于记录屏幕交互然后将其转换为 Flash 影片或 PDF 非常有用。
If you are looking at producing a user manual illustrating what each button does, I've found using something like Debugmode Wink or Adobe Captivate useful for recording the screen interaction and then converting it to either a Flash movie or PDF.
特别针对 Rails：
http://github.com/darthapo/comatose/tree/master 很棒可用于嵌入式帮助系统的小型 CMS 工具。
否则，http://tenderapp.com/ 可以很好地作为托管解决方案。
Specifically for Rails:
http://github.com/darthapo/comatose/tree/master is a great little CMS tool that you can use for imbedded help systems.
Otherwise, http://tenderapp.com/ works nicely as a hosted solution.