Comandos do pipeline
/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/plan-suite/] [phase-id] [--dry-run]Entradas
Superfície de documentação do repositório anfitrião
Saídas
Achados de documentação + REPORT.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 segue o fluxo de trabalho padrão do pipeline /plan:
- Carregar contexto — Lê a suite de plano, as regras e o Contrato de Retomada.
- Verificar pré-requisitos — Confirma que as fases de dependência estão concluídas.
- Executar tarefas — Cumpre a missão do comando.
- Verificar saídas — Confirma que todas as saídas declaradas existem e passam pelos portões de qualidade.
- Atualizar PROGRESS.md — Registra as saídas verificadas no Registro de Saídas de Fase.
- Emitir REPORT.md — Fica registrada a prova de liberação do portão de pré-emissão.
Modos de falha
| Sintoma | Causa | Recuperação |
|---|---|---|
| Pré-requisito incompleto | Fase dependente não finalizada | Conclua primeiro a fase a montante |
| Portão de qualidade FAIL | A saída não atende aos padrões | Corrija a saída e reexecute |
| Falta um arquivo de entrada | Arquivo da suite de plano ausente | Execute /plan-generate para criá-lo |
Exemplos
# Dry-run to preview what would happen
/docs-review --dry-run
# Execute against a named plan suite
/docs-review path/to/plan-suite/