Agent skill

Docs Audit

by glaucia86 in glaucia86/repocheckai

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

MITAuto-check passedDevelopment

Install Docs Audit

skills CLI
$ npx skills add glaucia86/repocheckai --skill docs-audit -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install glaucia86/repocheckai docs-audit --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/glaucia86/repocheckai.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/docs-audit .claude/skills/docs-audit && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-audit
GitHub stars
121
Token cost
~220 tokens
SKILL.md length
90 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
MIT

At a glance

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

  • Works in 3 steps: Verificar presença do README. → Localizar seções essenciais (instalação,… → Detectar textos confusos
  • Tasks that involve Technical documentation
  • SKILL.md covers Quando usar, Escopo da skill, Entradas esperadas and Como analisar, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Docs Audit is an agent skill from glaucia86/repocheckai. Avalia a documentação (README, CONTRIBUTING, etc.) para encontrar lacunas de clareza e onboarding.

Its SKILL.md is about 220 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: Agentic CLI Tool for GitHub Repository Health Analysis. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/docs-audit”

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

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

What it can do on your machine

Read from SKILL.md and the folder at commit dfc3830. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Audit loads about 220 tokens when it runs. Until then it costs about 27 tokens; SKILL.md has 90 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~27
When it runs · the whole SKILL.md, loaded when a task matches
~220

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from glaucia86/repocheckai at commit dfc3830, republished under its MIT licence (© glaucia86). 90 words, ~220 tokens.

Download SKILL.mdSave it as .claude/skills/docs-audit/SKILL.md (or your agent's skills folder).
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

© glaucia86, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .github/skills/docs-audit of glaucia86/repocheckai.

Open the folder on GitHubat commit dfc3830

Compare with similar skills

Docs Audit next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Audit compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Audit this skillglaucia86/repocheckai121—~220Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 6 days ago
    DevelopmentAuto-check: notes

More from glaucia86/repocheckai

All 8 skills in this repo
  • CI Workflow Audit

    glaucia86/repocheckai

    Avalia pipelines CI/CD, detectando gaps e oportunidades de melhoria.

    121 GitHub stars~215 tokensUpdated 3 mo ago
    Auto-check passed
  • Code Quality Audit

    glaucia86/repocheckai

    Analisa padrões de qualidade de código e detecta code smells, complexidade elevada e duplicação.

    121 GitHub stars~270 tokensUpdated 3 mo ago
    Auto-check passed
  • Security Hygiene

    glaucia86/repocheckai

    Detecta riscos básicos de segurança em repositórios (segredos expostos, configurações perigosas, padrões inseguros) e gera recomendações com evidências.

    121 GitHub stars~819 tokensUpdated 3 mo ago
    Auto-check: warnings
  • Dependency Health

    glaucia86/repocheckai

    Analisa dependências para identificar falta de uso, versões permissivas ou riscos.

    121 GitHub stars~198 tokensUpdated 3 mo ago
    Auto-check passed
  • Findings To GitHub Issues

    glaucia86/repocheckai

    Converte achados de outras skills em issues e comentários prontos para o GitHub.

    121 GitHub stars~210 tokensUpdated 3 mo ago
    Auto-check passed
  • Repo Health

    glaucia86/repocheckai

    Analisa o perfil do repositório e extrai um modelo estruturado com evidências para orientar outras análises.

    121 GitHub stars~392 tokensUpdated 3 mo ago
    Auto-check passed

Categories

Questions about Docs Audit

What does Docs Audit do?

Avalia a documentação (README, CONTRIBUTING, etc.) para encontrar lacunas de clareza e onboarding. Docs Audit is an agent skill from glaucia86/repocheckai.) para encontrar lacunas de clareza e onboarding.

When should I use Docs Audit?

Docs Audit fits situations like: tasks that involve Technical documentation.

How do I install Docs Audit in Claude Code?

Run `npx skills add glaucia86/repocheckai --skill docs-audit -a claude-code`. Or copy the skill folder (.github/skills/docs-audit in glaucia86/repocheckai) into .claude/skills/docs-audit in your project. Claude Code loads it when a task matches its description.

How do I install Docs Audit in Codex?

Run `npx skills add glaucia86/repocheckai --skill docs-audit -a codex`. Or copy the skill folder (.github/skills/docs-audit in glaucia86/repocheckai) into .agents/skills/docs-audit in your project. Codex loads it when a task matches its description.

Can I use Docs Audit in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add glaucia86/repocheckai --skill docs-audit -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-audit, .gemini/skills/docs-audit, .github/skills/docs-audit and .opencode/skills/docs-audit in your project.

What does Docs Audit need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Audit is instructions for the agent only.

Does Docs Audit access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Audit safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Audit use?

Docs Audit is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Audit use?

About 220 tokens (SKILL.md is roughly 880 characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Audit?

Skills that share tags, products or a category with Docs Audit: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Audit?

glaucia86 (a GitHub user) maintains it in glaucia86/repocheckai, which has 121 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on July 8, 2026.

Source: glaucia86/repocheckai on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.