Tutorial
Technical Communication

What writing clear documentation really is

The 4-minute mental model behind Writing clear documentation.

The idea in one line

On the surface, Writing clear documentation can look like a single technique you either know or you don't.

Why it's worth your time

A solution no one understands can't be bought, used, or trusted.

How to recognise it in the wild

1. Spot the moment. Notice when *writing clear documentation* is the move the situation is asking for — usually when it's tempting to skip it. 2. Name the goal. Say, in one sentence, what a good outcome looks like here. 3. See the core move. The heart of Writing clear documentation is simple: write a doc someone can act on alone. 4. Know you're done. You've got it when this stops feeling like a technique and starts feeling like instinct.

What "good" looks like

  • You explain the tradeoff, not just the answer.
  • You match the depth to your audience.
  • People leave the conversation clearer than they arrived.
Next: try the step-by-step tutorial to actually run the rep.