documentation - 如何在持续集成下管理项目的最终用户文档?

标签 documentation continuous-integration end-user

<分区>

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

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

最佳答案

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

希望这对您有所帮助。

关于documentation - 如何在持续集成下管理项目的最终用户文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2603263/

相关文章:

Eclipse 中的 C++ 代码浏览器

ruby-on-rails - 在 Rails 中记录部分参数

ios - Xcode Server CI Bot 构建失败 - 无法启动模拟器

vb.net - 允许最终用户移动控件

boost - Boost 库的 Doxygen 文档?

ruby-on-rails - 如何阅读/理解 ruby​​/rails 文档

android - 无法更新\.gradle\caches\4.4\file-changes\last-build.bin

go - Golang 的 Codeclimate 测试覆盖格式化程序

c++ - 如何在 Linux (Ubuntu) 上将 SDL 静态链接到我的 a.out

npm 和 bower 仅安装最终用户/生产文件