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 条
  • [21] Taxonomy of Quality Assessment for Intelligent Software Systems: A Systematic Literature Review
    Jabborov, Ahror
    Kharlamova, Arina
    Kholmatova, Zamira
    Kruglov, Artem
    Kruglov, Vasily
    Succi, Giancarlo
    IEEE ACCESS, 2023, 11 : 130491 - 130507
  • [22] Software Architectures for Adaptive Mobile Learning Systems: A Systematic Literature Review
    Nepomuceno, Aldair Ruiz
    Dominguez, Eduardo Lopez
    Isidro, Saul Dominguez
    Medina Nieto, Maria Auxilio
    Meneses-Viveros, Amilcar
    de la Calleja, Jorge
    APPLIED SCIENCES-BASEL, 2024, 14 (11):
  • [23] A systematic literature review of the use of formal methods in medical software systems
    Bonfanti, Silvia
    Gargantini, Angelo
    Mashkoor, Atif
    JOURNAL OF SOFTWARE-EVOLUTION AND PROCESS, 2018, 30 (05)
  • [24] Business process flexibility - a systematic literature review with a software systems perspective
    Riccardo Cognini
    Flavio Corradini
    Stefania Gnesi
    Andrea Polini
    Barbara Re
    Information Systems Frontiers, 2018, 20 : 343 - 371
  • [25] Business process flexibility - a systematic literature review with a software systems perspective
    Cognini, Riccardo
    Corradini, Flavio
    Gnesi, Stefania
    Polini, Andrea
    Re, Barbara
    INFORMATION SYSTEMS FRONTIERS, 2018, 20 (02) : 343 - 371
  • [26] Use of Review Software for IACUC Protocol Review and Member Training Documentation
    Lyons, J.
    Pritt, S. L.
    JOURNAL OF THE AMERICAN ASSOCIATION FOR LABORATORY ANIMAL SCIENCE, 2011, 50 (05): : 722 - 723
  • [27] Documentation during neonatal resuscitation: a systematic review
    Avila-Alvarez, Alejandro
    Davis, Peter Graham
    Kamlin, Camille Omar Farouk
    Thio, Marta
    ARCHIVES OF DISEASE IN CHILDHOOD-FETAL AND NEONATAL EDITION, 2021, 106 (04): : 376 - 380
  • [28] A systematic review of software robustness
    Shahrokni, Ali
    Feldt, Robert
    INFORMATION AND SOFTWARE TECHNOLOGY, 2013, 55 (01) : 1 - 17
  • [29] A systematic review of systematic review process research in software engineering
    Kitchenham, Barbara
    Brereton, Pearl
    INFORMATION AND SOFTWARE TECHNOLOGY, 2013, 55 (12) : 2049 - 2075
  • [30] Software Documentation Quality A Case Study for the Software Documentation of SIGEPE
    da Silva, Waldeyr Mendes C.
    de Sousa, Rafael
    da Mata, Daniel Q.
    Araujo, Aleteia P. F.
    Holanda, Maristela
    dos Santos, Gileno Dias
    2015 10TH IBERIAN CONFERENCE ON INFORMATION SYSTEMS AND TECHNOLOGIES (CISTI), 2015,