Living Documentation

Documentazione generata o convalidata a partire dal sistema in esecuzione, così da rimanere accurata man mano che il sistema evolve.

Che cos'è Living Documentation?

La living documentation, introdotta da Cyrille Martraire, rifiuta il presupposto che la documentazione debba per forza marcire. L'idea: trattare la documentazione come un output della base di codice (estratta, generata o continuamente convalidata) anziché come un artefatto parallelo che qualcuno deve ricordarsi di aggiornare. I modelli C4 scoperti dal codice e le regole di conformità applicate in CI sono entrambi esempi di questa idea.

Termini correlati

  • Architecture as Code — Descrivere l'architettura del sistema in un formato testuale e versionato, così da poterla revisionare, confrontare e convalidare come il codice sorgente.
  • Drift Architetturale — Il divario crescente tra l'architettura documentata e il sistema che gira davvero in produzione.
  • MCP Server — Un server che implementa il Model Context Protocol affinché gli assistenti AI di coding possano interrogare il contesto del progetto tramite un'interfaccia di strumenti standardizzata.