El terror de documentar

El titulo puede sonar bastante dramático, pero hay algo de verdad en el, últimamente hemos estado tratando el tema de la documentación de proyectos en el trabajo, y hay algunas personas a las cuales esto les causa terror (más bien flojera), el aterrizar en texto, diagramas o formatos todo lo necesario para lograr cumplir con los requerimientos u objetivos. Cabe mencionar que trabajo en desarrollo de software y el documentar las cosas puede ser una luz al final del túnel con el tiempo, porque hasta con tus propios proyectos se te olvidan detalles con el paso del tiempo y la llegada de nuevas ideas.

Volviendo al tema, el documentar es crear «el mapa», o el plano para saber como será formado algo, en el caso de software los requerimientos o cosas de debe de hacer un sistema o cambio, entonces, ¿por qué a los programadores no les gusta?, a muchos porque lo sienten como una perdida de tiempo, es que es algo al que hay que dedicarle horas y no es como que eso sobre.

Pero realmente esto es por un bien futuro, créeme, el tener que enfrentarte a un proyecto nuevo o heredado de alguien más y no tener idea de cómo funciona, hasta que haces pruebas y pruebas, no es algo bonito, porque a veces el código (mente) del compañero que ya no está o no hay forma de preguntarle, no es muy claro que digamos.

Entonces te toca explorar todo el código, verlo por partes, descubrirlo y pensar mucho, ¿qué intento hacer mi compañero aquí?, que con esfuerzo se logra resolver (después de toda una investigación).

Así que si para ti el documentar un proyecto supone el horror, te recuerdo los siguientes puntos:

Es por un bien futuro (el tuyo o el de otro programador).
Te ayudará a definir un alcance en tus proyectos.
Sabrás organizarte mejor, en cuestión de tiempos.
Estimarás de forma más eficaz tus limites (o en caso de que sea necesario apoyo).
Podrás repasar de qué trata un proyecto pasado.
El mantenimiento no se enfrasca en una persona, sino que el conocimiento se comparte.
Te será útil a la hora de analizar.
Te ayudará a ser un mejor desarrollador.
Un colega te lo agradecerá aunque nunca te vea.