01
It starts by itself
PR changes a document. Runs in GitHub Actions or Claude Code routine.
- ↻ PR changes a document
pull_request paths: **/*.md
riekelt · 18K installsTechnical Writing skill
Runs by itself, PR changes a document.
Docs stay sourced, current and plain.
Install the Technical Writing skill and make it a habit: follow https://gethabit.dev/skills/riekelt/technical-writing.md
- 1Copy
- 2Paste into Claude Code, Codex or Cursor
- 3It runs by itself
18K installs31 starsMIT licenceSource on GitHub ↗
Technical Writing
by riekelt · 18K installs
The skill
The technical writing skill gives your agent a house style for specs, design docs, READMEs, reference docs and reports: conclusion first, every claim sourced, one fact in one place and a list of banned constructions.
Only when you ask.
The habit
Docs stay sourced, current and plain.
↻ Runs by itselfPR changes a document
How the habit works.
You don't have to.
When does it start? How does it check its work? What does it remember?
One run, step by step.
Then it stops.
Stops after 5 documents per run and 1 retry each.
- 01
Read first
Your agent reads up to two comparable documents and checks whether the topic already has an owner.
- 02
Classify
It sorts the document as normative, descriptive, historical, runbook or reference and applies that edit rule.
- 03
Fill the checkpoint
It notes kind, audience, purpose and non-goals in working notes.
- 04
Load the type skill
It adds the matching sibling skill, such as writing-runbooks or writing-design-docs.
- 05
Ground claims
It traces each claim to code, a test or a source, or names the gap.
- 06
Check hard rules
It removes dashes, history narrative and Title Case headings.
- 07
Final review
It runs reviewing-technical-prose and follows every reference before delivery.
What it may do.
Nothing more.
It writes only in its own folder and asks you before anything goes out.
- Writes only indocs/**, **/README.md, loops/technical-doc-review-loop/**
- Talks tono outside service
- Sendsnothing
- Your OKNothing goes out, so it needs no OK.
Is it for you?
Use it when it fits.
Read both lists. If the left one sounds like you, the Technical Writing skill helps.
Use it when
- ✓ You write a spec or design doc
- ✓ You update docs to match code
- ✓ You review a README before merge
Skip it when
- – Marketing copy or social posts
- – UI microcopy
Technical Writing skill, answered.
Will it rewrite history in old specs?
No. Historical documents are never rewritten. The loop flags the gap and adds a new entry instead.
Will it restyle my voice?
If the author asks to keep their voice, the style pass stops. Truth and sourcing rules still apply.
How do I install the Technical Writing skill?
Copy the prompt at the top into your agent. It installs the skill from riekelt/technical-writer and sets up the habit. Or run npx skills add riekelt/technical-writer --skill technical-writing.
Is the Technical Writing skill free?
Yes. It is published under MIT. Habit is free too.
Technical Writing. Now as a habit.
Install the Technical Writing skill and make it a habit: follow https://gethabit.dev/skills/riekelt/technical-writing.md
All riekelt skills →More docs skills →
Works in
- Claude Code
- Codex
- Cursor
- ChatGPT
- Claude app
Made by riekelt, published under MIT. Habit links to the original and never changes it. Is this your skill?