Modelo de métricas para apoyar la evaluación de la deuda de la documentación en proyectos de software ágil

Abstract

Antecedentes: La deuda de la documentación de software se refiere a la falta o insuficiencia de información detallada y actualizada acerca del código, diseño, y funcionamiento de un programa informático. Esta carencia puede acumularse debido a restricciones de tiempo, cambios rápidos en los requisitos o prioridades, y puede resultar en dificultades para comprender, mantener y mejorar el software a lo largo del tiempo. Abordar la deuda de documentación implica dedicar esfuerzos para crear y mantener una documentación clara y completa, lo que contribuye a la comprensión efectiva y al desarrollo sostenible del software. Objetivos: Diseñar un modelo de métricas para medir la deuda de la documentación que se genera durante la ejecución de proyectos de desarrollo ágil de software mediante la definición de mecanismos de evaluación que integren características de transparencia sobre los atributos de la documentación en este tipo de proyectos. Método(s): Se utilizaron los siguientes métodos de investigación: (i) el método de investigación-acción, (ii) enfoque GQM (Goal-Question-Metric), y (iii) el estudio de caso. Resultados: (i) una revisión sistemática de la literatura para recolectar toda la información relevante sobre deuda de la documentación en el desarrollo ágil de software, (ii) una versión inicial de una ontología para organizar el conocimiento sobre la deuda de la documentación, (iii) una definición de las características y dimensiones de la documentación, así como un conjunto de 15 riesgos para documentación, (iv) un modelo de referencia compuesto por 39 métricas asociadas a las características de la documentación, las cuales fueron evaluadas mediante un estudio de caso, (v) una publicación en una revista indexada. Conclusiones: La solución propuesta es una valiosa iniciativa para estructurar el conocimiento sobre deuda de la documentación en el desarrollo ágil de software a partir de una revisión sistemática y la caracterización de este tipo de deuda. Asimismo, el modelo de métricas diseñado permite realizar un diagnóstico sobre el nivel de deuda en la documentación de los proyectos software para diseñar estrategias de solución o mitigación.

Background: Software documentation debt refers to the lack or insufficiency of detailed and updated information about the code, design, and operation of a computer program. This deficiency can accumulate due to time constraints, rapid changes in requirements or priorities, and can result in difficulties understanding, maintaining, and improving the software over time. Addressing documentation debt involves efforts to create and maintain clear and comprehensive documentation, contributing to effective understanding and sustainable software development. Objectives: Design a metrics model to measure documentation debt generated during the execution of agile software development projects by defining evaluation mechanisms that integrate transparency features regarding the attributes of documentation in these types of projects. Method(s): The following research methods were employed: (i) the action research method, (ii) the GQM (Goal-Question-Metric) approach, and (iii) the case study. Results: (i) a systematic literature review to gather all relevant information about documentation debt in agile software development, (ii) an initial version of an ontology to organize knowledge about documentation debt, (iii) a definition of documentation characteristics and dimensions, along with a set of 15 documentation risks, (iv) a reference model consisting of 39 metrics associated with documentation characteristics, evaluated through a case study, and (v) a publication in a indexed journal. Conclusions: The proposed solution is a valuable initiative to structure knowledge about debt documentation in agile software development through a systematic review and characterization of this type of debt. Likewise, the designed metrics model allows for a diagnosis of the level of debt in the documentation of software projects to design solution or mitigation strategies.