Buenas prácticas de documentación en desarrollo de software: Optimización a través de Jira Atlassian

Abstract

[ES] Este documento presenta un marco de trabajo para analizar y promover buenas prácticas de documentación en los procesos de desarrollo de software, optimizándolos a través de la plataforma Jira Software. Se explora, cómo la integración de Jira con técnicas de generación automática de documentos puede mejorar la eficiencia y calidad de la documentación asociada al desarrollo de software, lo cual impacta significativamente en la productividad y éxito de los proyectos. Se examinan los beneficios, desafíos y posibles aplicaciones de esta integración en proyectos de desarrollo ágil de software.

En primer lugar, se presenta un análisis de Jira Software, para definir una estructura ideal para la presentación de proyectos de software, basándose en estándares prácticos, es decir, una visión pragmática del ciclo de desarrollo de software. Luego, se extraen datos utilizando la herramienta Retool, que, con la ayuda de la inteligencia artificial, permite extraer información clave para la creación de introducciones, planes de trabajo y requerimientos del proyecto a partir de la información proporcionada en las tareas. Posteriormente, toda esta información se estructura en DITA para que pueda ser extraída y transformada según las necesidades de la documentación.

En este proyecto se aprovecha todo el potencial de estas herramientas de organización de software para crear un proceso de documentación semiautomático que ayude a los equipos de software a mejorar y ser más ágiles en su trabajo de documentación. Asimismo, se establecen buenas prácticas para las diferentes necesidades de una empresa de software.

[EN] This document presents a framework for analyzing and promoting a better documentation practice in software development processes, optimizing them through the Jira Software platform. It explores how integrating Jira with automatic document generation techniques can improve the efficiency and quality of documentation associated with software development, which significantly impacts the productivity and success of projects. The benefits, challenges, and potential applications of this integration in agile software development projects are examined.

First, an analysis of Jira Software is presented to define an ideal structure for presenting software projects, based on practical standards, a pragmatic view of the software development cycle. Then, data is extracted using the Retool tool, which, with the help of artificial intelligence, allows for extracting key information to create introductions, work plans, and project requirements from the task data. Subsequently, all this information is structured in DITA, so it can be extracted and transformed according to documentation needs.

This project leverages the full potential of these software organization tools to create a semi-automated documentation process that helps software teams improve and become more agile in their documentation work. Additionally, best practices are established to meet the various needs of a software company.