JPereira

En la mayoría de cursos de Ingeniería Informática se menciona la importancia de documentar los procesos y nuevos desarrollos que se realizan. Podemos decir que muchas veces la documentación es más importante que el proceso en si (que levante la mano donde se posee un software en producción y no se toca por no saber que podria suceder, por falta de documentación).

Además de esta documentación, una más importante es el código fuente. Muchas veces los documentos (sean Word, Pdfs, impresos, etc.) se pierden y solamente queda a disposición el código fuente.

Esta semana me tocó revisar un código que habia construido aproximadamente hace un año de la fecha de escritura de este post. No era algo muy complejo, tampoco es que fuera una operación trivial, pero si que hubiera significado un desgaste de tiempo volver a entender algo que habia escrito yo mismo hace tan poco tiempo.

Quizas en este caso mis comentarios fueron redundantes, pero estaba muy seguro que esta clase la tendria que ver mucho tiempo después, exactamente después de un año. Con lo cual con estos “simples” comentarios pude reducir el tiempo de reutilización del código en varias horas.

Además de utilizar el código fuente como documentación, algo que hacemos y que trato de instaurar en los equipos de desarrollo donde he participado, es tener un simple archivo de texto, con la información importante del proyecto. Un “LEEME.txt” de toda la vida.

Una ventaja de tener este archivo es por una parte, mantener una historia de lo que ha ocurrido con el proyecto, y además, con el control de versiones, verificar quienes son los que lo usan y quienes no. La documentación es tarea de todos dentro de un equipo, por lo que se agradece que todos puedan participar en la construcción de esta. Hay que recordar que muchas veces la vida del software es mas allá de nuestro paso en una organización, por lo que facilitar la mantenibilidad del mismo es algo que se agradece.