How SREs Should Document How-To for technical things

Failure is inevitable when you run before walking before crawling.

Most SREs hardly document. Others want to go from zero to 100. This is not possible because

  1. With unknowns sequence of tasks is incorrect.
  2. Edge cases will trip you.

Four Steps To Ensure You Document Everything

1: Crawl

Always start with a crawl for anything new. You will need to search before knowing how to proceed during a crawl.

2: Walk

It becomes a walkthrough when you crawl a few times and feel confident that you captured everything required to complete the task.

3: Run

Any task for which 5–10 times walkthrough has been completed can be considered for automation. Once automated, you can run it instead of walking it.

4: Host the docs

Documentation should get hosted on a site as soon as you commit it. No fuss hosting removes the friction usually associated with technical documentation.



Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store