.. _docs:

Documentación y comunicación efectiva
-------------------------------------

No existe un buen proyecto de software sin una buena documentación. ¿Cuantas veces hemos escuchado el RTFM! para
poder comprender mejor la herramienta que estamos usando? Pues aquí no es la excepción. Una vez aceptado nuestros
cambios en el repositorio es necesario crear la documentación correspondiente. Esto depende mucho del nivel de
profundidad que se haya hecho con lo cambios, puede ser que solo haya hecho cambios en algunas líneas y no cambiaría
mucho el uso del proyecto, pero en otros cambios, es necesario actualizar la documentación si se hicieron moviemientos
significativos al comportamiento.

La documentación que es imprescindible es la descripción de las funciones o líneas de programación "complicadas", así
como comentarios y/o *TODO's* a lo largo del proyecto. Esto nos ayuda a comprender mejor la lógica de programación
que tuvo el desarrollador responsable de ese cambio. Hay varias herramientas que nos ayudan a generar la documentación
*"técnica"* para poder visualizar varios aspectos del proyecto, un ejemplo es Doxygen, donde podemos navegar por las
clases, funciones, todo's, etc.

Por último los canales de comunicación directos como: Whatsapp, Telegram o Slack, nos facilitan la comunicación de
asuntos de carácter urgente. Pero siendo un proyecto descentralizado, bastaría con la documentación y la comunicación
en los hilos de cada issue, a menos como se dice anteriormente, el mensaje sea **urgente**.