# 武术评分系统 - 项目文档

## 📚 文档目录

本目录包含武术评分系统的完整项目文档，帮助开发者快速了解项目结构、功能设计和API接口。

---

## 📖 文档列表

### 1. [项目概述](./项目概述.md)

**内容概要**:
- 项目基本信息
- 核心功能介绍
- 技术架构
- 项目结构
- 页面流程
- 色彩系统
- 运行和部署说明
- 后续扩展建议

**适合人群**: 项目管理者、新加入的开发者、产品经理

---

### 2. [页面功能说明](./页面功能说明.md)

**内容概要**:
- 所有页面总览
- 登录页详细说明
- 评分列表页详细说明
- 评分详情页详细说明
- 多场地列表页详细说明
- 修改评分页详细说明
- 页面间跳转关系
- 页面共同特性

**适合人群**: 前端开发者、UI设计师、测试工程师

**关键信息**:
- 5个页面的完整功能说明
- 每个页面需要对接的API接口
- 页面数据结构
- 交互逻辑说明

---

### 3. [API接口设计](./API接口设计.md)

**内容概要**:
- 接口规范和通用格式
- 9大功能模块的完整API接口
  - 认证模块（3个接口）
  - 比赛信息模块（1个接口）
  - 场地管理模块（1个接口）
  - 项目管理模块（2个接口）
  - 选手管理模块（3个接口）
  - 评分管理模块（4个接口）
  - 扣分项管理模块（1个接口）
  - 统计分析模块（2个接口）
  - 实时推送模块（WebSocket）
- 接口调用示例（JavaScript）
- 接口安全建议
- 性能优化建议
- 环境配置

**适合人群**: 后端开发者、前端开发者、接口对接人员

**关键信息**:
- 共计17个REST API接口
- 完整的请求参数和响应格式
- 错误处理规范
- WebSocket推送协议

---

### 4. [数据结构设计](./数据结构设计.md)

**内容概要**:
- 17个核心数据结构定义（TypeScript）
- 用户角色相关（3个）
- 比赛相关（1个）
- 场地相关（2个）
- 项目相关（2个）
- 选手相关（3个）
- 评分相关（4个）
- 评分修改相关（2个）
- 扣分项相关（2个）
- 统计分析相关（3个）
- 前端页面数据结构（5个）
- 全局数据结构（1个）
- WebSocket推送数据结构（3个）
- 分页数据结构（2个）
- 数据验证规则
- 枚举类型汇总
- 数据关系图
- 数据存储建议

**适合人群**: 前端开发者、后端开发者、数据库设计人员

**关键信息**:
- 完整的TypeScript类型定义
- 数据关系说明
- 数据验证规则
- 前后端数据格式统一

---

### 5. [功能模块划分](./功能模块划分.md)

**内容概要**:
- 10大功能模块详细说明
  1. 用户认证模块
  2. 比赛信息模块
  3. 场地管理模块
  4. 项目管理模块
  5. 选手管理模块
  6. 评分管理模块（普通评委）
  7. 评分修改模块（裁判长）
  8. 扣分项管理模块
  9. 统计分析模块
  10. 实时推送模块
- 每个模块的核心功能
- 涉及的页面和API接口
- 数据结构
- 业务规则
- 权限说明
- 模块依赖关系
- 开发优先级建议
- 模块测试要点

**适合人群**: 项目经理、开发团队、测试团队

**关键信息**:
- 模块化的功能设计
- 开发优先级（3个阶段）
- 模块依赖关系图
- 完整的测试要点

---

## 🎯 快速导航

### 我是项目管理者

**推荐阅读顺序**:
1. [项目概述](./项目概述.md) - 了解项目整体情况
2. [功能模块划分](./功能模块划分.md) - 了解功能模块和开发计划
3. [页面功能说明](./页面功能说明.md) - 了解页面功能需求

### 我是前端开发者

**推荐阅读顺序**:
1. [项目概述](./项目概述.md) - 了解技术栈
2. [页面功能说明](./页面功能说明.md) - 了解页面需求
3. [数据结构设计](./数据结构设计.md) - 了解数据格式
4. [API接口设计](./API接口设计.md) - 了解如何对接API

### 我是后端开发者

**推荐阅读顺序**:
1. [项目概述](./项目概述.md) - 了解项目背景
2. [功能模块划分](./功能模块划分.md) - 了解业务逻辑
3. [API接口设计](./API接口设计.md) - 实现API接口
4. [数据结构设计](./数据结构设计.md) - 设计数据库

### 我是UI/UX设计师

**推荐阅读顺序**:
1. [项目概述](./项目概述.md) - 了解色彩系统和设计规范
2. [页面功能说明](./页面功能说明.md) - 了解页面需求和交互

### 我是测试工程师

