我需要为我的网络应用编写帮助（例如显示某些按钮的功能）。这样做有什么好的例子吗？
答案 0 :(得分：0)
Java Doc可用于提取java代码文件中包含的所有注释
答案 1 :(得分：0)
看看JavaHelp。模拟旧版Windows中的帮助系统
答案 2 :(得分：0)
在Wiki中编写文档非常现代。它易于编辑，非常适合结构等 但我讨厌它。我真讨厌它。它从来没有很好的结构和易于阅读。你必须付出很多努力才能使它变得更好。
所以我建议使用简单的CMS。没有矫枉过正，只需用链接进行文本编辑。您可以选择将其集成到您的webapp中，并且可以从中提取PDF 这对于提供打印等离线帮助非常简洁。
答案 3 :(得分：0)
我只是使用好的旧HTML / CSS - 这将维护用户在浏览器中已经知道的行为，并且您应该已经拥有应用程序的样式表，因此您将通过帮助页面维护L＆amp; F只需要额外的努力。
查看Google地图上的帮助（http://maps.google.co.uk/support/） - 了解布局提示等。
当我查看Google帮助页面时，我注意到的一件事是搜索（没有惊喜），这可能有点棘手 - 如果您的网站面向外部，那么我将使用'site：＆lt实现此功能; 您的网站＆gt;'关键字并使用Google搜索。如果您的网站是内部网站，则必须自行搜索，但这不应该太难，可能是一个非常有趣的子项目。
答案 4 :(得分：0)
如果您使用的是PHP，请查看phpDocumentor。
phpDocumentor工具是一个独立的工具 auto-documentor类似于JavaDoc 用PHP编写。
答案 5 :(得分：0)
如果您正在制作说明每个按钮功能的用户手册，我发现使用Debugmode Wink或Adobe Captivate等功能来记录屏幕交互，然后将其转换为Flash电影或PDF
答案 6 :(得分：0)
专门针对Rails： http://github.com/darthapo/comatose/tree/master是一个很棒的小型CMS工具，可用于嵌入式帮助系统。
否则，http://tenderapp.com/可以很好地作为托管解决方案。
答案 7 :(得分：0)
我发现构建引擎Hudson的帮助非常优雅和离散。
你有一个帮助图标，你点击它，帮助文本被内嵌到页面中，你再次点击它就会消失。
尝试启动https://hudson.dev.java.net/hudson.jnlp并转到http：// localhost：8080 / configure并单击右侧的多个（？）按钮。