Files
mkt.ose.tw/docs/templates/MODULE_SPEC_TEMPLATE.md
2026-03-23 20:23:58 +08:00

56 lines
1007 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Module Spec Template
## 1. 模組概要
- 模組名稱:
- 目標使用者:
- 問題定義:
- 成功指標KPI
## 2. 範圍定義
- In scope
- Out of scope
- 與既有模組關係:
## 3. 架構與資料邊界
- API 入口Admin / Editor / Runtime
- 主要 Entity
- Directus / Native 歸屬(參照 Data Ownership Matrix
- revision 需求:
- 自動編碼規則(如 `EX+timestamp` / `VA+timestamp`
- 使用者可編輯欄位(只列可編輯):
## 4. API 與 DTO
- 新增/調整端點:
- Request/Response DTO
- 錯誤碼:
- 版本策略(是否影響 v1
## 5. Frontend 互動
- 使用流程(行銷視角):
- 主要頁面與狀態:
- 中文化與簡化策略:
## 6. 驗收與測試
- 功能驗收案例:
- 回歸測試範圍:
- DoD
## 7. 上線與回滾
- 發布步驟:
- 監控指標:
- 回滾條件:
- 回滾步驟:
## 8. 風險與假設
- 主要風險:
- 依賴與前置:
- 已採用假設: