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,474 @@
+# 健身房管理系统基础版业务概要设计文档（HLD）
+
+> 文档编号: GYM-HLD-BASIC-001  
+> 版本: v1.0  
+> 日期: 2026-03-04  
+> 作者: 张翔  
+> 状态: 初稿
+
+---
+
+## 文档修订历史
+
+| 版本 | 日期 | 作者 | 修订内容 |
+| ---- | ---------- | ---- | ------------------ |
+| v1.0 | 2026-03-04 | 张翔 | 创建基础版业务概要设计 |
+
+---
+
+## 一、引言
+
+### 1.1 编写目的
+
+本文档为健身房管理系统基础版的业务概要设计文档（High-Level Design），旨在：
+
+1. 从业务层面描述基础版的业务范围、业务流程、业务规则
+2. 为基础版详细设计提供业务指导和约束
+3. 作为产品经理、业务分析师、开发人员的业务参考
+
+### 1.2 项目背景
+
+健身房管理系统基础版是面向小型工作室、个人教练等场景的核心版本，保证业务闭环，提供完整的会员管理、预约、签到等核心功能。
+
+### 1.3 术语定义
+
+| 术语 | 定义 |
+| ----------------------------- | ------------------------------------------------ |
+| 租户(Tenant) | 系统的多租户架构中的独立业务实体，如一个连锁品牌 |
+| 门店(Store) | 租户下的具体经营场所 |
+| 会员(Member) | 在门店注册的用户 |
+| 权益(Benefit) | 会员卡包含的时长、次数、储值、等级等权益 |
+| 可预约资源(Bookable Resource) | 团课等可被预约的对象 |
+| 时段(Slot) | 资源的可预约时间窗口 |
+
+### 1.4 参考文档
+
+- 《健身房管理系统基础版产品设计文档》 GYM-PRD-BASIC-001
+- 《健身房管理系统业务概要设计文档》 GYM-HLD-001
+
+---
+
+## 二、业务概述
+
+### 2.1 业务目标
+
+| 目标维度 | 目标描述 | 成功指标 |
+| -------- | ---------------------- | -------------------------------- |
+| 用户体验 | 提升会员预约和签到体验 | 预约成功率 ≥ 95%，签到耗时 ≤ 3秒 |
+| 运营效率 | 降低人工操作成本 | 人工处理时间减少 50% |
+| 数据价值 | 提供基础数据支持 | 数据报表使用率 ≥ 80% |
+
+### 2.2 用户角色
+
+| 角色 | 描述 | 主要功能 |
+| ---------- | -------------- | ---------------------------- |
+| 会员 | 健身房注册用户 | 预约课程、签到、查看个人信息 |
+| 教练 | 健身房教练 | 排课、团课签到管理 |
+| 前台 | 门店前台人员 | 会员接待、签到辅助、会员管理 |
+| 店长 | 门店管理者 | 单店全功能管理、数据查看 |
+| 超级管理员 | 平台最高权限 | 全平台管理、系统配置 |
+
+### 2.3 业务范围
+
+```
+┌─────────────────────────────────────────────────────────────────────────┐
+│                          基础版业务范围                              │
+├─────────────────────────────────────────────────────────────────────────┤
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐   │
+│  │ 会员管理                                                  │   │
+│  ├─────────────────────────────────────────────────────────────────┤   │
+│  │ • 会员注册  • 会员卡管理  • 权益管理                   │   │
+│  └─────────────────────────────────────────────────────────────────┘   │
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐   │
+│  │ 预约管理                                                  │   │
+│  ├─────────────────────────────────────────────────────────────────┤   │
+│  │ • 团课预约  • 团课管理                                  │   │
+│  └─────────────────────────────────────────────────────────────────┘   │
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐   │
+│  │ 签到管理                                                  │   │
+│  ├─────────────────────────────────────────────────────────────────┤   │
+│  │ • 扫码签到  • 签到记录管理                              │   │
+│  └─────────────────────────────────────────────────────────────────┘   │
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐   │
+│  │ 数据统计                                                  │   │
+│  ├─────────────────────────────────────────────────────────────────┤   │
+│  │ • 基础数据统计                                        │   │
+│  └─────────────────────────────────────────────────────────────────┘   │
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐   │
+│  │ 系统管理                                                  │   │
+│  ├─────────────────────────────────────────────────────────────────┤   │
+│  │ • 用户管理  • 角色权限管理                              │   │
+│  └─────────────────────────────────────────────────────────────────┘   │
+│                                                                         │
+└─────────────────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## 三、核心业务流程
+
+### 3.1 会员注册流程
+
+#### 3.1.1 业务场景
+
+新用户通过小程序或前台进行注册，成为健身房会员。
+
+#### 3.1.2 业务流程
+
+```
+┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐
+│ 用户打开 │ →  │ 填写手机 │ →  │ 验证手机 │ →  │ 填写基本 │ →  │ 注册成功 │
+│ 小程序   │    │ 号       │    │ 号       │    │ 信息     │    │         │
+└─────────┘    └─────────┘    └─────────┘    └─────────┘    └─────────┘
+```
+
+#### 3.1.3 业务规则
+
+- 手机号需验证唯一性
+- 手机号需通过短信验证码验证
+- 支持微信授权快速注册
+- 注册成功后自动创建会员档案
+
+#### 3.1.4 异常处理
+
+| 异常场景 | 处理方式 |
+|---------|---------|
+| 手机号已存在 | 提示用户直接登录 |
+| 验证码错误 | 提示用户重新输入 |
+| 验证码过期 | 提示用户重新获取 |
+
+---
+
+### 3.2 团课预约流程
+
+#### 3.2.1 业务场景
+
+会员通过小程序预约团课，教练通过管理后台创建团课。
+
+#### 3.2.2 业务流程
+
+**会员预约团课**：
+
+```
+┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐
+│ 会员打开 │ →  │ 查看团课 │ →  │ 选择团课 │ →  │ 确认预约 │ →  │ 预约成功 │
+│ 小程序   │    │ 列表     │    │          │    │          │    │         │
+└─────────┘    └─────────┘    └─────────┘    └─────────┘    └─────────┘
+```
+
+**教练创建团课**：
+
+```
+┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐
+│ 教练打开 │ →  │ 点击创建 │ →  │ 填写团课 │ →  │ 发布团课 │ →  │ 发布成功 │
+│ 管理后台 │    │ 团课     │    │ 信息     │    │          │    │         │
+└─────────┘    └─────────┘    └─────────┘    └─────────┘    └─────────┘
+```
+
+#### 3.2.3 业务规则
+
+- 预约需在课程开始前至少30分钟
+- 取消预约需在课程开始前至少2小时
+- 每节课最多20人
+- 预约成功后发送提醒
+- 预约成功后扣减权益
+- 团课需指定教练、时间、地点
+- 团课取消需提前24小时通知
+- 团课取消后自动退款
+
+#### 3.2.4 异常处理
+
+| 异常场景 | 处理方式 |
+|---------|---------|
+| 课程已满 | 提示用户选择其他课程 |
+| 会员卡权益不足 | 提示用户购买会员卡 |
+| 预约时间过短 | 提示用户提前预约 |
+
+---
+
+### 3.3 签到流程
+
+#### 3.3.1 业务场景
+
+会员到店后通过扫码进行签到，记录到店信息。
+
+#### 3.3.2 业务流程
+
+```
+┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐
+│ 会员到店 │ →  │ 扫描签到 │ →  │ 验证会员 │ →  │ 签到成功 │ →  │ 记录到店 │
+│          │    │ 码       │    │ 卡       │    │          │    │ 时间     │
+└─────────┘    └─────────┘    └─────────┘    └─────────┘    └─────────┘
+```
+
+#### 3.3.3 业务规则
+
+- 签到需验证会员卡有效性
+- 签到需验证预约信息（如有）
+- 签到成功后记录到店时间
+- 签到失败后提示原因
+
+#### 3.3.4 异常处理
+
+| 异常场景 | 处理方式 |
+|---------|---------|
+| 会员卡无效 | 提示用户购买会员卡 |
+| 会员卡过期 | 提示用户续费 |
+| 签到码无效 | 提示用户重新扫描 |
+
+---
+
+### 3.4 会员卡购买流程
+
+#### 3.4.1 业务场景
+
+会员通过小程序购买会员卡，获得相应权益。
+
+#### 3.4.2 业务流程
+
+```
+┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐
+│ 会员打开 │ →  │ 查看会员 │ →  │ 选择会员 │ →  │ 确认购买 │ →  │ 购买成功 │
+│ 小程序   │    │ 卡列表   │    │ 卡       │    │          │    │         │
+└─────────┘    └─────────┘    └─────────┘    └─────────┘    └─────────┘
+```
+
+#### 3.4.3 业务规则
+
+- 支持时长卡、次卡、储值卡
+- 会员卡到期前7天提醒
+- 会员卡续费后权益立即生效
+- 会员卡使用记录永久保存
+
+#### 3.4.4 异常处理
+
+| 异常场景 | 处理方式 |
+|---------|---------|
+| 支付失败 | 提示用户重新支付 |
+| 支付超时 | 提示用户重新发起支付 |
+
+---
+
+## 四、核心业务规则
+
+### 4.1 会员管理规则
+
+| 规则 | 描述 |
+|------|------|
+| 会员唯一性 | 手机号作为会员唯一标识 |
+| 会员信息完整性 | 必填字段：手机号、姓名、性别 |
+| 会员信息修改权限 | 会员只能编辑自己的基本信息，前台和店长可以编辑所有信息 |
+
+### 4.2 会员卡管理规则
+
+| 规则 | 描述 |
+|------|------|
+| 会员卡类型 | 支持时长卡、次卡、储值卡 |
+| 会员卡有效期 | 时长卡有有效期，次卡和储值卡无有效期 |
+| 会员卡到期提醒 | 到期前7天提醒 |
+| 会员卡续费 | 续费后权益立即生效 |
+
+### 4.3 预约管理规则
+
+| 规则 | 描述 |
+|------|------|
+| 预约时间限制 | 预约需在课程开始前至少30分钟 |
+| 取消预约时间限制 | 取消预约需在课程开始前至少2小时 |
+| 团课容量限制 | 每节课最多20人 |
+| 预约权益扣减 | 预约成功后扣减权益 |
+
+### 4.4 签到管理规则
+
+| 规则 | 描述 |
+|------|------|
+| 签到验证 | 签到需验证会员卡有效性 |
+| 签到预约验证 | 签到需验证预约信息（如有） |
+| 签到记录 | 签到成功后记录到店时间 |
+
+### 4.5 数据统计规则
+
+| 规则 | 描述 |
+|------|------|
+| 数据保留期限 | 数据保留30天 |
+| 统计维度 | 支持按日、周、月统计 |
+| 数据导出 | 支持数据导出 |
+
+---
+
+## 五、业务场景
+
+### 5.1 会员注册场景
+
+**场景描述**：
+新用户张三通过小程序注册成为健身房会员。
+
+**业务流程**：
+
+1. 张三打开小程序
+2. 点击注册
+3. 填写手机号
+4. 验证手机号
+5. 填写基本信息（姓名、性别、生日、身高体重、健身目标）
+6. 注册成功
+7. 自动创建会员档案
+
+**涉及的业务规则**：
+
+- 手机号需验证唯一性
+- 手机号需通过短信验证码验证
+- 注册成功后自动创建会员档案
+
+---
+
+### 5.2 团课预约场景
+
+**场景描述**：
+会员李四通过小程序预约团课。
+
+**业务流程**：
+
+1. 李四打开小程序
+2. 查看团课列表
+3. 选择团课
+4. 查看详情
+5. 确认预约
+6. 预约成功
+7. 接收提醒
+
+**涉及的业务规则**：
+
+- 预约需在课程开始前至少30分钟
+- 取消预约需在课程开始前至少2小时
+- 每节课最多20人
+- 预约成功后发送提醒
+- 预约成功后扣减权益
+
+---
+
+### 5.3 签到场景
+
+**场景描述**：
+会员王五到店后通过扫码进行签到。
+
+**业务流程**：
+
+1. 王五到店
+2. 扫描签到码
+3. 验证会员卡
+4. 签到成功
+5. 记录到店时间
+
+**涉及的业务规则**：
+
+- 签到需验证会员卡有效性
+- 签到需验证预约信息（如有）
+- 签到成功后记录到店时间
+- 签到失败后提示原因
+
+---
+
+### 5.4 会员卡购买场景
+
+**场景描述**：
+会员赵六通过小程序购买会员卡。
+
+**业务流程**：
+
+1. 赵六打开小程序
+2. 查看会员卡列表
+3. 选择会员卡
+4. 确认购买
+5. 购买成功
+
+**涉及的业务规则**：
+
+- 支持时长卡、次卡、储值卡
+- 会员卡到期前7天提醒
+- 会员卡续费后权益立即生效
+
+---
+
+## 六、数据模型
+
+### 6.1 核心实体
+
+| 实体 | 描述 |
+|------|------|
+| 会员(Member) | 健身房注册用户 |
+| 会员卡(MemberCard) | 会员购买的权益卡 |
+| 权益(Benefit) | 会员卡包含的权益 |
+| 团课(GroupClass) | 集体课程 |
+| 预约(Booking) | 会员预约记录 |
+| 签到(CheckIn) | 会员签到记录 |
+
+### 6.2 实体关系
+
+```
+会员(Member) ──1:N── 会员卡(MemberCard)
+会员(Member) ──1:N── 预约(Booking)
+会员(Member) ──1:N── 签到(CheckIn)
+会员卡(MemberCard) ──1:N── 权益(Benefit)
+团课(GroupClass) ──1:N── 预约(Booking)
+```
+
+---
+
+## 七、技术约束
+
+### 7.1 性能约束
+
+| 指标 | 要求 |
+|------|------|
+| API响应时间 (P99) | 200-400ms |
+| 并发用户 | 支持1000并发用户 |
+| 吞吐量 (QPS) | 3000-5000 |
+| 数据库查询 | 查询响应时间 ≤ 500ms |
+
+### 7.2 可用性约束
+
+| 指标 | 要求 |
+|------|------|
+| 系统可用性 | SLA ≥ 99.9% |
+| 故障恢复时间 | MTTR ≤ 30分钟 |
+
+### 7.3 安全性约束
+
+| 指标 | 要求 |
+|------|------|
+| 数据加密 | 敏感数据加密存储 |
+| 访问控制 | 基于角色的访问控制 |
+| 操作审计 | 关键操作记录审计日志 |
+
+### 7.4 可扩展性约束
+
+| 指标 | 要求 |
+|------|------|
+| 会员数量 | 最多500人 |
+| 门店数量 | 单门店 |
+| 团课容量 | 每节课最多20人 |
+| 数据保留 | 保留30天 |
+
+---
+
+## 八、附录
+
+### 8.1 术语定义
+
+| 术语 | 定义 |
+|------|------|
+| 会员 | 在健身房注册的用户 |
+| 会员卡 | 会员购买的权益卡，包括时长卡、次卡、储值卡 |
+| 权益 | 会员卡包含的时长、次数、储值、等级等权益 |
+| 团课 | 集体课程，由教练带领多个会员一起上课 |
+| 预约 | 会员预约团课 |
+| 签到 | 会员到店记录 |
+
+### 8.2 参考文档
+
+- 《健身房管理系统基础版产品设计文档》 GYM-PRD-BASIC-001
+- 《健身房管理系统业务概要设计文档》 GYM-HLD-001