首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >将Wiki内容转换为系统手册的工作流程

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

Stack Overflow用户
提问于 2009-03-06 11:21:59
回答 6查看 761关注 0票数 4

我们正在为很多地方的用户(超过8个国家的200+用户)部署一个新的软件系统。在过去,我们为用户编写了一份手册,然后每隔一段时间更新一次。这工作的很好,因为所有的用户都有相同的手册,它涵盖了主要的东西,但它也有它的问题,比如它不经常更新,我们有时会错过更新,一些用户会有旧的副本。

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

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

EN

回答 6

Stack Overflow用户

回答已采纳

发布于 2009-03-06 11:27:23

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

  • MediaWiki PDF Export
  • DokuWiki PDF Export
  • TWiki PDF Export
票数 4
EN

Stack Overflow用户

发布于 2009-03-06 11:29:07

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

此外,您可以将来自多个源的内容集成到LaTeX文档中,该文档可以与wiki内容混合和匹配。您还可以设置体系结构,以便它可以支持任意方向的交叉引用。

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

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

票数 1
EN

Stack Overflow用户

发布于 2009-03-06 12:46:17

Madcap Flare是一个帮助和手动创作工具,它使用超文本标记语言作为每个主题的源。您可以很容易地对Wiki页面进行大量导入。然后需要一些清理,但在此之后,您有一个很好的单一来源系统,可以输出CHM,web浏览的帮助,PDF,DOC/DOCX等。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/618508

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档