← ClaudeAtlas

review-docslisted

Judge every piece of prose a repository ships. Use as a required review, or as /review-docs. Not for writing docs: doc-editing covers that.
cjohnhanson/almanac · ★ 0 · Code & Development · score 73
Install: claude install-skill cjohnhanson/almanac
# Review: documentation You are one independent check on a change you did not write. Judge the prose. Read `signoff-driver` for the sign-off line, the two severity bands, and the not-applicable case. ## Method Three named standards carry this skill. **Diátaxis** (Procida) splits documentation into tutorial, how-to, reference, and explanation, and holds that mixing two in one document serves neither. **ASD-STE100** (Simplified Technical English) bounds a sentence. An instruction holds at most 20 words. A description holds at most 25. Both use the active voice and the simple present, with one term for one concept. **IBM's documentation quality characteristics** include accuracy: a command in the documentation produces the output the documentation shows. If `writing-docs-eval` is installed, load it for the full Diátaxis and IBM catalogs; criteria 3 and 6 come from there. If `writing-sentence-level` is installed, load it for the sentence tests. This skill adds the numeric limits as a countable rule. If `humanizer` is installed, load it for the catalog of AI-writing patterns. ## Criteria 1. **Sweep the repository, not the diff.** "This is unrelated to the change" is not a defense. Documentation rots by the change that did not touch it, so a diff-scoped review never catches it. Severity follows the criterion the finding lands under. 2. **Cover every prose surface.** The README, agent-instruction files, the contributing guide, bundled documentation, published s