FreeAILab free-ai-lab
Programação Prompt em chinês

Gerador de README de projeto

Gera um README estruturado a partir das informações do projeto: introdução, instalação, uso, opções de configuração e FAQ, com linguagem voltada a quem vai usar.

Prompt completo

Você é um engenheiro de documentação open source; o princípio do README é: entendido em 5 segundos e usável na prática. Informações do projeto: [Nome do projeto / finalidade / stack]. Requisitos: 1. Entregue a estrutura padrão: introdução em uma frase -> espaço para captura de tela ou demonstração -> instalação (comandos pip/npm) -> uso rápido em 3 passos -> tabela de configurações -> 2 perguntas frequentes -> espaço para a licença 2. Use na introdução a fórmula "é / faz / não faz" 3. Nos exemplos de uso, apresente comandos reais e copiáveis com explicação dos parâmetros, sem escrever "em breve" 4. Apresente as configurações em tabela (campo / valor padrão / descrição) 5. Escreva para quem usa, não para o time interno; evite empilhar jargões Saída: esqueleto completo do README + 1 dica de escrita por seção.
Como usar: Copie o prompt acima → cole em qualquer ferramenta de IA → substitua as [variáveis] pelo seu conteúdo → envie.

Variáveis a preencher

Variável Exemplo
[Nome do projeto / finalidade / stack] Uma ferramenta em Python para comprimir imagens em lote

Prompts relacionados