Skip to content

Draft — not approved. A working draft by UASK. It may change without notice.

Release spec (design document of one release)

Status
Review
Version
1.0.1
Authority
UASK standard
Applies to
Core
Markdown source

Definition

A release spec is a short document, written before building starts, that says what one release or significant change will do and what it will not, how it will be checked, how it will be rolled out and rolled back, and how much time the owner gives it (the appetite). Its shape is a design doc: context and scope, goals and non-goals, design, alternatives considered, then the checks, the rollout and rollback, the work packages and the open questions.

It is not a requirements specification. A specification describes what a product must do and lasts as long as the product; a release spec describes one change and closes when the release ships.

Example

RS-007: “Add a delivery date to the order. Goals: FR-12 and FR-13. Non-goal: a redesign of checkout. Checks first: two tests, red then green. Rollback: drop the column, ten minutes. Appetite: three agent-days.”

  • Release spec — the rules for writing, approving and closing it, and the template.
  • Project lifecycle — the phase (Spec) and the gate (G2 Ready) it belongs to.
  • Specification — the requirements side, which this term is kept apart from.
  • Blueprint — the system-level document that a release spec changes by section.

Sources