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 条
  • [31] Systematic development of requirements documentation for general purpose scientific computing software
    Smith, Spencer
    RE'06: 14TH IEEE INTERNATIONAL REQUIREMENTS ENGINEERING CONFERENCE, PROCEEDINGS, 2006, : 209 - 218
  • [32] Product Review: Covidence (Systematic Review Software)
    Babineau, Jessica
    JOURNAL OF THE CANADIAN HEALTH LIBRARIES ASSOCIATION, 2014, 35 (02): : 68 - 71
  • [33] Software documentation process - McGraw-Hill school systems
    Rogers, AE
    STC 1996 PROCEEDINGS - 43RD ANNUAL CONFERENCE: EVOLUTION/REVOLUTION, 1996, : 515 - 515
  • [34] Home-based telerehabilitation software systems for remote supervising: a systematic review
    Hosseiniravandi, Mohammad
    Kahlaee, Amir H.
    Karim, Hesam
    Ghamkhar, Leila
    Safdari, Reza
    INTERNATIONAL JOURNAL OF TECHNOLOGY ASSESSMENT IN HEALTH CARE, 2020, 36 (02) : 113 - 125
  • [35] Reference Architectures for Self-Managed Software Systems: a Systematic Literature Review
    Affonso, Frank J.
    Scannavino, Katia R. F.
    Oliveira, Lucas B. R.
    Nakagawa, Elisa Y.
    2014 EIGHTH BRAZILIAN SYMPOSIUM ON SOFTWARE COMPONENTS, ARCHITECTURES AND REUSE (SBCARS), 2014, : 21 - 31
  • [36] A systematic review of applying modern software engineering techniques to developing robotic systems
    Pons, Claudia
    Giandini, Roxana
    Arevalo, Gabriela
    INGENIERIA E INVESTIGACION, 2012, 32 (01): : 58 - 63
  • [37] Information systems security practices in social software applications A systematic literature review
    Tamrin, Suraya Ika
    Norman, Azah Anir
    Hamid, Suraya
    ASLIB JOURNAL OF INFORMATION MANAGEMENT, 2017, 69 (02) : 131 - 157
  • [38] A systematic review of solar photovoltaic energy systems design modelling, algorithms, and software
    Kazem, Hussein A.
    Chaichan, Miqdam T.
    Al-Waeli, Ali H. A.
    Gholami, Aslan
    ENERGY SOURCES PART A-RECOVERY UTILIZATION AND ENVIRONMENTAL EFFECTS, 2022, 44 (03) : 6709 - 6736
  • [39] AN EMPIRICAL-INVESTIGATION OF THE EFFECTIVENESS OF SOFTWARE DOCUMENTATION DELIVERY SYSTEMS
    EMDAD, A
    JOURNAL OF SYSTEMS AND SOFTWARE, 1991, 16 (02) : 129 - 134
  • [40] Improving hardware/software interface management in systems of systems through documentation as code
    Cadavid, Hector
    Andrikopoulos, Vasilios
    Avgeriou, Paris
    EMPIRICAL SOFTWARE ENGINEERING, 2023, 28 (04)