3

我有一个正在进行持续集成的项目,并希望将最终用户文档添加到项目中。最终用户文档是用户手册,而不是 API 文档。在我们的环境中,我们使用 windows、c#、msbuild、cruisecontrol.net 和 subversion。我们目前正在使用 DocToHelp 创建我们的帮助文件,该文件基于 msword 文档。

我正在寻找有关如何管理最终用户文档的指导。我应该使用哪些文档工具?任何文档工具都应该是构建脚本的一部分吗?文档工具的输出文件是否应该存储在 subversion 中?最好使用哪种类型的帮助文件?

4

3 回答 3

0

在过去的 6 年中,我们一直在使用XMLMind XML Editor以统一的 docbook 格式生成用户文档,这些文档可以存储在版本控制系统中。我们使用标准 XSL 转换从 docbook生成HTML 和 PDF 格式的用户文档。当然,这一切都是持续集成和发布构建周期的一部分。

希望这可以帮助。

于 2010-04-10T07:49:15.573 回答
0

您可能想看看 Doxygen: http: //www.doxygen.nl/

Doxygen 是一个用于 C++、C、Java、Objective-C、Python、IDL(Corba 和 Microsoft 风格)、Fortran、VHDL、PHP、C# 的文档系统

于 2010-04-10T08:04:42.107 回答
0

我不知道 DocToHelp,但这是我的看法:

即使这是您唯一要做的事情:首先添加您生成的帮助文件以及您用于在版本控制系统中创建它的所有文件。

如果生成帮助文件并不比处理 Word doc 文件多,那么也许我不会费心将它集成到 CI 服务器上。您的 CI 服务器的构建工件文件夹将仅包含从版本控制中获取的帮助文件。

如果有一大堆文件(可能是文档中的外部链接图像?)并且有可能失败,您可以添加它(如果帮助文件构建工具允许)。

基本上,您的 CI 服务器将证明它是否可以从版本控制中重现您的帮助文件(您是否提交并添加了所有内容?)。更进一步,您可以构建自动化测试,该测试将检查构建帮助文件并将其与软件本身中引用的帮助上下文 ID 进行比较。但是我在这里推测(我已经很久没有做过帮助文件了:-))。

于 2010-04-17T04:50:55.240 回答