This post describes an approach to technical writing, inspired by James Bach. Wait, don’t stop reading! It can be applied to any type of expression.
When writing, state your point right away.
If someone reads only the first sentence, they should get something.
Next, expand your point. Those who keep reading will get more details as they delve deeper.
As you’re writing, imagine a dialogue in your head. Ask “Why?” after each sentence.
Why?
You must always consider your reader’s point of view because they don’t know the subject as well as you.
Why not?
You have delved into the depths of the subject. Your reader has not. Too often, technical writing lacks narrative flow and alienates the common reader.
Why care about the common reader?
Writing is meaningless if it isn’t communicated well.
Most technical documents are verbose and poorly written.
Keep to the simple, especially when writing about the technical.
- State your point right away.
- Expand.
- Question each sentence.
Questioning comes naturally to little kids. It’s also a fundamental component of the Socratic Method.
Why argue with little kids and Socrates?
published .
Next Post : Sensemaking
Prev Post : Shit Talk
All Posts