# Docs Audit

> Avalia a documentação (README, CONTRIBUTING, etc.) para encontrar lacunas de clareza e onboarding. Use when this capability is needed.

- Skill: `tomevault-io/docs-audit-2` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/docs-audit-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/docs-audit-2/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Security
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/docs-audit-2

---


# 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

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/glaucia86) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-11 -->