**推荐阅读顺序**:
1. [页面功能说明](./页面功能说明.md) - 了解功能需求
2. [功能模块划分](./功能模块划分.md) - 了解测试要点
3. [API接口设计](./API接口设计.md) - 了解接口规范

---

## 📊 项目数据统计

### 页面统计
- **总页面数**: 5个
- **普通评委页面**: 3个（登录页、评分列表页、评分详情页）
- **裁判长页面**: 3个（登录页、多场地列表页、修改评分页）

### 功能模块统计
- **功能模块数**: 10个
- **已完成模块**: 8个
- **待开发模块**: 2个（统计分析、实时推送）

### API接口统计
- **REST API接口数**: 17个
- **WebSocket接口**: 1个
- **认证相关**: 3个
- **业务相关**: 14个

### 数据结构统计
- **核心数据结构**: 17个
- **页面数据结构**: 5个
- **推送数据结构**: 3个
- **枚举类型**: 6个

### 代码统计
- **总代码行数**: 约3000行
- **Vue页面**: 5个
- **配置文件**: 7个
- **文档文件**: 5个

---

## 🔧 技术栈

### 前端技术
- **框架**: UniApp + Vue.js 2.x
- **样式**: CSS3 + SCSS
- **UI**: UniApp原生组件
- **状态管理**: getApp().globalData
- **路由**: UniApp内置路由

### 支持平台
- 微信小程序
- H5

### 开发工具
- HBuilderX（推荐）
- VS Code + uni-cli

---

## 📝 版本历史

### v1.0.0 (2025-06-25)
- ✅ 完成5个页面的UI开发
- ✅ 完成角色区分（pub/admin）
- ✅ 完成评分功能（精度0.001）
- ✅ 完成扣分项多选
- ✅ 完成场地和项目切换
- ✅ 完成评分修改功能
- ✅ 完成项目文档

### 待开发功能
- ❌ 后端API对接
- ❌ 真实数据存储
- ❌ 用户身份持久化
- ❌ 实时数据同步
- ❌ 离线支持
- ❌ 数据统计和导出

---

## 👥 团队协作

### 前端开发

**工作内容**:
1. 阅读[页面功能说明](./页面功能说明.md)
2. 阅读[数据结构设计](./数据结构设计.md)
3. 根据现有页面进行功能完善
4. 对接后端API接口

**需要对接**:
- 与后端确认API接口格式
- 与UI设计师确认页面样式

### 后端开发

**工作内容**:
1. 阅读[API接口设计](./API接口设计.md)
2. 阅读[数据结构设计](./数据结构设计.md)
3. 设计数据库表结构
4. 实现API接口

**需要对接**:
- 与前端确认数据格式
- 与测试确认接口规范

### 测试工程师

**工作内容**:
1. 阅读[功能模块划分](./功能模块划分.md)中的测试要点
2. 编写测试用例
3. 进行功能测试和接口测试

**需要对接**:
- 与开发确认测试环境
- 与产品确认验收标准

---

## 🚀 开发建议

### 第一阶段（核心功能） - 2-3周

**任务**:
1. 搭建后端框架
2. 实现用户认证API
3. 实现评分相关API
4. 前端对接API
5. 完成基础功能测试

**产出**:
- 可用的登录功能
- 可用的评分功能
- 可用的评分修改功能

### 第二阶段（管理功能） - 1-2周

**任务**:
1. 实现场地和项目管理API
2. 实现选手管理API
3. 完善权限控制
4. 前端对接API
5. 完成功能测试

**产出**:
- 完整的裁判长功能
- 完整的权限控制

### 第三阶段（增强功能） - 2-3周

**任务**:
1. 实现统计分析功能
2. 实现WebSocket实时推送
3. 实现数据导出功能
4. 性能优化
5. 完成全面测试

**产出**:
- 完整的统计分析
- 实时数据更新
- 数据导出功能

---

## 📞 联系方式

如有疑问，请联系项目负责人。

---

## 📄 文档维护

**文档版本**: v1.0.0
**最后更新**: 2025-06-25
**维护人员**: 开发团队

**更新记录**:
- 2025-06-25: 创建初始文档

---

## ⚠️ 注意事项

1. 所有文档中的示例数据均为Mock数据
2. 实际开发时请根据后端返回的真实数据进行调整
3. API接口地址需要根据实际环境配置
4. 所有涉及安全的功能（登录、Token等）需要严格测试
5. 评分精度必须保证为0.001，不可有误差

---

## 📚 相关资源

- [UniApp官方文档](https://uniapp.dcloud.io/)
- [Vue.js官方文档](https://cn.vuejs.org/)
- [项目GitHub地址]() - 待添加
- [设计原型](../image/) - 查看设计图

---

**祝开发顺利！** 🎉