搜索

PythonReactSEOPDF
GitHub Skill

workbench-architecture

Architecture and ADR workflows for Workbench CLI. Use when documenting system design, decisions, tradeoffs, or rationale that must be tracked over time.

bravellian☆ 0 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

Key settings

  • .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:

workbench.ps1 doc new --type doc --title "Subsystem overview" --path docs/20-architecture/subsystem-overview.md --work-item TASK-0001

Create an ADR:

workbench.ps1 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.ps1 item link TASK-0001 --spec /docs/10-product/spec.md --adr /docs/40-decisions/ADR-YYYY-MM-DD-title.md

Sync backlinks:

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.

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-26
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!