Revisar qualidade de código e práticas de desenvolvimento
Use este guia como lente principal para esta situação.
Código profissional Guia para IA
Como ser um Programador Melhor
Atitude profissional, clareza, testes, manutenção, colaboração e evolução incremental do código.
- Autor
- Pete Goodliffe
- 458 páginas
- Formato do guia
- Markdown no padrão dos modelos originais + instruções operacionais para IA
Orientação
Como utilizar este .md
Não apenas “anexe e peça para programar”. Dê papel, contexto e critérios.
Anexe o .md junto com o requisitoO guia passa a ser a referência de engenharia para aquela tarefa.
Descreva contexto e restriçõesStack, estrutura atual, legado, prazo, compatibilidade, usuários e comportamento que não pode mudar.
Peça diagnóstico antes de soluçãoA IA deve identificar o problema e escolher somente os princípios relevantes.
Implemente em passos verificáveisEvite reescrita ampla. Peça testes, critérios de aceite e plano de rollback quando necessário.
Faça revisão contra o guiaNo final, peça divergências, riscos, trade-offs e pontos ainda não cobertos.
Casos de uso
Quando este guia é especialmente útil
Definir critérios profissionais para implementação e manutenção
Use este guia como lente principal para esta situação.
Orientar refatorações pequenas, seguras e testáveis
Use este guia como lente principal para esta situação.
Criar checklists de revisão e hábitos de equipe
Use este guia como lente principal para esta situação.
warning Limite de uso
Não use como substituto para requisitos do produto, arquitetura de domínio ou documentação específica da tecnologia.
Não use como substituto para requisitos do produto, arquitetura de domínio ou documentação específica da tecnologia.
Prompt pronto
Modelo para começar
Use o guia “Como ser um Programador Melhor” anexado como referência para analisar este projeto. Antes de alterar código: 1. Faça um diagnóstico do problema no contexto do projeto. 2. Identifique quais princípios do guia realmente se aplicam. 3. Compare a solução atual com uma alternativa mais simples. 4. Proponha uma mudança incremental e reversível. 5. Defina testes e critérios de aceite. 6. Ao final, revise a implementação contra o guia e liste trade-offs. Contexto: [DESCREVA o sistema, stack, estado atual e cenário da mudança] Objetivo: [DESCREVA o resultado observável que deve existir ao final] Restrições: [DESCREVA o que não pode mudar, compatibilidade e limites técnicos]
Exemplo preenchido — o que o usuário pode descrever
Use o modelo acima com dados concretos do projeto. O exemplo abaixo mostra o nível de detalhe esperado.
Contexto: Aplicação interna mantida por três desenvolvedores, com JavaScript e API REST; há funções longas, nomes pouco claros e testes parciais. Objetivo: Revisar o módulo de cadastro e propor melhorias pequenas que aumentem legibilidade, testabilidade e facilidade de manutenção. Restrições: Preservar comportamento e contrato da API; não reescrever o módulo inteiro; cada alteração deve ser pequena e coberta por teste.
ContextoStack, versões, arquitetura, página/módulo afetado, estado atual e comportamento existente.
ObjetivoResultado observável para o usuário ou para o sistema; diga o que deve funcionar ao final.
RestriçõesO que não pode mudar, compatibilidade, segurança, acessibilidade, performance, prazo e limites de escopo.
1. Diagnosticar
Peça análise do código e do problema antes de aplicar qualquer padrão ou princípio.
2. Decidir
Exija justificativa: por que esta técnica é adequada e quais alternativas foram descartadas.
3. Verificar
Finalize com testes, checklist, riscos e critérios de aceite.