Software Systems Documentation: A Systematic Review

被引:0
|
作者
Alzahrani, Abdullah A. H. [1 ]
机构
[1] Umm Al Qura Univ, Engn & Comp Coll Alqunfuda, Dept Comp, Mecca, Saudi Arabia
关键词
Software engineering; software systems documentation; software maintenance; software quality; software development; QUALITY; CODE;
D O I
10.14569/IJACSA.2024.0150816
中图分类号
TP301 [理论、方法];
学科分类号
081202 ;
摘要
In the domain of software engineering, software documentation encompasses the methodical creation and management of artifacts describing software systems. Traditionally linked to software maintenance, its significance extends throughout the entire software development lifecycle. While often regarded as a quintessential indicator of software quality, the perception of documentation as a time-consuming and arduous task frequently leads to its neglect or obsolescence. This research presents a systematic review of the past decade's literature on software documentation to identify trends and challenges. Employing a rigorous systematic methodology, the study yielded 29 primary studies and a collection of related works. Analysis of these studies revealed two primary themes: issues and best practices, and models and tools. Findings indicate a notable research gap in the area of software documentation. Furthermore, the study underscores several critical challenges, including a dearth of automated tools, immature documentation models, and an insufficient emphasis on forward-looking documentation.
引用
收藏
页码:155 / 162
页数:8
相关论文
共 50 条
  • [41] Improving hardware/software interface management in systems of systems through documentation as code
    Héctor Cadavid
    Vasilios Andrikopoulos
    Paris Avgeriou
    Empirical Software Engineering, 2023, 28
  • [42] A Systematic Review of Methods for Business Knowledge Extraction from Existing Software Systems
    Normantas, Kestutis
    Vasilecas, Olegas
    BALTIC JOURNAL OF MODERN COMPUTING, 2013, 1 (1-2): : 29 - 51
  • [43] A Review on Error-Inclusive Approaches to Software Documentation and Training
    van der Meij, Hans
    Flacke, Marie-Louise
    TECHNICAL COMMUNICATION, 2020, 67 (01) : 83 - 95
  • [44] Software Analytics to Software Practice: A Systematic Literature Review
    Abdellatif, Tamer Mohamed
    Capretz, Luiz Fernando
    Ho, Danny
    2015 IEEE/ACM 1ST INTERNATIONAL WORKSHOP ON BIG DATA SOFTWARE ENGINEERING, 2015, : 30 - 36
  • [45] Structuring Electronic Nursing Documentation: A Systematic Review of the Literature
    Buyukyilmaz, Funda
    Kaya, Hatice
    FLORENCE NIGHTINGALE JOURNAL OF NURSING-FLORENCE NIGHTINGALE HEMSIRELIK DERGISI, 2016, 24 (02): : 106 - 117
  • [46] Development of the Documentation and Appraisal Review Tool for systematic reviews
    Rebecca L Diekemper
    Belinda K Ireland
    Liana R Merz
    World Journal of Meta-Analysis, 2015, (03) : 142 - 150
  • [47] Documentation Errors and Deficiencies in Medical Records: A Systematic Review
    Shahbodaghi, Azam
    Moghaddasi, Hamid
    Asadi, Farkhondeh
    Hosseini, Azamossadat
    JOURNAL OF HEALTH MANAGEMENT, 2024, 26 (02) : 351 - 368
  • [48] Automatic documentation of professional health interactions: A systematic review
    Falcetta, Frederico Soares
    de Almeida, Fernando Kude
    Lemos, Janaina Conceicao Sutil
    Goldim, Jose Roberto
    da Costa, Cristiano Andre
    ARTIFICIAL INTELLIGENCE IN MEDICINE, 2023, 137
  • [49] Development of the Documentation and Appraisal Review Tool for systematic reviews
    Diekemper, Rebecca L.
    Ireland, Belinda K.
    Merz, Liana R.
    WORLD JOURNAL OF META-ANALYSIS, 2015, 3 (03): : 142 - 150
  • [50] Electronic nursing documentation for patient safety, quality of nursing care, and documentation: A systematic review
    Wahyuni, Erna Dwi
    Nursalam, Nursalam
    Dewi, Yulis Setiya
    Arifin, Hidayat
    Benjamin, Lizy Sonia
    JOURNAL OF THE PAKISTAN MEDICAL ASSOCIATION, 2024, 74 (09) : 1669 - 1677