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
mdté uma trilha advisory planejada, não gate bloqueante padrão.- O repositório ainda não depende de
mdtinstalado. - Enquanto não houver integração formal, use checks existentes:
repo:discourse:audit,docs:package:check,repo:bloat:audite revisão focal dos índices.
Contrato para adoção de MDT
- Check first: começar com
mdt checkou equivalente em escopo pequeno. - Changed files first: rodar em arquivos alterados antes de varrer docs inteiras.
- Ignore code: ignorar code fences, comandos, paths, IDs, logs, JSON e nomes de API.
- Advisory before blocking: gerar finding e evidência antes de falhar CI.
- Update pequeno:
mdt updatesó em blocos pequenos, revisáveis e com diff claro. - 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
docs/research/data/**e logs brutos;- arquivos em
docs/archive/**; - snapshots históricos que preservam comandos antigos;
- generated package guide copies, exceto via
pnpm run docs:package:sync.
Critério para CI
Uma futura Action deve começar como report-only:
- instalar/ativar ferramenta apenas se já estiver pinada e documentada;
- rodar em PRs com artifact ou comentário curto;
- não bloquear merge até termos falsos positivos classificados;
- 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
repo:discourse:audit: linguagem canônica e claims aspiracionais.docs:package:check: cópias empacotadas dos guias.repo:bloat:audit: dados/logs grandes e artefatos versionados.test:ci:workflow: contrato de workflows GitHub.
MDT deve complementar esses gates, não substituí-los.