279 lines
6.0 KiB
Markdown
279 lines
6.0 KiB
Markdown
# Drama Ling 問題追蹤系統
|
||
|
||
## 🎯 系統目的
|
||
管理專案中的規格不確定性、衝突、待辦事項和問題追蹤。
|
||
|
||
## 📊 問題分類
|
||
|
||
### 🔴 Critical (嚴重)
|
||
影響核心功能或架構的問題
|
||
- 資料庫設計衝突
|
||
- API 架構不一致
|
||
- 安全性漏洞
|
||
|
||
### 🟡 Important (重要)
|
||
影響開發進度的問題
|
||
- UI/UX 設計不確定
|
||
- 功能需求模糊
|
||
- 技術選型待定
|
||
|
||
### 🔵 Normal (一般)
|
||
可延後處理的問題
|
||
- 文檔不完整
|
||
- 小功能細節待定
|
||
- 效能優化建議
|
||
|
||
### 🟢 Low (輕微)
|
||
不影響開發的改進
|
||
- 程式碼風格統一
|
||
- 註解補充
|
||
- 文件格式調整
|
||
|
||
## 🏷️ 問題標籤
|
||
|
||
### 狀態標籤
|
||
- `status:open` - 未解決
|
||
- `status:in-progress` - 處理中
|
||
- `status:resolved` - 已解決
|
||
- `status:closed` - 已關閉
|
||
- `status:blocked` - 被阻擋
|
||
|
||
### 類型標籤
|
||
- `type:spec` - 規格問題
|
||
- `type:conflict` - 衝突問題
|
||
- `type:missing` - 缺失資訊
|
||
- `type:clarification` - 需要澄清
|
||
- `type:decision` - 待決定
|
||
- `type:bug` - 錯誤
|
||
- `type:enhancement` - 改進建議
|
||
|
||
### 模組標籤
|
||
- `module:auth` - 認證系統
|
||
- `module:learning` - 學習內容
|
||
- `module:ui` - 使用者介面
|
||
- `module:api` - API 規格
|
||
- `module:db` - 資料庫
|
||
- `module:docs` - 文檔
|
||
|
||
## 📋 問題追蹤格式
|
||
|
||
```markdown
|
||
## Issue #001 - [簡短標題]
|
||
|
||
**優先級**: 🔴 Critical / 🟡 Important / 🔵 Normal / 🟢 Low
|
||
**狀態**: Open
|
||
**標籤**: `type:spec` `module:api` `status:open`
|
||
**建立日期**: 2024-12-08
|
||
**負責人**: [指派人員]
|
||
**預計解決**: [日期]
|
||
|
||
### 問題描述
|
||
詳細描述問題的內容、影響範圍和背景資訊。
|
||
|
||
### 相關文件
|
||
- 檔案: `docs/01_requirement/system_structure_design.json:45`
|
||
- 檔案: `docs/04_technical/api-specifications.md:332-416`
|
||
|
||
### 可能解決方案
|
||
1. 方案A: [描述]
|
||
- 優點: [列出]
|
||
- 缺點: [列出]
|
||
|
||
2. 方案B: [描述]
|
||
- 優點: [列出]
|
||
- 缺點: [列出]
|
||
|
||
### 決議
|
||
[最終決定的解決方案和理由]
|
||
|
||
### 執行紀錄
|
||
- 2024-12-08: 建立問題
|
||
- 2024-12-09: 調查相關文件
|
||
- 2024-12-10: 提出解決方案
|
||
|
||
---
|
||
```
|
||
|
||
## 🔄 工作流程
|
||
|
||
### 1. 問題發現
|
||
- 在文檔檢查中發現
|
||
- 開發過程中遇到
|
||
- 團隊討論提出
|
||
- 自動檢查工具發現
|
||
|
||
### 2. 問題記錄
|
||
```bash
|
||
# 使用腳本快速建立問題
|
||
./scripts/maintenance/create_issue.sh "API endpoint conflict in user module"
|
||
```
|
||
|
||
### 3. 問題分類
|
||
- 設定優先級和標籤
|
||
- 指派負責人
|
||
- 設定預計解決日期
|
||
|
||
### 4. 問題追蹤
|
||
- 定期檢查進度
|
||
- 更新狀態
|
||
- 記錄解決過程
|
||
|
||
### 5. 問題解決
|
||
- 實施解決方案
|
||
- 更新相關文檔
|
||
- 驗證解決效果
|
||
- 關閉問題
|
||
|
||
## 📝 常見問題類型
|
||
|
||
### API 規格問題
|
||
- 端點命名不一致
|
||
- 參數定義模糊
|
||
- 回應格式衝突
|
||
- 錯誤碼重複
|
||
|
||
### 資料庫設計問題
|
||
- 表格關聯不清楚
|
||
- 欄位型態待定
|
||
- 索引策略未定
|
||
- 資料遷移方案
|
||
|
||
### UI/UX 設計問題
|
||
- 頁面流程不確定
|
||
- 元件命名衝突
|
||
- 互動行為模糊
|
||
- 響應式設計待定
|
||
|
||
### 功能需求問題
|
||
- 業務邏輯不明確
|
||
- 使用者權限設計
|
||
- 效能需求未定
|
||
- 相容性要求
|
||
|
||
## 🛠️ 管理工具
|
||
|
||
### 問題檢查腳本
|
||
```bash
|
||
# 檢查未解決問題
|
||
./scripts/maintenance/check_open_issues.sh
|
||
|
||
# 生成問題報告
|
||
./scripts/maintenance/generate_issue_report.sh
|
||
|
||
# 檢查逾期問題
|
||
./scripts/maintenance/check_overdue_issues.sh
|
||
```
|
||
|
||
### 問題統計
|
||
- 每週問題報告
|
||
- 解決效率統計
|
||
- 問題類型分析
|
||
- 模組問題分布
|
||
|
||
---
|
||
|
||
## Issue #009 - API模組化文檔中有7個待建立的模組
|
||
|
||
**優先級**: 🟡 Important
|
||
**狀態**: Open
|
||
**標籤**: `type:spec` `module:api` `status:open`
|
||
**建立日期**: 2024-12-08
|
||
**負責人**: [待指派]
|
||
**預計解決**: [待設定]
|
||
|
||
### 問題描述
|
||
根據 api-specifications.md 文檔，有7個API模組尚未建立：
|
||
- 學習內容API (第332-416行)
|
||
- 對話練習API (第615-776行)
|
||
- 詞彙系統API (第417-614行)
|
||
- 遊戲化系統API (第98-252行，第777-930行，第1791-1867行)
|
||
- 訂閱系統API (第1868-2188行)
|
||
- 特殊任務API (第1142-1447行)
|
||
- 語言程度API (第1448-1790行)
|
||
|
||
### 相關文件
|
||
- 檔案: `docs/04_technical/api-specifications.md:37-46`
|
||
|
||
### 可能解決方案
|
||
1. 方案A: 逐一建立各模組文檔
|
||
- 優點: 結構清晰，便於維護
|
||
- 缺點: 工作量較大
|
||
|
||
2. 方案B: 先建立關鍵模組，其他延後
|
||
- 優點: 快速開發核心功能
|
||
- 缺點: 可能導致架構不完整
|
||
|
||
### 決議
|
||
[待決定]
|
||
|
||
### 執行紀錄
|
||
- 2024-12-08: 建立問題
|
||
|
||
---
|
||
|
||
## Issue #010 - System Design與User Flow的UI名稱存在差異
|
||
|
||
**優先級**: 🔵 Normal
|
||
**狀態**: Open
|
||
**標籤**: `type:conflict` `module:ui` `status:open`
|
||
**建立日期**: 2024-12-08
|
||
**負責人**: [待指派]
|
||
**預計解決**: [待設定]
|
||
|
||
### 問題描述
|
||
從一致性檢查發現，System Design和User Flow之間的UI命名存在差異，可能導致開發時的混淆。
|
||
|
||
### 相關文件
|
||
- 檔案: `docs/01_requirement/system_structure_design.json`
|
||
- 檔案: `docs/04_technical/user-flow-specification.md`
|
||
|
||
### 可能解決方案
|
||
1. 統一UI命名規範
|
||
2. 建立UI命名對照表
|
||
3. 更新一致性檢查規則
|
||
|
||
### 決議
|
||
[待決定]
|
||
|
||
### 執行紀錄
|
||
- 2024-12-08: 建立問題
|
||
|
||
## 📊 問題追蹤看板
|
||
|
||
### 待處理 (Backlog)
|
||
- Issue #001: API endpoint naming conflicts
|
||
- Issue #003: Database schema uncertainties
|
||
- Issue #005: UI component specifications
|
||
|
||
### 進行中 (In Progress)
|
||
- Issue #002: User authentication flow
|
||
- Issue #004: Learning content API design
|
||
|
||
### 待驗證 (Review)
|
||
- Issue #006: Subscription model conflicts
|
||
|
||
### 已完成 (Done)
|
||
- Issue #007: Error handling standardization ✅
|
||
- Issue #008: API response format unification ✅
|
||
|
||
## 🔍 問題搜尋
|
||
|
||
### 依優先級搜尋
|
||
```bash
|
||
grep "🔴 Critical" docs/04_technical/issues-tracking.md
|
||
```
|
||
|
||
### 依模組搜尋
|
||
```bash
|
||
grep "module:api" docs/04_technical/issues-tracking.md
|
||
```
|
||
|
||
### 依狀態搜尋
|
||
```bash
|
||
grep "status:open" docs/04_technical/issues-tracking.md
|
||
```
|
||
|
||
---
|
||
|
||
**更新日期**: 2024-12-08
|
||
**維護人員**: Drama Ling 開發團隊 |