Documentación viva

Documentación que se genera o se valida a partir del sistema en ejecución, de modo que se mantiene precisa a medida que el sistema evoluciona.

¿Qué es Documentación viva?

La documentación viva, presentada por Cyrille Martraire, rechaza la premisa de que la documentación tenga que pudrirse. La idea: tratar la documentación como una salida del código base (extraída, generada o validada continuamente) en lugar de como un artefacto paralelo que alguien tiene que acordarse de actualizar. Los modelos C4 descubiertos a partir del código y las reglas de conformidad aplicadas en CI son ejemplos de esta idea.

Términos relacionados

  • Arquitectura como código — Describir la arquitectura del sistema en un formato versionado y basado en texto para poder revisarla, comparar sus diferencias y validarla como el código fuente.
  • Deriva de arquitectura — La brecha creciente entre la arquitectura documentada y el sistema que realmente se ejecuta en producción.
  • Servidor MCP — Un servidor que implementa el Model Context Protocol para que los asistentes de programación con IA puedan consultar el contexto del proyecto a través de una interfaz de herramientas estandarizada.