technical-writing

Installation
SKILL.md

Technical Writing

Prose that ships — docs, RFCs, readmes, PR descriptions, commit messages — follows one standard so readers can navigate any of them the same way.

The standard

  1. Outcome first. The first sentence says what changed for whom and what the reader can now do. Context comes after the reader knows why they care.
  2. One meaning, one home. Each fact lives in exactly one place; every other mention links there. Duplicated facts rot at different speeds.
  3. Checkable statements. Prefer a statement the reader can verify with a command or a glance over an adjective. "Builds in ~40s" beats "fast".
  4. Layered structure. Summary, then detail, then edge cases — each layer readable alone, each deeper layer skippable.
  5. No filler. No restating the obvious, no throat-clearing, no AI tells (ai-slop-cleaner territory; this skill composes with it).
Installs
34
GitHub Stars
40.9K
First Seen
10 days ago