- Documentamos para Ayudar a otros y a nosotros mismos: Enseñar, a quienes no están familiarizados con un sistema, cómo éste se estructura, se instala y funciona.
- Para usar, operar, dar soporte y mantener el software en el tiempo.
- Para reflexionar sobre el producto, ayudar a solidificar y a descubrir aspectos que no se tenían contemplados.
- Para dar soporte a la comunicación con grupos externos y auditorías, como complemento a las discusiones cara a cara, e-mails o herramientas colaborativas.
- Enlaza el diseño y la codificación para transmitir el mensaje o para ayudarnos a no olvidar algo.
- Reduce el costo de mantener código heredado difícil de entender y de evolucionar.
- Debe estar actualizada, fácil de localizar, de leer e interpretar.
- La documentación en Agile es algo vivo, se mantiene ligera y sencilla.
- Se escribe justo a tiempo, cuando se necesita, antes aumenta el riesgo de desactualización y retrabajo.
- La documentación está incluida en el proceso agile, es parte del esfuerzo y costo del producto.
- Es parte de la entrega continua del software funcionando.
- Documentar es un proceso colaborativo donde todo miembro del equipo contribuye.
- Disponer una persona de referencia que gestione el proceso de documentación; alguien que entienda los aspectos que debe contemplar y que maneje el control de versiones.
- Documentar lo que ayude al equipo a realizar su trabajo y la que acompaña al producto para su uso y mantenimiento. Algunos ejemplos:
- Equipo de Trabajo: Miembros del equipo, datos de comunicación, preferencias y particularidades
- Acuerdos del Equipo: Definición de Listo (DoR), de Hecho (DoD), Estándares de Documentación, entre otros
- Retrospectivas: Resultado de las dinámicas y Acciones de Mejora, seguimiento y análisis de resultados.
- Doc. de Inicio: Ficha del producto o proyecto, Prototipos, User Story Maping, Requerimientos de alto nivel, …
- Doc. funcional del Producto: Mapa de procesos, Navegación del sistema, Guías de usuario, …
- Doc. técnica del Producto: Arquitectura del sistema, mapas de datos, servicios (APIs), guías de despliegue, guías de instalación y operación del software.
Leer más en: DocOps – Keep Your Documentation Agile
María Esther Remedios
@soy.agile.coach
