Archetype: doc_runbook.org.mustache
Runbook: Goal / Preconditions / Steps / Postconditions composition of recipes and skills. Org-mode document scaffold generated from the entity meta-model. The produced `.org` file is tangled into the site build and kept in the org-roam graph.
See the Template variable reference for the complete list of available variables and their semantics.
Template
The full template source. Edit here and re-tangle with
compass build --direct tangle_codegen_templates to regenerate
library/templates/doc_runbook.org.mustache.
{{! GENERATED FILE — tangled from projects/ores.codegen/library/templates/doc.org. Edit the org source. }}
:PROPERTIES:
:ID: {{id}}
:END:
#+title: {{title}}
#+description: {{description}}
#+type: runbook
#+level: cross
#+filetags: {{filetags}}
#+created: {{date}}
#+updated: {{date}}
This page documents a [[id:B555D2A6-10CA-4A93-973E-F2AF4E1D7E55][runbook]] — a named, repeatable composition of [[id:0C57932D-D13A-480F-B426-49525AA8BA3D][recipes]] and [[id:6054CC20-5F41-482F-A587-759512577B1D][skills]] for a complete multi-step procedure. Each step references a recipe or skill by id-link.
* Goal
(Describe what this runbook achieves, in one sentence.)
* Preconditions
(What must be true before starting: branch state, sprint state, tooling available, etc.)
* Steps
In execution order:
1. (Step description — reference a [[id:RECIPE-UUID][recipe]] or [[id:SKILL-UUID][skill]] by id-link.)
2. (Optional: name a skill to load before the step. Steps may branch: "if declined, go to step N.")
* Postconditions
(What is true after completing: e.g. "feature branch exists, story is STARTED, PR is open.")
* See also
- [[id:<UUID>][Related document or runbook]]
See also
- Parent facet: Documentation templates
- Template variable reference