Como Escrever Prompts Melhores para IA de Programação

Prompts bem estruturados são fundamentais para obter código de qualidade de ferramentas de IA como GitHub Copilot, ChatGPT e Claude. A precisão do código gerado depende diretamente da clareza e especificidade das suas instruções.

1. Defina o contexto técnico completo. Especifique a linguagem de programação, versão, framework e ambiente. Em vez de 'crie uma função', escreva 'crie uma função Python 3.11 usando Flask 2.3 para validar dados JSON'. Inclua detalhes sobre bibliotecas, estrutura do projeto e dependências relevantes.
2. Forneça exemplos de entrada e saída esperados. Inclua dados de exemplo que mostrem exatamente o que a função deve receber e retornar. Especifique tipos de dados, formatos e estruturas. Para APIs, forneça exemplos de payloads JSON completos com todos os campos obrigatórios e opcionais.
3. Especifique tratamento de erros e validações. Detalhe quais erros devem ser capturados e como tratá-los. Solicite validações específicas de entrada, mensagens de erro personalizadas e códigos de status HTTP apropriados. Mencione se deve usar try-catch, retornar valores específicos ou lançar exceções customizadas.
4. Solicite documentação e comentários inline. Peça explicitamente docstrings, comentários explicativos e anotações de tipo. Solicite que a IA explique algoritmos complexos e justifique decisões de implementação. Especifique o padrão de documentação desejado (JSDoc, Sphinx, etc.).
5. Defina padrões de código e convenções. Especifique guias de estilo (PEP 8, Airbnb, Google Style Guide), convenções de nomenclatura e estrutura de pastas. Mencione se deve seguir princípios SOLID, usar design patterns específicos ou aderir a práticas de clean code particulares.
6. Inclua restrições e requisitos de performance. Especifique limitações de memória, tempo de execução máximo, compatibilidade com versões antigas e requisitos de segurança. Mencione se o código deve ser thread-safe, otimizado para concorrência ou seguir práticas específicas de segurança.
7. Revise e refine iterativamente. Use o código gerado como base para prompts mais específicos. Peça melhorias incrementais, otimizações ou adaptações para casos de uso particulares. Combine múltiplas respostas para criar soluções mais robustas e completas.