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

时间:2009-03-06 11:21:59

标签: wiki manuals

我们正在为很多地方的用户(超过8个国家/地区的200多个用户)部署新的软件系统。在过去,我们为用户编写了一本手册,然后经常更新。这项工作正常,因为所有用户都使用相同的手册,它涵盖了主要内容,但它有问题,例如它不经常更新,我们有时会错过更新,而且有些用户会有旧版本。

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

有没有其他人做过类似的事情?有关维基系统,工作流程,文档格式等的任何建议吗?

6 个答案:

答案 0 :(得分:4)

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

答案 1 :(得分:1)

您可以从Wiki中编写生成LaTeX的内容,并将手册呈现为PDF。对于像hyperref这样的包,您可以将交叉引用保留为超链接。

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

Framemaker也可以使用生成的MIF文件来支持这一点,您也可以以类似的方式使用Lout或将您的Wiki内容转换为docbook,,这样就可以了使用该格式可用的任何渲染选项。

另外,以下Stackoverflow帖子讨论了各种维护文档的系统。

答案 2 :(得分:1)

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

答案 3 :(得分:0)

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

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

答案 4 :(得分:0)

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

答案 5 :(得分:0)

我提供了一个previous answer,它可能对“wiki to PDF”部分有用 - 看看使用开源的PediaPress代码或功能。您也可以从中获取ODF,虽然他们的PDF已经相当漂亮了(但您可能想要重新命名并为我的公司重新设计它。)