用于编写基于HTML的用户手册的最佳软件

Question

我正在开展一个项目，我需要为一个软件生成最终用户文档。在明年的某个时候，我正在编写本文档的软件将被淘汰。因此，我不想花很多时间在专业级手册上。这是一所大学的研究生和一些内部专业人士将会看到的东西。虽然如果它足够好又有用，我可以将其作为免费文档反馈给开源社区。

我认为HTML手册非常合适。该软件是用PHP编写的，所以无论谁使用它都会打开一个Web浏览器并准备就绪。这也导致我或其他人将手册页面集成到软件本身的可能性。

我对制作/使用这个软件的wiki不感兴趣。我真正需要的是一个软件，我可以像普通文档一样编写并生成简单的HTML。我知道有像Dreamweaver和Frontpage这样的软件，但我特别感兴趣的是一些旨在简化文档创建过程的东西（其中屏幕上限和视频的过程与简单的图像/视频编辑一起集成）。

如果您认为另一种方法（HTML文档除外）可能会更好，我很乐意听到它。如果你有另一种方法，并且你认为你知道一个很好的软件解决方案来实现它，请告诉我。

我对该方法的主要愿望和实现它的软件是

• 部署简单（HTML页面无需特殊设置。可以简单地部署帮助目录，其中包含所有手册页）。
• 无需使用特殊软件（每个拥有网络浏览器的人都可以阅读HTML）
• 使用方便我编写文档/小学习曲线（我不想花很多时间学习一个复杂的软件来处理一个相对较小的项目）
• 能够将文本，视频和图像合并为单个文档（HTML页面显然支持将所有这些组合在一起）

谢谢！

@Lie Ryan：“MediaWiki将所有文本和数据（内容页面，用户详细信息，系统消息等）存储在数据库中......”这是我想要避免的。我认为wiki非常棒且有用，但我只对提供非常低开销的静态数据感兴趣。

Answer 1

每当我被要求编写用户手册时（意味着每次我完成一个项目），我都喜欢使用Markdown。结合最小的CSS，它非常易于使用。

  

Markdown是一种文本到HTML的转换   网络作家的工具。 Markdown允许   你用易读的书写，   那么易于编写的纯文本格式   将其转换为结构上有效的XHTML   （或HTML）。

     

因此，“Markdown”是两件事：（1）a   纯文本格式化语法; （2）   一个用Perl编写的软件工具   将纯文本格式转换为   HTML。

Answer 2

我想这并不完全符合你的所有要求，但我是Sphinx的忠实粉丝。您可以在ReST中编写文档，并且可以非常轻松地生成HTML和PDF版本。 HTML生成使用模板，因此它可以自定义。此外，对于我们这些喜欢此类事物的人来说，使用纯文本版本（ReST有点可读）还有额外的好处：）

Answer 3

以XML格式编写手册，使用docbook之类的内容。这将允许您对内容执行任何操作，然后以自己的方式生成演示文稿。

对于HTML工具，docbook上有很多tutorials。

编辑：我忘了提及OO can save in docbook。

Answer 4

我建议只在OpenOffice中编写并发布为PDF。 PDF，甚至可能超过HTML，与平台无关，并且在多个客户端和操作系统中看起来几乎相同。如果您真的想要视频，可以链接到外部网站，例如Youtube或PDF中的“你有什么”。