verify-docs-findable

Solid

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.

AI & Automation 13 stars 1 forks Updated today MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
38
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# 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. Phras...

Details

Author
zernie
Repository
zernie/vigiles
Created
4 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

check-docs-consistency

Cross-reference project docs for drift, stale references, and contradictions. Outputs timestamped report. Discovers Markdown wherever it lives in the repo.

2 Updated yesterday
RockyHong
AI & Automation Solid

repo-wayfinder

Wayfind repository documentation by tracing real tasks to code-owned authority. Use when the user wants to audit scattered, stale, duplicated, or mixed-role docs; decide whether README, AGENTS.md, architecture, runbook, or protocol documents should exist and where they belong; or apply an accepted documentation-topology repair.

2 Updated today
Wang-Cankun
Data & Documents Listed

factcheck

Adversarial citation and claim audit for any document — "do these sources actually say what the text claims?" Takes a markdown file, URL, or pasted draft (including this repo's own pulse/verdict briefs), extracts every checkable claim, then fans out verifier sub-agents instructed to refute, not confirm: does the cited link resolve AND assert the claim as stated, is the source primary or a laundered secondary write-up, has the claim gone stale. Emits a graded audit table — VERIFIED / MISATTRIBUTED / UNSUPPORTED / STALE / UNCHECKABLE — with a quoted passage as evidence for every grade, saved to out/factcheck/. Advisory: it grades, the human edits. Use when the user wants to check citations, verify sources, or audit a report, post, or brief — e.g. "/factcheck <doc>", "verify the sources in this", "are these citations real?", "is this actually true?". For researching a fresh topic use pulse; for judging code changes use done.

7 Updated yesterday
duthaho