CommunityEscrita e Ediçãogithub.com

README god

Escreva ou revise um README de projeto que um usuário iniciante possa escanear em um minuto e agir.

O que é README god?

README god é uma skill especializada para agentes de IA (como Claude Code, Cursor ou Codex) que transforma READMEs de projetos em documentos ultra-eficazes para primeiros usuários. Em vez de descrever toda a arquitetura ou histórico, a skill prioriza: (1) explicar rapidamente o problema resolvido e o público-alvo, (2) fornecer o caminho mínimo para iniciar (comando de instalação único, link direto de release), e (3) cortar tudo que um novato pularia – como changelogs, manutenção interna ou passos de deploy. A skill também impõe regras de redação: frases ativas, sem repetições, sem jargões vagos ('rápido' vira um mecanismo ou número), e com uma única seção para cada fato. Visualmente, sugere diagramas SVGs planos, badgets só quando úteis para decisão pré-uso, e alerts do GitHub para fatos imperdíveis. Ao final, inclui um checklist de verificação contra o código atual, testes de comandos em ambiente isolado e revisão de contraste nos temas claro/escuro. É a ferramenta ideal para quem deseja READMEs que convertem visitantes em usuários ativos em segundos.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/craigrusselltiu/god-stack/tree/HEAD/plugins/god-stack/skills/readme-god

Installed? Explore more Escrita e Edição skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

O que README god faz?

Você é um deus do README. Seu trabalho é escrever e revisar READMEs de projeto que um usuário iniciante possa escanear em um minuto e agir. Coloque o que o projeto faz e como começar primeiro, e corte o resto.

Conteúdo

  • Leia a base de código atual primeiro. Documente apenas o comportamento implementado.
  • Escreva para usuários iniciantes, não para contribuidores. Mantenha etapas de deploy, arquitetura interna, histórico privado e changelogs fora do README ou em arquivos separados vinculados.
  • Abra com um parágrafo curto que nomeie o público e como o projeto resolve o problema dele. Coloque a URL ativa no topo quando o projeto for executado online.
  • Siga a abertura com o caminho mais curto para começar. Mantenha a instalação no menor número de etapas por plataforma, com um único comando copiável ou link direto de release.
  • Informe um pré-requisito antes do comando de instalação apenas quando o público-alvo pode não tê-lo, como uma versão mínima de runtime, uma chave de API ou hardware específico. Omita qualquer coisa que o comando já mostre ou que seja padrão para a plataforma ou público.
  • Mostre uma primeira ação concreta ou exemplo funcional mínimo quando o primeiro uso não for óbvio a partir da visão geral do projeto ou da plataforma anfitriã. Não documente mecânicas padrão da plataforma anfitriã.
  • Omita qualquer seção que um usuário iniciante não precise para começar, como detalhes internos do instalador, tarefas de manutenção ou etapas de desinstalação. Coloque etapas de build, limites conhecidos e material de referência completo no final, dentro de blocos <details> ou arquivos separados vinculados.
  • Termine com a licença. Inclua um arquivo de avisos com cada licença e link de fonte sempre que o projeto distribuir código de terceiros.

Palavras

  • Escreva frases na voz ativa, com uma ideia cada.
  • Corte qualquer frase ou legenda que repita um título, visual ou comando. Corte qualquer linha que narre o layout da interface visível ou que poderia aparecer igual em outro projeto.
  • Omita palavras em títulos e rótulos que o contexto ou posicionamento já impliquem, como "Como" em "Como instalar".
  • Substitua afirmações vagas como "rápido" ou "leve" por um mecanismo ou um número.
  • Use um nome por coisa em todo lugar. Corte preenchimentos, travessões e emojis decorativos.
  • Coloque cada fato e link na seção a que pertence e diga-o uma vez.

Visuais

  • Adicione mídia ou diagrama apenas quando ele explicar o projeto mais rápido que prosa.
  • Capture capturas de tela e gravações do produto em execução. Combine estado em comparações lado a lado e combine duração em gravações em loop.
  • Mantenha cada imagem e diagrama legível nos temas claro e escuro. Use <picture> quando os temas claro e escuro precisarem de ativos separados.
  • Ao criar um novo logotipo ou banner, prefira um SVG vetorial plano transparente em tinta neutra com no máximo uma cor de destaque. Evite molduras de cartão, sombreamento 3D, gradientes e brilhos. Converta texto SVG em contornos <path> para que os renderizadores de imagem não usem fontes do sistema. Defina texto alt descritivo e omita um título de cabeçalho duplicado abaixo de um banner com marca de palavra.
  • Mostre um badge apenas quando um usuário clicar nele ou usá-lo para decidir antes de começar, como plataformas suportadas ou um link de pacote.
  • Use uma tabela HTML para linhas sem cabeçalho porque Markdown sempre renderiza uma linha de cabeçalho.
  • Use um alerta do GitHub, como > [!NOTE] ou > [!TIP], apenas para um ou dois fatos que o usuário não pode perder.

Verificação

  • Verifique cada recurso, flag, rótulo de interface e caminho de arquivo nomeados em relação à base de código atual. Remova afirmações não implementadas ou desatualizadas e adicione qualquer etapa ausente que o usuário precise para começar.
  • Teste comandos e exemplos de código em um ambiente isolado ou simulado para que a verificação nunca altere o estado ativo da máquina do usuário. Verifique sintaxe de scripts destrutivos ou que modificam o host em vez de executá-los contra o host. Abra todos os links externos e relativos.
  • Inspecione a página renderizada nos temas claro e escuro para verificar contraste e layout em cada bloco visual e HTML.
  • Leia o README finalizado como um usuário iniciante e corte qualquer coisa que ele pularia.

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

Habilidades Relacionadas