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:

  1. Technical truth and safety. Do not invent, weaken, or silently change facts, requirements, uncertainty, warnings, code, commands, identifiers, or interface labels.
  2. 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.
  3. Findability and sequence. Make the answer easy to locate, scan, and follow from a search result or direct link.
  4. Clarity and concision. Prefer direct, literal, natural language. Remove avoidable friction and repetition.
  5. 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.

Before writing

Installs
2
GitHub Stars
3
First Seen
5 days ago
write-good-docs — tristanmanchester/agent-skills