К основному содержанию
скилл CX Codex

review-docs · zernie — скилл для Claude Code: обзор и установка

Параллельно проверяет README или страницу документации глазами разных читателей и выдаёт оценки с правками по конкретным строкам.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add zernie/vigiles --skill review-docs -a claude-code
Открыть на GitHub

Что делает review-docs

Скилл читает README.md или путь, который задаст пользователь, затем запускает отдельного субагента для каждой аудитории. В набор входят новичок Claude Code, опытный пользователь, автор плагинов и скиллов, скептичный senior-инженер и человек, который принимает решение без запуска команды. При необходимости добавляется взгляд пользователя Codex.

Каждый проверяющий ставит оценку по шкале x/5, описывает впечатление от первого экрана, отмечает непонятные термины и предлагает правки с привязкой к строкам. Скилл также просматривает связанные документы, собирает общие проблемы и выдаёт ранжированный список исправлений. По умолчанию он формирует отчёт, а повторный цикл с правками запускается только по явной просьбе.

Для проверки кода этот скилл не подходит: в инструкции прямо предусмотрено использование /code-review. Для работы нужна платформа с установленным скиллом и доступ к целевому документу.

Какие задачи решает

  • проверить README глазами разных аудиторий
  • оценить ясность первого экрана документации
  • найти непонятные термины и перегруженные фразы
  • собрать правки с привязкой к строкам
  • расставить исправления по влиянию на читателей

Примеры запросов агенту

  • Проверь README.md глазами пяти аудиторий и дай оценки по шкале x/5.
  • Проведи ревью docs/intro.md, найди проблемы в первом экране и предложи правки по строкам.
  • Оцени документацию до N/5, затем внеси самые важные исправления и повтори проверку.

Как установить review-docs

1Через Skills CLI (Vercel)

npx skills add zernie/vigiles --skill review-docs -a claude-code

2Вручную: положить файлы

~/.claude/skills/review-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/review-docs/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о review-docs

Как установить review-docs в Claude Code?

Выполните npx skills add zernie/vigiles --skill review-docs -a claude-code, затем проверьте файл ~/.claude/skills/review-docs/SKILL.md.

Что делает review-docs?

Скилл запускает параллельных субагентов с разными читательскими ролями. Они оценивают документ, находят проблемы по строкам, а затем скилл собирает общие и приоритетные исправления.

Проверяет ли review-docs исходный код?

Нет. Он предназначен для README и других документов, которые открывают пользователю путь к проекту; для ревью кода в инструкции указан /code-review.

Исходный текст

SKILL.md · MIT
---
name: review-docs
description: 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).
---

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:
>
> 1. **SCORE: x/5**
> 2. **30-second test:** after the first screen only, in one sentence, what do you
>    think this tool does — and is that right/wrong/fuzzy?
> 3. **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).
> 4. **Jargon check:** every word you had to stop on (harness, spec, eval, subagent,
>    rings, recall/precision…) — is it defined in context or left guessing?
> 5. **What works** — keep these, so revisions don't lose them.
> 6. **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.

1. **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.
2. **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.
3. **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?"
4. **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.
5. **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.
6. **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.

© zernie · MIT · zernie/vigiles

Похожие скиллы

Все скиллы по теме «Тексты и документация» →

Сначала — review-docs от других авторов.

review-docs tldraw Запускает аудит документации по гайдам стиля и кодовой базе tldraw с оценкой по 40-балльной шкале. Помогает находить неточности в коде и исправлять текст по шагам. CX Codex +1 391установок grill-with-docs Matt Pocock Скилл проводит жёсткое интервью по плану или дизайну и по ходу создаёт ADR и глоссарий. Подойдёт перед началом сложной разработки. 1 219 756установок skill-creator официальный anthropics Помогает создать новый скилл, доработать существующий и проверить результат через тестовые промпты и оценки. 414 180установок setup-matt-pocock-skills Matt Pocock Скилл настраивает репозиторий для инженерных скиллов Matt Pocock: задаёт трекер задач, метки триажа и расположение доменной документации. Запустите его перед первым использованием остальных скиллов. 1 052 851установок handoff Matt Pocock Собирает текущий диалог в документ передачи, чтобы другой агент продолжил работу с нужным контекстом. Нужен при смене сессии или исполнителя. 1 038 491установок triage Matt Pocock Скилл проводит issue и внешние PR через роли триажа, проверку и подготовку брифа для агента. Подойдёт мейнтейнеру, который разбирает очередь задач. 990 453установок domain-modeling Matt Pocock Скилл помогает уточнять термины проекта, вести GLOSSARY.md и фиксировать архитектурные решения в ADR. Нужен, когда модель предметной области меняется. 876 391установок

Из того же набора13

linter-docs Справочник по правилам ESLint, Ruff, Pylint, RuboCop, Stylelint и Clippy. Нужен, когда пишешь или отлаживаешь правило enforce() в vigiles. CX Codex +1 2 000установок adopt-spec Превращает уже написанный CLAUDE.md или AGENTS.md в типизированный CLAUDE.md.spec.ts, не трогая исходный файл. Пригодится, если хочется проверять инструкции линтером, но переписывать их с нуля неохота. CX Codex +1 1 800установок debug-my-harness Разбирает, почему агентная обвязка сработала не так, читая локальный журнал .vigiles/runs.jsonl. Пригодится, когда скилл перестал запускаться или хук пропустил то, что должен был заблокировать. CX Codex +1 1 500установок deep-research Организует сбор данных через параллельных субагентов и сохраняет факты со ссылками на диск, чтобы детали не пропали после сжатия контекста. CX Codex +1 762установок pr-to-lint-rule Скилл превращает повторяющееся правило ревью в пользовательское правило линтера и проверяет его на ошибках до подключения. CX Codex +1 436установок enforce-rules-format Проверяет, отмечены ли правила как enforce, check или guidance, и предлагает исправления. Пригодится для проектов с Vigiles и файлами инструкций. CX Codex +1 433установок code-quality Скилл для рефакторинга TypeScript и JavaScript: приводит типы в порядок, убирает невозможные состояния и разделяет логику с вводом-выводом. CX Codex +1 391установок verify-docs-findable Проверяет, отвечает ли документация на реальные вопросы читателя. Запускает дешёвых агентов Haiku, которые читают только доки и показывают, где ответы теряются. CX Codex +1 340установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой