Documentation 您的团队使用什么工具编写用户手册？_Documentation_Wiki_Markdown_Manuals

Documentation 您的团队使用什么工具编写用户手册？

documentation markdown

Documentation 您的团队使用什么工具编写用户手册？,documentation,wiki,markdown,manuals,Documentation,Wiki,Markdown,Manuals,基本要求如下：可读/文本格式（便于版本控制）在线（用于协作）易于格式化（标记ok，html太多）严格的格式（因此作者不会发明新类型的标题，子弹等）可导出为PDF、HTML 易于备份和部署（因此我们可以将其“部署”到客户站点只读版本）我们正在考虑使用某种wiki引擎，但它需要使用文件进行存储，或者对客户使用其他“部署”方式，并且易于安装/维护。此外，它必须是免费/便宜的（confluence太贵了）有什么建议吗编辑：我不是在寻找记录代码的工具，我们已经用Sandcastle

基本要求如下：

可读/文本格式（便于版本控制）
在线（用于协作）
易于格式化（标记ok，html太多）
严格的格式（因此作者不会发明新类型的标题，子弹等）
可导出为PDF、HTML
易于备份和部署（因此我们可以将其“部署”到客户站点只读版本）

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

有什么建议吗

编辑：我不是在寻找记录代码的工具，我们已经用Sandcastle涵盖了这一点

我们用于手册和帮助文件。没有html导出，但它提供html帮助、winhelp、pdf和其他一些格式。

试试我们使用Word。它被放入我们的版本控制中，所以我们有历史记录（每个项目都有一个文档文件夹链接）。格式可以使用模板进行控制，我们现在已经设置了所有模板，因此在布局标准内进行更改很容易。这些文件可以导出为PDF格式。您可以将它们发布为只读文档，以便与用户共享。

尽管它可能无法满足您的所有请求，但可能值得一看

与其他Wiki一样，它有一个用于生成的版本控制，以及一个可以方便地用于帮助系统的功能

您可能需要评估，看看它是否能满足您的需求

还有，似乎也有一个好的。虽然我没有使用DokuWiki或其插件，但似乎也有可用的插件。

对于我们的API，我们使用，这很好。

我们使用的是wiki。我推荐是因为

设置非常简单（即使在笔记本电脑上）
备份非常简单（您甚至可以将wiki提交到版本控制系统，以便在笔记本电脑之间进行同步，以便脱机使用）
好语法
易于扩展
易于搜索

我们不使用类似Word的东西，因为：

文档腐烂得太快了
搜索所有文档是一件痛苦的事
信息位之间的链接是一种痛苦
版本之间没有差异
二进制格式，它把任何VCS都搞砸了
没有深度书签
文档变得太大，然后变得笨拙：拆分（不再搜索）或等待加载

Edit：修复了断开的链接，还想提及我们使用的与Sandcastle相关的其他工具。像和这样的东西是常用的工具。第一个用于编辑Sandcastle项目和MAML，第二个用于提高代码中的注释质量。