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

verify-docs-findable — скилл для Claude Code: аудит находимости

Проверяет, отвечает ли документация на реальные вопросы читателя. Запускает дешёвых агентов Haiku, которые читают только доки и показывают, где ответы теряются.

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

Что делает verify-docs-findable

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

Внутри — пошаговая процедура. Сначала собираются 3–8 вопросов: те, на которых вы только что споткнулись, плюс канонические ответы, ради которых документация существует. Потом на каждый вопрос запускается параллельный агент Haiku с шаблоном «используй только доки, начни с индекса». Каждый отчитывается: ответ, файл, число шагов от индекса, пришлось ли читать исходники. Оценка простая: 1–2 шага — хорошо, 3 и больше — нет указателя; залез в код — факта нет в прозе; сослался на два противоречащих дока — баг связности.

Haiku выбран намеренно: слабая модель без контекста сессии ведёт себя как наивный новичок. Сильная модель с вашим контекстом прочитает исходники и спрячет проблему документации. Запускать стоит после реорганизации доков, когда они «ощущаются разбросанными», или когда одно и то же недопонимание повторяется. На выходе — таблица с вердиктами и приоритетный список правок.

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

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

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

  • Проверь документацию: после реорганизации запусти verify-docs-findable и покажи, где ответы на канонические вопросы теряются
  • Запусти verify-docs-findable с вопросом «как настроить CI» и отчитайся о шагах от индекса
  • Запусти verify-docs-findable с auto, собери вопросы из недавних недопониманий

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

1Через Skills CLI (Vercel)

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

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

~/.claude/skills/verify-docs-findable/SKILL.md

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

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

Вопросы о verify-docs-findable

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

Выполните npx skills add zernie/vigiles --skill verify-docs-findable -a claude-code. Скилл попадёт в ~/.claude/skills/verify-docs-findable/SKILL.md.

Что делает verify-docs-findable?

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

Почему именно Haiku, а не сильная модель?

Слабая модель без контекста сессии ведёт себя как наивный читатель. Сильная модель с вашим контекстом прочитает исходники и обойдёт пробелы документации, скрыв проблему.

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

SKILL.md · MIT
---
name: verify-docs-findable
description: Audit whether a repo's docs actually ANSWER the questions a reader has — by spawning fresh, cheap (Haiku) agents that cold-read ONLY the docs and measuring how fast they reach the answer, whether they hit dead-ends, whether they fall back to source code, and whether they cite docs that contradict each other. Use after a doc reorg, when docs "feel scattered," or when the same confusion keeps recurring. Surfaces findability gaps (a corpus can be COMPLETE — every doc indexed — yet not FINDABLE) plus a prioritized fix list. Works on any repo's docs, not just this one.
disable-model-invocation: true
argument-hint:
  [optional: a question, or "auto" to derive from recent confusions]
---

# verify-docs-findable — cold-read the docs with fresh eyes

The insight this operationalizes: **complete ≠ findable.** An index that lists every doc
(and even passes a "every doc is indexed" check) can still make a reader take 5 hops and
fall back to source code to answer a basic question. The only honest test is to give the
question to someone who has never seen the repo and watch how far they get **from the docs
alone.** A fresh cheap agent is that someone.

## Why HAIKU, and why "docs only"

- **Haiku (a small, cheap model), fresh (no session context).** The point is a naive cold
  reader, NOT a clever one. A strong model with your context will grep the source, reason
  around gaps, and _hide_ the doc problem. Haiku, told to use only the docs, exposes it.
- **"Use ONLY the docs, start at the index."** The moment a verifier has to open source code
  to answer, the docs have failed — that's the signal. Steps-from-index is the metric.

## Procedure

### 1. Get the questions (3–8)

Test the **recurring, load-bearing, and mis-stated** questions — the ones that actually cost
time. Sources, in order:

- What the user (or you) just got confused about this session — the highest-signal source.
- The "canonical answers" the docs _claim_ to provide (a docs corpus usually has ~5–8 facts
  it exists to convey; test those).
- If none given: ask the user for the questions, or infer them from the corpus's top-level
  topics. Don't invent trivia — test what a real contributor needs.

Phrase each as a **real question a reader would ask**, not a doc title.

### 2. Spawn one fresh Haiku verifier per question (in parallel)

Use the Agent tool with `model: "haiku"`, `run_in_background: true`, one per question. Give
each the SAME strict template (fill in `<QUESTION>`):

