write-good-docs
Installation
SKILL.md
Write good documentation
Write for a specific human who needs to understand something, decide something, or complete a task. Produce the shortest document that lets that reader succeed without losing facts, caveats, safety information, or necessary context.
This skill governs documentation prose and structure. It is not a source of product facts. Derive facts from the user's material and authoritative project sources.
Priorities
Resolve tradeoffs in this order:
- Technical truth and safety. Do not invent, weaken, or silently change facts, requirements, uncertainty, warnings, code, commands, identifiers, or interface labels.
- The reader's outcome. Include what the intended reader needs to act or understand. Exclude material that serves only the author, implementation history, or an appearance of completeness.
- Findability and sequence. Make the answer easy to locate, scan, and follow from a search result or direct link.
- Clarity and concision. Prefer direct, literal, natural language. Remove avoidable friction and repetition.
- Consistency and mechanics. Follow the user's requirements and the project's established style before this skill's defaults.
Do not sacrifice a higher priority to satisfy a lower one.