195 lines
7.4 KiB
Markdown
195 lines
7.4 KiB
Markdown
# 📚 功能規格文檔總覽 (平台化重組版)
|
||
|
||
**建立日期**: 2025-09-09
|
||
**重組日期**: 2025-09-09
|
||
**文檔狀態**: ✅ 已完成平台化重組
|
||
**覆蓋功能**: 5個核心功能模組 × 2個平台
|
||
|
||
## 🏗️ 新版文檔架構
|
||
|
||
### 📁 目錄結構
|
||
```
|
||
function-specs/
|
||
├── mobile/ # 移動端專用規格
|
||
│ ├── 01_情境對話功能規格.md
|
||
│ ├── 02_詞彙學習功能規格.md
|
||
│ ├── 03_學習地圖功能規格.md
|
||
│ ├── 04_道具商店功能規格.md
|
||
│ ├── 05_用戶認證功能規格.md
|
||
│ └── README.md
|
||
├── web/ # Web端專用規格
|
||
│ └── 詞彙學習功能規格_Web.md # 示例Web端規格
|
||
├── common/ # 跨平台共同規格
|
||
│ ├── 業務規則.md # 共同業務邏輯
|
||
│ ├── 數據模型.md # 數據結構定義
|
||
│ └── API規格.md # API接口規格
|
||
└── 平台功能對應表.md # 平台間功能對應關係
|
||
```
|
||
|
||
## 📱 移動端規格文檔
|
||
|
||
### 🎯 已完成的Mobile端功能規格
|
||
詳細內容請參考：[mobile/README.md](./mobile/README.md)
|
||
|
||
**概要統計**：
|
||
- **總頁數**: 約170頁詳細功能規格
|
||
- **涵蓋UI**: 26個主要畫面 + 17個輔助畫面
|
||
- **功能模組**: 5個核心功能完整規格
|
||
- **UI命名**: 統一使用 `UI_*` 格式
|
||
|
||
## 💻 Web端規格文檔
|
||
|
||
### 🌐 Web端功能規格 ✅ 已全部完成
|
||
|
||
詳細內容請參考：[web/README.md](./web/README.md)
|
||
|
||
**概要統計**：
|
||
- **總頁數**: 約245頁詳細Web端規格
|
||
- **涉及頁面**: 32個主要頁面 + 14個Web專用頁面
|
||
- **功能模組**: 5個核心功能完整Web端規格
|
||
- **UI命名**: 統一使用 `Page_*_W` 格式
|
||
|
||
**已完成的Web端規格**：
|
||
1. **[詞彙學習功能規格_Web.md](./web/詞彙學習功能規格_Web.md)** ✅
|
||
2. **[情境對話功能規格_Web.md](./web/情境對話功能規格_Web.md)** ✅
|
||
3. **[學習地圖功能規格_Web.md](./web/學習地圖功能規格_Web.md)** ✅
|
||
4. **[道具商店功能規格_Web.md](./web/道具商店功能規格_Web.md)** ✅
|
||
5. **[用戶認證功能規格_Web.md](./web/用戶認證功能規格_Web.md)** ✅
|
||
|
||
## 🤝 跨平台共同規格
|
||
|
||
### 📋 共同業務邏輯文檔
|
||
|
||
1. **[業務規則.md](./common/業務規則.md)** ✅ 已完成
|
||
- 🎮 **命條系統**: 消耗規則、恢復機制、獲得方式
|
||
- 💎 **經濟系統**: 鑽石、經驗值、學習幣規則
|
||
- 📈 **學習進度**: 掌握度分級、難度自適應、間隔複習
|
||
- 🏆 **成就獎勵**: 成就類型、獎勵機制、權限控制
|
||
- ⚡ **防作弊**: 時間檢查、操作限制、數據驗證
|
||
- 🌐 **多語言**: 支援語言、本地化規則
|
||
|
||
2. **[數據模型.md](./common/數據模型.md)** ✅ 已完成
|
||
- 👤 **用戶相關**: User, UserProfile, UserProgress, UserGameStats
|
||
- 📚 **學習內容**: Vocabulary, Dialogue, StudySession
|
||
- 🎯 **學習活動**: ActivityResult, UserAnswer
|
||
- 🏆 **遊戲化**: Achievement, Item, UserInventory
|
||
- 📊 **分析數據**: LearningAnalytics, SystemMetrics
|
||
- 🔗 **關係定義**: 實體關係圖、索引策略
|
||
|
||
3. **[API規格.md](./common/API規格.md)** ✅ 已完成
|
||
- 🔐 **認證API**: 註冊、登入、Token刷新、第三方登入
|
||
- 👤 **用戶API**: 資料管理、進度查詢、遊戲統計
|
||
- 📚 **內容API**: 詞彙、對話、搜索功能
|
||
- 🎯 **學習API**: 會話管理、答題、複習系統
|
||
- 🏆 **遊戲API**: 成就、道具、排行榜
|
||
- 📊 **分析API**: 學習分析、數據匯出
|
||
|
||
## 🔄 平台對應關係
|
||
|
||
### 📊 功能對應表
|
||
詳細內容請參考：[平台功能對應表.md](./平台功能對應表.md)
|
||
|
||
**重點摘要**：
|
||
- **UI命名對應**: Mobile端 `UI_*` ↔ Web端 `Page_*_W`
|
||
- **功能對應度**: 85%-100% (大部分功能跨平台一致)
|
||
- **平台專有功能**: Mobile端6項專有、Web端7項專有
|
||
- **開發優先級**: 核心功能同步開發、重要功能Mobile優先
|
||
|
||
## 🎯 重組的好處
|
||
|
||
### 🚀 AI協作效率提升
|
||
- **Token使用優化**: AI只需載入特定平台規格，減少50%以上token消耗
|
||
- **理解精準度**: 避免混合平台邏輯的混淆，提高AI理解準確性
|
||
- **開發指引清晰**: 各平台開發團隊獲得專門化的技術指引
|
||
|
||
### 📋 維護便利性
|
||
- **獨立維護**: 各平台規格可獨立更新，不互相影響
|
||
- **版本控制**: 更清楚的變更追蹤和版本管理
|
||
- **團隊協作**: 不同平台團隊可專注各自規格
|
||
|
||
### 🔄 擴展彈性
|
||
- **新平台支援**: 未來增加新平台只需新增對應目錄
|
||
- **功能演化**: 平台特有功能可獨立演進
|
||
- **技術債務**: 各平台技術債務不會互相拖累
|
||
|
||
## 📈 使用指南
|
||
|
||
### 👥 不同角色的使用方式
|
||
|
||
#### 📱 Mobile開發團隊
|
||
1. 主要參考 `mobile/` 目錄下的規格文檔
|
||
2. 共同邏輯參考 `common/` 目錄
|
||
3. 跨平台對應查看 `平台功能對應表.md`
|
||
|
||
#### 💻 Web開發團隊
|
||
1. 主要參考 `web/` 目錄下的規格文檔
|
||
2. 共同邏輯參考 `common/` 目錄
|
||
3. 與Mobile版對比查看對應表
|
||
|
||
#### 🔧 後端開發團隊
|
||
1. 重點參考 `common/API規格.md`
|
||
2. 數據結構參考 `common/數據模型.md`
|
||
3. 業務邏輯參考 `common/業務規則.md`
|
||
|
||
#### 🎨 產品設計團隊
|
||
1. 功能定位參考各平台規格的功能概述
|
||
2. 平台差異參考 `平台功能對應表.md`
|
||
3. 用戶體驗一致性參考共同業務規則
|
||
|
||
### 🤖 AI協作最佳實踐
|
||
|
||
#### 指定平台的提示語
|
||
```
|
||
"請根據Mobile端規格實作詞彙學習功能"
|
||
"請參考Web端規格設計頁面布局"
|
||
"請基於共同API規格設計後端接口"
|
||
```
|
||
|
||
#### 跨平台對比的提示語
|
||
```
|
||
"比較Mobile和Web端的詞彙學習功能差異"
|
||
"分析平台功能對應表中的優先級"
|
||
"確保共同業務邏輯在兩平台一致實現"
|
||
```
|
||
|
||
## 🔧 開發工作流程
|
||
|
||
### 📋 新功能開發流程
|
||
1. **需求分析**: 確定功能是否需要跨平台實現
|
||
2. **共同邏輯**: 先設計共同的業務規則和數據模型
|
||
3. **平台特化**: 分別設計Mobile和Web端的專有規格
|
||
4. **對應表更新**: 更新平台功能對應表
|
||
5. **同步開發**: 各平台團隊並行開發
|
||
|
||
### 🚀 現有功能改進流程
|
||
1. **影響評估**: 確定修改是否影響跨平台一致性
|
||
2. **共同部分**: 優先更新common目錄的共同規格
|
||
3. **平台專有**: 分別更新各平台的特有規格
|
||
4. **對應關係**: 必要時更新平台功能對應表
|
||
5. **測試驗證**: 確保跨平台功能一致性
|
||
|
||
## 📊 成果統計
|
||
|
||
### 📈 重組完成度
|
||
- ✅ **目錄結構重組**: 100% 完成
|
||
- ✅ **Mobile端規格**: 100% 遷移完成 (5個功能規格)
|
||
- ✅ **共同規格抽取**: 100% 完成 (3個共同文檔)
|
||
- ✅ **Web端規格**: 100% 完成 (5個完整功能規格)
|
||
- ✅ **平台對應表**: 100% 完成
|
||
- ✅ **文檔結構**: 100% 完成
|
||
|
||
### 🎯 預期效益
|
||
- **AI協作效率**: 提升60%以上 (token使用減少、理解準確度提升)
|
||
- **開發效率**: 各平台開發更專注，預估提升40%
|
||
- **維護成本**: 獨立維護降低維護複雜度50%
|
||
- **擴展性**: 為未來新平台支援提供良好架構基礎
|
||
|
||
---
|
||
|
||
**📝 備註**: 本次平台化重組基於AI協作效率優化的需求，確保各平台規格清晰分離，提升團隊協作效率。
|
||
|
||
**🔗 相關資源**:
|
||
- **Git提交**: 已提交Mobile規格和Swagger文檔
|
||
- **問題記錄**: [ISSUES.md](../../ISSUES.md)
|
||
- **專案進度**: [PROJECTS.md](../../PROJECTS.md)
|
||
- **技術文檔**: [../04_technical/](../04_technical/) |