docs-audit

star 117

Avalia a documentação (README, CONTRIBUTING, etc.) para encontrar lacunas de clareza e onboarding.

glaucia86 By glaucia86 schedule Updated 2/4/2026
play_arrow Run Skill in Manus View GitHub

name: docs-audit description: Avalia a documentação (README, CONTRIBUTING, etc.) para encontrar lacunas de clareza e onboarding.

Skill: Documentation Audit

Quando usar

Sempre que for necessário checar:

  • Qualidade da documentação
  • Facilidade de onboarding

Escopo da skill

Inclui:

  • Presença de seções essenciais
  • Clareza e exemplos
  • Guias de contribuição

Não inclui:

  • Correção automática de texto

Entradas esperadas

  • README.md
  • docs/
  • Outros arquivos Markdown

Como analisar

  1. Verificar presença do README.
  2. Localizar seções essenciais (instalação, uso, contribuição).
  3. Detectar textos confusos

Saída esperada

Achados com:

  • Falta de seções
  • Sugestões de conteúdo
  • Evidência de contexto

Regras obrigatórias

  • Evidência real em Markdown
  • Sugestões acionáveis

Limitações

  • Não faz análise semântica profunda de linguagem
Install via CLI
npx skills add https://github.com/glaucia86/repocheckai --skill docs-audit
Repository Details
star Stars 117
call_split Forks 11
navigation Branch main
article Path SKILL.md
Occupations
Technical Writers
More from Creator
glaucia86
glaucia86 Explore all skills →