← ClaudeAtlas

docs-structurelisted

Check, build and fill a repository's Markdown documentation from what the repository actually contains. Read-only by default - reports which docs a repo needs (derived from its code, configs and history, not a fixed list), which existing doc covers each concern whatever its file name, and what is unreachable, oversized, dead-linked or cited by line number. On request it lays down skeleton docs for uncovered concerns and drafts them sentence by sentence from repo evidence with the source in brackets, marked for review. Use for docs layout, a docs index, orphaned or oversized docs, splitting a big doc, owner lines, setting up docs for a new repo, or drafting an architecture, deployment, data-model or API doc from the repo. Not for whether existing prose is still true or has missed a code change (use docs-sync-audit) and not for source-code structure (use repo-health-audit).
specialone0007/review-skills · ★ 1 · Data & Documents · score 75
Install: claude install-skill specialone0007/review-skills
# Docs Structure Check the shape of a repository's documentation, build the docs it is missing, and fill them from the repository's own evidence. Three jobs, two modes. **plan** is the default and read-only: run the checker, report. **apply** writes Markdown into the working tree only when the user asks, and stops; the user owns branches, commits and PRs. Nothing here judges whether a sentence a human wrote is true: that is `docs-sync-audit`. ## Core Rules - Stay read-only until the user says "apply". The plan report is the contract: apply never does what the report did not list. - Which docs a repo needs comes from its evidence inventory (`scripts/docs_evidence.py`): a table of concerns, each one earned by something the repo contains or held by every repo. Where each doc lives is fixed by the shape in `references/shape.md`: six buckets by reader intent (getting-started, guides, reference, explanation, plans, history), every doc always in its bucket folder. Fourteen are unconditional - the README, the agent file, setup, onboarding, the daily loop, testing, deployment, operations, contributing, what it is, the architecture, the configuration, the integrations, security - and every other concern has to be earned; an `unknown` ecosystem means fill writes only open questions; every default is overridable in the manifest. There is no compatibility mode: a doc that covers a concern at another path is a move (R15), and apply does the move. - Never delete or reword prose a human w