架構決策與經驗 Architecture
跨專案的架構決策、踩坑紀錄、遷移指南、設計 Pattern 的沉澱。
收錄什麼
- ADR(Architecture Decision Record)— 重大架構選型決策
- 踩坑紀錄 / 後驗教訓(pitfalls)
- Legacy 系統遷移策略
- 跨專案重用的架構 pattern
- Post-mortem(事故後驗)
不收錄什麼
- 個別 library 的使用 →
framework/ - 個別協定的整合 →
protocols/ - 個人學習筆記 / 半成品 →
Personal-Learning/ - Code 實作 / Pattern 範例 code → 對應 repo 內的
samples/
子分組
| 子分組 | 範圍 |
|---|---|
adr/ | Architecture Decision Records(已 merge 的決策) |
pitfalls/ | 踩坑紀錄、common-pitfalls、debugging 心得 |
migration/ | Legacy 系統 / 大版本升級遷移指南 |
patterns/ | 跨專案重用的架構 pattern(預留) |
子分組規則
ADR
- 命名:
ADR-NNN-{kebab-case-title}.md,編號連續 - 用
adr-template.md起手 - ADR 不可修改 — 決策變更要新增 ADR-NNN+1 標明 Supersedes ADR-NNN
Pitfalls
- 每個踩坑單獨一檔(如
pitfalls/wpf-dispatcher-deadlock.md) - 或合併到
common-pitfalls.md的小節(看內容大小)
Migration
- 重大版本升級 / 系統重構才寫
- 一次性指南,完成後可標記
archived: true但保留
Patterns
- 至少 2 個專案實作過同一 pattern 才 promote 上來
- 每個 pattern 一檔,包含 Context / Forces / Solution / Examples