# 📋 技術文檔總覽

**專案名稱**: Drama Ling 語言學習應用  
**最後更新**: 2025-09-09  
**文檔狀態**: 🔄 建議重組中  

## 🗂️ 文檔分類說明

本目錄包含 Drama Ling 專案的所有技術文檔，按功能和階段進行分類組織。

### 📊 當前文檔統計
- **總文檔數**: 27個
- **API文檔**: 11個
- **前端文檔**: 4個  
- **架構文檔**: 3個
- **開發工具**: 5個
- **其他文檔**: 4個

## 📁 建議的目錄重組結構

### 🏗️ 01_architecture/ - 架構設計
核心系統架構和技術選型決策文檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `tech-stack-decision.md` | 技術選型決策和比較分析 | ✅ 已完成 |
| `database-schema.md` | 資料庫結構設計 | ✅ 已完成 |
| `system-integration.md` | 系統整合架構 | ✅ 已完成 |

### 🔌 02_api/ - API 規格文檔
完整的後端 API 規格和介面文檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `README.md` | API 文檔導航和概覽 | 📝 需建立 |
| `api-specifications.md` | API 總規格文檔 | ✅ 已完成 |
| `common.md` | 通用 API 規範 | ✅ 已完成 |
| `errors.md` | 錯誤處理規範 | ✅ 已完成 |
| `authentication.md` | 認證相關 API | ✅ 已完成 |
| `user-management.md` | 用戶管理 API | ✅ 已完成 |
| `vocabulary.md` | 詞彙學習 API | ✅ 已完成 |
| `dialogue-practice.md` | 對話練習 API | ✅ 已完成 |
| `learning-content.md` | 學習內容 API | ✅ 已完成 |
| `gamification.md` | 遊戲化系統 API | ✅ 已完成 |
| `subscription.md` | 訂閱系統 API | ✅ 已完成 |
| `daily-missions.md` | 每日任務 API | ✅ 已完成 |
| `language-levels.md` | 語言等級 API | ✅ 已完成 |

### 💻 03_frontend/ - 前端技術文檔
Vue.js Web 應用程式開發相關文檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `README.md` | 前端技術文檔導航 | 📝 需建立 |
| `vue-frontend-architecture.md` | Vue.js 架構設計和技術選型 | ✅ 已完成 |
| `vue-project-structure.md` | 專案結構和配置檔案 | ✅ 已完成 |
| `vue-tools-configuration.md` | 開發工具和環境配置 | ✅ 已完成 |
| `vue-development-standards.md` | 開發規範和最佳實踐 | ✅ 已完成 |

### 📱 04_mobile/ - 移動端技術文檔
Flutter 移動應用程式開發相關文檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `README.md` | 移動端技術文檔導航 | 📝 需建立 |
| `flutter-architecture.md` | Flutter 架構設計 | 🔄 規劃中 |
| `flutter-integration.md` | Flutter 與後端整合 | ✅ 已完成 |

### 🚀 05_deployment/ - 部署和運維
應用程式部署、運維和維護相關文檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `README.md` | 部署文檔導航 | 📝 需建立 |
| `low-budget-deployment.md` | 低預算部署方案 | ✅ 已完成 |
| `production-deployment.md` | 生產環境部署指南 | 🔄 規劃中 |

### 🛠️ 06_development/ - 開發流程和工具
開發環境設定、流程規範和工具使用指南

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `README.md` | 開發流程文檔導航 | 📝 需建立 |
| `environment/README.md` | 開發環境設定總覽 | ✅ 已完成 |
| `environment/xcode_setup_guide.md` | Xcode 開發環境設定 | ✅ 已完成 |
| `user-flow-specification.md` | 用戶流程規格說明 | ✅ 已完成 |
| `file-organization-strategy.md` | 檔案組織策略 | ✅ 已完成 |
| `issues-tracking.md` | 問題追蹤系統使用 | ✅ 已完成 |

### 📋 07_planning/ - 規劃文檔
專案規劃、計劃和檢查相關文檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `README.md` | 規劃文檔導航 | 📝 需建立 |
| `api-specifications-completion-plan.md` | API 規格完成計劃 | ✅ 已完成 |
| `quick-consistency-check.md` | 快速一致性檢查 | ✅ 已完成 |

### 📦 archive/ - 歷史歸檔
舊版本或不再使用的文檔歸檔

| 文檔 | 內容 | 狀態 |
|------|------|------|
| `user-flow-specification-old.md` | 舊版用戶流程規格 | 📦 已歸檔 |

## 🔍 快速導航

### 🆕 新開發者入門路徑
1. 📖 **開始**: `01_architecture/tech-stack-decision.md` - 了解技術選型
2. 🏗️ **架構**: `01_architecture/database-schema.md` - 理解資料結構  
3. 🔌 **API**: `02_api/README.md` - 學習 API 規格
4. 💻 **前端**: `03_frontend/vue-frontend-architecture.md` - 前端開發指南
5. 🛠️ **環境**: `06_development/environment/README.md` - 設定開發環境

### 👨‍💻 前端開發者路徑
1. `03_frontend/vue-frontend-architecture.md` - 架構總覽
2. `03_frontend/vue-project-structure.md` - 專案結構
3. `03_frontend/vue-tools-configuration.md` - 工具配置
4. `03_frontend/vue-development-standards.md` - 開發規範
5. `02_api/api-specifications.md` - API 整合

### 🔧 後端開發者路徑
1. `01_architecture/database-schema.md` - 資料庫設計
2. `02_api/api-specifications.md` - API 總規格
3. `02_api/common.md` - 通用規範
4. `02_api/authentication.md` - 認證系統
5. 其他特定 API 文檔

### 📱 移動端開發者路徑
1. `04_mobile/flutter-architecture.md` - Flutter 架構
2. `04_mobile/flutter-integration.md` - 後端整合
3. `06_development/environment/xcode_setup_guide.md` - iOS 環境
4. `02_api/api-specifications.md` - API 整合

### 🚀 部署和運維路徑
1. `05_deployment/low-budget-deployment.md` - 基礎部署
2. `05_deployment/production-deployment.md` - 生產部署
3. `01_architecture/system-integration.md` - 系統整合
4. `07_planning/quick-consistency-check.md` - 檢查清單

## 📊 文檔完成度追蹤

### ✅ 已完成 (22/27)
- 架構文檔: 3/3
- API 文檔: 11/12  
- 前端文檔: 4/4
- 開發工具: 4/4

### 🔄 進行中 (2/27)
- 移動端文檔: 1/2
- 部署文檔: 1/2

### 📝 待建立 (3/27)
- 各分類的 README.md 導航文檔

## 🔧 維護指南

### 新增文檔時
1. 將文檔放在適當的分類目錄下
2. 更新對應分類的 README.md
3. 更新本總覽文檔的統計和表格
4. 確保文檔包含標準的元數據（建立日期、最後更新、狀態）

### 文檔審查週期
- **每週**: 檢查文檔狀態更新
- **每月**: 檢查文檔內容是否需要更新
- **版本發布前**: 全面檢查文檔的準確性和完整性

## 📞 聯繫資訊

**文檔維護者**: 技術團隊  
**最後審查**: 2025-09-09  
**下次審查**: 2025-09-16

---

> 💡 **提示**: 如果你是新加入的開發者，建議從「新開發者入門路徑」開始閱讀相關文檔。