将 Wiki 内容转变为系统手册的工作流程

题

我们正在向许多地方的许多用户（8 个国家/地区的 200 多个用户）部署新的软件系统。过去我们为用户编写了一份手册，然后经常更新。这工作正常，因为所有用户都有相同的手册，它涵盖了主要内容，但它也有问题，比如它不经常更新，我们有时会错过更新，并且一些用户会有旧副本。

我们一直在讨论在测试和部署阶段使用 wiki 来构建有关系统的知识库。理想情况下，我们希望通过某种方式将其转换为某种形式的电子文档，然后我们可以将其“漂亮”并作为官方手册发送出去，并让用户使用和更新 wiki。

还有其他人做过类似的事情吗？对于 wiki 系统、工作流程、文档格式等有什么建议吗？

解决方案

大多数 wiki 支持通过 PDF 导出，例如：

其他提示

你可以写一些生成的东西乳胶从 wiki 并将手册呈现为 PDF。像这样的包超引用您可以将交叉引用保留为超链接。

此外，您可以将来自多个来源（例如数据字典）的内容集成到 LaTeX 文档中，该文档可以与 wiki 内容混合和匹配。您还可以设置架构，以便它可以支持任一方式的交叉引用。

制框师也可以使用生成的支持这一点米夫文件，你也可以使用劳特以类似的方式或将您的 wiki 内容转换为文档书，这将允许您使用该格式可用的许多渲染选项中的任何一个。

顺便说一句，以下 Stackoverflow 帖子讨论了维护文档的各种系统。

Madcap Flare 是一个帮助和手动创作工具，它使用HTML作为每个主题的来源。您可以很容易地大量导入Wiki页面。然后需要一些清洁，但之后你有一个很好的单源系统，可以输出CHM，网络浏览帮助，PDF，DOC / DOCX等。

目前您是如何存储帮助来源的？是MS Word文件，MS帮助，LaTeX？

如果您将帮助源文件置于版本控制之下，那么您将获得维基的所有好处而无需迁移到新系统 - 人们可以轻松编辑帮助文件 - 可以跟踪，还原这些更改等你和以前一样得到了美化手册。

我跟踪 Node 的链接并发现了一些我认为值得注意的 mediawiki 页面。

我提供了之前的回答，这可能很有用对于“wiki to PDF”部分 - 看看使用开源的PediaPress代码或功能。您也可以从中获取ODF，虽然他们的PDF已经相当漂亮了（但您可能想要重新命名并为我的公司重新设计它。）

许可以下： CC-BY-SA 和归因