Document type: runbook
Table of Contents
This page defines the runbook 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 runbook.
Contract
- Folder
doc/llm/runbooks/- Level
cross- Filename
runbook.orginside a<slug>/folder (same pattern asstory.org,task_*.org).- (no term)
- Not stateful — runbooks are durable reference. No TODO.
- How to create
compass add runbookorprojects/ores.codegen/generate_doc.sh --type runbook.- Required sections
* Goal— what this runbook achieves, in one sentence.* Preconditions— what must be true before starting (branch state, sprint state, tooling, etc.).* Steps— ordered list. Each step references a recipe or skill by id-link, with a one-line description. Steps may branch ("if declined, go to step N").* Postconditions— what is true after completing.* See also— id-links to related runbooks, recipes, or knowledge documents.