
review-docs
Review the README or a documentation page from several real reader points of view at once. Fans out one parallel reviewer per audience — Claude Code newcomer, power user, plugin/skill author, skeptical senior engineer, non-running decision-maker — each scoring it x/5 and naming concrete, line-level fixes. Use when asked to review, critique, grade, or "get to N/5" the README or any front-door doc, or to check how a doc reads for real users. Not for code review (use /code-review for that).
- Installs
- 626
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/zernie/vigiles --skill review-docs- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads review-docs automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Review a front-door doc (default README.md; honor a path the user names) the way
real readers would — not the way the author does. The author knows what every line
means; a first-time reader does not. The job is to surface where a specific audience
gets confused, under-served, or bounces, score it, and propose concrete fixes.
The method is fan-out: spawn one subagent PER PERSONA, all in parallel, each doing a cold read as that reader. Different readers catch different things; running them concurrently is faster and keeps each read uncontaminated by the others.
How to run it
1. Read the target doc yourself first
Read the doc in full and skim the docs it links to (so "promises depth the linked doc doesn't deliver" is checkable). You need this to judge the personas' findings and to apply fixes later.
2. Fan out one subagent per persona — in parallel
Spawn the personas below as subagents in a single message (multiple Agent/Task calls at once) so they run concurrently. Use a fast, cheap model (Sonnet or Haiku) — this is a reading/judgment task, not heavy synthesis — and say so in one line when you launch them.
Give EACH subagent the same rubric, only the persona changes:
You are <PERSONA>. Read
<path>(ignore any HTML comment block at the top — that's internal authoring notes, not user-facing copy). Do a COLD read as this reader: adopt their goals, vocabulary, and patience. Be a harsh grader — most READMEs are a 3; 5/5 means you'd genuinely act on it and it's crisp end to end. Return ONLY:
- SCORE: x/5
- 30-second test: after the first screen only, in one sentence, what do you think this tool does — and is that right/wrong/fuzzy?
- Top 3 concrete problems — each quotes the exact line/phrase and gives a specific suggested rewrite (confusing jargon, sentences carrying too many ideas, anything that doesn't sell, formatting that hurts scanning, hype that costs trust).
- Jargon check: every word you had to stop on (harness, spec, eval, subagent, rings, recall/precision…) — is it defined in context or left guessing?
- What works — keep these, so revisions don't lose them.
- The one change that would move the score most. Quote exact text. Be useful, not polite.
3. The personas (the fan-out set)
Run all of these unless the user scopes to a subset. Edit the set freely for a given doc — these are the default readers of vigiles's front door.
- Claude Code newcomer — new to agentic tooling, bounces on undefined terms. Needs a clear "what do I do first," not theory. Catches jargon used before it's defined.
- Claude Code power user — lives in CC, skimming on a phone between tasks. Wants the WOW in the first screen and a copy-paste install in seconds; allergic to fluff.
- Plugin / skill author — mid-level dev, comfortable with TS but not a rule-enforcer/types nerd. Found this because it claims to test their skills. Cares about "does it work on MY repo without learning a new theory?"
- Skeptical senior / staff engineer — scans for substance in ~20s, mentally compares to promptfoo / ESLint / ast-grep. Anything hand-wavy or overclaimed costs trust; every load-bearing claim should link proof.
- Decision-maker (won't run a command) — deciding whether the team adopts. Cares about cost, risk, effort; needs the "free deterministic vs. metered per-token" story and the low-risk incremental on-ramp to be legible without running anything.
- Codex user (optional) — uses
AGENTS.md, not Claude Code. Skeptical this is "a Claude-only thing." Is Codex support visible early or buried/footnoted?
4. Synthesize
Collect the scores and reports. Then:
- Cross-cutting issues first. The 2–4 problems that hurt MULTIPLE personas are the highest-leverage fixes — lead with those.
- Lowest score is the ceiling. The doc is only as good as its weakest reader's read; name what's blocking that persona.
- Produce a ranked fix list — highest reader-impact first, each a one-line action quoting the line and the fix.
5. Iterate to a target (only when asked)
If the user asks to "get it to N/5" (or "until 5/5"): apply the highest-leverage fixes yourself, then re-fan-out (resume the same subagents with the change list, or spawn fresh) and collect new scores. Repeat until every persona is at the target or scores stop moving. Bound it — if a round produces no improvement, or after ~3 rounds, stop and report what's blocking the last point rather than churning. By default this skill REPORTS; only enter the apply-and-iterate loop on an explicit "fix it / get it to N/5".
Output format
# Doc review — <file>
## Scores
<persona> — x/5 (one-line verdict each)
## Cross-cutting issues (highest leverage)
The 2–4 problems hitting multiple personas, each with the line + the fix.
## Per-persona highlights
The sharpest single finding from each reader (don't dump the full reports).
## Ranked fixes
Ordered, highest reader-impact first — each a one-line action.
Keep the synthesis scannable and ACTIONABLE: every finding names a line and a fix. Hold the doc to its own standards while reviewing — for the README that's the front-door brevity bar (lead with benefits, one idea per sentence, define jargon at first use, push depth into linked docs). Don't rewrite the doc in place unless the user asks for the iterate loop — this skill REPORTS by default.
FAQ
What does the review-docs skill do?
Review the README or a documentation page from several real reader points of view at once. Fans out one parallel reviewer per audience — Claude Code newcomer, power user, plugin/skill author, skeptical senior engineer, non-running decision-maker — each scoring it x/5 and naming concrete, line-level fixes. Use when asked to review, critique, grade, or "get to N/5" the README or any front-door doc, or to check how a doc reads for real users. Not for code review (use /code-review for that).
How do I install review-docs?
Run npx skills add https://github.com/zernie/vigiles --skill review-docs in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/review-docs/ (personal) or .claude/skills/review-docs/ (project).
Which AI agents can use review-docs?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is review-docs safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains review-docs?
It is published by zernie in zernie/vigiles. It has 626 recorded installs.
More from zernie/vigiles
edit-spec
zernie/vigiles
Edit a vigiles .spec.ts to change a compiled instruction file (CLAUDE.md / AGENTS.md) — add, modify, or remove a rule, section, command, or file pointer (including a request to add a "key file" — the keyFiles field is deprecated). Use whenever you need to change a CLAUDE.md/AGENTS.md that carries a vigiles hash (edit the spec, never the artifact), including adding a new enforce()/check()/guidance() rule.
strengthen
zernie/vigiles
Upgrade a vigiles spec's guidance() rules to enforce() — scan the guidance rules in a CLAUDE.md/AGENTS.md spec and find existing linter rules (ESLint, Ruff, Clippy, Pylint, RuboCop, Stylelint) that back them. Use when asked to strengthen, harden, or make vigiles rules enforceable; NOT for general linting or fixing lint errors.
test-harness
zernie/vigiles
Install vigiles and test a Claude Code harness — hooks, skills, agents, settings, CLAUDE.md — by picking the right tier (unit / deterministic / eval) and writing a test that passes. Use to check that a hook fires or blocks, that a skill triggers, that injected context lands; or to observe a run — which tools it called, whether it stayed inside its declared allowed-tools, what files and side effects it produced, how to intercept a call without executing it.
linter-docs
zernie/vigiles
Deep linter reference for authoring or debugging a vigiles enforce() rule — plugin tables, AST selectors, type-aware rules, auto-fix, and edge cases for ESLint, Ruff, Pylint, RuboCop, Stylelint, and Clippy. Use when you need the exact rule name or config for a specific linter, not for running a linter. (JVM/Go linters — detekt, ktlint, Checkstyle, golangci-lint — and Cedar have no deep-dive file yet; their reference lives in docs/linter-support.md.)
adopt-spec
zernie/vigiles
Adopt a typed .spec.ts for an existing hand-written CLAUDE.md — start from the file you already have, non-destructively
debug-my-harness
zernie/vigiles
Diagnose why an agent harness misbehaved by reading the local flight-recorder ledger (.vigiles/runs.jsonl) — which skills fired or got hijacked, which hooks blocked or wrongly allowed, which subagent tool-contract violations happened, and how a skill's trigger rate moved. Use when asked why a skill stopped firing, why a hook didn't block, why the wrong skill ran, or to debug/investigate what the harness actually did. NOT for writing new rules (use strengthen) or editing the spec (use edit-spec).
Popular code quality & workflow skills
grill-me
mattpocock/skills
A relentless interview to sharpen a plan or design.
improve-codebase-architecture
mattpocock/skills
Scan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.
handoff
mattpocock/skills
Compact the current conversation into a handoff document for another agent to pick up.
domain-modeling
mattpocock/skills
Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a GLOSSARY.md, or recording or editing an ADR.
codebase-design
mattpocock/skills
Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-navigable, or when another skill needs the deep-module vocabulary.
diagnosing-bugs
mattpocock/skills
Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.