CommunityEscrita e Ediçãogithub.com

mrgnhnt96/impa-review

Revisa documentos técnicos em relação ao código que descrevem e relata onde discordam, e se um desenvolvedor ou agente pode agir com base neles. Retorna apenas conclusões e nunca corrige nada. Use sempre que o usuário pedir para revisar, auditar, verificar ou validar um README, site de documentação, pasta de docs, referência de API ou CLI, guia, changelog ou arquivo de instrução de agente, ou perguntar se a documentação está precisa, atualizada ou corresponde ao código, ou o que mudou. A skill impa também inicia isso automaticamente após cada rodada. Não use para páginas de marketing (use beedle-review), para páginas de artefato ou um link do claude.ai (use mudora), para UI de aplicativo (use ultrahand:review) ou para revisão de código.

O que é impa-review?

A skill impa-review automatiza a revisão técnica de documentação, comparando-a com o código que descreve, sem fazer edições. Ela inicia uma sessão de revisão isolada, onde gera um relatório listando discrepâncias entre a documentação (como READMEs, referências de API, guias e changelogs) e o código real, indicando se um desenvolvedor ou agente pode agir sobre elas. A impa-review suporta projetos locais e dependências, usando um método de revisão próprio que carrega regras e listas de verificação de forma independente, evitando interferências da sessão atual. Ela é ideal para verificar precisão, atualização e desalinhamento de documentação técnica, especialmente em fluxos contínuos de desenvolvimento, onde é acionada automaticamente após cada rodada de mudanças. A skill reporta apenas conclusões sem corrigir nenhum arquivo, garantindo que a revisão seja puramente diagnóstica.

Funciona com✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/mrgnhnt96/impa/tree/HEAD/review

Installed? Explore more Escrita e Edição skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

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

  1. 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.
    
  2. Inicie-o em segundo plano. Adicione --add-dir para cada caminho em Outras fontes:

    impa review --brief <briefing> --add-dir <projeto>
    

    Um conjunto grande de documentação pode precisar de --timeout <minutos>, que é 20 por padrão.

  3. Se o comando sair com código 1, a revisão não terminou, e qualquer revisao-1.md é parcial. Sem revisao-1.json, ou com um erro que começa com Error: 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 --timeout maior. Se isso falhar novamente, informe ao usuário que nenhuma revisão foi concluída, com o erro de revisao-1.json.

  4. 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. Se veredito estiver vazio em revisao-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.

Habilidades Relacionadas