Documentation Technical Debt - A Qualitative Study in a Software Development Organization

被引:0
|
作者
Mendes, Leonardo [1 ]
Cerdeiral, Cristina [1 ]
Santos, Gleison [1 ]
机构
[1] Univ Fed Estado Rio Janeiro UNIRIO, Rio De Janeiro, Brazil
关键词
Technical Debt; Documentation Technical Debt; Software; Documentation; Technical Debt Management; MANAGEMENT;
D O I
10.1145/3350768.3350773
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
Context: Technical debt refers to software development pending issues that may cause great damages in the future if not resolved in the present. The longer the payment is delayed, the greater the interests. Documentation technical debt comprises problems concerning non-existent, inadequate or incomplete software projects' documentation. Motivation: Despite the importance of documentation, there is a lack of reports on how documentation technical debt occurs in software development organizations. Objective: We executed a qualitative study in a software development team of a large public health organization aiming to identify causes that led to documentation technical debts, along with possible consequences of their occurrence, and best practices to avoid documentation problems. Method: We interviewed four members of the development team and codified the collected data using thematic analysis technique. Results: We identified 35 causes, 20 consequences, and 15 best practices. Conclusions: We identified several problems that led to poor documentation despite the existence of well-defined processes. Also, we could observe how organizational culture influences the processes execution, and how team members' technical expertise can minimize the effects of poor documentation.
引用
收藏
页码:447 / 451
页数:5
相关论文
共 50 条
  • [31] Investigating on the impact of software clones on Technical Debt
    Lerina, Aversano
    Nardi, Laura
    2019 IEEE/ACM INTERNATIONAL CONFERENCE ON TECHNICAL DEBT (TECHDEBT 2019), 2019, : 108 - 112
  • [32] Machine Learning for Software Technical Debt Detection
    Kachanov, V. V.
    Markov, S. I.
    Tsurkov, V. I.
    JOURNAL OF COMPUTER AND SYSTEMS SCIENCES INTERNATIONAL, 2023, 62 (04) : 689 - 694
  • [33] The influence of Technical Debt on software developer morale
    Besker, Terese
    Ghanbari, Hadi
    Martini, Antonio
    Bosch, Jan
    JOURNAL OF SYSTEMS AND SOFTWARE, 2020, 167
  • [34] Exploring Technical Debt on IoT Software Projects
    Rios, Nicolli
    Spinola, Rodrigo
    Travassos, Guilherme H.
    PROCEEDINGS OF THE 21TH BRAZILIAN SYMPOSIUM ON SOFTWARE QUALITY, SBOS 2022, 2022,
  • [35] Machine Learning for Software Technical Debt Detection
    V. V. Kachanov
    S. I. Markov
    V. I. Tsurkov
    Journal of Computer and Systems Sciences International, 2023, 62 : 689 - 694
  • [36] A Recommender System for Technical Software Documentation in Wikis
    Andres Diaz-Pace, J.
    Nicoletti, Matias
    Schiaffino, Silvia
    Crisanto, Rodrigo
    Najle, Martin
    2014 IEEE BIENNIAL CONGRESS OF ARGENTINA (ARGENCON), 2014, : 393 - 398
  • [37] Managing Technical Debt in Enterprise Software Packages
    Ramasubbu, Narayan
    Kemerer, Chris F.
    IEEE TRANSACTIONS ON SOFTWARE ENGINEERING, 2014, 40 (08) : 758 - 772
  • [38] Clone Detection in Reuse of Software Technical Documentation
    Koznov, Dmitrij
    Luciv, Dmitry
    Basit, Hamid Abdul
    Lieh, Ouh Eng
    Smirnov, Mikhail
    PERSPECTIVES OF SYSTEM INFORMATICS, PSI 2015, 2016, 9609 : 170 - 185
  • [39] 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 - +
  • [40] Navigating social debt and its link with technical debt in large-scale agile software development projects
    Saeeda, Hina
    Ahmad, Muhammad Ovais
    Gustavsson, Tomas
    SOFTWARE QUALITY JOURNAL, 2024, 32 (04) : 1581 - 1613