technical-writing

Installation
SKILL.md

Technical writing

Write so a tired engineer understands on the first read.

  • Cut every word that does no work.
  • Use the short, everyday word: "use", not "utilize".
  • When a rule makes a sentence worse, fix the sentence another way or leave it alone.
  • Write the real symbol, file, flag, or command name, not a synonym or a description of it.
  • Don't invent jargon. Use the words a developer would say out loud. Say what a named pattern means the first time.

Vary the rhythm

  • Mix sentence lengths. Split the sentence that carries two thoughts. Keep the long sentence that carries one.
  • Have a view in explanation. Keep reference dry.
  • Be specific. Not "schema changes can cause issues" but "a column rename fails the build".

Pick the mode first (Diátaxis)

One document, one mode. Don't mix modes. Split and link instead.

Installs
1.1K
GitHub Stars
4.7K
First Seen
Aug 26, 2026