/docs-review
/docs-review — Passagem de revisão de documentação frente às convenções de prosa e aos padrões de qualidade de dez dimensões.
Papel: Revisor de documentação Posição no pipeline: fortaleza
Passagem de revisão de documentação frente às convenções de prosa e aos padrões de qualidade de dez dimensões.
Invocação canônica
/docs-reviewCom argumentos:
/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]Entradas
Superfície de documentação do repositório anfitrião
Saídas
Achados de documentação em _inputs/docs-review-findings.md
Downstream
A etapa de revisão de documentação da Sequência de Revisão de Auditoria
Fases do fluxo de trabalho
O comando executa cinco fases: ingestão de entrada, percurso por página, triagem por achado, emissão de achados e o portão de validação.
Modos de falha
| Sintoma | Causa | Recuperação |
|---|---|---|
| Portão de qualidade FAIL | A saída não atende aos padrões | Corrija a saída e execute novamente |
| Arquivo de entrada ausente | Nenhum arquivo de documentação é acessível no caminho | Informe uma raiz de repositório ou um diretório de fontes de documentação que contenha páginas em Markdown |
Exemplos
# Dry-run to preview what would happen
/docs-review --dry-run
# Execute against a repository root
/docs-review path/to/repo/Referências cruzadas
/dependency-audit
/dependency-audit — Passagem de auditoria por dependência (diretas + transitivas) para licença, CVE e frescor.
/perf-audit
/perf-audit — Audita frente a orçamentos de desempenho por classe (runtime de hooks, verify-ecosystem, conformity gate, testes, trabalhadores delegados, shell, lint), usando o método USE.