Lint da documentação
Execute uma vez pouco antes da implantação. Verifica apenas o que a validação estrutural (pnpm docs:validate) não captura.
Execute com o modelo mais forte. A capacidade de encontrar regras e a capacidade de segui-las são distintas.
Escopo de leitura
Não leia tudo. Ler amplamente aumenta a poluição com documentos irrelevantes, reduzindo a precisão.
- Use
pnpm docs:related <caminhos…>com os caminhos de código afetados por esta implantação para obter os documentos roteados. - Os ADRs linkados por esses documentos e os planos ativos daquela área.
- Documentos permanentes que
pnpm docs:validatealertou por ultrapassarem 90 dias desde a última verificação. - Itens abertos em
docs/findings.md.
O que verificar
- Inconsistências bidirecionais entre documento e código. Verifique separadamente o que está no código mas não no documento (omissão) e o que está no documento mas não no código (alucinação). Olhar apenas para um lado perde metade.
- Candidatos a contradição de ADR. Dois ADRs Aceitos na mesma área que chegam a conclusões opostas sem uma relação de substituição. Use
pnpm docs:links <ADR>para verificar a cadeia de substituições. - Tabelas de valores duplicadas do código. O documento copiou valores ou listas que podem ser lidos diretamente do código?
- Planos pendentes com mais de 90 dias. Eleve como item perguntando se deve arquivar ou retomar.
- ADRs Propostos com mais de 14 dias. A decisão está atrasada.
- Registros de experiência misturados em guias. Itens do tipo "tentei e não funcionou" devem ir para
docs/flows/. - Linhas expiradas em
docs/operations/current-state.md. Linhas com data de verificação antiga não indicam sucesso, mas sim falta de verificação.
Saída
Adicione itens a docs/findings.md. Cada item deve ter cinco linhas.
- Descoberta 2026-09-04 · docs/policies/xxx.md
Alega: (o que o documento diz)
Evidência: (caminho de código ou número de ADR)
Proposta: (o que fazer)
Escopo: (corrigir nesta implantação ou adiar)
Não corrija. A resolução será feita pelo PR que realiza o trabalho, e esse PR removerá o item.
Atualize a data de verificação dos documentos permanentes lidos para hoje. Atualize apenas documentos efetivamente contrastados com o código. Colocar a data de hoje em documentos não contrastados cria um falso sinal de atualização.
Orçamento
Assuma que um em cada três itens encontrados é um falso positivo. A precisão da detecção de inconsistências por LLM isolado é de cerca de 0,6. Se não tiver certeza, registre isso no item.
Na primeira linha do relatório, escreva «número de Findings abertos e idade do item mais antigo».
Adicionar e remover regras
Para adicionar um item a esta lista, você deve apresentar um caso real que ele capturou. Não inclua itens sem fundamento.
Remova um item se não houver ocorrência do mesmo tipo de falha em 12 meses e se ele não for útil na avaliação pnpm docs:harness-eval.