history Last updated

Delivery documents are read under time pressure, often at night. Everything here is optimised for scanning: checklists over prose, explicit commands over descriptions of commands, and a rollback step that is written before the deployment starts.

Linked from

  • Architecture & Design — Architecture documents, decision records, API specs and data models.
  • Code Review Checklist — What a human should look for once linters, tests and scanners have had their turn.
  • Coding Standards — The rules a team agrees to enforce — and, more importantly, which ones a machine enforces instead of a human.
  • Deployment Runbook — The exact sequence to ship a release, verify it, and back it out — written before the deployment starts.
  • Operations & Incident — Runbooks, incident reports, postmortems, change requests and on-call handovers.
  • Overview — Copy-paste document templates for IT work, each with a worked example and the mistakes that usually spoil it.
  • Pull Request Template — The context a reviewer needs, collected before they start rather than asked for afterwards.
  • Release Notes — What changed, what breaks, and what the reader has to do about it.
  • Testing & QA — Test plans, test case specifications, defect reports, UAT plans and summary reports.