Documentation Web应用程序的软件使用文档工具

我们希望为web应用程序准备软件使用文档。这主要包含大多数页面中的屏幕截图（以及相关文档）。此外，我们希望有一个顶部的菜单链接，使用它我们可以跳转到相应的页面

---

请推荐可用于满足上述要求的工具。

我确信有一些很棒的工具集成了使用说明文件所需的一切，但我会告诉你我使用了什么

我经常抓取正在使用的应用程序的屏幕截图。我倾向于启动它，在浏览应用程序时抓取大量屏幕截图，甚至只是应用程序的一部分。接下来，我在wink中编辑项目，删除多余的屏幕截图，重新排序，并在每个帧上放置鼠标。然后我添加了高亮显示，这通常只是我演示的屏幕部分周围的一个漂亮的方框。Wink允许您使用信息框和箭头覆盖图像，然后我将项目导出为html，并使用编号的导出png图像作为我文档的基础

我倾向于将它们拖到OpenOfficeWriter（或任何你正在使用的排版工具）中，并用更多的信息来补充它们——即上面的几段解释用户正在做什么以及为什么

我们使用acrobat输出此文档，如果您的目录正确完成，它可以在pdf中插入书签，以便跳转到相关部分

---

我们从wink中获得的主要好处是，当事情发生变化时，可以很容易地重新抓取快照，并且它可以输出到flash中，为发布到web上的小功能提供漂亮、时髦的演示。

这对您的项目来说可能有些过分，但我更喜欢用docbook（xml）编写文档，因为它非常便携/可转换

为了简化文档创建，您可以转向，但也可以在任何其他xml（甚至文本）编辑器中执行相同的工作

---

文档准备好后，生成html（多页或单页）和pdf版本就变得非常简单了。

Dr Explain非常不错

---

它将分析您的页面，并创建需要标注的控件、按钮等的列表。

如果您使用特定的文档工具编写文档，则输出到HTML相对简单。LaTex、markdown（考虑到Pandoc）、reStructuredText（考虑到Pandoc或Pandoc）、AsciiDoc（考虑到DocBook工具）和DocBook（考虑到DocBook工具——参见Pandoc）

所有这些格式都允许您轻松地组织文档，然后以您认为合适的方式将其导出为HTML（可能是按主标题，然后围绕文件构建一个简单的包装器）。Sphinx还可以输出基于web的文档（参见Python.org的文档）

对于屏幕截图，我建议在您选择的平台上使用一个独立的应用程序，最好是一个允许您在程序中进行注释的应用程序。Mac的Skitch、Windows的Jing、Shutter-project.org或linux中的Jing

---

最后，我建议您也做一些屏幕广播，因为它们可以特别有助于展示web应用程序的趣味性/功能。

我不知道您编写代码的语言是什么，但是在Java的情况下，您可以使用

有了maven，您可以使用许多插件，例如，创建一个包含许多API/软件信息的站点，并包含所需的顶部菜单

这是maven生成的站点的屏幕截图：

我希望这些能有所帮助

干杯