workbench-architecture

Files (1)

• SKILL.md

SKILL.md (first lines)

## Key settings

- [`.workbench/config.json`](../../../.workbench/config.json): paths.docsRoot, git.defaultBaseBranch.
- Use `workbench.ps1 config show --format json` to confirm defaults.

## Core workflows

1. Planning phase: create architecture docs for design intent and scope.
2. When a decision is made or changes, create or update an ADR.
3. Link ADRs and architecture docs to work items and specs.

## Commands

Create an architecture doc:
```bash
workbench.ps1 doc new --type doc --title "Subsystem overview" --path architecture/subsystem-overview.md --work-item WI-WB-0001
```

Create an ADR:
```bash
workbench.ps1 doc new --type adr --title "Decision title" --path decisions/ADR-YYYY-MM-DD-title.md --work-item WI-WB-0001
```

Link existing docs to a work item:
```bash
workbench.ps1 item link WI-WB-0001 --spec /overview/spec.md --adr /decisions/ADR-YYYY-MM-DD-title.md
```

Sync backlinks:
```bash
workbench.ps1 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.

From incursa/workbench, Apache-2.0.

More from incursa/workbench