Revisão Impa
Inicia uma revisão de documentação técnica em sua própria sessão bloqueada e retorna o relatório. Funciona em qualquer conjunto de documentação, sem necessidade de envolvimento de um escritor. Apenas conclusões: nunca edita a documentação nem o código, mesmo que seja solicitado "revisar e corrigir".
Não leia method.md, checklist.md ou qualquer coisa em reference/. O revisor carrega esses arquivos por conta própria
e mantê-los fora desta sessão é essencial.
Se você escreveu ou alterou esta documentação nesta sessão, siga round.md em vez disso.
Etapas
-
Escreva o briefing em
"${TMPDIR:-/tmp}"/impa/<projeto>/diretas-<n>/briefing-1.md, com<n>um número acima da última pasta existente. Ele contém fatos e nunca sua opinião, portanto não leia a documentação primeiro:Revisar documentação técnica pelo método de revisão impa. Não edite nenhum arquivo. Projeto: <caminho absoluto> Documentação: <caminhos absolutos que o usuário mencionou, ou "encontrá-los"> Outras fontes: <caminhos absolutos de dependências ou repositórios irmãos que o usuário mencionou, ou "nenhuma"> Plano de documentação: <caminho absoluto para .impa/plan.md se o projeto tiver um, ou "nenhum"> Solicitação desta rodada, nas palavras do usuário: "<prompt>" Escopo: <o que o usuário mencionou, ou "todo o conjunto de documentação"> Pendente da última rodada: nenhum Entregue a uma pessoa: nenhum Retorne o relatório do método. Mencione qualquer problema fora do escopo que você eventualmente veja, mas não procure por um. -
Inicie-o em segundo plano. Adicione
--add-dirpara cada caminho emOutras fontes:impa review --brief <briefing> --add-dir <projeto>Um conjunto grande de documentação pode precisar de
--timeout <minutos>, que é 20 por padrão. -
Se o comando sair com código 1, a revisão não terminou, e qualquer
revisao-1.mdé parcial. Semrevisao-1.json, ou com umerroque começa comError: spawn, a revisão não pôde iniciar: leia o que o comando imprimiu e use a alternativa. Caso contrário, execute-o mais uma vez com um--timeoutmaior. Se isso falhar novamente, informe ao usuário que nenhuma revisão foi concluída, com oerroderevisao-1.json. -
Caso contrário, leia apenas
revisao-1.md, ao lado do briefing. Retorne-o como está, com o custo da linha que o comando imprimiu, e pare. Não aja com base nas conclusões a menos que o usuário peça: corrigir é uma etapa separada, após esta. Severeditoestiver vazio emrevisao-1.json, não há linha de veredito, então diga que o relatório não é confiável.
Se impa não estiver no PATH ou não puder iniciar, use a alternativa na seção 3 de
round.md. Se essa também não puder iniciar, informe ao usuário que nenhuma revisão foi executada. Nunca revise
nesta sessão.