Files
gym-manage/docs/product/PRD-基础版产品设计文档.md
T
张翔 971d51cb36 feat: 同步UI模版定制功能到PRD、HLD、LLD文档
PRD更新:
- 新增2.6 UI模版定制模块
- 包含品牌定制、布局调整、预设模板、配置历史、可视化配置器五个子模块
- 每个子模块包含功能描述、用户故事、功能点、业务规则、验收标准

HLD更新:
- 业务范围中新增UI模版定制模块
- 新增3.5 UI模版定制流程(业务场景、业务流程、业务规则、异常处理)
- 新增4.6 UI模版定制规则(品牌元素应用、Logo格式限制、颜色格式限制等8条规则)

LLD更新:
- 新增2.6 UI模版定制模块(模块概述、数据模型设计、核心业务逻辑)
- 数据模型包含4个表:tenant_ui_config、ui_template、ui_config_history、ui_resource
- 核心业务逻辑包含4个Service:BrandConfigService、LayoutConfigService、TemplateService、ConfigHistoryService
- 新增3.5 UI模版定制模块API(10个API接口,涵盖品牌定制、布局调整、模板管理、配置历史)

所有文档已保持一致性,UI模版定制功能已完整同步到产品需求、概要设计、详细设计文档中
2026-03-07 16:59:32 +08:00

517 lines
13 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 健身房管理系统基础版产品设计文档(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%
---
### 2.6 UI模版定制模块
#### 2.6.1 品牌定制
**功能描述**:租户通过可视化配置器定制品牌元素,包括Logo、颜色、背景图等。
**用户故事**:作为一个租户,我希望能够上传自己的Logo和设置品牌颜色,以便在系统中展示我的品牌特色。
**功能点**
- Logo上传(支持拖拽上传、自动裁剪、多尺寸缩略图)
- 品牌主色调设置(颜色选择器、预设色板)
- 品牌辅助色设置
- 背景图上传(支持轮播背景)
- 品牌名称和Slogan设置
- 实时预览所有品牌元素
**业务规则**
- Logo支持PNG/JPG格式,限制2MB以内
- 颜色支持RGB和HEX格式
- 品牌元素应用范围包括小程序和管理后台
- 配置变更实时生效,无需重新部署
**验收标准**
- Logo上传成功率 ≥ 95%
- 实时预览响应时间 ≤ 200ms
- 品牌元素应用一致性 100%
#### 2.6.2 布局调整
**功能描述**:租户通过拖拽式界面调整页面模块的显示顺序和布局结构。
**用户故事**:作为一个租户,我希望能够调整页面的模块顺序和隐藏不需要的功能,以便优化用户体验。
**功能点**
- 模块顺序调整(拖拽排序)
- 模块隐藏/显示开关
- 首页布局类型选择(卡片式、列表式、轮播式)
- 导航菜单自定义(添加/编辑/删除菜单项)
- 模块分组管理
- 批量操作(全选、反选、批量隐藏)
- 布局调整撤销/重做
**业务规则**
- 模块顺序调整支持跨区域移动
- 隐藏的模块不显示但数据保留
- 布局调整按角色区分(店长、前台、会员)
- 布局变更自动保存到配置历史
**验收标准**
- 拖拽操作流畅度 ≥ 90%
- 布局变更响应时间 ≤ 300ms
- 模块隐藏成功率 100%
#### 2.6.3 预设模板
**功能描述**:系统提供3-5个精心设计的预设模板,租户可以直接选择并应用。
**用户故事**:作为一个租户,我希望能够从预设模板中选择适合我的模板,快速完成UI定制。
**功能点**
- 模板预览(缩略图、大图预览)
- 模板类型筛选(简约、运动、科技、高端)
- 一键应用模板
- 模板收藏功能
- 模板对比功能(并排对比、差异高亮)
- 模板应用前确认对话框
- 模板预览模式(正式应用前预览效果)
**业务规则**
- 模板应用后保留租户已有的品牌配置
- 模板支持版本控制和灰度发布
- 模板切换支持配置合并
- 禁用的模板不可选择
**验收标准**
- 模板加载成功率 ≥ 98%
- 模板应用成功率 ≥ 95%
- 模板切换响应时间 ≤ 500ms
#### 2.6.4 配置历史
**功能描述**:记录租户的配置变更历史,支持配置回滚和对比。
**用户故事**:作为一个租户,我希望能够查看配置变更历史,并在需要时回滚到之前的配置。
**功能点**
- 配置历史列表查看
- 配置版本对比(新旧配置差异)
- 配置回滚到历史版本
- 配置导出(JSON文件)
- 配置导入(从JSON文件恢复)
- 变更原因记录
**业务规则**
- 每次配置变更自动生成新版本号
- 配置历史保留90天
- 回滚操作需要确认
- 配置对比高亮显示差异
**验收标准**
- 配置保存成功率 ≥ 99%
- 配置回滚成功率 ≥ 98%
- 配置对比准确性 100%
#### 2.6.5 可视化配置器
**功能描述**:提供直观的可视化配置界面,降低租户定制UI的技术门槛。
**用户故事**:作为一个租户,我希望通过可视化的拖拽界面来定制UI,而不需要编写代码。
**功能点**
- 三区域布局(品牌配置区、布局配置区、模板选择区)
- 拖拽式模块排序
- 实时预览(支持多设备尺寸切换)
- 智能提示(颜色搭配建议、Logo尺寸建议、模板推荐)
- 快捷操作(一键重置、一键预览、一键保存、一键发布)
- 配置导出/导入
**业务规则**
- 所有配置变更实时反映在预览区
- 预览区模拟真实页面结构
- 拖拽操作提供视觉反馈
- 配置器支持键盘快捷键
**验收标准**
- 配置器加载时间 ≤ 1秒
- 实时预览延迟 ≤ 100ms
- 拖拽操作流畅度 ≥ 95%
---
## 三、非功能需求
### 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-HLD-BASIC-001
- 《健身房管理系统基础版详细设计文档》 GYM-LLD-BASIC-001