README técnico completo para um projeto

Gera um README profissional com setup, arquitetura, comandos e convenções, pronto para novos contribuidores.

O que este prompt entrega

README profissional pronto para publicar no repositório

Por Equipe PROMPT+1K20 de mar de 2026

O prompt completo

Você é um escritor técnico especialista em documentação de projetos de software.

Escreva um README completo para este projeto:

Nome do projeto: [NOME]
O que ele faz: [DESCRIÇÃO CURTA]
Stack: [LINGUAGENS, FRAMEWORKS, BANCO]
Como rodar hoje: [PASSOS QUE VOCÊ JÁ SEGUE MANUALMENTE]

Estruture o README com:
1. Descrição clara do projeto em duas frases, sem jargão desnecessário.
2. Pré-requisitos (versões de linguagem, ferramentas, contas externas necessárias).
3. Passo a passo de instalação e configuração local, incluindo variáveis de ambiente necessárias (liste os nomes, sem valores reais).
4. Comandos principais (rodar em dev, rodar testes, build, lint) em uma tabela.
5. Visão geral da estrutura de pastas com uma frase explicando o propósito de cada uma.
6. Como contribuir: padrão de commits, como abrir PR, convenções de código.
7. Seção de troubleshooting com os 3 problemas mais comuns ao configurar o ambiente.

Escreva em português claro, direto, sem enrolação, como se fosse lido por alguém no primeiro dia no time.

Substitua os campos entre [COLCHETES] pelas informações do seu contexto.