technical-writing

Writes and edits documentation prose using plain-language rules and an AI-tics checklist.

1|Updated Sep 10, 2026
One-click install
npx skills add https://github.com/blauwtje/exo --skill technical-writing-blauwtje
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/blauwtje/exo/tree/main/skills/technical-writing
Command: npx skills add https://github.com/blauwtje/exo --skill technical-writing-blauwtje

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Prose written for readers outside the session often sounds finished but says little: benefits instead of facts, passive verbs hiding the actor, and machine-written patterns that make readers dismiss the text. This Skill rewrites READMEs, PR bodies, changelogs, and specs into factual, plain-worded documents. ## Core Features & Use Cases - Fact-over-benefit rewriting: Replaces vague claims like "more robust" with the number, behavior, or error that actually changed. - AI-tics checklist: Scans every draft against references/ai-tics.md, a catalog of over 40 machine-writing patterns (stock vocabulary, em dashes, hedging, chat artifacts) with before/after fixes. - Documentation mode selection: Picks one mode per document (tutorial, how-to, reference, or explanation) so a Usage section opens on the command, not a welcome. - Use Case: You finish a pull request and the body reads as generated. Run this Skill to rewrite it with named actors, real file and flag names, and whole sentences under 25 words. ## Quick Start Use the technical-writing skill to rewrite this PR description so it states the facts and passes the AI-tics scan.

Frequently Asked Questions about technical-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I make AI-generated documentation sound less machine-written?▼

Scan the draft against a checklist of AI writing tics: stock vocabulary like "delve" and "seamless", trailing "-ing" benefit phrases, em dashes, and stacked hedges. Rewrite each hit with the concrete fact, number, or mechanism, keeping the original meaning.

How to write a good pull request description?▼

State what changed with the actor and mechanism named, such as which file reads which option, and include the proof like a test result or issue number. Cut welcomes, sign-offs, and benefit claims that the text cannot back with a fact.

What is the difference between tutorial, how-to, reference, and explanation docs?▼

A tutorial teaches by doing, a how-to completes a known task, a reference lists what exists, and an explanation says why. Each document should pick one mode; a Usage section is a how-to or reference, so it opens on the command rather than a welcome.

When should I not use this writing skill?▼

Do not use it for chat replies, code comments, or product interface strings, which follow their own style rules. It also does not set the structure of PRs, issues, commits, or briefs; it only words the text inside fields other skills define.

Does plain-language rewriting mean dropping articles and verbs?▼

No. Over-compressed telegraphic text forces the reader to decode it. Keep articles and verbs, write whole sentences with one thought each, and split sentences past 25 words; clarity outranks brevity.