Hearing the Voice of Software Practitioners on Causes, Effects, and Practices to Deal with Documentation Debt

Rios, Nicolli; Mendes L.; Cerdeiral C.; Magalhães, A.P.F.; Perez, Boris; Correal, Darío

Abstract

[Context and Motivation] It is common for teams to take shortcuts during software development that, in the future, will lead to maintainability issues and affect productivity and development cost. Different types of technical debt may affect software projects, including those associated with software documentation. Although there are many studies on technical debt, few focus on documentation debt in an industrial environment. [Question/Problem] We aimed to identify how software practitioners perceive the occurrence of documentation debt in their projects. We present a combined analysis of the results from two complementary studies: a survey (InsighTD) and an interview-based case study. [Principal Ideas/Results] We provide a list of causes and effects of documentation debt, along with practices that can be used to deal with it during software development projects. [Contribution] We find that documentation debt is strongly related to requirements issues. Moreover, we propose a theoretical framework, which provides a comprehensive depiction of the documentation debt phenomenon.

Más información

Título según SCOPUS: Hearing the Voice of Software Practitioners on Causes, Effects, and Practices to Deal with Documentation Debt
Título de la Revista: Lecture Notes in Computer Science (including subseries Lecture Notes in Artificial Intelligence and Lecture Notes in Bioinformatics)
Volumen: 12045
Editorial: Springer Science and Business Media Deutschland GmbH
Fecha de publicación: 2020
Año de Inicio/Término: Mar 2020
Página final: 70
Idioma: English
DOI:

10.1007/978-3-030-44429-7_4

Notas: SCOPUS - Scopus 10.1007/978-3-030-44429-7_4