Skip to content

Documentation — Senior

Senior documentation makes change and recovery safe. Runbooks need trigger, impact, diagnosis, mitigation, rollback, validation, escalation, and cleanup. Exercise them during game days.

Migration docs must describe compatibility windows, data states, traffic stages, ownership, stop conditions, and removal of temporary paths. Changelogs explain user impact and action, not commit history.

Prevent rot with ownership metadata, freshness checks, link validation, executable examples, and review tied to system changes. Archive obsolete decisions while preserving history.

Test yourself

  1. Which runbook step proves recovery?
  2. What must a migration document say about mixed versions?
  3. How can an example become executable evidence?
  4. Who owns documentation spanning teams?

Continue to professional.md.