cli-audit-doc

A documentation quality checker that reviews project docs across areas such as completeness, readability, examples, accessibility, and freshness. It also looks for common writing problems and checks the project's code when needed.

In plain words
What is it for?
Use it to review a README or documentation folder, check whether public features are explained, find stale content, and produce evidence-based quality findings.
Why use it?
It helps find documentation that is unclear, incomplete, outdated, or difficult to use before it misleads readers.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/destynova2/cli-code-skills/cli-audit-doc
Any agent
npx skills add Destynova2/cli-code-skills --skill cli-audit-doc
Clone the repo
git clone --depth 1 https://github.com/Destynova2/cli-code-skills

Made for: Claude Code, Codex.

Per session 89 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,870 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00089 $0.01870
Opus 5 $0.00044 $0.00935
Sonnet 5 $0.00018 $0.00374
Haiku 4.5 $0.00009 $0.00187

Measured 2d ago against content hash b4ac7815f0fd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

cli-audit-doc 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 2d 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.

cli-audit-doc/SKILL.md · 159 lines

How it starts

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

Optimization: This skill uses on-demand loading. Heavy content lives in references/ and is loaded only when needed.

Language rule: Skill instructions are written in English. When generating user-facing output, detect the project's primary language (from README, comments, docs, commit messages) and produce the report in that language. If the project is bilingual, ask the user which language to use before proceeding.

Audit Doc — Documentation Quality Index (DQI)

"Stale docs are worse than no docs." — Docs-as-Tests methodology

Core Principles

  1. Evidence-based — every finding needs a file:line reference
  2. Read the code — verify docs match implementation. Stale docs are the #1 problem
  3. Diataxis-aware — classify each doc by type (tutorial, how-to, reference, explanation) and check mode purity
  4. Language-specific — apply each language's idiomatic doc conventions (see reference.md for language-specific rules)
  5. Public API first — public items are priority. Private items are nice-to-have
  6. Gotchas — read ../gotchas.md before producing output to avoid known mistakes

Input

$ARGUMENTS is the target to audit (file path, directory, or empty for whole src/).

  • If a specific file: audit that file deeply
  • If a directory: audit all source files in it
  • If empty: audit src/ (or project root) broadly (sample 15-20 key files)

First, detect the primary language(s) from file extensions. Consult reference.md for language-specific conventions.

12-Dimension Framework

Score each dimension 0.0-1.0, then compute a weighted DQI. Read references/categories.md for detailed check lists per category.

# Category Weight Key question
C1 Diataxis Coverage 10% All 4 doc types present? Mode purity?
C2 Completeness 12% Public API items documented? Coverage > 80%?
C3 Freshness & Accuracy 10% Docs match current code? No stale references?
C4 Readability & Prose Quality 10% No weasel words, condescension, passive voice? Register calibrated to the expected reader?
C5 Structure & Findability 8% Heading hierarchy? Scannable? No orphan pages?
C6 Standard Sections 8% Errors, params, returns, examples documented?
C7 Code Examples 10% Working, copy-pasteable, no unwrap()?
C8 Accessibility & Inclusivity 6% Alt text? Bias-free language? Global-ready?
C9 Inline Comments Quality 8% WHY not WHAT? No stale TODOs?
C10 Cross-references & Linking 5% Types linked? Related items connected?
C11 Testing & CI 8% Doc-tests? Link checking? Prose linting?
C12 Maintenance Process 5% Docs reviewed in PRs? Ownership clear?

Read the full file on GitHub · 159 lines

Files

What ships with it

3 files 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. 2d ago First seen · 159 lines · 89 tokens per session scan A b4ac7815f0fd

Subscribe to this mod's changes

cli-audit-doc is a skill published in the GitHub repository Destynova2/cli-code-skills (5 stars, last pushed 9d ago), licensed MIT. It adds 89 tokens to every session and 1,870 once invoked, about $0.0004 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.