Table of contents
Essay
1 min read
Writing for Operators
Documentation reads better when it helps the next person act, not just admire the architecture.
The best technical writing shortens the distance between confusion and the next correct action.
Lead with the question
People usually open documentation because something is unclear, slow, or failing.
Keep commands close to context
Readers should not need to scroll through theory to find the next useful step.
Prefer repair over ceremony
The right note at the right moment is worth more than a beautifully structured document nobody uses.