技能 architecture-decision-records
📦

architecture-decision-records

安全

建立架構決策記錄

也可從以下取得: wshobson

此技能協助團隊使用結構化模板記錄重要的技術決策。它提供全面的 ADR 格式、生命週期管理指引,以及捕捉背景脈絡、取捨和理由的最佳實踐。

支援: Claude Codex Code(CC)
🥉 75 青銅
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「architecture-decision-records」。 為我們的專案採用 TypeScript 建立一個 ADR

預期結果:

一份完整的 ADR 文件,包含狀態:已接受、關於當前 React 程式碼庫挑戰的背景脈絡、採用 TypeScript 的決策、後果(包含優點:型別安全、IDE 支援)和(缺點:學習曲線、建構複雜性),以及緩解措施(包含培訓課程)。

正在使用「architecture-decision-records」。 記錄我們傳統認證服務的廢棄

預期結果:

一份廢棄 ADR,狀態顯示它取代了 ADR-0015,背景脈絡列出當前服務的問題,包含階段性方法的遷移計劃,以及關於原始決策出了什麼問題的經驗教訓。

安全審計

安全
v1 • 2/24/2026

Security analysis confirms this is a safe documentation skill. Static findings for external_commands, network, and weak_crypto are false positives. The skill contains markdown templates, example CLI commands (shown as documentation), and reference URLs to external documentation. No executable code, no data exfiltration, no cryptographic operations.

1
已掃描檔案
444
分析行數
0
發現項
1
審計總數
未發現安全問題

偵測到的模式

False Positive: External Commands DetectionFalse Positive: Network DetectionFalse Positive: Weak Cryptographic Algorithm
審計者: claude

品質評分

38
架構
100
可維護性
87
內容
50
社群
100
安全
100
規範符合性

你能建構什麼

記錄資料庫技術選擇

當在新專案中選擇 PostgreSQL、MySQL 或 MongoDB 時,使用標準 ADR 模板捕捉需求、比較選項,並記錄帶有完整理由的決策。

記錄框架遷移決策

當計劃從 Angular 遷移到 React 時,建立廢棄 ADR 來記錄變更原因、遷移階段和從先前決策中學到的經驗教訓。

建立團隊決策流程

當新團隊成員入職時,使用 ADR 模板協助他們了解過去的架構選擇和當前架構背後的理由。

試試這些提示

基本 ADR 請求
建立一個關於 [DECISION_TITLE] 的架構決策記錄。使用標準 MADR 格式。包含關於為何需要做出此決策的背景脈絡、我們考慮的選項、我們的最終決策,以及後果。
技術比較
建立一個 ADR 來比較 [TECHNOLOGY_A]、[TECHNOLOGY_B] 和 [TECHNOLOGY_C] 用於我們的 [USE_CASE]。包含每個選項的詳細優缺點、我們的需求,並推薦最佳選擇及其理由。
廢棄記錄
為 [OLD_TECHNOLOGY] 建立一個廢棄 ADR,它將被 [NEW_TECHNOLOGY] 取代。包含原始決策制定的背景脈絡、什麼改變了、遷移計劃,以及經驗教訓。
RFC 風格提案
為 [PROPOSAL] 建立一個詳細的 RFC 風格 ADR。包含動機、詳細設計、缺點、考慮的替代方案、未解決的問題和實施計劃。使其適合團隊審查和討論。

最佳實務

  • 在實施開始前撰寫 ADR 以準確捕捉決策背景脈絡
  • 在後果章節中包含誠實的取捨和潛在缺點
  • 連結相關的 ADR 以建立專案的決策依賴圖
  • 當決策被廢棄或取代時更新 ADR 狀態

避免

  • 撰寫沒有具體背景脈絡或理由的模糊決策
  • 跳过替代方案章節以避免顯示曾考慮其他選項
  • 修改已接受的 ADR 而不是建立新的 ADR 來取代
  • 為不需要架構文件的次要決策建立 ADR

常見問題

什麼是架構決策記錄?
架構決策記錄 (ADR) 是一份記錄專案期間做出的重要架構決策的文件。它通常包含背景脈絡、決策本身,以及該決策的後果。
我應該何時建立 ADR?
當做出重大架構決策時建立 ADR,例如框架採用、資料庫技術選擇、API 設計模式、安全架構或整合模式。跳過次要修補或常規維護的 ADR。
我應該使用什麼 ADR 格式?
對全面性決策使用標準 MADR 格式,對快速決策使用輕量級格式,對簡短選擇使用 Y-Statement,對需要團隊審查的複雜提案使用 RFC 風格。
我如何連結相關的 ADR?
在每個 ADR 中包含相關決策章節,按編號引用其他 ADR。使用狀態指示器如「取代 ADR-0003」或「補充 ADR-0002」來顯示關係。
我可以修改已接受的 ADR 嗎?
不可以。已接受的 ADR 絕不應被修改。相反地,建立一个新的 ADR 來取代舊的,並記錄什麼改變了以及為什麼。
什麼工具可以幫助管理 ADR?
adr-tools 是一個受歡迎的 CLI 工具用於管理 ADR。它可以初始化目錄、建立新 ADR、生成目錄,以及連結相關決策。

開發者詳情

檔案結構

📄 SKILL.md