162 lines
6.0 KiB
Markdown
162 lines
6.0 KiB
Markdown
# 📚 文檔指南
|
||
|
||
本文檔提供 Drama Ling 專案文檔結構的完整說明。
|
||
|
||
## 📁 目錄結構
|
||
|
||
```
|
||
docs/
|
||
├── 00_starter/ # 專案初始化和模板
|
||
├── 01_requirement/ # 專案需求和規格說明
|
||
├── design/ # 設計和使用者體驗文檔
|
||
├── technical/ # 技術架構和規格說明
|
||
├── development/ # 開發指南和工作流程
|
||
└── README.md # 本文件 - 文檔總覽
|
||
```
|
||
|
||
---
|
||
|
||
## 📂 目錄詳細說明
|
||
|
||
### 🚀 `/00_starter` - 專案基礎
|
||
**用途**: 包含專案初始化和AI輔助開發所使用的基礎模板和提示詞。
|
||
|
||
| 檔案名稱 | 用途 |
|
||
|------|---------|
|
||
| `CLAUDE_TEMPLATE.md` | Claude AI 互動模板和專案設置 |
|
||
| `READ.md` | 使用入門模板的說明指引 |
|
||
| `business_function_design_prompt.md` | 生成業務功能設計的 AI 提示詞 |
|
||
| `generate_requirements_prompt.md` | 創建專案需求的 AI 提示詞 |
|
||
| `generate_system_structure_prompt.md` | 系統架構生成的 AI 提示詞 |
|
||
| `system_detail_prompt.md` | 詳細系統規格的 AI 提示詞 |
|
||
| `system_structured_schema.json` | 結構化系統設計輸出的 JSON 架構 |
|
||
|
||
**使用時機**: 這些檔案主要在專案初始化時使用，以及與 AI 助手協作生成文檔和程式碼結構時使用。
|
||
|
||
---
|
||
|
||
### 📋 `/01_requirement` - 專案需求
|
||
**用途**: 包含核心專案需求、規格說明和系統設計文檔。
|
||
|
||
| 檔案名稱 | 用途 |
|
||
|------|---------|
|
||
| `founding_pitch.md` | 初始專案提案和商業案例 |
|
||
| `requirements.md` | **主要需求文檔** - 詳細的產品規格、功能和使用者故事 |
|
||
| `system_structure_design.json` | **結構化系統設計** - 從需求生成，包含模組、功能和UI視圖的JSON格式 |
|
||
|
||
**關鍵文檔**: `requirements.md` 是產品應該做什麼以及如何運作的唯一真實來源。
|
||
|
||
---
|
||
|
||
### 🎨 `/design` - 設計規格
|
||
**用途**: 涵蓋使用者體驗、視覺設計和互動模式的文檔。
|
||
|
||
| 檔案名稱 | 用途 |
|
||
|------|---------|
|
||
| `ai-algorithm-specs.md` | AI 分析演算法和語言處理規格 |
|
||
| `business-logic-rules.md` | 核心商業規則和邏輯流程定義 |
|
||
| `content-management-specs.md` | 內容創建、策劃和管理工作流程 |
|
||
| `gamification-mechanics.md` | 遊戲元素、成就和獎勵系統設計 |
|
||
| `ui-ux-guidelines.md` | 視覺設計標準、組件庫和使用者介面指南 |
|
||
|
||
**目標讀者**: 設計師、前端開發人員和產品經理。
|
||
|
||
---
|
||
|
||
### ⚙️ `/technical` - 技術架構
|
||
**用途**: 技術實作細節、系統架構和整合規格說明。
|
||
|
||
| 檔案名稱 | 用途 |
|
||
|------|---------|
|
||
| `api-specifications.md` | **REST API 文檔** - 端點、請求/回應格式、認證 |
|
||
| `database-schema.md` | 資料庫設計、資料表、關聯和資料模型 |
|
||
| `flutter-dotnet-integration.md` | Flutter 前端與 .NET Core 後端的整合指南 |
|
||
| `tech-stack-decision.md` | 技術選擇、理由和架構決策 |
|
||
|
||
**關鍵文檔**: `api-specifications.md` 作為前端和後端團隊之間的契約。
|
||
|
||
---
|
||
|
||
### 👨💻 `/development` - 開發指南
|
||
**用途**: 為開發人員提供編碼標準、工作流程和專案路線圖的指南。
|
||
|
||
| 檔案名稱 | 用途 |
|
||
|------|---------|
|
||
| `coding-standards.md` | Flutter/Dart 和 .NET/C# 的程式碼風格指南、命名慣例和最佳實踐 |
|
||
| `development-workflow.md` | Git 工作流程、分支策略、程式碼審查流程和開發生命週期 |
|
||
| `project-roadmap.md` | **開發時程表** - 階段、里程碑和功能交付時程 |
|
||
|
||
**目標讀者**: 所有參與專案的開發人員。
|
||
|
||
---
|
||
|
||
## 🎯 如何使用這個文檔
|
||
|
||
### 新團隊成員
|
||
1. **從這裡開始**: 閱讀這個 `README.md` 文檔總覽
|
||
2. **了解產品**: 閱讀 `/01_requirement/requirements.md`
|
||
3. **學習技術棧**: 查看 `/technical/tech-stack-decision.md`
|
||
4. **遵循開發流程**: 學習 `/development/development-workflow.md`
|
||
5. **遵守編碼標準**: 查看 `/development/coding-standards.md`
|
||
|
||
### 前端開發人員
|
||
- 主要文檔: `/design/ui-ux-guidelines.md`, `/technical/flutter-dotnet-integration.md`
|
||
- API 契約: `/technical/api-specifications.md`
|
||
- 編碼標準: `/development/coding-standards.md`
|
||
|
||
### 後端開發人員
|
||
- 主要文檔: `/technical/api-specifications.md`, `/technical/database-schema.md`
|
||
- 整合指南: `/technical/flutter-dotnet-integration.md`
|
||
- 商業邏輯: `/design/business-logic-rules.md`
|
||
|
||
### 產品經理
|
||
- 主要文檔: `/01_requirement/requirements.md`, `/development/project-roadmap.md`
|
||
- 設計規格: `/design/` 目錄下的所有檔案
|
||
- 進度追蹤: `/development/project-roadmap.md`
|
||
|
||
### 設計師
|
||
- 主要文檔: `/design/ui-ux-guidelines.md`, `/design/gamification-mechanics.md`
|
||
- 內容策略: `/design/content-management-specs.md`
|
||
|
||
---
|
||
|
||
## 🔄 文檔維護
|
||
|
||
### 何時更新
|
||
- **需求變更**: 更新 `/01_requirement/requirements.md` 並重新生成 `system_structure_design.json`
|
||
- **API 變更**: 更新 `/technical/api-specifications.md`
|
||
- **設計更新**: 更新 `/design/` 目錄中相關檔案
|
||
- **新功能**: 更新 `/development/project-roadmap.md` 中的路線圖
|
||
|
||
### 責任歸屬
|
||
- **產品團隊**: `/01_requirement/` 和 `/design/` 目錄
|
||
- **工程團隊**: `/technical/` 和 `/development/` 目錄
|
||
- **AI/DevOps**: `/00_starter/` 目錄（模板維護）
|
||
|
||
---
|
||
|
||
## 🔍 快速參考
|
||
|
||
| 尋找... | 前往... |
|
||
|----------------|----------|
|
||
| 要建構什麼功能 | `/01_requirement/requirements.md` |
|
||
| API 端點和資料格式 | `/technical/api-specifications.md` |
|
||
| 資料庫結構 | `/technical/database-schema.md` |
|
||
| UI 設計標準 | `/design/ui-ux-guidelines.md` |
|
||
| 如何貢獻程式碼 | `/development/development-workflow.md` |
|
||
| 開發時程表 | `/development/project-roadmap.md` |
|
||
| 系統架構 | `/01_requirement/system_structure_design.json` |
|
||
|
||
---
|
||
|
||
## 📞 技術支援
|
||
|
||
如果您需要任何文檔的說明：
|
||
- 📧 Email: dev@dramaling.com
|
||
- 💬 Slack: #dev-support
|
||
- 📱 Issues: [GitHub Issues](https://github.com/JettCheng/DramaLingApp/issues)
|
||
|
||
---
|
||
|
||
**最後更新**: 2025-01-05
|
||
**版本**: 1.0.0 |