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模版定制功能已完整同步到产品需求、概要设计、详细设计文档中
This commit is contained in:
张翔
+142
-92
@@ -10,8 +10,8 @@
|
||||
|
||||
## 文档修订历史
|
||||
|
||||
| 版本 | 日期 | 作者 | 修订内容 |
|
||||
| ---- | ---------- | ---- | ------------------ |
|
||||
| 版本 | 日期 | 作者 | 修订内容 |
|
||||
| ---- | ---------- | ---- | ---------------------- |
|
||||
| v1.0 | 2026-03-04 | 张翔 | 创建基础版业务概要设计 |
|
||||
|
||||
---
|
||||
@@ -32,19 +32,18 @@
|
||||
|
||||
### 1.3 术语定义
|
||||
|
||||
| 术语 | 定义 |
|
||||
| 术语 | 定义 |
|
||||
| ----------------------------- | ------------------------------------------------ |
|
||||
| 租户(Tenant) | 系统的多租户架构中的独立业务实体，如一个连锁品牌 |
|
||||
| 门店(Store) | 租户下的具体经营场所 |
|
||||
| 会员(Member) | 在门店注册的用户 |
|
||||
| 权益(Benefit) | 会员卡包含的时长、次数、储值、等级等权益 |
|
||||
| 可预约资源(Bookable Resource) | 团课等可被预约的对象 |
|
||||
| 时段(Slot) | 资源的可预约时间窗口 |
|
||||
| 租户(Tenant) | 系统的多租户架构中的独立业务实体，如一个连锁品牌 |
|
||||
| 门店(Store) | 租户下的具体经营场所 |
|
||||
| 会员(Member) | 在门店注册的用户 |
|
||||
| 权益(Benefit) | 会员卡包含的时长、次数、储值、等级等权益 |
|
||||
| 可预约资源(Bookable Resource) | 团课等可被预约的对象 |
|
||||
| 时段(Slot) | 资源的可预约时间窗口 |
|
||||
|
||||
### 1.4 参考文档
|
||||
|
||||
- 《健身房管理系统基础版产品设计文档》 GYM-PRD-BASIC-001
|
||||
- 《健身房管理系统业务概要设计文档》 GYM-HLD-001
|
||||
|
||||
---
|
||||
|
||||
@@ -52,21 +51,21 @@
|
||||
|
||||
### 2.1 业务目标
|
||||
|
||||
| 目标维度 | 目标描述 | 成功指标 |
|
||||
| 目标维度 | 目标描述 | 成功指标 |
|
||||
| -------- | ---------------------- | -------------------------------- |
|
||||
| 用户体验 | 提升会员预约和签到体验 | 预约成功率 ≥ 95%，签到耗时 ≤ 3秒 |
|
||||
| 运营效率 | 降低人工操作成本 | 人工处理时间减少 50% |
|
||||
| 数据价值 | 提供基础数据支持 | 数据报表使用率 ≥ 80% |
|
||||
| 运营效率 | 降低人工操作成本 | 人工处理时间减少 50% |
|
||||
| 数据价值 | 提供基础数据支持 | 数据报表使用率 ≥ 80% |
|
||||
|
||||
### 2.2 用户角色
|
||||
|
||||
| 角色 | 描述 | 主要功能 |
|
||||
| 角色 | 描述 | 主要功能 |
|
||||
| ---------- | -------------- | ---------------------------- |
|
||||
| 会员 | 健身房注册用户 | 预约课程、签到、查看个人信息 |
|
||||
| 教练 | 健身房教练 | 排课、团课签到管理 |
|
||||
| 前台 | 门店前台人员 | 会员接待、签到辅助、会员管理 |
|
||||
| 店长 | 门店管理者 | 单店全功能管理、数据查看 |
|
||||
| 超级管理员 | 平台最高权限 | 全平台管理、系统配置 |
|
||||
| 会员 | 健身房注册用户 | 预约课程、签到、查看个人信息 |
|
||||
| 教练 | 健身房教练 | 排课、团课签到管理 |
|
||||
| 前台 | 门店前台人员 | 会员接待、签到辅助、会员管理 |
|
||||
| 店长 | 门店管理者 | 单店全功能管理、数据查看 |
|
||||
| 超级管理员 | 平台最高权限 | 全平台管理、系统配置 |
|
||||
|
||||
### 2.3 业务范围
|
||||
|
||||
@@ -105,6 +104,12 @@
|
||||
│ │ • 用户管理 • 角色权限管理 │ │
|
||||
│ └─────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ UI模版定制 │ │
|
||||
│ ├─────────────────────────────────────────────────────────────────┤ │
|
||||
│ │ • 品牌定制 • 布局调整 • 预设模板 • 配置历史 │ │
|
||||
│ └─────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
@@ -136,11 +141,11 @@
|
||||
|
||||
#### 3.1.4 异常处理
|
||||
|
||||
| 异常场景 | 处理方式 |
|
||||
|---------|---------|
|
||||
| 异常场景 | 处理方式 |
|
||||
| ------------ | ---------------- |
|
||||
| 手机号已存在 | 提示用户直接登录 |
|
||||
| 验证码错误 | 提示用户重新输入 |
|
||||
| 验证码过期 | 提示用户重新获取 |
|
||||
| 验证码错误 | 提示用户重新输入 |
|
||||
| 验证码过期 | 提示用户重新获取 |
|
||||
|
||||
---
|
||||
|
||||
@@ -183,11 +188,11 @@
|
||||
|
||||
#### 3.2.4 异常处理
|
||||
|
||||
| 异常场景 | 处理方式 |
|
||||
|---------|---------|
|
||||
| 课程已满 | 提示用户选择其他课程 |
|
||||
| 会员卡权益不足 | 提示用户购买会员卡 |
|
||||
| 预约时间过短 | 提示用户提前预约 |
|
||||
| 异常场景 | 处理方式 |
|
||||
| -------------- | -------------------- |
|
||||
| 课程已满 | 提示用户选择其他课程 |
|
||||
| 会员卡权益不足 | 提示用户购买会员卡 |
|
||||
| 预约时间过短 | 提示用户提前预约 |
|
||||
|
||||
---
|
||||
|
||||
@@ -215,11 +220,11 @@
|
||||
|
||||
#### 3.3.4 异常处理
|
||||
|
||||
| 异常场景 | 处理方式 |
|
||||
|---------|---------|
|
||||
| 异常场景 | 处理方式 |
|
||||
| ---------- | ------------------ |
|
||||
| 会员卡无效 | 提示用户购买会员卡 |
|
||||
| 会员卡过期 | 提示用户续费 |
|
||||
| 签到码无效 | 提示用户重新扫描 |
|
||||
| 会员卡过期 | 提示用户续费 |
|
||||
| 签到码无效 | 提示用户重新扫描 |
|
||||
|
||||
---
|
||||
|
||||
@@ -247,56 +252,103 @@
|
||||
|
||||
#### 3.4.4 异常处理
|
||||
|
||||
| 异常场景 | 处理方式 |
|
||||
|---------|---------|
|
||||
| 支付失败 | 提示用户重新支付 |
|
||||
| 异常场景 | 处理方式 |
|
||||
| -------- | -------------------- |
|
||||
| 支付失败 | 提示用户重新支付 |
|
||||
| 支付超时 | 提示用户重新发起支付 |
|
||||
|
||||
---
|
||||
|
||||
### 3.5 UI模版定制流程
|
||||
|
||||
#### 3.5.1 业务场景
|
||||
|
||||
租户通过管理后台的可视化配置器定制自己的UI，包括品牌元素、布局结构和预设模板。
|
||||
|
||||
#### 3.5.2 业务流程
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│ 租户登录 │ → │ 打开UI │ → │ 品牌定制 │ → │ 布局调整 │ → │ 配置保存 │
|
||||
│ 管理后台 │ │ 定制器 │ │ │ │ │ │ │
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘
|
||||
```
|
||||
|
||||
#### 3.5.3 业务规则
|
||||
|
||||
- 品牌元素应用范围包括小程序和管理后台
|
||||
- 布局调整支持拖拽排序和模块隐藏
|
||||
- 预设模板应用后保留品牌配置
|
||||
- 配置变更实时生效，无需重新部署
|
||||
- 配置变更自动记录到历史
|
||||
|
||||
#### 3.5.4 异常处理
|
||||
|
||||
| 异常场景 | 处理方式 |
|
||||
| ------------ | -------------------- |
|
||||
| Logo上传失败 | 提示用户重新上传 |
|
||||
| 配置保存失败 | 提示用户检查配置格式 |
|
||||
| 模板应用失败 | 提示用户调整品牌配置 |
|
||||
| 配置回滚失败 | 提示用户选择其他版本 |
|
||||
|
||||
---
|
||||
|
||||
## 四、核心业务规则
|
||||
|
||||
### 4.1 会员管理规则
|
||||
|
||||
| 规则 | 描述 |
|
||||
|------|------|
|
||||
| 会员唯一性 | 手机号作为会员唯一标识 |
|
||||
| 会员信息完整性 | 必填字段：手机号、姓名、性别 |
|
||||
| 规则 | 描述 |
|
||||
| ---------------- | ------------------------------------------------------ |
|
||||
| 会员唯一性 | 手机号作为会员唯一标识 |
|
||||
| 会员信息完整性 | 必填字段：手机号、姓名、性别 |
|
||||
| 会员信息修改权限 | 会员只能编辑自己的基本信息，前台和店长可以编辑所有信息 |
|
||||
|
||||
### 4.2 会员卡管理规则
|
||||
|
||||
| 规则 | 描述 |
|
||||
|------|------|
|
||||
| 会员卡类型 | 支持时长卡、次卡、储值卡 |
|
||||
| 会员卡有效期 | 时长卡有有效期，次卡和储值卡无有效期 |
|
||||
| 会员卡到期提醒 | 到期前7天提醒 |
|
||||
| 会员卡续费 | 续费后权益立即生效 |
|
||||
| 规则 | 描述 |
|
||||
| -------------- | ------------------------------------ |
|
||||
| 会员卡类型 | 支持时长卡、次卡、储值卡 |
|
||||
| 会员卡有效期 | 时长卡有有效期，次卡和储值卡无有效期 |
|
||||
| 会员卡到期提醒 | 到期前7天提醒 |
|
||||
| 会员卡续费 | 续费后权益立即生效 |
|
||||
|
||||
### 4.3 预约管理规则
|
||||
|
||||
| 规则 | 描述 |
|
||||
|------|------|
|
||||
| 预约时间限制 | 预约需在课程开始前至少30分钟 |
|
||||
| 规则 | 描述 |
|
||||
| ---------------- | ------------------------------- |
|
||||
| 预约时间限制 | 预约需在课程开始前至少30分钟 |
|
||||
| 取消预约时间限制 | 取消预约需在课程开始前至少2小时 |
|
||||
| 团课容量限制 | 每节课最多20人 |
|
||||
| 预约权益扣减 | 预约成功后扣减权益 |
|
||||
| 团课容量限制 | 每节课最多20人 |
|
||||
| 预约权益扣减 | 预约成功后扣减权益 |
|
||||
|
||||
### 4.4 签到管理规则
|
||||
|
||||
| 规则 | 描述 |
|
||||
|------|------|
|
||||
| 签到验证 | 签到需验证会员卡有效性 |
|
||||
| 规则 | 描述 |
|
||||
| ------------ | -------------------------- |
|
||||
| 签到验证 | 签到需验证会员卡有效性 |
|
||||
| 签到预约验证 | 签到需验证预约信息（如有） |
|
||||
| 签到记录 | 签到成功后记录到店时间 |
|
||||
| 签到记录 | 签到成功后记录到店时间 |
|
||||
|
||||
### 4.5 数据统计规则
|
||||
|
||||
| 规则 | 描述 |
|
||||
|------|------|
|
||||
| 数据保留期限 | 数据保留30天 |
|
||||
| 统计维度 | 支持按日、周、月统计 |
|
||||
| 数据导出 | 支持数据导出 |
|
||||
| 规则 | 描述 |
|
||||
| ------------ | -------------------- |
|
||||
| 数据保留期限 | 数据保留30天 |
|
||||
| 统计维度 | 支持按日、周、月统计 |
|
||||
| 数据导出 | 支持数据导出 |
|
||||
|
||||
### 4.6 UI模版定制规则
|
||||
|
||||
| 规则 | 描述 |
|
||||
| ------------ | ------------------------------------------ |
|
||||
| 品牌元素应用 | 品牌元素应用范围包括小程序和管理后台 |
|
||||
| Logo格式限制 | Logo支持PNG/JPG格式，限制2MB以内 |
|
||||
| 颜色格式限制 | 颜色支持RGB和HEX格式 |
|
||||
| 布局调整权限 | 布局调整支持按角色区分（店长、前台、会员） |
|
||||
| 模板应用规则 | 模板应用后保留租户已有的品牌配置 |
|
||||
| 配置版本管理 | 每次配置变更自动生成新版本号 |
|
||||
| 配置历史保留 | 配置历史保留90天 |
|
||||
| 配置实时生效 | 配置变更实时生效，无需重新部署 |
|
||||
|
||||
---
|
||||
|
||||
@@ -397,14 +449,14 @@
|
||||
|
||||
### 6.1 核心实体
|
||||
|
||||
| 实体 | 描述 |
|
||||
|------|------|
|
||||
| 会员(Member) | 健身房注册用户 |
|
||||
| 实体 | 描述 |
|
||||
| ------------------ | ---------------- |
|
||||
| 会员(Member) | 健身房注册用户 |
|
||||
| 会员卡(MemberCard) | 会员购买的权益卡 |
|
||||
| 权益(Benefit) | 会员卡包含的权益 |
|
||||
| 团课(GroupClass) | 集体课程 |
|
||||
| 预约(Booking) | 会员预约记录 |
|
||||
| 签到(CheckIn) | 会员签到记录 |
|
||||
| 权益(Benefit) | 会员卡包含的权益 |
|
||||
| 团课(GroupClass) | 集体课程 |
|
||||
| 预约(Booking) | 会员预约记录 |
|
||||
| 签到(CheckIn) | 会员签到记录 |
|
||||
|
||||
### 6.2 实体关系
|
||||
|
||||
@@ -422,36 +474,35 @@
|
||||
|
||||
### 7.1 性能约束
|
||||
|
||||
| 指标 | 要求 |
|
||||
|------|------|
|
||||
| API响应时间 (P99) | 200-400ms |
|
||||
| 并发用户 | 支持1000并发用户 |
|
||||
| 吞吐量 (QPS) | 3000-5000 |
|
||||
| 数据库查询 | 查询响应时间 ≤ 500ms |
|
||||
| 指标 | 要求 |
|
||||
| ----------------- | ----------------- |
|
||||
| API响应时间 (P99) | ≤ 500ms |
|
||||
| 并发用户 | 支持100并发用户 |
|
||||
| 数据库查询 | 查询响应时间 ≤ 1s |
|
||||
|
||||
### 7.2 可用性约束
|
||||
|
||||
| 指标 | 要求 |
|
||||
|------|------|
|
||||
| 系统可用性 | SLA ≥ 99.9% |
|
||||
| 指标 | 要求 |
|
||||
| ------------ | ------------- |
|
||||
| 系统可用性 | SLA ≥ 99.9% |
|
||||
| 故障恢复时间 | MTTR ≤ 30分钟 |
|
||||
|
||||
### 7.3 安全性约束
|
||||
|
||||
| 指标 | 要求 |
|
||||
|------|------|
|
||||
| 数据加密 | 敏感数据加密存储 |
|
||||
| 访问控制 | 基于角色的访问控制 |
|
||||
| 指标 | 要求 |
|
||||
| -------- | -------------------- |
|
||||
| 数据加密 | 敏感数据加密存储 |
|
||||
| 访问控制 | 基于角色的访问控制 |
|
||||
| 操作审计 | 关键操作记录审计日志 |
|
||||
|
||||
### 7.4 可扩展性约束
|
||||
|
||||
| 指标 | 要求 |
|
||||
|------|------|
|
||||
| 会员数量 | 最多500人 |
|
||||
| 门店数量 | 单门店 |
|
||||
| 指标 | 要求 |
|
||||
| -------- | -------------- |
|
||||
| 会员数量 | 最多500人 |
|
||||
| 门店数量 | 单门店 |
|
||||
| 团课容量 | 每节课最多20人 |
|
||||
| 数据保留 | 保留30天 |
|
||||
| 数据保留 | 保留30天 |
|
||||
|
||||
---
|
||||
|
||||
@@ -459,16 +510,15 @@
|
||||
|
||||
### 8.1 术语定义
|
||||
|
||||
| 术语 | 定义 |
|
||||
|------|------|
|
||||
| 会员 | 在健身房注册的用户 |
|
||||
| 术语 | 定义 |
|
||||
| ------ | ------------------------------------------ |
|
||||
| 会员 | 在健身房注册的用户 |
|
||||
| 会员卡 | 会员购买的权益卡，包括时长卡、次卡、储值卡 |
|
||||
| 权益 | 会员卡包含的时长、次数、储值、等级等权益 |
|
||||
| 团课 | 集体课程，由教练带领多个会员一起上课 |
|
||||
| 预约 | 会员预约团课 |
|
||||
| 签到 | 会员到店记录 |
|
||||
| 权益 | 会员卡包含的时长、次数、储值、等级等权益 |
|
||||
| 团课 | 集体课程，由教练带领多个会员一起上课 |
|
||||
| 预约 | 会员预约团课 |
|
||||
| 签到 | 会员到店记录 |
|
||||
|
||||
### 8.2 参考文档
|
||||
|
||||
- 《健身房管理系统基础版产品设计文档》 GYM-PRD-BASIC-001
|
||||
- 《健身房管理系统业务概要设计文档》 GYM-HLD-001
|
||||
|
||||
Reference in New Issue
Block a user