Agent skill

workbench-docs

Documentation workflows for Workbench CLI. Use when creating or updating specs, ADRs, runbooks, guides, or general docs, and when syncing backlinks or change notes.

View SKILL.md on GitHub Repository
Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/documents/workbench-docs

SKILL.md

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:

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

Create a spec:

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

Create an architecture doc:

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

Create an ADR:

bash
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:

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

Unlink a doc from work items:

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

Sync front matter and backlinks:

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

Summarize doc changes:

bash
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.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

majiayu000/claude-skill-registry

agent-ops-spec

Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.

163 31
Explore
majiayu000/claude-skill-registry

agent-ops-state

Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.

163 31
Explore
majiayu000/claude-skill-registry

agent-ops-spec

Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.

163 31
Explore
majiayu000/claude-skill-registry

agent-ops-testing

Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.

163 31
Explore
majiayu000/claude-skill-registry

agent-ops-testing

Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.

163 31
Explore
majiayu000/claude-skill-registry

agent-ops-state

Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.

163 31
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results