La Documentación Agile: La útil y necesaria

  • Documentamos para Ayudar a otros y a nosotros mismosEnseñ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 actualizadafácil de localizarde 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

Share on facebook
Facebook
Share on google
Google+
Share on twitter
Twitter
Share on linkedin
LinkedIn

Deja un comentario

Tu dirección de correo electrónico no será publicada.

Artículos relacionados

Intranet

Energías Renovables

¿Qué es?

Ofrecemos servicios especializados de energía solar fotovoltaica que se obtiene directamente de la radiación solar mediante un panel solar que a su vez la transforma en  energía eléctrica.

¿A quién va dirigido?

Todas aquellas empresas, comercios y hogares que en su día a día quiera reducir los costos y deseen tener un plan de sustentabilidad para apoyo al medio ambiente así como su economía.

¿Por qué elegirnos?

1.- Apoyo de un equipo comprometido con el medio ambiente.
2.- GSB te brindará la mejor solución acorde a tus necesidades
3.- Control y seguimiento así com reportes de operación, mantenimiento de equipos preventivo y correctivo.

Cyberseguridad

¿Qué es?

Ofrecemos servicios especializados en Cyber Seguridad en tiempo real con las mejores herramientas, alianzas y tecnología para la protección de su información y operación.

¿A quién va dirigido?

Todas aquellas empresas que en su día a día utilicen tecnología y deseen tener la garantía de un equipo con vasta experiencia, conocimiento, amabilidad, eficacia y rapidez.

¿Por qué elegirnos?

1.- Identificamos sus necesidades y procedemos a definir las acciones requeridas, mediante el uso de herramientas de análisis como: entrevistas de diagnóstico, pruebas de concepto, simuladores y cuestionarios.

2.- Contamos con los mejores especialistas en el mercado, lo cual nos permite brindarte un servicio que te garantice tu protección ante amenazas.

3.- Implementamos procesos que permiten una retroalimentación oportuna, mediante la cual logramos mitigar riesgos y resguardar la seguridad informática de tu empresa.