编写和维护印刷文档的工具

Question

我们的一些客户要求以适合打印的格式提供最终用户文档。目前，我使用Microsoft Word 2002编写文档和非免费的PDF打印机来生成带有可搜索书签的PDF文件。然后我将这两个文件存储在Subversion repositoryT中。虽然它有效，但它有一些缺点：

• 它不是版本控制友好的。更具体地说，我不能在分支之间移植更改，并且很难处理徽标或屏幕捕获等品牌内容。
• 我有时会忘记生成输出所需的一些手动步骤，PDF文件中缺少目录。

我需要一个适用于 Windows 的工具，允许维护同一文档的并行分支，提供一种处理图像的简单方法 （外部文件可以加分）并使用可搜索的书签生成高质量的 PDF 文件。如果它是免费的或开源的并且具有合理的学习曲线，我也会感激。

目标是为PHP驱动的Intranet站点生成可打印的最终用户手册，我不是在寻找在线文档或API文档工具。你有什么建议？

Answer 1

我喜欢DocBook +这种类型工作的首选SCM工具（Subversion）。可以从单一来源生成html和pdf输出（使用xsl转换+一些FOP处理器）。 DocBook起初并不简单，但功能非常强大。

Answer 2

这可能有点矫枉过正，但我​​推荐LyX。它是一个跨平台，OSS，用户友好的LaTeX前端。

文档的“源”文件采用文本和版本控制，并且合并友好。在学习曲线方面，直接使用LyX代替LaTeX是一个很好的选择。

我们已经将它用于小组文档，并且在版本控制中合并的能力是一个真正的好处。

Answer 3

我建议使用 LaTeX 和一个好的工作流脚本或Makefile（例如Google代码上的latex-makefile项目）来处理dvi / ps生成并使用正确数量的编译。另外，为了简单处理本地修订， Mercurial 比svn设置/使用起来要简单得多，就像 hg init，hg add，hg commit 一样简单！你的训练在这里完成:-)。它让我想起了我如何在本地使用RCS来满足我自己对LaTeX和源文件的需求。当需要并行版本的文档时，创建分支或简单地克隆存储库也非常容易。

如果你更愿意留在所见即所得的世界，另一个更好的版本控制的解决方案是使用 Open Office 和OOoSVN extension，它允许存储修订版（更大的）未压缩的XML文件，但真正处理差异，与存储二进制文件时发生的情况相反。不像第一个解决方案恕我直言，但这个解决方案将避免遗留文档和LaTeX学习曲线的翻译（说实话，它根本不陡峭）。

希望它会有所帮助。

Answer 4

我们使用LaTeX生成文档。您可以生成任何类型的文档... PDF等。 所有文档都存储在一个额外的SVN中。因此，很容易通知客户有关文档的更改。

此外，您的团队可以在文档上一起工作，并且满足您对多个分支的需求。

我们的文档由Hudson定期编写。

Answer 5

在此处查看巨大文档工具列表：

http://www.doxygen.nl/links.html

我曾经使用Doc-O-Matic作为我的Delphi项目，并且非常喜欢它 - 但是在几年前。当时评估中的第2名是Help & Manual，得分几乎和Doc-o-Matic一样高。

两者都是商业工具，但从长远来看，它们值得你花费你的每一分钱。

Answer 6

你考虑过LaTeX吗？由于它基于源的性质，它对SCM非常友好，并且有非常强大的功能和包，用于PDF导出，维护词汇表，首字母缩略词，自动TOC生成，嵌入式源代码等。