doc-standards
Installation
SKILL.md
Applying the documentation standard
The documentation rules live in the repository's documentation standard (typically docs/AGENTS.md). This workflow covers placement, corpus audits, budgets, and validation across Markdown, JSDoc, and code comments. It is guidance, not a script; use prose-standard for required coverage and editorial judgment, and never treat length alone as a defect.
Sources of truth (read, don't re-summarize)
- The repository's documentation standard — hierarchy, tutorial/reference forms, taxonomy, budgets, and slop checklist.
- The repository's Agent Note rules — when a decision earns an Agent Note, how to file it, and what goes inside one (the header block, per-lifecycle skeleton, and alternatives-considered mandate, gated by the repository's note-format gate); the repository's postmortem rules, when present — when an incident earns a postmortem.
- The repository's bilingual pairing contract — editing either side of a pair obligates the counterpart in the same change.
- The root
AGENTS.md— the standing orders whose budget discipline this skill protects. - Frozen archived Agent Notes — historical snapshots excluded from editorial maintenance and evolving documentation gates.
Review structure before prose
Apply the standard's authoring order to every human-facing document in scope. Do not apply this structural pass to Agent Notes. Classify a postmortem as a reference scoped to one incident; preserve its required chronological evidence without treating chronology as a teaching sequence.