HomeCasa Prompts

Escrever o README de um projeto

Crie um README claro e completo, com secções de instalação, utilização, configuração e contribuição, a partir da descrição do seu projeto. Pensado para ChatGPT, Claude e Gemini. Inclui 4 variáveis personalizáveis e pode copiá-lo gratuitamente com um clique.

Iniciante · Código · Pendente de revisão editorial

Pensado para:

Prompt

Age como um redator técnico com experiência em projetos de código aberto.

Escreve o README.md do projeto {{name}}.
Descrição: {{description}}
Tecnologias: {{technologies}}
Público do README: {{audience}}

Inclui estas secções em Markdown:
1. Título e descrição numa frase.
2. Funcionalidades principais (máx. 6 pontos).
3. Pré-requisitos.
4. Instalação passo a passo com blocos de comandos.
5. Configuração (variáveis de ambiente numa tabela: nome, descrição, obrigatória, exemplo).
6. Utilização com um exemplo mínimo.
7. Estrutura de pastas resumida.
8. Como contribuir e licença: usa [LICENÇA] se eu não especificar nenhuma.

Usa frases curtas, voz ativa e evita jargão desnecessário. Não inventes comandos que não se possam deduzir das tecnologias indicadas: marca-os como [VERIFICAR].

Como utilizar

Cole também o seu package.json, composer.json ou requirements.txt para que os comandos sejam rigorosos.

Exemplo de utilização

Projeto: API de marcações em Node.js com PostgreSQL para um ginásio.

Exemplo de resultado

# TaskFlow

Gestor de tarefas colaborativo com quadros kanban, para alojar no seu próprio servidor.

Funcionalidades

  • Quadros kanban com colunas personalizáveis.
  • Tarefas com responsáveis, etiquetas e prazos.
  • Trabalho em equipa com permissões por quadro.
  • API REST para integrações.

Pré-requisitos

  • Node.js [VERIFICAR versão mínima]
  • PostgreSQL [VERIFICAR versão mínima]
  • npm

Instalação

git clone [URL_DO_REPOSITÓRIO] taskflow
cd taskflow
npm install
cp .env.example .env        # [VERIFICAR] nome do ficheiro de exemplo
npm run migrate             # [VERIFICAR] script de migrações
npm run dev

Configuração

VariávelDescriçãoObrigatóriaExemplo
DATABASE_URLLigação ao PostgreSQLSimpostgres://user:pass@localhost:5432/taskflow
PORTPorta da API ExpressNão3000
JWT_SECRETChave para assinar sessões [VERIFICAR]Simmudar-isto

Licença

[LICENÇA]…

Dados-chave

Categoria
Programação e desenvolvimento · Documentação
Tipo de resultado
Código
Nível
Iniciante
Pensado para
ChatGPT, Claude e Gemini
Verificado em
Pendente de verificação editorial
Variáveis
Nome do projeto, Descrição, Tecnologias e Público
Idioma
Português
Preço
Gratuito, sem registo
Atualizado
07/11/2026

Perguntas frequentes

O que significam os marcadores [VERIFICAR]?

Assinalam comandos ou definições que a IA não conseguiu deduzir da sua descrição. Substitua-os pelos reais depois de fazer a instalação a partir de um clone limpo.

Serve para um projeto privado de empresa?

Sim. Indique a sua equipa como público e substitua a secção de licença pela política de utilização interna.

Para que serve este prompt?

Crie um README claro e completo, com secções de instalação, utilização, configuração e contribuição, a partir da descrição do seu projeto.

Com que ferramentas de IA funciona?

Foi pensado para ChatGPT, Claude e Gemini. Ainda não o verificámos nestas ferramentas, pelo que os resultados podem variar entre elas.

Como personalizo o prompt?

Clique em “Personalizar” e preencha as variáveis (Nome do projeto, Descrição, Tecnologias e Público). O texto atualiza-se instantaneamente e pode depois copiá-lo com um clique. Os valores ficam guardados apenas no seu navegador.

Preciso de experiência para o utilizar?

Não. É um prompt de nível iniciante: basta preencher os dados e colá-lo na sua ferramenta de IA.

Este prompt é gratuito?

Sim. Todos os prompts do HomeCasa Prompts são gratuitos, sem registo nem subscrição. Pode também utilizá-los em projetos profissionais.

Posso confiar no resultado da IA?

Trate-o como um rascunho de qualidade: verifique sempre os dados, os números e as afirmações importantes antes de publicar ou tomar decisões.

Prompts relacionados