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

Question

就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用或专业知识的支持，但这个问题可能会引起辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the help center为指导。




8年前关闭。




基本要求是:

人类可读/文本格式(便于版本控制)

在线(合作)

易于格式化(markdown 可以，html 太多了)

严格的格式(因此作者不会发明新类型的标题，
子弹等)

可导出为 PDF、HTML

轻松备份和部署(因此我们可以“部署”到客户站点作为
只读版本)

我们正在考虑使用某种 wiki 引擎，但它需要使用文件进行存储或有其他“部署”给客户的方式，并且易于安装/维护。此外，它必须是免费/便宜的(汇合太贵了)

有什么建议？

编辑:我不是在寻找记录代码的工具，我们使用 SandcaSTLe 进行了介绍。

Answer 1

尽管它可能无法满足您的所有要求，DokuWiki可能值得一看。

与其他 wiki 一样，它有一个 simple syntax , 并具有到 track revisions 的版本控制, 生成 table of contents , 和 full-text search可以为帮助系统派上用场的功能。

您可能想要评估 feature list看看它是否能满足您的需求。

另外，好像还有一个不错的collection of avaialble plugins .虽然我没有使用过 DokuWiki 或它的插件，但似乎有插件可用于 PDF export以及。