"We Wrote It Down" Isn't the Same as "Someone Can Follow It"
Documentation & Runbooks
Chapter 1 · "We Wrote It Down" Isn't the Same as "Someone Can Follow It"
Every course in this subject so far has assumed good documentation already exists somewhere to consult — a ladder to follow, a procedure to reference, a runbook to reach for. This course exists because that assumption is often false, and because writing something down is only the first of two very different achievements. `backup1` spent an entire course establishing that "we have backups" isn't the same claim as "we can recover." This course makes the identical argument about documentation: "we wrote it down" isn't the same claim as "someone under pressure, unfamiliar with the system, can actually follow it and succeed."
What Every Prior Chapter in This Subject Quietly Assumed
Each Technical Support course so far has assumed a piece of documentation exists somewhere, ready to be used. This course exists because writing that documentation, and making it actually work, is a real skill nobody else in this subject has taught:
| Course | What it quietly assumes |
|---|---|
| log1 | Logs exist and are trustworthy — not that anyone wrote down how to interpret them |
| netdiag1 / perfdiag1 / appdiag1 | A diagnostic ladder exists in the reader's head — not that it's captured anywhere for the next person |
| incident1 | A ticket captures what happened for this incident — a one-off record, not reusable knowledge |
| remote1 | You know how to reach a system — not that anyone wrote the procedure down for a new hire to follow safely |
| secsupport1 | You can recognize an attack — not that the actual response procedure is documented anywhere |
| backup1 | A restore procedure exists to follow — and, per its own core lesson, existing isn't the same as working |
This course is specifically about producing the thing every other course assumes is already sitting there, ready and correct, when it's actually needed.
Not a Sysadmin-Architecture Course
This course isn't about designing systems or deciding what tooling an organization should use — that's a separate discipline. It's about capturing and communicating knowledge about systems that already exist, so the next person who needs that knowledge doesn't have to rediscover it under pressure.
The Central Claim of This Whole Course
"We wrote it down" confirms only that words exist in a document somewhere. It confirms nothing about whether those words are complete, accurate, still current, or genuinely followable by someone who isn't already the expert who wrote them. Those are different claims, and — exactly as `backup1` argued for backups — only one of them is actually proven by someone genuinely unfamiliar with the system successfully following the document, under real conditions.
What This Course Actually Covers
- Choosing and structuring the right document (Chapters 2–4) — KB article vs. runbook vs. ticket, writing for a reader under pressure, and a runbook's own proper shape
- Capturing and protecting knowledge (Chapters 5–6) — getting tribal knowledge out of people's heads before it's lost, and doing so without creating a security liability
- Keeping documentation actually trustworthy (Chapters 7–8) — fighting silent decay over time, and testing a runbook the way `backup1` tests a backup
- Making it usable (Chapter 9) — organizing documentation so the right person can actually find it when they need it
An Outage That Isn't Resolved Yet
An on-call technician, alone during a real outage at 3am, pulls up an existing runbook for restarting a specific service and follows it step by step. It fails partway through — step 4 references a server hostname that was decommissioned eight months ago during a migration nobody updated the runbook for. The outage takes twice as long to resolve as it should have. Nothing about this is resolved in this chapter — it's deliberately left open. Chapter 8 comes back to it directly, once the material on testing a runbook has actually been covered.
Hands-On Exercises
Explain the parallel this chapter draws between its own central claim and `backup1`'s central claim, and why the same underlying logic applies to both documentation and backups.
📄 View solutionUsing the comparison table, identify the shared assumption across the other seven Technical Support courses this new course exists to question, and explain why it can't always be trusted.
📄 View solutionExplain why the 3am outage scenario is left deliberately unresolved in this chapter, and name the specific chapter that returns to it.
📄 View solutionChapter 1 Quick Reference
- This course covers producing documentation, not consuming documentation someone else already wrote
- Core claim: writing something down proves it exists, not that it's accurate, current, or followable under pressure
- Four areas ahead: choosing/structuring documents, capturing knowledge safely, keeping documentation current, making it findable
- Core idea: only someone genuinely unfamiliar successfully following a document proves it actually works — the same test-restore logic `backup1` applied to backups
- Next: Chapter 2, KB articles, runbooks, and tickets as three genuinely different documents