📝 AI-Assisted Documentation

Three pages. Turning what's in your head into something the next person can follow.

🎯 What This Series Is

Documentation is the task every SysAdmin means to get to and rarely does — not because it’s hard, but because writing clearly takes a different kind of effort than solving the problem did. You already know what you did. Turning that into a runbook someone else can follow at 3 AM, or a change log entry that still makes sense six months later, is a separate skill — and it’s one AI is genuinely good at, provided you stay in the loop.

This three-page series covers: drafting runbooks from a raw sequence of commands or a terminal history; turning incidents and change work into readable, honest change log entries; and — just as important — how to do both without publishing something wrong just because it reads well.

Same standard as the rest of this site: real SysAdmin use cases, copy-paste ready prompts, and no pretending AI output is ready to ship unreviewed. Page 3 exists specifically to keep Pages 1 and 2 honest.
Have a mess of commands from an incident and need a runbook fast? Start with Page 1 — Runbooks. Writing up something that already happened? Page 2 — Change Logs is the one you want.

🗺️ The Three-Page Map

PAGE 1 — RUNBOOKS ───────────────── ai-documentation-runbooks Turning a sequence of commands or a terminal history into a clean, repeatable runbook. Prompt patterns, structure, and a real worked example from start to finish. PAGE 2 — CHANGE LOGS ──────────────────── ai-documentation- Turning a raw timeline or incident notes changelogs into a readable change record. What belongs │ in a change log entry, what doesn't, and ▼ how AI helps you write it fast without losing the details that matter later. PAGE 3 — DOING IT WELL ◄── Read this even if you skip the others ─────────────────────── ai-documentation- The honest page. Why unreviewed AI-written best-practices documentation is worse than no documentation. Review discipline, tool-agnostic guidance (sgpt, aider, fabric, Claude), and where this fits into your existing workflow.

🤔 Who This Is For

You are…You will get…
Sitting on a terminal history from an incident you never wrote up A fast path from raw commands to a runbook someone else can actually follow
Expected to keep a change log but always behind on it Prompt patterns that turn a rough timeline into a clean entry in minutes, not an hour
Skeptical of AI-written documentation Page 3. It was written for you specifically.
Already using sgpt, aider, or fabric day to day How those same tools apply to documentation work, not just code

⚠️ One Thing Before You Start

AI-written documentation is a first draft, not a finished document. A runbook with a hallucinated flag, a wrong path, or a step that was true last Tuesday but isn't anymore is worse than no runbook at all — it fails silently, at the exact moment someone is relying on it. Every technique in this series assumes you read what it produces before anyone else does.

Read Page 3 at some point regardless of where you start. It isn't a disclaimer — it's the difference between documentation that helps and documentation that quietly makes things worse.

📋 The Three Pages

✅ Live ✅ Live ✅ Live