Analisador de README
Analise a qualidade do seu README.md. Receba score, checklist e sugestões de melhoria.
O que é Analisador de README?
O Analisador de README avalia a qualidade de um arquivo README.md, dando nota de 0 a 100 e apontando o que falta com base em um checklist de 10 itens (título, descrição, instalação, uso, licença, badges, contribuição, contato, documentação e stack). O humberto.ai roda toda a análise no navegador — cole o texto ou envie um arquivo .md, .markdown ou .txt e nada é enviado a servidor algum.
Como usar
- Cole o conteúdo do seu README.md no campo de texto ou clique em "Fazer Upload de README.md" para carregar um arquivo .md, .markdown ou .txt.
- Clique em "Analisar README" para rodar o checklist de 10 itens localmente, no navegador.
- Veja o score de 0 a 100, as estatísticas (linhas, seções, links, badges) e o checklist marcado item a item como presente ou ausente.
- Leia as sugestões de melhoria geradas para cada item faltante — itens críticos ausentes reduzem a nota final em 30%.
- Ajuste o README e repita a análise quantas vezes quiser; use "Resetar" para limpar o texto e recomeçar.
Perguntas frequentes
Meus dados do README saem do navegador?
Não. Toda a análise — leitura do arquivo, checagem do checklist e cálculo do score — roda em JavaScript no seu navegador; nada é enviado a servidor ou provedor de IA.
Que formatos de arquivo posso enviar?
Arquivos .md, .markdown ou .txt via upload, ou você pode colar o texto diretamente no campo. A ferramenta não define um limite de tamanho próprio.
Como o score de 0 a 100 é calculado?
São verificados 10 itens: 4 críticos (título, descrição, instalação, uso/exemplos) e 6 opcionais (licença, badges, contribuição, contato, documentação, stack). O score é a porcentagem de itens presentes; se faltar algum item crítico, a nota final é multiplicada por 0,7.
A análise usa IA para entender o conteúdo do README?
Não. É uma varredura por expressões regulares e palavras-chave (cabeçalhos markdown, termos como "instalação"/"installation", padrões de imagem e link) — não há interpretação semântica por IA.
Por que meu README com título, descrição e instalação ainda ficou com nota baixa?
Porque nesse caso ainda falta o item crítico "uso/exemplos", e qualquer item crítico ausente já multiplica a nota por 0,7. Além disso, os 6 itens opcionais (licença, badges, contribuição, contato, documentação, stack) também entram na porcentagem do score — faltando muitos deles, a nota final cai.
A ferramenta reconhece READMEs em inglês?
Sim, o checklist busca termos equivalentes em português e inglês, como "instalação"/"installation" e "uso"/"usage"/"example".