← ClaudeAtlas

docs-standardslisted

Fabrizio's documentation conventions for a repository's docs/ tree. Consult this whenever writing or maintaining docs in one of his repos — adding or changing an ADR, plan, runbook, or reference doc; updating a README index; recording an architectural decision; retiring a completed plan; or scanning for stale docs at session end. Covers the Diátaxis directory split (decisions, plans, runbooks, reference), the Nygard ADR format, the ephemeral two-PR plan lifecycle, keeping every README index current in the same commit, the agent-directed and verify callouts, semantic line breaks, and a session-end doc-maintenance checklist. Complements the repo's own CLAUDE.md rather than overriding it.
flungo/claude-plugins · ★ 0 · AI & Automation · score 60
Install: claude install-skill flungo/claude-plugins
# Documentation Standards Fabrizio's standing conventions for how a repository's `docs/` tree is organised and maintained. Documentation is a first-class deliverable — stale docs are actively harmful, because they mislead future sessions into re-deriving settled decisions or acting on wrong assumptions. Apply these any time you write or touch documentation in one of his repos, whether or not a named command was invoked. **These conventions complement repo/context rules, they never supersede them.** Always check for a `CLAUDE.md`, `CONTRIBUTING.md`, or similar guidance in the repo first; where the repo specifies something different, follow the repo. These conventions only fill the gaps the repo doesn't cover. ## The reference files Read the relevant reference before doing the work — each is the authoritative detail for its area: - **`references/documentation-model.md`** — the core model: the Diátaxis directory split (`decisions/`, `plans/`, `runbooks/`, `reference/`), what belongs in each, keeping every `README.md` index current in the same commit, the ephemeral two-PR plan lifecycle, the end-of-session staleness scan, the two callout devices, and semantic line breaks. Read it before adding or moving any doc, or at session end. - **`references/adr-template.md`** — the canonical Nygard ADR format (the exact heading shape, the `Date` and `Status` metadata, the `Context` / `Decision` / `Consequences` sections), sequential numbering, and supersession. Read it