Document type: version

Table of Contents

This page defines the version document type — one entry in the document types taxonomy. The general contract every document follows (frontmatter, state, linking, tags) lives on the taxonomy page; this page carries only what is specific to version.

Contract

Folder
versions/<v>/
Title
Version N — no prefix (the word "Version" is already in the title).
Level
s4
TODO vocabulary
STARTED | RELEASED (one in flight at a time; the rest are released).
How to create
see New version in the codegen recipe.
Required sections (in this order)
  • Blurb — opens with This page documents the [[id:CA4D4BDE-2EAB-4F0A-BC8B-7C0BCB17BC82][version]] *Version N* of ORE Studio. ... see [[id:436FB40C-422A-465B-B949-E9F0760820C1][product identity]].
  • * Identity — what makes this version distinct.
  • * Mission — what the version is for.
  • * Definition of done — when the version can close.
  • * Status — table; rows State / Now / Waiting on / Next / Last touched (no Parent row — versions are top-level).
  • * Sprints — table with class hug-leading; columns Sprint / Start / End / Theme.
  • * Release scope — what is in, what is deferred.

Emacs 29.1 (Org mode 9.6.6)