Desarrollo

Documentar sin frenar al equipo de desarrollo

La documentación no tiene que ser una tarea al final. Puede vivir junto al código.

Equipo Kiowa4 min de lectura

Documentación junto al código

Cuando la documentación vive en el mismo repositorio que el código, se revisa y se actualiza en el mismo flujo de trabajo. Así deja de ser una tarea pendiente que nadie quiere hacer.

Registrar las decisiones

Un registro breve de cada decisión de arquitectura (qué se decidió, por qué y qué alternativas se descartaron) evita repetir las mismas discusiones cada vez que entra alguien nuevo.

Parte de lo terminado

  • Incluye la documentación en la definición de terminado.
  • Usa plantillas cortas para que nadie empiece de cero.
  • Genera diagramas desde el código cuando sea posible.

Lista de verificación

0 de 3 listos

¿Te sirvió? Compártelo con tu equipo.

¿Quieres aplicar esto en tu empresa?

Revisamos tu operación y te decimos por dónde empezar.

Agendar diagnóstico

Sigue leyendo