> You are a fresh engineer opening `<repo path>` for the first time. Answer using ONLY the
> repo's docs — START at the index (`<the index file(s)>`) and follow pointers; prefer docs
> over reading source code.
> QUESTION: `<QUESTION>`
> REPORT: (a) your answer; (b) the exact file(s) where you found it; (c) how many steps from
> the index (did a pointer take you straight there, or did you dig?); (d) clear/unambiguous
> or scattered/confusing? (e) did you have to read source code because the docs didn't say?
> Be honest — this tests whether the docs make this findable.

Run all in one message so they go concurrently. (Haiku + parallel = the audit is cheap.)

### 3. Score each answer

| Signal                  | Good                 | Gap                                                                     |
| ----------------------- | -------------------- | ----------------------------------------------------------------------- |
| **Correct?**            | matches ground truth | wrong/partial → the doc is wrong or missing                             |
| **Steps from index**    | 1–2                  | 3+ → no signposted pointer                                              |
| **Dead-ends**           | none                 | landed on a wrong-but-plausible doc first → title/scoping is misleading |
| **Needed source code?** | no                   | yes → the docs don't actually state it                                  |
| **Contradictions**      | —                    | cited two docs that disagree → a cohesion bug (fix immediately)         |

Verifiers surface contradictions **for free** — a cold reader citing two docs that say
different things is the cheapest contradiction-finder you have.

### 4. Fix the gaps

- **3+ steps / dead-end** → add a **question→doc pointer** at the index entry point (a
  "Canonical answers: question → the ONE doc" block). Naming the answer is what turns 5 hops
  into 1.
- **Needed source code** → the fact isn't in prose; write it into the one canonical doc.
- **Wrong answer** → the doc is stale/incorrect; fix it (append-don't-erase if it records a
  decision).
- **Contradiction** → reconcile the docs; keep the historical decision, mark it superseded.
- **Scattered across N docs** → consolidate into ONE doc per question; make the others point
  to it.

### 5. Re-verify (measure, don't assume)

Re-run the **worst** question(s) against the fixed docs. Confirm the number moved (e.g.
5 steps → 2). A fix you didn't re-measure is a guess.

## Output

A short findability scorecard (question | correct | steps | needed-source | verdict) + a
prioritized fix list. Report the before/after on any question you fixed and re-verified.

## Notes

- This is orthogonal to "is every doc indexed?" completeness checks — it measures the layer
  above: can a stranger _reach_ the answer. Run it after any doc reorganization.
- Keep the question set in the repo (e.g. a `docs-findability-questions.md`) so the audit is
  repeatable and the canonical answers stay honest as the corpus grows.
- Scales down (1 question, 1 agent, to spot-check one fix) and up (the full canonical set).

© zernie · MIT · zernie/vigiles

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

Всё по теме «Тексты и документация» →
docs-code-sample-standards Samuel Berthe Скилл задаёт правила для примеров кода в документации и проверяет уже опубликованные сниппеты по этим правилам, выдавая очередь правок. CX Codex +1 10 300установок developer-docs-structure-audit Samuel Berthe Проводит инвентаризацию и аудит структуры документации по методологии Diátaxis. Помогает найти пробелы, смешанные страницы и выстроить очередь правок. CX Codex +1 10 200установок audit-verify-explain-grade-5 MengTo Скилл заставляет агента проверить работу по фактам, а потом объяснить результат простыми словами. Пригодится, когда нужно разобрать чужой фикс или отчёт о тестах. CX Codex +1 1 400установок k6-docs grafana Скилл для составления и проверки документации k6, генерации типов TypeScript и подготовки заметок к релизу. CX Codex +1 4 200установок iot-witness-verify ruvnet Проверяет целостность цепочки свидетелей для устройств Cognitum Seed и находит разрывы хешей. Инструмент оценивает сохранность данных и фиксирует пропуски эпох. CX Codex +1 728установок tailwind-4-docs Lombiq Скилл подтягивает локальный снимок документации Tailwind CSS v4 и помогает агенту отвечать по утилитам, конфигу и миграции с v3. CX Codex +1 17 600установок

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

test-harness Скилл помогает протестировать обвязку Claude: хуки, скиллы, агентов, настройки и CLAUDE.md. Выбирает подходящий уровень теста и пишет его. CX Codex +1 2 100установок strengthen Скилл проходит по спекам vigiles и переводит правила guidance() в enforce(), подбирая под них реальные правила линтеров. Пригодится, когда хочется, чтобы договорённости проверялись автоматически. CX Codex +1 2 100установок 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установок code-quality Скилл для рефакторинга TypeScript и JavaScript: приводит типы в порядок, убирает невозможные состояния и разделяет логику с вводом-выводом. CX Codex +1 391установок

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

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