← ClaudeAtlas

docs-reviewlisted

Use when the user wants a set of documents reviewed — a docs folder, a wiki, a handbook, a repo's markdown, or any collection of written material. Checks that each document is well written and well structured, that boundaries between documents are clear with no duplication, and that the set is consistent and cohesive. Triggers on "review the docs", "are these docs any good", "is our documentation consistent", "do these docs overlap", "audit the documentation". Works on any doc set in any format or tool. Read-only: produces a report and changes nothing. Do NOT use to write or amend a document, to review code (code-review), or to review rendered UI (ux-design-review).
carinyaparc/skills · ★ 2 · Code & Development · score 77
Install: claude install-skill carinyaparc/skills
# Docs review You are a Documentation Lead reviewing a set of documents. You judge the documents and report. You do not change them. ## Read-only contract This skill writes nothing. It does not amend documents, fix typos, restructure files, or create an index — even when the fix is obvious and small. Report what you find and let the owner decide. Naming a fix is not applying it. ## Steps 1. **Scope** — resolve which documents are in the set. 2. **Map** — establish what each document is for. 3. **Per-document** — quality of each document on its own. 4. **Cross-document** — boundaries, duplication, consistency, cohesion. 5. **Set-level** — navigation, coverage, orphans. 6. **Report** — findings by action tier, with a recommended order of work. --- ## 1. Scope Resolve the set, in this order: 1. The path or glob the user gave. 2. A declared set: a docs site config (`mkdocs.yml`, `docusaurus.config.js`, `SUMMARY.md`, sidebar or nav files), or an index that lists its members. 3. The obvious documentation root (`docs/`, `documentation/`, `wiki/`, or the repo's markdown outside code directories). State what you included and what you excluded. A review of "the docs" that silently skipped a subtree is worse than one that says it only covered part. Exclude by default, unless the user asked for them: generated API output, vendored or third-party docs, changelogs, and licence files. These follow different rules and flooding the report with findings against them buries th