4

我们正在为许多地方的许多用户(8 个国家/地区的 200 多个用户)部署一个新的软件系统。过去我们为用户编写了手册,然后每隔一段时间进行更新。这行得通,因为所有用户都拥有相同的手册,它涵盖了主要内容,但它也有问题,比如它不会经常更新,我们有时会错过更新,并且一些用户会有旧副本。

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

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

4

6 回答 6

4

大多数 wiki 支持通过 PDF 导出,例如:

于 2009-03-06T11:27:22.923 回答
1

您可以编写一些东西,从 wiki 生成LaTeX并将手册呈现为 PDF。使用hyperref之类的包,您可以将交叉引用保留为超链接。

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

Framemaker还可以使用生成的MIF文件来支持这一点,您也可以以类似的方式使用Lout或将您的 wiki 内容转换为docbook,这将允许您使用该格式可用的许多渲染选项中的任何一个。

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

于 2009-03-06T11:29:07.257 回答
1

Madcap Flare是一个帮助和手动创作工具,它使用 HTML 作为每个主题的来源。您可以很容易地大量导入 Wiki 页面。然后需要进行一些清理,但之后您就有了一个不错的单源系统,可以输出 CHM、Web 可浏览帮助、PDF、DOC/DOCX 等。

于 2009-03-06T12:46:17.353 回答
0

您目前如何存储帮助源?是 MS Word 文件、MS 帮助、LaTeX 吗?

如果您将帮助源文件置于版本控制之下,那么您将获得 wiki 的所有好处,而无需迁移到新系统 - 人们可以轻松地对帮助文件进行编辑 - 这些更改可以被跟踪、恢复等,而您像以前一样获得美化手册。

于 2009-03-06T11:27:51.580 回答
0

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

于 2009-03-06T11:59:20.010 回答
0

我给出了一个可能对“wiki 到 PDF”部分有用的答案——看看使用开源 PediaPress 代码或功能。您也可以从中获取 ODF,尽管它们的 PDF 已经非常漂亮(但我想您可能想要重新命名它并为您的公司重新设计它)。

于 2009-03-09T01:43:29.650 回答