docs: rebuild documentation set for new architecture and add DB schema guide

This commit is contained in:
Chris
2026-03-30 19:21:54 +08:00
parent f884f1043d
commit 37a69081e3
18 changed files with 245 additions and 916 deletions

View File

@@ -1,38 +1,23 @@
# member docs index
# member.ose.tw 文件入口
## 0. 先看這兩份(入口
1. `docs/ARCHITECTURE_AND_CONFIG.md`
2. `docs/BACKEND_ARCHITECTURE.md`
## 閱讀順序(先看
1. `docs/ARCHITECTURE.md`
2. `docs/DB_SCHEMA.md`
3. `docs/BACKEND_TASKPLAN.md`
4. `docs/FRONTEND_TASKPLAN.md`
5. `docs/FRONTEND_HANDOFF.md`
6. `docs/LOCAL_DEV_RUNBOOK.md`
## 1. 架構核心(你現在的實際模型
- 業務層級:`公司 companies -> 品牌站台 sites -> 會員 users`
- 功能層級:`系統 systems -> 模組 modules`
- 授權層級:`scope(company/site) + system + module(可空) + action`
- 權限來源:`直接授權 + 群組授權`
## 交辦順序(執行
1. 後端先完成新 schema 與 API 契約
2. 前端依 handoff 完成頁面與串接
3. 本地驗收跑 Runbook
## 2. 前端交辦(直接丟給另一隻 AI
1. `docs/FRONTEND_API_CONTRACT.md`
2. `docs/FRONTEND_HANDOFF_SCHEMA_V2.md`
3. `docs/FRONTEND_ARCHITECTURE.md`
## 目前狀態
- 架構方向已定版群組中心、site scope、action view/edit 多選)
- 文件重整:已完成(舊文件已清除)
- 程式重構:待後續依 TaskPlan 實作
## 3. 後端與環境
- `docs/BACKEND_BOOTSTRAP.md`
- `docs/TASKPLAN_BACKEND.md`
- `backend/.env.development`(本機開發)
## 4. DB單一來源
- `backend/scripts/init_schema.sql`(完整 schema
- `docs/DB_SCHEMA_SNAPSHOT.md`(目前資料庫結構快照)
## 5. 管理流程(建議操作順序)
1. 建立 `systems``modules`
2. 建立 `companies``sites`
3. 建立/同步 `members`(可同步 Authentik
4. 建立 `permission-groups`
5. 在會員頁指定會員所屬群組
6. 在權限頁做直接授權,或在群組頁做群組授權
## 6. 前端頁面責任切分
- 會員頁:會員基本資料 + 群組指派
- 群組頁:群組 CRUD + 群組權限列表 + 群組授權/撤銷
- 權限管理頁:直接授權/撤銷 + 直接授權列表(可逐筆撤銷)
## 備註
- 本輪不產最終規格表/最終規範矩陣
- DB 文檔以 `docs/DB_SCHEMA.md` 為說明入口,實際 SQL 以 `backend/scripts/init_schema.sql` 為準