Writing Way¶
Source: hooks/ways/writing/writing.md
Frontmatter
| Field | Value |
|---|---|
description |
writing and editing prose for people — a report, proposal, memo, status or progress update, presentation, or announcement, and the conventions each genre follows |
vocabulary |
write writing draft compose write up proposal report presentation deck slides memo status update progress update announcement outline revise edit rewrite polish tone audience prose style genre |
refire |
0.15 |
macro |
append |
scope |
agent |
requires |
['Bash(grep:*)'] |
Scope¶
General content creation — proposals, reports, presentations, memos, briefs. For code documentation (README, docstrings, API docs), see the Docs Way.
Before Writing¶
- Audience — who reads this and what do they need to walk away with?
- Format — match the medium to the message. A slide deck argues differently than a report.
- Core message — every document has one. Find it before outlining.
- Style — ask the user about voice, tone, and register. Don't assume.
Structure¶
Outline before drafting. Defend the structure to the user.
| Content type | Structure |
|---|---|
| Proposal / pitch | Problem → solution → evidence → ask |
| Technical report | Summary → findings → analysis → recommendations |
| Status update | Progress → blockers → next steps |
| Presentation | Hook → tension → resolution → takeaway |
| Decision doc | Context → options → recommendation → consequences |
Genre¶
Where a genre's needs and a general style rule disagree, the genre wins.
| Genre | Prioritize | Avoid |
|---|---|---|
| Technical doc | task success, exact terms, prerequisites, observable behavior, examples, failure modes, recovery | flourish in a procedure; varying a canonical term for style; softening mandatory wording |
| ADR | problem, constraints, alternatives considered, decision, trade-offs, interfaces, migration, verification | dressing a preference as an inevitability; blurring "we chose" with "the system requires" |
| Brief for an agent | the task, the done criteria, the bounds, what to read first, the shape of the report back | pasting context the agent can read from disk; leaving done undefined |
| Proposal | problem, proposed change, rationale, scope, cost where known, trade-offs, risks, success criteria | overselling; omitting limitations |
| Status update | what changed, what is blocked and by whom, the next action, all early | scene-setting the reader already has; a list of next steps with no owner |
Prose Style¶
Write prose, not bullet points wearing a trenchcoat. Let ideas develop across sentences. Vary sentence length and rhythm — short sentences create urgency, longer ones let complex ideas breathe.
Defaults (override per user preference): - Prefer active voice. Use passive only when the actor is irrelevant or unknown. - Avoid staccato sentence fragments for rhetorical impact. Let the substance carry the weight. - Lead with the conclusion when the audience is busy. Lead with context when the audience needs persuading. - Cut filler on revision. "In order to" → "To". "It should be noted that" → delete. - Name the real term, then gloss it. For domain vocabulary, give the precise term and a plain-language gloss on first use — neither a jargon wall nor analogy-mush. Analogies illustrate; they don't carry the argument.
Ask the user about style preferences early. Use literary terms when discussing: register (formal/informal), diction (word choice), syntax (sentence structure), cadence (rhythm), tone (attitude toward subject). These terms are precise and help the user articulate what they want.
Avoid: - Corporate filler — hollow superlatives, engagement bait, breathless enthusiasm disconnected from substance. - Constructivism framing — "it's not X, it's Y" patterns that define by negation. Say what it is. - Adjective stacking. One precise adjective beats three vague ones.
Revision¶
Revise in passes, not all at once: 1. Structure — is the argument in the right order? 2. Clarity — can each sentence be misread? Fix ambiguity. 3. Tone — does it match the audience and purpose? 4. Concision — what can be cut without losing meaning?
Pushback¶
If the format doesn't fit the content (a slide deck for something that needs a detailed report), push back. Explain why format matters and suggest an alternative. Preserve the user's intent — they want to communicate something, the format is negotiable.
See Also¶
- documentation(documentation) — code documentation is a specialized form of writing
- trust/prose(meta) — decoration and self-explanation in your own prose
- trust/voice(meta) — voice and tone in written communication