Prompt de Revisão entre Código e Documentação
Prompt avançado para realizar revisão de código com foco na verificação de alinhamento entre a documentação e o código, gerando um relatório estruturado com lacunas, mapeamento, recomendações e evidências.
4.5
16 usos
ChatGPT
Prompt completo:\n\nObjetivo: Verificar se a documentação corresponde ao código implementado e se tudo descrito está de fato implementado, conforme a especificação.\n\nFormato de entrada esperado: dois arquivos/textos - Documentação (Markdown/Texto) e Código-fonte (em qualquer linguagem suportada). Opcional: arquivo de Especificação (Spec), Lista de Casos de Teste.\n\nInstruções de execução:\n1) Analisar a documentação e extrair as seções-chave (requisitos, entidades, interfaces, fluxos).\n2) Analisar o código e mapear para as seções da documentação (funções, classes, módulos, APIs, endpoints).\n3) Verificar correspondência: para cada item da documentação, existe implementação equivalente no código? existem desvios de comportamento? Falta de cobertura de casos de uso?\n4) Gerar um relatório estruturado contendo:\n - Resumo de conformidade (Ex.: Completo, Parcial, Ausente);\n - Lista de lacunas (lacuna_id, seção_doc, componente_code, descrição, severidade: Alta/Media/Baixa, evidência: referências a trechos de código/doc);\n - Recomendações de remediação para código e para documentação (incluindo mudanças de nomes, URLs, descrições, testes);\n - Mapeamento de rastreabilidade: vincular cada item da doc ao código correspondente (ou indicar ausência);\n - Patch sugerido (pseudo-diff) para corrigir documentação ou código (com descrições claras do que mudar);\n - Checklist de qualidade (criterios satisfeitos/danificados: consistência, cobertura, nomes, estilo, testes).\n5) Formato de saída: retornar um objeto estruturado em JSON com chaves: conformidade, lacunas, mapeamento, recomendações, diffs_sugeridos, testes_recomendados. Forneça evidências citando trechos da documentação e do código quando possível (cite linhas ou títulos de seções).\n\nNotas:\n- Não assuma contexto além do fornecido; peça esclarecimentos se necessário.\n- Caso haja ambiguidade entre doc e código, priorize a especificação explícita e marque a ambiguidade como tal.\n- Produza um sumário executivo em poucas linhas no topo, seguido do relatório detalhado.
Tags relacionadas
Como Usar este Prompt
1
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
2
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
3
Cole o prompt e substitua as variáveis (se houver) com suas informações.