你的团队使用什么工具编写用户手册？
基本要求是：
- 人类可读/文本格式（便于版本控制）
- 在线（用于协作）
- 容易格式化（markdown ok，html太多了）
- 严格的格式（所以作者不发明新的标题，子弹等types）
- 可导出为PDF，HTML
- 容易的备份和部署（所以我们可以“只”部署到客户站点作为只读版本）
我们正在考虑使用某种wiki引擎，但是它需要使用文件进行存储，或者有其他的方式来“部署”给客户，并且易于安装/维护。 此外，它将不得不免费/便宜（合stream是太昂贵）
有什么build议么？
编辑：我不是在寻找工具来logging代码，我们有覆盖使用沙堡。
虽然它可能不会回答你的所有要求， DokuWiki可能值得一看。
与其他wiki一样，它有一个简单的语法 ，并有版本控制来跟踪修订 ，生成目录和全文searchfunction，可以方便地帮助系统。
您可能需要评估function列表 ，看它是否能满足您的需求。
此外，似乎也有一个很好的收集可用插件 。 虽然我没有使用过DokuWiki或者它的插件，但是似乎还有可用于PDF导出的插件。
胶乳
对于我们的API，我们使用Doxygen ，这非常棒。
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 org-mode，EPUB电子书，以及S5和Slidy HTML幻灯片。 PDF输出（通过LaTeX）也支持包含markdown2pdf包装脚本。
Pandoc获得额外的开放源代码，并在Haskell的热点写入;）
我不能说关于Asciidoc的好东西。 它具有非常简单的标记语法，可以生成从pdf到roff的所有内容，可移植实现，并且只需稍加修改即可轻松插入任何wiki。
即使在标记状态下，也非常容易阅读。 使用它的唯一的东西是表格，但这并不难。
如果将文本格式的文件保存在存储库中，修订版本跟踪非常简单。
对于代码清理，我使用Doxygen 。
我们使用手册和帮助文件的帮助和手册 。 没有html导出，但它提供了html帮助，winhelp，pdf和一些更多的格式。
我们正在使用维基。 我build议MoinMoin因为
- 安装非常简单（甚至在笔记本电脑上）
- 非常简单的备份（甚至可以将wiki提交到版本控制系统，以在笔记本电脑之间进行同步，以便离线使用）。
- 很好的语法
- 容易延伸
- 易于search
我们不使用像Word一样的东西，因为：
- 文档腐烂太快
- search所有文件是一个痛苦
- 信息位之间的链接是一个痛苦
- 版本之间没有差异
- 二进制格式，从任何VCS中榨取地狱
- 没有深刻的书签
- 文件变得太大，然后他们变得笨拙：分裂（和不再search）或等待年龄加载。
你没有提到你正在使用的语言/框架。 这里有非常好的文档工具，但其中一些特定于您正在开发的内容。我们是C＃商店，所以如果您使用.NET，我的答案将只适用于您。
我们使用Sandcastle ，它不仅是免费的，而且是开源的。 虽然人们主要将其看作是从XML文档生成文档的应用程序，但您可以在MAML中提供自己的内容。 它可以针对CHM和网站部署，满足我们的需求。 还有一些额外的工具可以提供诸如标记collections夹和主题评分之类的东西，但我们还没有开始使用它们。
这为我们提供了内部和外部的文件。 由于我们也使用了Team Foundation Server，所以我们在Sharepoint的团队项目中使用了内置的Wiki，但是更适合于项目协作。
编辑：修复了断开的链接，也想提一下还有其他的工具与Sandcastle一起使用。 像Sandcastle帮助文件生成器和GhostDoc的东西是常用的工具。 第一个编辑Sandcastle项目和MAML，第二个提高代码中的注释质量。
尝试狮身人面像 。 所有的python文档都是使用这个工具http://docs.python.org/
对于“手册”，Docbook。 这是一个为技术文档devise的SGML方言。 http://www.docbook.org/ 。 它可能不符合你的“简单标记”标准，但它确实在LaTex（可以转换为PDF）和良好的HTML输出产生良好的输出，如果你煮你自己的CSS样式表。 文本文件保存在版本控制中。 所有程序还使用一个库，它将命令行参数parsing与“–help”输出结合在一起，形成格式select（正常，手册页和docbook）。 对于API参考，doxygen当然。
在我目前的工作中，我们只使用一次性软件，所以文档经常被放在旁边，在Word中完成。
然而，在我上一份工作中，文档团队似乎不断咆哮疯狂的上限软件产品“Flare” 。 它允许你写在一个格式和发布到许多媒体，所以你的手册也可以是你的在线帮助或网站等…
尝试Dikiwiki
我们使用Word。 它被放入我们的版本控制，所以我们有历史（有一个文档文件夹链接到每个项目）。 格式化可以使用模板进行控制，所有这些都是我们现在设置的，所以在布局标准中做出更改很容易。 这些文件可以导出为PDF。 您可以将它们发布为只读文档，以便与用户分享。
DocToHelp已经取得了巨大的成功。 它适用于基于Microsoft Word的文档以及其他forms，甚至为Visual Studio提供了一些很好的集成function。
最好的部分是，一旦你有一个核心的文档库导入到DocToHelp，你可以select任何一种导出格式WinHelp，HTML帮助，Java帮助或漂亮的和可search的networking帮助。
代码我使用Doxigen。 我更喜欢linux版本，在Windows版本中有一些function有问题
我的公司使用MediaWiki和TikiWiki获取大多数文档。 我们也有一个人编译成MS Word和PDF格式的东西打印/发送给客户。 我build议你避免像瘟疫一样的TikiWiki。 MediaWiki是伟大的，因为它很容易使用，因为每个人都知道如何使用它 – 这是事实上的标准维基，恕我直言，恕我直言。
一段时间以来，我们一直在使用DocBook，但很难用更先进和必要的function（语法高亮，分割成多个文件，多语言pipe理等）进行扩展。 后来，我们决定从头开始编写我们自己的系统，并将其作为开源： 链接文本发布 。 它使用纯文本文件和Markdown作为语法语言，现在我们拥有了我们所需要的一切。 缺点是目前可能没有Markdownparsing器产生的东西不是HTML输出。 目前这已经足够了，但我们正在考虑很快实施PDF支持。
而且，我们正在维护MediaWiki作为一个基于社区的帮助。
