讓「找規格」跟「日常速查」兩種需求各有歸宿,避免同樣資訊散落多處:
- 改寫 docs/identity-member-design.md:從 Big5 亂碼的 2673 行設計草稿
→ ~200 行 UTF-8 跨模組總覽(架構決策、模組依賴、UID、JWT、Casbin、
Pub/Sub、Notification 全部一頁看完),不再跟模組 README 重疊
- 新增 internal/model/auth/README.md:合併原 auth-unified-registration
+ auth/SDD 的高層概念,留 SDD 給規格細節
- 精簡 member / permission / notification README:保留 sequence diagram、
curl、ServiceContext wiring 等日常開發要的東西;逐欄位 schema / Redis
key TTL / API endpoint list 等規格細節改指向各模組 SDD.md
- 每個 README 頂部加「規格 vs 速查」一行指路,找欄位 → SDD,找流程 → README
- root README 同步補上各模組 README + SDD 並列連結
- code comment 裡的 internal/model/{member,permission}/SDD.md §X.Y 引用
全部對齊新章節編號
Co-authored-by: Cursor <cursoragent@cursor.com>
|
||
|---|---|---|
| .. | ||
| openapi | ||
| auth-unified-registration.md | ||
| e2e-testing.md | ||
| identity-member-design.md | ||
| model.md | ||
| notification-testing.md | ||