Como criar um README com configuração reproduzível.
Um README deve tornar a configuração reproduzível a partir de requisitos verificados. Diferencie instruções conferidas de comandos propostos ou configuração indisponível.
Adapte o fluxo à sua tarefa.
Use scripts, pré-requisitos e configuração reais do repositório para explicar instalação e primeiro uso. Separe comandos verificados de etapas propostas, retire segredos dos exemplos e indique um caminho claro para testar.
- O que você fornece
- Comportamento verificado do projeto e requisitos de configuração.
- O que você recebe
- Documentação com etapas executáveis que precisam de verificação.
Veja a entrada e o resultado.
Entrada e saída ilustrativas · exemplo didático, não uma execução real do WebAct
Exemplo campo
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
Exemplo completo
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
Carregue esta entrada no prompt e copie para o WebAct para testar a tarefa. Seu resultado pode ser diferente da ilustração.
Decisões e solução de problemas.
Um README deve inventar um comando de instalação que pareça convencional?
Confira o projeto primeiro. Um comando conhecido pode ser errado para o gerenciador de pacotes, lockfile ou processo de build usado.
Por que a configuração falha mesmo seguindo o README?
Compare versões de execução, configuração exigida e scripts reais. Reproduza a etapa ausente em vez de acrescentar um parágrafo vago de solução de problemas.
Teste com sua própria fonte.
Substitua o exemplo pelo seu material no prompt. Mantenha os requisitos necessários e copie a tarefa para o WebAct.
Personalizar e copiar a tarefa ↑