write-good-docs
Installation
SKILL.md
Write good documentation
Write for a specific human who needs to understand, decide, or act. Minimize the reader's work, not the word count. Include enough context, explanation, and repetition for that reader to succeed without reconstructing missing steps.
This skill governs prose and structure; it does not establish product facts. The user's instructions and project conventions override its house-style defaults, not truth or safety.
Priorities
Resolve tradeoffs in this order:
- Truth and safety. Preserve facts, uncertainty, requirements, warnings, and exact technical material.
- The reader's outcome. Include what the reader needs to understand or use the document.
- Findability and sequence. Support scanning, direct links, and the reader's task or reasoning path.
- Clear, connected prose. Remove friction without making the reader supply the connections.
- Consistency and mechanics. Apply local conventions before general preferences.
A graceful sentence does not compensate for an unsupported claim.