¿Por qué es importante la documentación de software?
Cuando una persona que programa escucha “hay que documentar”, podrás notar una cara de desagrado o molestia, esto es porque les parece una tarea tediosa y aburrida, pero sabemos que es necesaria. No te voy a mentir, es cierto, la documentación puede llegar a ser difícil, sin embargo, aquí te platico rápidamente por qué es necesaria y tambien te comparto unos tips para que se te haga más fácil:
Llevar la documentación es como llevar una bitácora.
El hecho de tener registros desde el inicio hasta que finaliza o se entrega del proyecto, es lo que hace que parezca que llevas una bitácora. Hay que tomar nota de todo, incluyendo cuando haya cambios, pues esto funciona para reacomodar tiempos.
Le sirve a nuevos integrantes y al equipo.
El tener documentación del código, diagramas o procesos del proyecto en desarrollo, le facilita la vida a alguien que se ha sumado a trabajar con el equipo y debe conocer el sistema lo más pronto posible, ya sólo se preocuparán por ir resolviendo sus dudas. De igual manera, le sirve a otros miembros del equipo que necesiten información precisa. Además, la documentación como manuales técnicos y de usuario les puede servir a otras áreas de la empresa que deben familiarizarse con el uso de productos o servicios desarrollados.
Tips para documentar
Sé organizado/a. Lo recomendable es tener la información organizada en carpetas, una carpeta por cada fase del ciclo de vida del proyecto, y dentro de ellas ir colocando los respectivos documentos con un nombre fácil de identificar. Para ello, piensa en una nomenclatura, te ayuda a encontrar rápido la documentación.
Crea plantillas. Cuando se está documentando se empiezan a generar muchos documentos y al llegar otro proyecto pasará lo mismo. Seguramente necesites el mismo formato que usaste en el proyecto anterior, por lo cual, lo mejor es definir plantillas que se usen en cada fase del proyecto. Esto ayuda a que a futuro sólo tengas que descargar la plantilla, llenarla y listo. ¡Te ahorrarás tiempo de diseño!
Asigna a alguien para documentar. Puede que sea más difícil de hacer que de decir, pero hay personas a las que sí les gusta redactar “la bitácora” del proyecto. Descubre quién es y motívala a realizar esta labor junto al equipo de desarrollo. Otra opción es que contrates a alguien que se dedique a ello. Si eres el líder de un proyecto, trata de tener una comunicación constante con esa persona, para que la documentación se lleve de manera rápida y detallada.
Usa herramientas cooperativas. Al usar herramientas como GSuite o Microsoft Office online, puedes compartir información en línea con tu equipo y sin necesidad de imprimir nada. Además, existen herramientas para hacer diagramas, incluso para documentar el código como Doxygen, Jsdocs o Apiary y formar una documentación en línea. Sólo es cuestión de investigar cuáles se adaptan más al equipo.
Para finalizar, te comento que existen estándares de documentación y calidad del software que facilitan cómo llevar a cabo esta labor, puedes usarlos o basarte en ellos para crear un proceso que sea mejor para tu equipo. Innovar siempre es una buena opción.
