60. Sustainable technical documentation (pocket version)

TL;DR (5 lines)

  • Delivery is proof preservation.
  • Each gate should protect a named claim.
  • Local, CI, and review evidence are not interchangeable.
  • The chapter should connect process to code.
  • Good delivery docs reduce ambiguity about readiness.

Concrete Problem

Delivery chapters often list CI or review steps without connecting them to the evidence they are supposed to protect.

Coherent example

space demo/delivery

proc validate_release(name: string) -> int {
  if name == "" { give 11 }
  give 0
}

Global explanation

Delivery pages should explain evidence flow. Local checks, CI pipelines, and review rules are useful only when the reader knows what claim each one is guarding and what kind of regression it can still miss.

Short exercise

Take the example and write one local check, one CI check, and one review question that would protect it.

Next best action

Keep the example small, reproduce it locally, then continue to the full chapter if you need the broader context.