01
It starts by itself
PR changes a document. Runs in GitHub Actions.
- ↻ PR changes a document
pull_request with changed .md files
riekelt · 17K installsReviewing Technical Prose skill
Runs by itself, PR changes a document.
Every doc reviewed before it ships.
Install the Reviewing Technical Prose skill and make it a habit: follow https://gethabit.dev/skills/riekelt/reviewing-technical-prose.md
- 1Copy
- 2Paste into Claude Code, Codex or Cursor
- 3It runs by itself
17K installs31 starsMIT licenceSource on GitHub ↗
Reviewing Technical Prose
by riekelt · 17K installs
The skill
The reviewing technical prose skill is a review pass for technical documents, with a severity scale, a findings format, a list of patterns not to flag and a delivery checklist, for writers and reviewers checking docs before they ship.
Only when you ask.
The habit
Every doc reviewed before it ships.
↻ 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 one pull request and at most 5 documents per run.
- 01
Load background
The agent reads the technical-writing skill with references/style.md and references/truth.md.
- 02
Read it whole
It reviews the full document, never a summary of it.
- 03
Rate findings
Each defect gets BLOCKER, WARNING or OBS.
- 04
Skip false alarms
Patterns on the leave-alone list are only flagged when several signs meet in one paragraph.
- 05
Write the report
The verdict comes first, then each finding with location, proposed fix and confidence.
- 06
Run the checklist
It walks the delivery checklist line by line before the document ships.
What it may do.
Nothing more.
It writes only in its own folder and asks you before anything goes out.
- Writes only inloops/docs-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 Reviewing Technical Prose skill helps.
Use it when
- ✓ Reviewing someone else's technical text
- ✓ Writing a review report on a document
- ✓ Final check before a document ships
Skip it when
- – Reviewing code
- – Reopening decisions already settled
Reviewing Technical Prose skill, answered.
Does it review code?
No. It reviews only the prose, including prose inside code comments or docs.
Will it rewrite my text?
Only for a named defect, and the content stays the same. Unattended in a repository, the commit is the proposal.
What if there is nothing to fix?
The report says FINDINGS: none and still notes what is good.
How do I install the Reviewing Technical Prose 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 reviewing-technical-prose.
Is the Reviewing Technical Prose skill free?
Yes. It is published under MIT. Habit is free too.
Reviewing Technical Prose. Now as a habit.
Install the Reviewing Technical Prose skill and make it a habit: follow https://gethabit.dev/skills/riekelt/reviewing-technical-prose.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?