8

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

我在想 HTML 手册会很合适。该软件是用 PHP 编写的，因此无论谁使用它，都将打开一个 Web 浏览器并准备就绪。这也导致我或其他人有可能将手册的页面集成到软件本身中。

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

如果您认为另一种方法（HTML 文档除外）可能会更好，我很想听听。如果您有另一种方法，并且您认为您知道实现此目的的良好软件解决方案，请告诉我。

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

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

谢谢！

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

4

4 回答 4

7

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

Markdown 是一个用于网络作家的文本到 HTML 转换工具。Markdown 允许您使用易于阅读、易于编写的纯文本格式进行编写，然后将其转换为结构上有效的 XHTML（或 HTML）。

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

于 2010-09-27T23:45:05.240 回答
2

我想这并不能完全满足您的所有要求，但我是Sphinx的忠实粉丝。你用ReST编写你的文档，你可以很容易地生成 HTML 和 PDF 版本。HTML 生成使用模板，因此可以自定义。此外，对于我们这些喜欢这些东西的人来说，拥有纯文本版本（ReST 在某种程度上是可读的）还有一个额外的好处：）

于 2010-09-27T20:47:14.293 回答
1

用 XML 编写手册，使用类似docbook的东西。这将使您可以对内容做任何您需要的事情，然后以自己的方式生成演示文稿。

那里有很多关于 docbook 到 HTML 工具的教程。

编辑：我忘了提到OO 可以保存在 docbook 中。

于 2010-09-27T20:26:12.903 回答
0

我建议只在 OpenOffice 中编写它并发布到 PDF。PDF 甚至可能比 HTML 更重要，它与平台无关，并且在多个客户端和操作系统中看起来几乎相同。如果您真的想要视频，您可以链接到外部网站，例如 Youtube 或 PDF 中的 what-have-you。

于 2010-09-27T20:39:28.473 回答