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
- •Verificar presença do README.
- •Localizar seções essenciais (instalação, uso, contribuição).
- •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