Documentar correctamente aumenta la sustentabilidad de aplicación, ya que facilita que otras personas la instalen, mantengan y utilicen.

Ideal

• Compartí toda la información sobre tus productos para que sea lo más clara posible y disponible en el Repositorio Público
• Creá documentación tanto para personal técnico como para usuarios nuevos
• Documentá el código mediante comentarios y entidades comprensibles
• Utilizá alguna herramienta de documentación automática(14)
• Automatizá el versionado de tu software
• Registrá los eventos de tus sistemas con herramientas abiertas(15)

Mínimo

• Escribí instrucciones detalladas de instalación y probá que los pasos te lleven a instalar correctamente el sistema
• Si estás reutilizando un software, documentá exhaustivamente todos los cambios que realices al código fuente, para que tu equipo o algún equipo futuro los pueda reproducir en caso de actualizar el software
• Utilizá alguna herramienta de seguimiento de defectos(16)
• Incorporá algún sistema de versionado(17)
• Mantené informados a tus usuarios respecto a actualizaciones y cambios en el sistema

Por dónde empezar

• Mirá la documentación de otros proyectos oficiales, como Poncho y Autenticar
• Visibilizá tu proyecto a través de una página pública con enlaces a otros recursos relevantes(18)
• Definí al comienzo del proyecto todos los entregables y documentos que deberá disponerse con la finalización del desarrollo del software