Runbooks catalogue
This page catalogues every runbook — named, repeatable compositions of recipes and skills into complete multi-step procedures. For the conceptual overview of how runbooks fit with instructions, recipes, skills, functions, settings, and memory, see LLM Configuration and Artefacts.
To create a new runbook: compass add runbook or
projects/ores.codegen/generate_doc.sh --type runbook. List
all runbooks with compass list --type runbook.
Catalogue
| Runbook | Description |
|---|---|
| Start work on a new story | Scaffold a story → create branch → mark STARTED → wire sprint → PR |
| Add a task to an existing story | Scaffold task via compass task new → fill content → wire story → PR |
| Work a task through to merged PR | Pick up BACKLOG task → implement → commit → PR → review → merge |
| Add a new entity across all layers | Domain type → SQL → repository → service → Qt UI → CLI → HTTP → tests |
| Open a new sprint | Close sprint → release notes → scaffold new sprint → bump version |
| Create a new component | Scaffold api/core/service → CMake → overview → stub tests → verify |
| Bootstrap a developer environment | Clone → install deps → CMake configure → build → test → verify |
| Deploy the documentation site | Build site → deploy settings → deploy skills → deploy diagrams → verify |
| Handle a PR review round | Sync main → read comments → decide → fix → push → reply → resolve → record |
| Create a new recipe | Scaffold → fill Question/Answer → test commands → wire inventory → PR |
| Add a new knowledge document | Scaffold → fill Summary/Detail → tag → wire knowledge index → PR |
| Run a sprint health review | Branch → charts → task scaffold → System 2 analysis → findings → shape fixes → PR |
| Handle a hotfix | Extract error → branch hotfix/ → scaffold → diagnose/fix → commit → PR |
See also
- LLM Configuration and Artefacts — how runbooks fit with the other LLM components.
- Runbook glossary entry — definition and contract.
- Document types§runbook — the frontmatter contract.