docs: reorganize documentation structure

2026-03-05 13:48:13 +08:00
parent 349b0a754f
commit 104fa7e7c8
59 changed files with 22859 additions and 916 deletions
@@ -0,0 +1,386 @@
+# 健身房管理系统基础版产品设计文档（PRD）
+
+> 文档编号: GYM-PRD-BASIC-001  
+> 版本: v1.0  
+> 日期: 2026-03-04  
+> 作者: 张翔  
+> 状态: 初稿
+
+---
+
+## 文档修订历史
+
+| 版本 | 日期 | 作者 | 修订内容 |
+|------|------|------|---------|
+| v1.0 | 2026-03-04 | 张翔 | 初稿 |
+
+---
+
+## 一、产品概述
+
+### 1.1 产品背景
+
+随着健身行业数字化转型的加速，传统健身房面临着会员管理效率低、预约流程繁琐、数据统计困难等痛点。本系统基础版旨在为小型工作室、个人教练等提供核心的数字化管理平台，实现：
+
+- 会员端：一站式查看个人所有信息，便捷预约签到
+- 管理后台：基础数据整理与统计，支撑日常运营
+- 核心功能：保证业务闭环，满足基础运营需求
+
+### 1.2 产品目标
+
+| 目标维度 | 目标描述 | 成功指标 |
+|---------|---------|---------|
+| 用户体验 | 提升会员预约和签到体验 | 预约成功率 ≥ 95%，签到耗时 ≤ 3秒 |
+| 运营效率 | 降低人工操作成本 | 人工处理时间减少 50% |
+| 数据价值 | 提供基础数据支持 | 数据报表使用率 ≥ 80% |
+| 系统稳定 | 保证高可用性 | SLA ≥ 99.9% |
+
+### 1.3 适用场景
+
+- 小型工作室（1-5名教练）
+- 个人教练工作室
+- 社区健身房
+- 初创健身品牌
+
+### 1.4 产品定位
+
+基础版是健身房管理系统的核心版本，保证业务闭环，适合小型工作室、个人教练等场景，提供完整的会员管理、预约、签到等核心功能。
+
+---
+
+## 二、功能模块
+
+### 2.1 会员管理模块
+
+#### 2.1.1 会员注册
+
+**功能描述**：会员通过小程序或前台进行注册，填写基本信息。
+
+**用户故事**：作为一个新会员，我希望能够快速注册成为健身房会员，以便开始使用健身房服务。
+
+**功能点**：
+- 手机号注册（必填）
+- 姓名录入（必填）
+- 性别选择（必填）
+- 生日录入（选填）
+- 身高体重录入（选填）
+- 健身目标选择（选填）
+- 微信授权登录（可选）
+
+**业务规则**：
+- 手机号需验证唯一性
+- 手机号需通过短信验证码验证
+- 支持微信授权快速注册
+- 注册成功后自动创建会员档案
+
+**验收标准**：
+- 注册流程 ≤ 3步
+- 注册成功率 ≥ 95%
+- 验证码发送成功率 ≥ 98%
+
+#### 2.1.2 会员信息管理
+
+**功能描述**：会员查看和编辑个人信息，前台和店长可以管理会员信息。
+
+**功能点**：
+- 会员查看个人信息
+- 会员编辑个人信息
+- 前台查看会员信息
+- 前台编辑会员信息
+- 店长查看所有会员信息
+- 店长编辑会员信息
+
+**业务规则**：
+- 会员只能编辑自己的基本信息
+- 前台可以编辑会员的所有信息
+- 店长拥有最高权限
+- 关键信息修改需记录操作日志
+
+**验收标准**：
+- 信息更新实时生效
+- 操作日志记录完整
+
+#### 2.1.3 会员卡管理
+
+**功能描述**：会员购买和使用会员卡，管理会员卡权益。
+
+**功能点**：
+- 会员卡购买
+- 会员卡查看
+- 会员卡使用记录
+- 会员卡到期提醒
+- 会员卡续费
+
+**业务规则**：
+- 支持时长卡、次卡、储值卡
+- 会员卡到期前7天提醒
+- 会员卡续费后权益立即生效
+- 会员卡使用记录永久保存
+
+**验收标准**：
+- 会员卡购买成功率 ≥ 98%
+- 到期提醒发送成功率 ≥ 95%
+
+### 2.2 预约管理模块
+
+#### 2.2.1 团课预约
+
+**功能描述**：会员预约团课，查看课程信息，取消预约。
+
+**用户故事**：作为一个会员，我希望能够预约团课，以便参加我感兴趣的课程。
+
+**功能点**：
+- 团课列表展示
+- 团课详情查看
+- 团课预约
+- 团课取消预约
+- 预约记录查看
+- 预约提醒
+
+**业务规则**：
+- 预约需在课程开始前至少30分钟
+- 取消预约需在课程开始前至少2小时
+- 每节课最多20人
+- 预约成功后发送提醒
+- 预约成功后扣减权益
+
+**验收标准**：
+- 预约成功率 ≥ 95%
+- 预约取消成功率 ≥ 95%
+- 预约提醒发送成功率 ≥ 95%
+
+#### 2.2.2 团课管理
+
+**功能描述**：教练和店长管理团课，包括创建、编辑、取消团课。
+
+**功能点**：
+- 团课创建
+- 团课编辑
+- 团课取消
+- 团课列表查看
+- 团课详情查看
+- 团课签到管理
+
+**业务规则**：
+- 团课需指定教练、时间、地点
+- 团课取消需提前24小时通知
+- 团课取消后自动退款
+- 团课签到后记录考勤
+
+**验收标准**：
+- 团课创建成功率 ≥ 98%
+- 团课取消通知发送成功率 ≥ 95%
+
+### 2.3 签到管理模块
+
+#### 2.3.1 扫码签到
+
+**功能描述**：会员通过扫码进行签到，记录到店信息。
+
+**用户故事**：作为一个会员，我希望能够快速签到，以便记录我的到店信息。
+
+**功能点**：
+- 会员扫码签到
+- 签到成功提示
+- 签到记录查看
+- 签到失败处理
+
+**业务规则**：
+- 签到需验证会员卡有效性
+- 签到需验证预约信息（如有）
+- 签到成功后记录到店时间
+- 签到失败后提示原因
+
+**验收标准**：
+- 签到成功率 ≥ 98%
+- 签到耗时 ≤ 3秒
+
+#### 2.3.2 签到记录管理
+
+**功能描述**：前台和店长查看和管理签到记录。
+
+**功能点**：
+- 签到记录查看
+- 签到记录导出
+- 签到统计查看
+
+**业务规则**：
+- 签到记录永久保存
+- 支持按时间范围查询
+- 支持按会员查询
+
+**验收标准**：
+- 签到记录查询响应时间 ≤ 1秒
+
+### 2.4 数据统计模块
+
+#### 2.4.1 基础数据统计
+
+**功能描述**：店长查看基础运营数据，包括会员数据、预约数据、签到数据。
+
+**功能点**：
+- 会员数据统计
+- 预约数据统计
+- 签到数据统计
+- 数据导出
+
+**业务规则**：
+- 数据保留30天
+- 支持按日、周、月统计
+- 支持数据导出
+
+**验收标准**：
+- 数据统计准确率 ≥ 99%
+- 数据查询响应时间 ≤ 2秒
+
+### 2.5 系统管理模块
+
+#### 2.5.1 用户管理
+
+**功能描述**：超级管理员管理系统用户，包括创建、编辑、删除用户。
+
+**功能点**：
+- 用户创建
+- 用户编辑
+- 用户删除
+- 用户角色分配
+
+**业务规则**：
+- 用户需分配角色
+- 用户删除需确认
+- 用户密码需加密存储
+
+**验收标准**：
+- 用户创建成功率 ≥ 98%
+- 用户删除成功率 ≥ 98%
+
+#### 2.5.2 角色权限管理
+
+**功能描述**：超级管理员管理角色和权限，分配角色给用户。
+
+**功能点**：
+- 角色创建
+- 角色编辑
+- 角色删除
+- 权限分配
+- 角色分配
+
+**业务规则**：
+- 角色需分配权限
+- 角色删除需确认
+- 权限分配需最小化原则
+
+**验收标准**：
+- 权限控制准确率 100%
+
+---
+
+## 三、非功能需求
+
+### 3.1 性能需求
+
+| 指标 | 要求 |
+|------|------|
+| 响应时间 | API响应时间 ≤ 500ms |
+| 并发用户 | 支持100并发用户 |
+| 数据库查询 | 查询响应时间 ≤ 1s |
+
+### 3.2 可用性需求
+
+| 指标 | 要求 |
+|------|------|
+| 系统可用性 | SLA ≥ 99.9% |
+| 故障恢复时间 | MTTR ≤ 30分钟 |
+
+### 3.3 安全性需求
+
+| 指标 | 要求 |
+|------|------|
+| 数据加密 | 敏感数据加密存储 |
+| 访问控制 | 基于角色的访问控制 |
+| 操作审计 | 关键操作记录审计日志 |
+
+### 3.4 可扩展性需求
+
+| 指标 | 要求 |
+|------|------|
+| 会员数量 | 最多500人 |
+| 门店数量 | 单门店 |
+| 团课容量 | 每节课最多20人 |
+| 数据保留 | 保留30天 |
+
+---
+
+## 四、用户角色
+
+| 角色 | 描述 | 主要功能 |
+|------|------|---------|
+| 会员 | 健身房注册用户 | 预约课程、签到、查看个人信息 |
+| 教练 | 健身房教练 | 排课、团课签到管理 |
+| 前台 | 门店前台人员 | 会员接待、签到辅助、会员管理 |
+| 店长 | 门店管理者 | 单店全功能管理、数据查看 |
+| 超级管理员 | 平台最高权限 | 全平台管理、系统配置 |
+
+---
+
+## 五、业务流程
+
+### 5.1 会员注册流程
+
+```
+会员打开小程序 → 点击注册 → 填写手机号 → 验证手机号 → 填写基本信息 → 注册成功
+```
+
+### 5.2 团课预约流程
+
+```
+会员打开小程序 → 查看团课列表 → 选择团课 → 查看详情 → 确认预约 → 预约成功 → 接收提醒
+```
+
+### 5.3 签到流程
+
+```
+会员到店 → 扫描签到码 → 验证会员卡 → 签到成功 → 记录到店时间
+```
+
+---
+
+## 六、验收标准
+
+### 6.1 功能验收
+
+- 所有功能模块按需求实现
+- 业务规则正确执行
+- 用户流程顺畅
+
+### 6.2 性能验收
+
+- API响应时间 ≤ 500ms
+- 支持100并发用户
+- 数据库查询响应时间 ≤ 1s
+
+### 6.3 安全验收
+
+- 敏感数据加密存储
+- 访问控制正确实施
+- 操作审计日志完整
+
+---
+
+## 七、附录
+
+### 7.1 术语定义
+
+| 术语 | 定义 |
+|------|------|
+| 会员 | 在健身房注册的用户 |
+| 会员卡 | 会员购买的权益卡，包括时长卡、次卡、储值卡 |
+| 团课 | 集体课程，由教练带领多个会员一起上课 |
+| 预约 | 会员预约团课 |
+| 签到 | 会员到店记录 |
+
+### 7.2 参考文档
+
+- 《健身房管理系统产品设计文档》 GYM-PRD-001
+- 《健身房管理系统业务概要设计文档》 GYM-HLD-001
+- 《健身房管理系统详细设计文档》 GYM-LLD-000