您的团队使用哪些工具编写用户手册？

Question

基本要求是:

• 人类可读/文本格式(便于版本控制)
• 在线(合作)
• 容易格式化(降价好,html太多)
• 严格格式化(因此作者不会发明新类型的标题,项目符号等)
• 可导出为PDF,HTML
• 轻松备份和部署(因此我们可以作为只读版本"部署"到客户站点)

我们正在考虑使用某种wiki引擎,但它需要使用文件进行存储,或者有其他方式"部署"给客户并且易于安装/维护.此外,它必须是免费/廉价(汇合太昂贵)

有什么建议？

编辑:我不是在寻找用于记录代码的工具,我们已经使用Sandcastle进行了覆盖.

Answer 1

胶乳

Answer 2

虽然它可能无法满足您的所有要求,但DokuWiki可能值得一看.

与其他wiki一样,它具有简单的语法,并具有版本控制以跟踪修订,生成目录和全文搜索功能,这对于帮助系统来说非常方便.

您可能需要评估功能列表以查看它是否满足您的需求.

此外,似乎还有很多可用的插件.虽然我没有使用过DokuWiki或其插件,但似乎还有可用于PDF导出的插件.

Answer 3

对于我们的API,我们使用Doxygen,这很棒.

Answer 4

Pandoc是一种用于在各种标记格式之间进行转换的出色工具.我们在markdown中编写文档并使用Pandoc转换为其他格式.

来自pandoc网站:

如果您需要将文件从一种标记格式转换为另一种标记格式,那么pandoc就是您的瑞士军刀.Pandoc可以读取markdown和(子集)reStructuredText,textile,HTML和LaTeX,它可以写纯文本,markdown,reStructuredText,HTML,LaTeX,ConTeXt,PDF,RTF,DocBook XML,OpenDocument XML,ODT,GNU Texinfo, MediaWiki标记,纺织品,groff手册页,Emacs组织模式,EPUB电子书以及S5和Slidy HTML幻灯片放映.附带的markdown2pdf包装脚本也支持PDF输出(通过LaTeX).

Pandoc获得了开源的额外分数,并以Haskell的热度写出;)