我需要为我的网络应用程序编写帮助（例如显示某些按钮功能的描述）。有没有这样做的好例子？
问问题
723 次
8 回答
0
Java Doc可用于提取包含在 java 代码文件中的所有注释
于 2009-07-07T09:25:29.903 回答
0
看看JavaHelp。模拟旧版 Windows 中的帮助系统
于 2009-07-07T09:36:25.747 回答
0
在 Wiki 中编写文档是非常现代的。它很容易编辑，结构很好等。
但我讨厌它。我真的很讨厌它。它从来都不是结构良好且易于阅读的。您必须在 wiki 中付出很多努力才能使它变得更好。
所以我推荐使用一个简单的CMS。没有矫枉过正，只是带有链接的文本编辑。您可以选择将其集成到您的 web 应用程序中，并且可以从中提取 PDF。
这很适合为打印等提供离线帮助。
于 2009-07-07T09:45:04.107 回答
0
我只是使用良好的旧 HTML/CSS - 这将保持用户在浏览器中已经知道的行为，并且您应该已经拥有应用程序的样式表，因此您将通过帮助页面维护 L&F，而无需付出额外的努力。
查看 Google 地图 ( http://maps.google.co.uk/support/ ) 上的帮助 - 了解布局创意等。
当我查看 Google 帮助页面时，我注意到的一件事是搜索（这并不奇怪），这可能有点棘手 - 如果您的网站面向外部，那么我将使用 'site:< your site > ' 关键字并使用 Google 搜索。如果您的网站是内部网站，您将不得不推出自己的搜索，但这应该不会太难，并且可能会是一个非常有趣的子项目。
于 2009-07-07T09:53:53.590 回答
0
如果您使用的是 PHP，请查看phpDocumentor。
phpDocumentor 工具是一个独立的自动文档工具，类似于用 PHP 编写的 JavaDoc。
于 2009-07-08T23:59:43.187 回答
0
如果您正在查看说明每个按钮的作用的用户手册，我发现使用Debugmode Wink或 Adobe Captivate 之类的工具可用于记录屏幕交互，然后将其转换为 Flash 电影或 PDF。
于 2009-07-12T13:05:28.847 回答
0
专门针对 Rails： http: //github.com/darthapo/comatose/tree/master是一个很棒的小型 CMS 工具，可用于嵌入式帮助系统。
否则，http ://tenderapp.com/可以很好地用作托管解决方案。
于 2009-07-25T22:48:14.723 回答
0
我发现构建引擎 Hudson 中的帮助非常优雅和离散。
您有一个帮助图标，单击它，帮助文本在页面内展开，再次单击它会消失。
尝试启动https://hudson.dev.java.net/hudson.jnlp并转到 http://localhost:8080/configure 并单击右侧的许多 (?) 按钮。
于 2009-07-26T21:18:20.140 回答