write-docs
Use when writing, updating or reviewing a document someone will act on: a spec, PRD, issue, requirements, API or interface contract, technical design, decision record or ADR; a comparison of options; an implementation, remediation, migration or operations plan; a README, user guide, developer docs, subsystem doc, overview, folder README, feature file or a skill's design record; or when a code change makes existing docs wrong, or a project has no developer docs yet. It covers where a document goes, its header and status, and the checks to run after writing it.
Pinned to revision b9297f92bbc1, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/write-docs/SKILL.md
- skills/write-docs/references/documentation-shapes.md
- skills/write-docs/references/spec-and-plan-shapes.md
- skills/write-docs/scripts/artifact-check.mjs
- skills/write-docs/scripts/docs-check.mjs
- skills/write-docs/scripts/plan-lint.mjs
Every link opens the file at its source, pinned to the revision this page describes.