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

发布于 2024-08-28 08:30:00 字数 1539 浏览 7 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

蓝咒 2024-09-04 08:30:00

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

希望这有帮助。

We has been using XMLMind XML Editor to produce user documentation in the unified docbook format that can be stored in a version control system for the past 6 years. We use standard XSL transformations to generate user documentation from docbook in HTML and PDF format. Of course, this all is a part of the Continuous Integration and release build cycle.

Hope this helps.

薄荷港 2024-09-04 08:30:00

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

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

如果生成帮助文件与处理 Word 文档文件没什么区别,那么也许我不会费心将其集成到 CI 服务器上。 CI 服务器的构建工件文件夹将仅包含从版本控制中获取的帮助文件。

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

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

I don't know DocToHelp but here is my take:

Even if it's the only thing you do: Start with adding your generated help file and all the files you used to create it in your version control system.

If generating the help file is not much more then processing a Word doc file then perhaps I wouldn't bother integrating it on the CI server. Your CI server's build artifact folder will just contain the help file as fetched from version control.

If there is a whole bunch of files (perhaps externally linked images in the doc?) and there is a chance of failure you could add it (if the help file building tool allows).

Basically what your CI server would prove then is if it can reproduce your help file from version control (did you commit and add everything?).
Taking it even further you could build automated tests which would examine the build help file and compare it with the referenced helpcontext IDs in the software itself. But here I am speculating (I haven't done helpfiles in ages :-)).

铃予 2024-09-04 08:30:00

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

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

You might want to take a look at Doxygen:
http://www.doxygen.nl/

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文