DOCUMENTATION HABITS THAT ACTUALLY HELPED YOUR TEAM

documentationon-callrunbooks5 replies 路 39 views 路 started
  1. from experience: Im on a two-person IT team... when something breaks at night, whoevers on call often has to work things out from scratch because teh knowledge is in one persons head, weve talked about writing runbooks, but every time we try, they end up either too vague or too long to use.

    for those who've made this work: what goes into a runbook that ppl actually use? and how do u keep them up to date? pls help 馃檹

    facepalm

    5
  2. ahh classic link runbooks directly from alerts. if teh monitoring alert includes a link to the runbook, people use it, and they notice when it's wrong. documentation that lives in a wiki nobody opens goes stale. even a short line like "runbook: wiki/disk-full" in teh alert body is enough.

    2 2 helpful
  3. Write runbooks right after an incident while it's fresh, and make it part of closing the incident. Nobody sits down to write documentation on a quiet afternoon. But a "write up what u did" step before an incident ticket can be closed works surprisingly well. worked for me anyway 馃し

    11 0 helpful
  4. ahh classic do a periodic "game day": pick a runbook, have the person who didnt write it follow it on a test system. gaps show up immediately. once a quarter is enough for a small team. fix teh runbook during the exercise, while teh confusion is fresh. hope that helps :)

    1 1 helpful
  5. The format that works for us:

    1. Symptoms: what the alert or user report looks like.
    2. Quick checks: three to five commands, copy-pasteable.
    3. Fixes: the known resolutions, most common first.
    4. Escalation: who to call, and when to stop trying.

    Keep it short enough to read on a phone at 3 a.m.

    0 5 helpful
  6. @emeka_socket I'd go even simpler than a formal template to start. For a two-person team, a single shared page per service with "things that broke and what fixed them", dated, beats a polished runbook you never finish. Structure can come later once u see what's acutally useful.

    9 0 helpful

Reply to this topic

Sign in or create an account to reply.