documentation-standardslisted

Use whenever writing, reviewing, or restructuring a Markdown document in this knowledge base: choosing YAML front matter fields, a document type (STD, GUIDE, ADR, COMPETENCY, and so on), or a lifecycle status (Idea through Archived); naming a new file; deciding whether a design or feature doc needs a Mermaid sequenceDiagram or stateDiagram-v2 block and what that diagram must show; formatting cross-references, reference-style links, or anchors; writing or reviewing a table; or resolving which document canonically owns a topic. This is the cross-cutting documentation-formatting authority every stage skill (Design, Documentation, Implementation, and others) defers to for these rules rather than restating them — it is not itself a stage and does not gather requirements or write code.
BhangeeF16/kaizen · ★ 0 · Data & Documents · score 67

Install: claude install-skill BhangeeF16/kaizen

# Documentation Standards This is a meta-skill: a rule that applies across every stage rather than belonging to one. Whenever any stage skill in this plugin produces or reviews a Markdown document — a design doc, a plan, an ADR, a README, a competency file — the formatting, metadata, diagram, linking, and table rules below govern it, read live from this plugin's own `skills/documentation-standards/documentation-standard.md` every time this skill runs. There is no separate paraphrased copy anywhere, so this content cannot silently drift the way a hand-maintained summary could. ## Documentation standard (live) !`cat "${CLAUDE_PLUGIN_ROOT}/skills/documentation-standards/documentation-standard.md"` ## Instructions 1. Apply the Required Metadata front-matter shape to every active Markdown document you write or edit — `id`, `title`, `type`, `status`, `owner`, `priority`, `tags`, `depends_on`, `related`, `last_updated` — using only an Approved Document Type and an Approved Lifecycle Status from the lists above. Machine-readable YAML manifests are the one named exception; they do not use this envelope. 2. Before adding a Mermaid `sequenceDiagram`, check the Mermaid Sequence Diagram Rules' required-cases list (cross-capability workflows, broker/event flows, orchestration/state transitions, auth/token flows, external-provider integrations, multi-service async user actions) — if the design matches one of these and has no sequence diagram, treat the design as incomplete unless you r