workbench-architecture
Architecture and ADR workflows for Workbench CLI. Use when documenting system design, decisions, tradeoffs, or rationale that must be tracked over time.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
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:
workbench doc new --type doc --title "Subsystem overview" --path docs/20-architecture/subsystem-overview.md --work-item TASK-0001
Create an ADR:
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:
workbench item link TASK-0001 --spec /docs/10-product/spec.md --adr /docs/40-decisions/ADR-YYYY-MM-DD-title.md
Sync backlinks:
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.
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!