agents-lab

Local-first lab for reusable AI-agent primitives and the curated pi-stack.

View on GitHub

Doc Drift e MDT

Este guia define como tratar documentação repetida, snippets de política e diagramas como superfície governada. O objetivo é reduzir drift sem transformar docs em um pipeline pesado.

Posição atual

Contrato para adoção de MDT

  1. Check first: começar com mdt check ou equivalente em escopo pequeno.
  2. Changed files first: rodar em arquivos alterados antes de varrer docs inteiras.
  3. Ignore code: ignorar code fences, comandos, paths, IDs, logs, JSON e nomes de API.
  4. Advisory before blocking: gerar finding e evidência antes de falhar CI.
  5. Update pequeno: mdt update só em blocos pequenos, revisáveis e com diff claro.
  6. No prioritization: MDT sincroniza documentação; não escolhe roadmap nem fecha task.

Escopos bons para MDT

Escopo Por que usar
README raiz + docs/start-here.md manter posicionamento público coerente
docs/guides/README.md + package copies evitar links ou descrições divergentes
snippets de comandos pnpm/devcontainer reduzir regressão para npm run legado
glossário control-plane/operator evitar aliases e termos paralelos
blocos Mermaid/diagramas detectar drift entre diagrama e runtime descrito

Escopos que devem ficar fora no início

Critério para CI

Uma futura Action deve começar como report-only:

  1. instalar/ativar ferramenta apenas se já estiver pinada e documentada;
  2. rodar em PRs com artifact ou comentário curto;
  3. não bloquear merge até termos falsos positivos classificados;
  4. promover para blocking apenas para regras de alto sinal, como links quebrados em docs públicas ou snippets canônicos divergentes.

Relação com os gates atuais

MDT deve complementar esses gates, não substituí-los.