Key settings
- •
.workbench/config.json: paths.docsRoot, git.defaultBaseBranch. - •Use
workbench config show --format jsonto confirm defaults.
Core workflows
- •Planning phase: create architecture docs for design intent and scope.
- •When a decision is made or changes, create or update an ADR.
- •Link ADRs and architecture docs to work items and specs.
Commands
Create an architecture doc:
bash
workbench doc new --type doc --title "Subsystem overview" --path docs/20-architecture/subsystem-overview.md --work-item TASK-0001
Create an ADR:
bash
workbench doc new --type adr --title "Decision title" --path docs/40-decisions/ADR-YYYY-MM-DD-title.md --work-item TASK-0001
Link existing docs to a work item:
bash
workbench item link TASK-0001 --spec /docs/10-product/spec.md --adr /docs/40-decisions/ADR-YYYY-MM-DD-title.md
Sync backlinks:
bash
workbench doc sync --all
Output
- •Architecture docs and ADRs with consistent front matter.
- •Work items that reference related specs and ADRs.
Guardrails
- •Use ADRs for decisions, architecture docs for structure and flows.
- •Keep ADR status updated (proposed, accepted, superseded, deprecated).
- •If an ADR does not exist for a significant decision, create one.