technical-writing

Installation
SKILL.md

Technical writing

Use for repository documentation, including READMEs, guides, references, flow docs, specifications, and technical PR descriptions. Read the applicable AGENTS.md first; it owns documentation destinations, length limits, and repository terminology. This skill needs no global tools or skill installation.

Establish the reader and evidence

  1. Identify the reader, intended action or decision, page scope, and source of truth. Read current code, schemas, tests, command output, and the relevant diff.
  2. Choose the requested mode: create from evidence, edit while preserving useful facts and the author's intent, or review with findings before proposed fixes.
  3. Lead with what the reader can accomplish and one recommended path. Mention implementation first when explaining architecture or internals is the task.
  4. Verify claims, examples, defaults, paths, and failure behavior. Label material uncertainty and name the missing evidence; polished prose is not verification.
  5. Before handing off any writing, complete the required plain-language pass.
Installs
2
GitHub Stars
392
First Seen
7 days ago