.claude/skills/adr-assistant/SKILL.md
[UDS] 建立、管理和追蹤架構決策記錄(ADR)
npx skillsauth add asiaostrich/universal-dev-standards adrInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
語言: English | 繁體中文
建立、管理和追蹤架構決策記錄。捕捉重大技術決策的背景、選項和理由。
CAPTURE ──► ANALYZE ──► DECIDE ──► RECORD ──► LINK
捕捉背景 分析選項 做出決策 記錄 ADR 建立連結
識別驅動決策的背景與限制條件。
| 步驟 | 動作 | |------|------| | 1 | 識別問題或機會 | | 2 | 列出限制條件(時間、預算、團隊技能) | | 3 | 定義決策驅動因素 |
至少探索 2 個選項,列出優缺點。
| 步驟 | 動作 | |------|------| | 1 | 腦力激盪候選方案 | | 2 | 根據決策驅動因素評估各方案 | | 3 | 記錄各方案優缺點 |
選擇最佳方案並闡述理由。
依照標準模板產生 ADR 檔案。
與相關工件(規格、PR、程式碼)建立交叉引用。
| 撰寫 ADR | 不需要 ADR | |----------|-----------| | 框架/函式庫選擇 | 例行性依賴更新 | | API 合約或資料格式 | 現有架構內的 Bug 修復 | | 部署策略變更 | 程式碼風格決策 | | 建立新模式 | 瑣碎的實作選擇 |
經驗法則:如果 6 個月後有人可能會問「為什麼?」,就寫一份 ADR。
Proposed ──► Accepted ──► Deprecated
│
└──► Superseded by ADR-NNN
| 狀態 | 說明 | |------|------| | Proposed | 討論中,尚未決定 | | Accepted | 已接受,應遵循 | | Deprecated | 不再適用 | | Superseded | 已被新 ADR 取代 |
# ADR-NNN: [決策標題]
- Status: [Proposed | Accepted | Deprecated | Superseded]
- Date: YYYY-MM-DD
- Deciders: [參與決策者]
- Technical Story: [SPEC-ID 或 Issue]
## Context(背景)
## Decision Drivers(決策驅動因素)
## Considered Options(考慮的選項)
## Decision Outcome(決策結果)
### Consequences(後果:Good / Bad / Neutral)
## Links(相關連結)
docs/adr/
├── ADR-001-short-description.md
├── ADR-002-short-description.md
└── README.md # 索引(可選)
| 指令 | 說明 |
|------|------|
| /adr | 互動式建立 ADR |
| /adr create | 建立新 ADR |
| /adr list | 列出所有 ADR 及狀態 |
| /adr search [關鍵字] | 依關鍵字搜尋 ADR |
| /adr supersede [ADR-NNN] | 取代現有 ADR |
| /adr review | 審查過期的 ADR |
| 技能 | 整合方式 |
|------|---------|
| /sdd | 在技術設計中引用 ADR;重大決策時建議建立 ADR |
| /review | 程式碼審查時引用 ADR 作為設計依據 |
| /commit | 提交時在 footer 加入 ADR 編號 |
| /brainstorm | 腦力激盪結果作為 ADR 選項分析輸入 |
| 檢查項目 | 標準 | |----------|------| | ☐ 背景 | 清楚說明問題 | | ☐ 選項 | 至少考慮 2 個選項 | | ☐ 驅動因素 | 決策驅動因素明確列出 | | ☐ 後果 | 包含正面與負面結果 | | ☐ 連結 | 相關工件已引用 |
/adr 完成後,AI 助手應建議:
ADR 已建立。建議下一步:
- 執行
/sdd建立規格(若決策需要實作)- 執行
/commit提交 ADR 檔案- 更新相關規格以引用此 ADR
- 若狀態為
Proposed,分享給團隊審查
development
[UDS] 扫描代码库的调试残留与代码质量问题;可自动修正安全模式。 Use when: before committing, during PR review, or periodic codebase cleanup. Keywords: sweep, debug cleanup, console.log, debugger, TODO, ts-any, code quality, 扫描, 清理.
tools
[UDS] 从规格衍生 BDD 场景、TDD 骨架或 ATDD 表格
development
[UDS] 识别重复流程并以正确的开发深度构建 Skill
tools
[UDS] AI 辅助 git push 安全层:质量门禁 + 协作护栏。 Use when: pushing commits, force pushing, pushing to protected branches, pushing feature branches. Keywords: git push, force push, protected branch, quality gate, push receipt, PR automation, 推送, 保护分支, 质量门禁.