摘要:随着DevOps在各大软件企业中的广泛实施，加速了系统软件类产品的版本交付和部署.中兴通讯在实施过程中，发现产品重要的组成部分——产品文档，还采用传统研发方式，缺乏配套流程和工具，导致产品文档交付的节奏无法与软件版本匹配，严重影响了产品完整交付的及时性.文档DevOps是一种针对产品文档持续交付的模式.通过分析开源和DITA的文档交付解决方案，同时结合系统软件的研发特点，总结出一套适合系统软件的文档交付综合解决方案，它借助DevOps理念，基于业界的DevOps工具链，构建了"文档DevOps平台"（以下简称iDoc平台），实现面向用户各类文档交付的解决方案，其典型特征有：与软件迭代流程融合，信息单元同源引用，多格式内容源的管理，持续集成的质量守护.在实际企业中通过文档DevOps实现了产品文档与软件版本的同步交付，极大地促进了文档的准确性、完整性和交付效率的提升.iDoc平台已在50多个软件产品中得到成功应用.文档DevOps解决的问题具有普遍性，有助于在更大范围内帮助其他系统软件实现敏捷价值交付，并且，文档DevOps还是对DevOps的一个补充，扩展了业界的DevOps的适用范围：交付对象涵盖了产品文档，流程延伸到市场规划，协同人员覆盖面更广.



Abstract:With the extensive implementation of DevOps in major software enterprises, the version delivery and deployment of system software class products has been accelerated. In the process of implementation, it is found that the important part of the product, the product document, is still developed by traditional R&D method and lack of supporting processes and tools, which leads to the delay in the product document delivery comparing with the delivery of the software version, and which seriously affected the complete and just-in-time delivery of the product. The "Document DevOps" introduced in this paper is a continuous product document delivery mode. By analyzing the document delivery solutions of open source and DITA, and combining with the R&D characteristics of system software, a set of comprehensive document delivery solutions that is fit for system software has been summarized. With the concept of DevOps, and based on the DevOps tool chain of the industry, it has contracted a "Document DevOps Platform" (hereinafter referred to as the platform), to achieve a user-oriented document delivery solution. Its typical characteristics are:integration with software iteration process, information unit homologous citation, management of multi-format content sources, and protection of continuous integration quality. Zhongxing has achieved the simultaneous delivery of product documents and software versions by the "Document DevOps", which greatly improves the accuracy, integrity, and delivery efficiency of documents. The iDoc platform has been successfully applied in more than 50 software products. The problem solved by the "Document DevOps" is universal, helping the other system software to achieve agile value delivery in a wider range. Moreover, the "Document DevOps" is a supplement to DevOps, for it extends the application scope of DevOps:the delivery object covers product documentation, and the process extends to market planning, covering a broader range of collaborative personnel.



PDF全文下载地址:

http://jos.org.cn/jos/article/pdf/5792