NeuroDynamic.Tech
Sign inJoin
Toolsillustrative example

Documentation was my 'weakness'. Now my templates are the team standard

I couldn't write runbooks the way the team wanted, so I rebuilt the way runbooks work: diagrams first, numbered steps, one action per line. Then everyone started using mine.

An infrastructure team lead · · 2 min read, or listen below

Background

Dyslexic, fifteen years in infrastructure, promoted to team lead three years ago. The promotion terrified me for one reason: leads own the documentation standard, and documentation had been the red pen on every review I'd ever had.

The challenge

Our runbooks were dense prose - paragraphs describing what to click and type, written by people who find paragraphs easy. Following them during a 2am incident was miserable for everyone, but for me it was near-impossible: eyes skipping lines, re-reading the same sentence while a production system burned.

The accommodations you build for yourself are usually just good engineering hygiene nobody bothered to do.

What helped

I stopped trying to write like the old runbooks and made the format fit how I actually think:

  1. A diagram at the top. One picture of the system before any words.
  2. Numbered steps, one action each. Never 'configure the interface and verify connectivity' - that's two steps.
  3. Commands in code blocks, always. Copy-paste beats transcription for everybody, not just me.
  4. A 'you are done when…' line so there's no ambiguity about success.

I wrote mine this way quietly. During the next major incident the on-call engineer - not dyslexic - used my template and said it was the first runbook he'd ever followed without swearing. It became the team standard within a year.

Advice for others

The accommodations you build for yourself are usually just good engineering hygiene that nobody bothered to do. Don't pitch them as accessibility - pitch them as incident-response quality. Then let them make everyone faster, and take the credit you're owed.


Sound familiar?

The forum has a room for exactly this conversation: swap tactics, ask the question you can’t ask at work, or just say “same”.