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 条
  • [1] Knowledge-based approaches in software documentation: A systematic literature review
    Ding, Wei
    Liang, Peng
    Tang, Antony
    van Vliet, Hans
    INFORMATION AND SOFTWARE TECHNOLOGY, 2014, 56 (06) : 545 - 567
  • [2] A systematic review on the engineering of software for ubiquitous systems
    Guinea, Alejandro Sanchez
    Nain, Gregory
    Le Traon, Yves
    JOURNAL OF SYSTEMS AND SOFTWARE, 2016, 118 : 251 - 276
  • [3] A Systematic Literature Review on the Description of Software Architectures for Systems of Systems
    Guessi, Milena
    Neto, Valdemar V. G.
    Bianchi, Thiago
    Felizardo, Katia R.
    Oquendo, Flavio
    Nakagawa, Elisa Y.
    30TH ANNUAL ACM SYMPOSIUM ON APPLIED COMPUTING, VOLS I AND II, 2015, : 1433 - 1440
  • [4] Choosing an NLP Library for Analyzing Software Documentation: A Systematic Literature Review and a Series of Experiments
    Al Omran, Fouad Nasser A.
    Treude, Christoph
    2017 IEEE/ACM 14TH INTERNATIONAL CONFERENCE ON MINING SOFTWARE REPOSITORIES (MSR 2017), 2017, : 187 - 197
  • [5] Artificial Intelligence (AI) - Powered Documentation Systems in Healthcare: A Systematic Review
    Bracken, Aisling
    Reilly, Clodagh
    Feeley, Aoife
    Sheehan, Eoin
    Merghani, Khalid
    Feeley, Iain
    JOURNAL OF MEDICAL SYSTEMS, 2025, 49 (01)
  • [6] Preliminary Systematic Literature Review of Software and Systems Traceability
    Kaiya, Haruhiko
    Sato, Ryohei
    Hazeyama, Atsuo
    Ogata, Shinpei
    Okubo, Takao
    Tanaka, Takafumi
    Yoshioka, Nobukazu
    Washizaki, Hironori
    KNOWLEDGE-BASED AND INTELLIGENT INFORMATION & ENGINEERING SYSTEMS, 2017, 112 : 1141 - 1150
  • [7] Threat analysis of software systems: A systematic literature review
    Tuma, K.
    Calikli, G.
    Scandariato, R.
    JOURNAL OF SYSTEMS AND SOFTWARE, 2018, 144 : 275 - 294
  • [8] Software architecture for quantum computing systems - A systematic review
    Khan, Arif Ali
    Ahmad, Aakash
    Waseem, Muhammad
    Liang, Peng
    Fahmideh, Mahdi
    Mikkonen, Tommi
    Abrahamsson, Pekka
    JOURNAL OF SYSTEMS AND SOFTWARE, 2023, 201
  • [9] Variability in Software Systems-A Systematic Literature Review
    Galster, Matthias
    Weyns, Danny
    Tofan, Dan
    Michalik, Bartosz
    Avgeriou, Paris
    IEEE TRANSACTIONS ON SOFTWARE ENGINEERING, 2014, 40 (03) : 282 - 306
  • [10] Technical documentation of software and hardware in embedded systems
    Muranko, Beate
    Drechsler, Rolf
    IFIP VLSI-SOC 2006: IFIP WG 10.5 INTERNATIONAL CONFERENCE ON VERY LARGE SCALE INTEGRATION & SYSTEM-ON-CHIP, 2006, : 261 - +