workbench-docs

Key settings

• .workbench/config.json: paths.docsRoot, paths.templatesDir, ids.width, prefixes, git.defaultBaseBranch, github.owner, github.repository.
• Use workbench config show --format json to verify effective settings.

Core workflows

1. Planning phase: create specs and architecture docs before major changes.
2. Doing phase: keep docs updated as implementation decisions change.
3. Keep doc front matter and backlinks in sync.
4. Summarize doc changes when publishing.

Commands

Create a doc:

workbench doc new --type doc --title "Title" --path docs/10-product/title.md --work-item TASK-0001

Create a spec:

workbench doc new --type spec --title "Title" --path docs/10-product/title.md --work-item TASK-0001

Create an architecture doc:

workbench doc new --type doc --title "System design" --path docs/20-architecture/system-design.md --work-item TASK-0001

Create an ADR:

workbench doc new --type adr --title "Decision" --path docs/40-decisions/ADR-YYYY-MM-DD-title.md --work-item TASK-0001

Link a doc to work items:

workbench doc link --type spec --path docs/10-product/title.md --work-item TASK-0001

Unlink a doc from work items:

workbench doc unlink --type adr --path docs/40-decisions/ADR-YYYY-MM-DD-title.md --work-item TASK-0001

Sync front matter and backlinks:

workbench doc sync --all --dry-run
workbench doc sync --all

Summarize doc changes:

workbench doc summarize --staged --update-index

Output

• Markdown docs with Workbench front matter and backlinks.
• Updated work item references in docs and work items.

Guardrails

• Keep doc types aligned with folder intent (product, architecture, decisions, runbooks).
• Always link docs to relevant work items with --work-item or workbench item link.
• For major changes, write a spec before implementation.
• When decisions change, update or create the ADR.
• Prefer workbench doc commands; workbench spec and workbench adr are deprecated.