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

Question

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

请提供可用于满足上述要求的工具。

Answer 1

Explain博士非常好。

http://www.drexplain.com/

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

Answer 2

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

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

对于屏幕截图，我建议在您选择的平台上使用独立应用程序，理想情况下，您可以在程序中进行注释。 Skitch for Mac，Jing for Windows，Shutter shutter-project.org或Jing in linux。

最后我建议也进行截屏视频，因为它们可以特别有助于展示网络应用程序的趣味性/强大功能。

Answer 3

这可能对你的项目来说太过分了，但我更喜欢在docbook（xml）中准备文档，因为它非常便携/可转换。

为简化文档创建，您可以转到http://www.oxygenxml.com/，但您也可以在任何其他xml（甚至 text ）编辑器中执行相同的工作。

准备好文档后，生成html（多页或单页）和pdf版本是微不足道的。

Answer 4

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

使用maven，您可以使用许多插件，例如JavaDoc，site创建一个包含有关您的API /软件的许多信息的网站，并包含 顶级菜单 你想要的。

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

我希望这些能有所帮助！

干杯

Answer 5

我确信那里有一些很棒的工具，它集成了使用文档所需的一切，但我会告诉你我使用的是什么！

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

我倾向于将它们拖入OpenOffice Writer（或者用于排版的任何内容）并用更多信息补充它们 - 即几段顶部解释用户正在做什么以及为什么。

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

我们从wink获得的主要好处是，当事情发生变化时，它很容易重新拍摄，并且可以输出到闪光灯，以便在网络上发布小型功能的漂亮，时髦的演示。