Documentação Viva

Documentação que é gerada ou validada a partir do sistema em execução, de modo que permanece precisa à medida que o sistema evolui.

O que é Documentação Viva?

A documentação viva, apresentada por Cyrille Martraire, rejeita a premissa de que a documentação precisa apodrecer. A ideia: tratar a documentação como uma saída da base de código (extraída, gerada ou continuamente validada) em vez de um artefato paralelo que alguém precisa lembrar de atualizar. Modelos C4 descobertos a partir do código e regras de conformidade aplicadas na CI são exemplos dessa ideia.

Termos relacionados

  • Arquitetura como Código — Descrever a arquitetura do sistema em um formato versionado e baseado em texto, para que possa ser revisada, comparada (diff) e validada como código-fonte.
  • Drift de Arquitetura — A lacuna cada vez maior entre a arquitetura documentada e o sistema que de fato roda em produção.
  • Servidor MCP — Um servidor que implementa o Model Context Protocol para que assistentes de programação com IA possam consultar o contexto do projeto por meio de uma interface de ferramentas padronizada.