Soy un obseso de la documentación porque considero que es una parte importantísima del sistema. Una documentación de calidad nos permitirá ganar contexto rápidamente, minimizará el riesgo de cometer errores y de reinvertir tiempo en problemas que ya se solucionaron en el pasado. Es además un medio de comunicación con el resto del equipo, stakeholders y nuestro yo del futuro.
Para mí la documentación debe cumplir estos puntos:
- Breve, clara y concisa.
- En un formato legible, común y estándar.
- Correctamente estructurada. Toda documentación similar debe estructurarse de manera similar.
- Correctamente redactada. Por favor minimicemos las faltas.
- Fácil de localizar y consultar.
- Actualizada y actualizable.
- No debe estar duplicada.
- Debe ser interesante o importante.
Walking the Stack 