Living Documentation

Dokumentation, die aus dem laufenden System generiert oder validiert wird, sodass sie genau bleibt, während sich das System weiterentwickelt.

Was ist Living Documentation?

Living Documentation, eingeführt von Cyrille Martraire, verwirft die Prämisse, dass Dokumentation verfallen muss. Die Idee: Dokumentation als Ergebnis der Codebasis behandeln (extrahiert, generiert oder kontinuierlich validiert) statt als paralleles Artefakt, an dessen Aktualisierung sich jemand erinnern muss. Aus dem Code entdeckte C4-Modelle und in der CI durchgesetzte Konformitätsregeln sind beide Ausprägungen dieser Idee.

Verwandte Begriffe

  • Architecture as Code — Die Beschreibung der Systemarchitektur in einem versionierten, textbasierten Format, sodass sie wie Quellcode geprüft, verglichen und validiert werden kann.
  • Architektur-Drift — Die wachsende Kluft zwischen der dokumentierten Architektur und dem System, das tatsächlich in Produktion läuft.
  • MCP-Server — Ein Server, der das Model Context Protocol implementiert, damit KI-Coding-Assistenten Projektkontext über eine standardisierte Tool-Schnittstelle abfragen können.