docs-audit

docs-audit is a skill for Claude Code, Codex from stark-ai-de/agent-skills. It costs 46 tokens per session (596 once invoked), scanned A, original, Apache-2.0.

A review of a software repository's documentation, including its README, examples, installation guide, API reference, and contribution instructions. It compares what the documents promise with the repository's actual code and commands.

In plain words
What is it for?
Use it to check onboarding steps, command accuracy, examples, links, screenshots, generated documentation, maintenance guidance, and whether the repository is ready to publish.
Why use it?
It finds unclear, incomplete, outdated, or broken instructions that can stop users, contributors, maintainers, or agents from using the project safely.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to check onboarding steps, command accuracy, examples, links, screenshots, generated documentation, maintenance guidance, and whether the repository is ready to publish.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/stark-ai-de/agent-skills/docs-audit
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add stark-ai-de/agent-skills --skill docs-audit
Clone the repo
git clone --depth 1 https://github.com/stark-ai-de/agent-skills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-audit

README.md
[![agentmods](https://agentmods.dev/badge/skills/stark-ai-de/agent-skills/docs-audit/github.svg)](https://agentmods.dev/skills/stark-ai-de/agent-skills/docs-audit)
Your own site
<a href="https://agentmods.dev/skills/stark-ai-de/agent-skills/docs-audit"><img src="https://agentmods.dev/badge/skills/stark-ai-de/agent-skills/docs-audit/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for docs-audit

Your own site · 80×15
<a href="https://agentmods.dev/skills/stark-ai-de/agent-skills/docs-audit"><img src="https://agentmods.dev/badge/skills/stark-ai-de/agent-skills/docs-audit.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 596 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00046 $0.00596
Opus 5 $0.00023 $0.00298
Sonnet 5 $0.00009 $0.00119
Haiku 4.5 $0.00005 $0.00060

Measured 9d ago against content hash ab3edf0305b4, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

docs-audit scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

incubator/skills/repo-maintenance/docs-audit/SKILL.md · 87 lines

How it starts

The opening of the file, as written. The whole thing — 87 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Docs Audit

Goal

Find documentation gaps that block users, contributors, maintainers, or agents from understanding, installing, validating, and safely changing the repository.

When to use

  • The user asks whether docs are clear, complete, current, or public-ready.
  • README, examples, onboarding, API docs, or contribution docs need review.
  • Documentation promises may have drifted from actual code and commands.

When not to use

  • The user asks for a full repo maintenance audit; use repo-health-audit.
  • The user wants release notes; use release-manager.
  • The user wants prose editing only and no repo evidence check.

Inputs to inspect

  • README, docs, examples, changelog, contributing guide, security policy, and license.
  • Package scripts, CLI help, config examples, and source files that docs mention.
  • Internal links, install commands, screenshots, and generated docs.

Review rubric

Check audience fit, first-run path, command accuracy, link integrity, examples, maintenance docs, public safety, and agent usability. Read references/docs-rubric.md for details.

Workflow

  1. Identify the intended audiences and main user journeys.
  2. Compare README promises with actual files and commands.
  3. Verify install, validate, and usage examples where practical.
  4. Check internal links and stale references.
  5. Separate user-facing docs gaps from maintainer-only improvements.
  6. Produce a prioritized docs gap list.

Safety rules

  • Do not publish docs, rewrite policy, or change public support commitments without approval.
  • Do not include private URLs, internal hostnames, customer details, or credentials in examples.
  • Mark commands as unverified when they were not run.

References

Read only when needed:

  • references/docs-rubric.md

Scripts

No bundled scripts.

Output format

Return:

  1. Summary
  2. Blocking docs gaps
  3. Confusing or stale sections
  4. Missing examples
  5. Suggested rewrite or new docs
  6. Recommended next action

Failure modes

Read the full file on GitHub · 87 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 87 lines · 46 tokens per session scan A ab3edf0305b4

Subscribe to this mod's changes

docs-audit is a skill published in the GitHub repository stark-ai-de/agent-skills (5 stars, last pushed yesterday), licensed Apache-2.0. It adds 46 tokens to every session and 596 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.