Prompt para escrever o README e a documentação
Prompt para gerar README e documentação técnica com IA: para quem é, instalação que funciona, exemplos reais e o que fica de fora.
Onde usar: Cursor, Claude Code ou Claude
O rascunho de sempre
É assim que quase todo mundo pede. A IA responde, mas preenche o que faltou com o genérico.
faz um readme pro projeto
O prompt completo
Copie e troque os 2 trechos entre colchetes pelo seu caso. Quanto mais específico, melhor a resposta.
Escreva o README de [nome do projeto], lendo o código deste repositório. Quem vai ler: [ex.: um dev novo no time que precisa rodar o projeto no primeiro dia]. O que o projeto faz, em uma frase: [descrição]. Seções: 1. O que é e para que serve (3 linhas, sem marketing). 2. Como rodar localmente: pré-requisitos com versão, comandos na ordem, como saber que funcionou. 3. Configuração: cada variável de ambiente, para que serve e um valor de exemplo seguro. 4. Estrutura de pastas: só as que alguém precisa conhecer. 5. Como rodar os testes e o deploy. 6. Problemas comuns e a solução. Regras: comandos copiáveis em blocos de código; não invente nada que não esteja no código; se algo não estiver claro no repositório, marque com TODO e uma pergunta.
Por que funciona
- Dizer quem lê decide o nível de detalhe: um README para o time é diferente de um para usuários da biblioteca.
- "Como saber que funcionou" é o passo que quase toda documentação esquece.
- Proibir invenção e marcar TODO evita documentação confiante e errada.
Sem copiar e colar
O Lapidia faz isso no próprio campo em que você escreve, no ChatGPT, no Claude, no Cursor ou em qualquer app: lê o rascunho, pergunta o que só você sabe e devolve o pedido completo. O texto não fica guardado.