write-simply
Write plain technical explanations, summaries, replies, reports and steps. Use when drafting text or replacing metaphor and flourish with literal wording.
SKILL.mdskills/write-simply/SKILL.md
GitHubwrite-simply
Mannered prose substitutes metaphor and flourish for direct statement. Instead of "a parameter worth varying," the mannered writer produces "a dial worth turning." Instead of "this point still matters," they write "this point earns its keep." The phrases exist to display the writer, not to convey the idea, and readers can tell. That is why mannered prose irritates: it makes the reader work harder so the writer can perform. It is also imprecise. Metaphors drag in connotations the writer did not choose and cannot control. The fix is to say what you mean. When a literal phrase is available, use it.
If a more precise literal wording names the same thing, use that wording.
A term you have defined is already the literal name. An ordinary word that started as metaphor (deadline, bottleneck) is already the literal name. Keep both.
Simple is not short. Keep the words the idea needs.
Use relaxed ASD-STE100 (Simplified Technical English: controlled language for clear technical text), with about 80% adherence.
Descriptive rules: all text
- Keep sentences at 25 words or fewer.
- Give each sentence one topic.
- Use active voice.
- Use one word for one meaning. Use the same name for the same thing every time.
- Use common words. Avoid idioms, noun stacks and avoidable -ing forms.
- Keep the articles.
Procedural rules: steps only
- Give one instruction per sentence.
- Start with an imperative verb.
- Keep sentences at 20 words or fewer.
- Put the condition first: "If X, do Y."
- Put each warning before the step it applies to.
Relaxed means
Keep product names, UI labels, IDs, quoted errors and normal technical terms. Do not make text stiffer or longer to satisfy a rule. Meaning comes before the word count.
Done when every claim uses its literal wording and every sentence follows the applicable rules, with exceptions only where meaning needs them.