review-documentation

review-documentation is a skill for Claude Code, Codex from paultyng/skill-issue. It costs 83 tokens per session (2,491 once invoked), scanned A, original, MIT.

A process for checking whether documentation matches the code, including Go comments, protocol definitions, API descriptions, Markdown files, and example tests.

In plain words
What is it for?
Use it to review a whole repository, selected packages, specific files, or changes in a pull request, and to produce prioritized findings with code references.
Why use it?
Documentation can become incorrect or incomplete as software changes. This helps find gaps and outdated explanations before they confuse users or maintainers.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: reads .claude/ paths; mentions subagents.

Good fit Use it to review a whole repository, selected packages, specific files, or changes in a pull request, and to produce prioritized findings with code references.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/paultyng/skill-issue/review-documentation
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 paultyng/skill-issue --skill review-documentation
Clone the repo
git clone --depth 1 https://github.com/paultyng/skill-issue

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 review-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/paultyng/skill-issue/review-documentation/github.svg)](https://agentmods.dev/skills/paultyng/skill-issue/review-documentation)
Your own site
<a href="https://agentmods.dev/skills/paultyng/skill-issue/review-documentation"><img src="https://agentmods.dev/badge/skills/paultyng/skill-issue/review-documentation/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 review-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/paultyng/skill-issue/review-documentation"><img src="https://agentmods.dev/badge/skills/paultyng/skill-issue/review-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 83 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,491 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00083 $0.02491
Opus 5.5 $0.00033 $0.00996
Sonnet 5.5 $0.00017 $0.00498
Haiku 4.5 $0.00008 $0.00249

Measured 8d ago against content hash 0cef07c4c153, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

review-documentation scanned grade A with 1 finding 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 8d 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.

Reads agent configuration directorieslowAgent snooping

.claude/, .codex/, .gemini/ hold keys, settings and other credentials a mod has no legitimate need for.

- Findings must cite probed evidence (`path:line`, grep output, command result), not pattern-matched suspicion. Per `~/.claude/rules/probe-not-assume.md`.

Downgraded: this mod is about security review, or the phrase is quoted, so it is likely naming the pattern rather than instructing it.

skills/review-documentation/SKILL.md · 182 lines

How it starts

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

Documentation Review

Structured documentation review producing actionable, prioritized findings with code-level references. Checks that documentation exists, is accurate, and stays in sync with the implementation.

Workflow

1. Scope and explore

  • Confirm scope with the user: full codebase, specific packages/directories, changed files only (PR or branch diff), or specific concern.
  • Resolve scope to a file/package list. Based on what the user requested:
    • Changed files (PR or branch): Run git diff --name-only --diff-filter=d <base>...HEAD to get changed files (default <base> is main). If the user references a PR number, use gh pr diff <number> --name-only instead. Filter to relevant file types (.go, .proto, .md, OpenAPI specs). Derive affected Go packages from the file paths (unique parent directories containing .go files).
    • Explicit paths/packages: The user may specify directories (e.g. internal/auth/), Go package patterns (e.g. ./internal/auth/...), or individual files. When given a directory or package pattern, include all files under it. Derive Go package paths for go doc invocations.
    • Full codebase: No filtering; explore everything (default).
  • Pass the resolved scope (file list and derived package paths) to all exploration and investigation subagents so findings stay scoped to those files. Reading is not scoped: follow callees, callers, and third-party source wherever a finding depends on their behavior. Report bugs in code the scope touches or calls even when they predate the diff, prefixed pre-existing:.
  • Detect which documentation surfaces exist within the resolved scope:
    • .go files → go doc analysis, doc.go files, Example* tests
    • .proto files → service/method/message/field comments
    • openapi.yml / openapi.yaml / swagger.* → API descriptions
    • *.md files → README, guides, changelogs

2. Launch investigation subagents in parallel

Launch up to 3 investigation subagents concurrently using the Task tool (model: sonnet per subagent-model-routing — documentation analysis requires cross-referencing signatures and prose). Each receives the list of in-scope files as context. Only launch subagents whose preconditions are met.

Read the full file on GitHub · 182 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. 8d ago Changed · +28 tokens per session 0cef07c4c153
  2. 1mo ago First seen · 182 lines · 55 tokens per session scan A 21b98c25ec97

Subscribe to this mod's changes

review-documentation is a skill published in the GitHub repository paultyng/skill-issue (8 stars, last pushed 4d ago), licensed MIT. It adds 83 tokens to every session and 2,491 once invoked, about $0.0003 per session on Opus 5.5. A static security scan graded it A with 1 finding (reads agent configuration directories). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

deep-review

Evidence-based deep code review rubric — severity + confidence findings across maintainability, correctness, security, performance, and testing. Push for ambitious structural simplification (code judo), not just local cleanup. Escalate hands-on triage to the code-reviewer agent.

ulises-jeremias/agent-toolkit · 57 tokens

gh-address-comments

Triage and address open GitHub PR review and conversation comments using the gh CLI. Use when the user wants to "address PR comments", "resolve review threads", or "respond to reviewers" on the current branch's pull request.

ulises-jeremias/agent-toolkit · 51 tokens

pr-alignment-loop

Iterate a PR to its final form by running two opposing reviewer droids (reviewer-robustness and reviewer-minimalist) in a bounded back-and-forth loop. The main orchestrator synthesizes their feedback, makes edits, runs tests, and stops when both approve, on stagnation, or after 3 rounds. Use when the user asks to…

nikships/skills-registry · 122 tokens

deslop

Remove AI-generated code slop and clean up code style.

ulises-jeremias/agent-toolkit · 14 tokens

blind-spot-pass

Run a pre-build blind spot pass before the agent builds anything. Treat the user's prompt as the map and the real project as the territory: classify gaps across known knowns, known unknowns, unknown knowns, and unknown unknowns (with deps, edge cases, and blast radius under unknown unknowns); ask 5 to 10 high-leverage…

emaraschio/cursor-commands · 138 tokens

merge-open-prs

Review, verify (Docker by default), and auto-merge open PRs when CI, reviews, and local verification pass. Batch up to 10 PRs per run. Use when the user wants to merge all open PRs, clear the PR queue, or run /merge-open-prs.

emaraschio/cursor-commands · 65 tokens