Cost, benefits and quality of software development documentation: A systematic mapping

被引:63
|
作者
Zhi, Junji [1 ]
Garousi-Yusifoglu, Vahid [2 ,3 ]
Sun, Bo [4 ,5 ]
Garousi, Golara [3 ,6 ]
Shahnewaz, Shawn [3 ]
Ruhe, Guenther [3 ,4 ]
机构
[1] Univ Toronto, Dept Comp Sci, Comp Syst & Networks Res Grp, Toronto, ON M5S 1A1, Canada
[2] Atilim Univ, Dept Software Engn, Syst & Software Qual Engn Res Grp SySoQual, Ankara, Turkey
[3] Univ Calgary, Dept Elect & Comp Engn, Calgary, AB T2N 1N4, Canada
[4] Univ Calgary, Dept Comp Sci, Calgary, AB T2N 1N4, Canada
[5] iSolutions Inc, Calgary, AB, Canada
[6] GeoLOG Syst Inc, Calgary, AB, Canada
基金
加拿大自然科学与工程研究理事会;
关键词
Software documentation; Documentation benefit; Systematic mapping; DESIGN; MAINTENANCE; STATE; UML;
D O I
10.1016/j.jss.2014.09.042
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
Context: Software documentation is an integral part of any software development process. Researchers and practitioners have expressed concerns about costs, benefits and quality of software documentation in practice. On the one hand, there is a lack of a comprehensive model to evaluate the quality of documentation. On the other hand, researchers and practitioners need to assess whether documentation cost outweighs its benefit. Objectives: In this study, we aim to summarize the existing literature and provide an overview of the field of software documentation cost, benefit and quality. Method: We use the systematic-mapping methodology to map the existing body of knowledge related to software documentation cost, benefit and quality. To achieve our objectives, 11 Research Questions (RQ) are raised. The primary papers are carefully selected. After applying the inclusion and exclusion criteria, our study pool included a set of 69 papers from 1971 to 2011. A systematic map is developed and refined iteratively. Results: We present the results of a systematic mapping covering different research aspects related to software documentation cost, benefit and quality (RQ1-11). Key findings include: (1) validation research papers are dominating (27 papers), followed by solution proposals (21 papers). (2) Most papers (61 out of 69) do not mention the development life-cycle model explicitly. Agile development is only mentioned in 6 papers. (3) Most papers include only one "System under Study" (SUS) which is mostly academic prototype. The average number of participants in survey-based papers is 106, the highest one having approximately 1000 participants. (4) In terms of focus of papers, 50 papers focused on documentation quality, followed by 37 papers on benefit, and 12 papers on documentation cost. (5) The quality attributes of documentation that appear in most papers are, in order: completeness, consistency and accessibility. Additionally, improved meta-models for documentation cost, benefit and quality are also presented. Furthermore, we have created an online paper repository of the primary papers analyzed and mapped during this study. Conclusion: Our study results show that this research area is emerging but far from mature. Firstly, documentation cost aspect seems to have been neglected in the existing literature and there are no systematic methods or models to measure cost. Also, despite a substantial number of solutions proposed during the last 40 years, more and stronger empirical evidences are still needed to enhance our understanding of this area. In particular, what we expect includes (1) more validation or evaluation studies; (2) studies involving large-scale development projects, or from large number of study participants of various organizations; (3) more industry-academia collaborations; (4) more estimation models or methods to assess documentation quality, benefit and, especially, cost. (C) 2014 Elsevier Inc. All rights reserved.
引用
收藏
页码:175 / 198
页数:24
相关论文
共 50 条
  • [1] A mapping study on documentation in Continuous Software Development
    Theunissen, Theo
    van Heesch, Uwe
    Avgeriou, Paris
    [J]. INFORMATION AND SOFTWARE TECHNOLOGY, 2022, 142
  • [2] A mapping study on documentation in Continuous Software Development
    Theunissen, Theo
    van Heesch, Uwe
    Avgeriou, Paris
    [J]. Information and Software Technology, 2022, 142
  • [3] Quality measurement in agile and rapid software development: A systematic mapping
    Lopez, Lidia
    Burgues, Xavier
    Martinez-Fernandez, Silverio
    Vollmer, Anna Maria
    Behutiye, Woubshet
    Karhapaa, Pertti
    Franch, Xavier
    Rodriguez, Pilar
    Oivo, Markku
    [J]. JOURNAL OF SYSTEMS AND SOFTWARE, 2022, 186
  • [4] DevOps and software quality: A systematic mapping
    Mishra, Alok
    Otaiwi, Ziadoon
    [J]. COMPUTER SCIENCE REVIEW, 2020, 38 (38)
  • [5] Management of quality requirements in agile and rapid software development: A systematic mapping study
    Behutiye, Woubshet
    Karhapaa, Pertti
    Lopez, Lidia
    Burgues, Xavier
    Martinez-Fernandez, Silverio
    Vollmer, Anna Maria
    Rodriguez, Pilar
    Franch, Xavier
    Oivo, Markku
    [J]. INFORMATION AND SOFTWARE TECHNOLOGY, 2020, 123
  • [6] Quality Requirement Documentation Guidelines for Agile Software Development
    Behutiye, Woubshet
    Rodriguez, Pilar
    Oivo, Markku
    [J]. IEEE ACCESS, 2022, 10 : 70154 - 70173
  • [7] Software Quality Models: A Systematic Mapping Study
    Nistala, Padmalata
    Nori, Kesav Vithal
    Reddy, Raghu
    [J]. 2019 IEEE/ACM INTERNATIONAL CONFERENCE ON SOFTWARE AND SYSTEM PROCESSES (ICSSP 2019), 2019, : 125 - 134
  • [8] Software Quality Requirements: a systematic mapping study
    Ouhbi, Sofia
    Idri, Ali
    Luis Fernandez-Aleman, Jose
    Toval, Ambrosio
    [J]. 2013 20TH ASIA-PACIFIC SOFTWARE ENGINEERING CONFERENCE (APSEC 2013), VOL 1, 2013, : 231 - 238
  • [9] A systematic mapping study on gamified software quality
    Vargas-Enriquez, Juan
    Garcia-Mundo, Lilia
    Genero, Marcela
    Piattini, Mario
    [J]. 2015 IEEE 7TH INTERNATIONAL CONFERENCE ON GAMES AND VIRTUAL WORLDS FOR SERIOUS APPLICATIONS (VS-GAMES), 2015, : 131 - 138
  • [10] Quality Characteristics of Software Requirements: A Systematic Mapping
    Carrizo, Dante
    Urbina, Victor E.
    [J]. EDUCATION EXCELLENCE AND INNOVATION MANAGEMENT THROUGH VISION 2020, 2019, : 9034 - 9045