Web 应用程序的交互式手册示例 [关闭]答案

【问题标题】：example of interactive manual for web app [closed]Web 应用程序的交互式手册示例 [关闭]
【发布时间】：2009-07-07 09:19:32
【问题描述】：

我需要为我的网络应用程序编写帮助（例如显示某些按钮的作用的描述）。有没有这样做的好例子？

【问题讨论】：

【解决方案1】：

我发现构建引擎 Hudson 中的帮助非常优雅和独立。

你有一个帮助图标，你点击它，帮助文本在页面内展开，你再次点击它就消失了。

尝试启动 https://hudson.dev.java.net/hudson.jnlp 并转到 http://localhost:8080/configure 并单击右侧的许多 (?) 按钮。

【讨论】：

【解决方案2】：

Java Doc 可用于提取包含在 java 代码文件中的所有 cmets

【讨论】：

【解决方案3】：

看看JavaHelp。模拟旧版 Windows 中的帮助系统

【讨论】：

【解决方案4】：

在 Wiki 中编写文档非常现代。它易于编辑，结构良好等。
但我讨厌它。我真的很讨厌它。它从来都不是结构良好且易于阅读的。您必须在 wiki 中付出很多努力才能使它变得更好。

所以我建议使用简单的 CMS。没有矫枉过正，只是带有链接的文本编辑。您可以选择将其集成到您的网络应用程序中，并且可以从中提取 PDF。
这很适合为打印等提供离线帮助。

【讨论】：

【解决方案5】：

我只会使用旧的 HTML/CSS - 这将保持用户在浏览器中已经知道的行为，并且您应该已经拥有应用程序的样式表，因此您将通过帮助页面维护 L&F额外的努力。

查看 Google 地图 (http://maps.google.co.uk/support/) 上的帮助 - 了解布局思路等。

当我查看 Google 帮助页面时，我注意到的一件事是搜索（这并不奇怪），这可能有点棘手 - 如果您的网站面向外部，那么我将使用 'site:您的网站>'关键字并使用 Google 搜索。如果您的网站是内部网站，您将不得不推出自己的搜索，但这应该不会太难，而且可能会是一个非常有趣的子项目。

【讨论】：

【解决方案6】：

如果您使用的是 PHP，请查看 phpDocumentor。

phpDocumentor 工具是独立的类似于 JavaDoc 的自动文档器用 PHP 编写。

【讨论】：

【解决方案7】：

如果您正在考虑制作说明每个按钮功能的用户手册，我发现使用 Debugmode Wink 或 Adobe Captivate 之类的方法可用于记录屏幕交互，然后将其转换为 Flash 电影或 PDF。

【讨论】：

【解决方案8】：

专门针对 Rails： http://github.com/darthapo/comatose/tree/master 是一个很棒的小型 CMS 工具，可用于嵌入式帮助系统。

否则，http://tenderapp.com/ 可以很好地用作托管解决方案。

【讨论】：