Research on Application of DevOps in Documentation towards Full Value Delivery

被引：0

作者：

Jin Z.-F. ^{[1
]}

Zhang Y.-W. ^{[1
]}

Ye W.-H. ^{[1
]}

Zhang H. ^{[2
]}

Shao D. ^{[2
]}

机构：

[1] Zhongxing Telecommunication Equipment Corporation, Nanjing

[2] State Key Laboratory for Novel Software Technology, Nanjing University, Nanjing

来源：

Ruan Jian Xue Bao/Journal of Software | 2019年 / 30卷 / 10期

基金：

中国国家自然科学基金;

关键词：

Agile; Continuous delivery; Continuous integration; DevOps; Document; Document DevOps; Value delivery;

D O I：

10.13328/j.cnki.jos.005792

中图分类号：

学科分类号：

摘要：

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. © Copyright 2019, Institute of Software, the Chinese Academy of Sciences. All rights reserved.

引用

页码：3127 / 3147

页数：20

共 27 条

[1]

Janessa R., Van Der Rob M., Gartner says by 2016, devops will evolve from a niche to a mainstream strategy employed by 25 percent of global 2000 organizations, (2015)

[2]

2016 state of the cloud report, (2016)

[3]

2017 state of the cloud report, (2017)

[4]

Van Heesch U., Theunissen T., Zimmermann O., Zdun U., Software specification and documentation in continuous software development: A focus group report, Proc. of the 22nd European Conf. on Pattern Languages of Programs, (2017)

[5]

Van Heesch U., Et al., Software specification in continuous software development-A focus group report, (2017)

[6]

Merilinna J., Matinlassi M., State of the art and practice of open source component integration, Proc. of the 32nd EUROMICRO Conf. on Software Engineering and Advanced Applications, EUROMICRO 2006, pp. 170-177, (2006)

[7]

Sommerville I., Software documentation process, Software Engineering, Vol 2: The Supporting Processes, pp. 141-164, (2002)

[8]

Briand L.C., Software documentation: How much is enough, Proc. of the 7th European Conf. on Software Maintenance and Reengineering, CSMR 2003, pp. 13-15, (2003)

[9]

De Souza S.C.B., Anquetil N., De Oliveira K.M., A study of the documentation essential to software maintenance, Proc. of the 23rd Annual Int'l Conf. on Design of Communication: Documenting & Designing for Pervasive Information, SIGDOC 2005, 2005, pp. 68-75, (2005)

[10]

Forward A., Et al., The relevance of software documentation, tools and technologies: A survey, Proc. of the 2002 ACM Symp. on Document Engineering, DocEng 2002, pp. 26-33, (2002)

← 1 2 3 →