novalon/gym-manage

Fork 0

Files

T

张翔 08a265ac52 docs: 归档 HLD-技术架构设计文档，整合到 T-ILD 体系

2026-03-08 21:30:47 +08:00

28 KiB

Raw Blame History

健身房管理系统文档清单

文档编号: GYM-DOC-LIST-001
版本：v1.8
日期: 2026-03-08
作者: 张翔
状态: 完成

文档修订历史

版本	日期	作者	修订内容
v1.0	2026-03-05	张翔	创建文档清单
v1.1	2026-03-07	张翔	更新文档清单，补充智能获客工具和智能体测数据联动模块内容
v1.2	2026-03-07	张翔	更新文档状态为"已发布"，修复定价信息不一致问题
v1.3	2026-03-07	张翔	修复文档状态不一致问题，补充 UI 模版定制功能，更新产品介绍手册定价信息
v1.4	2026-03-08	张翔	修复并发用户数不一致问题，统一文档状态为"正式发布"，统一文档日期为 2026-03-04
v1.5	2026-03-08	张翔	完成文档架构优化，实现业务设计和技术设计分离，新增 BLD 和 TLD 文档，归档 HLD 文档
v1.6	2026-03-08	张翔	完成文档架构优化，实现业务概要设计（B-HLD）、业务详细设计（B-LLD）、技术实现详细设计（T-ILD）三层架构
v1.7	2026-03-08	张翔	删除过时的模块 LLD 文档，内容已整合到 T-ILD 文档中
v1.8	2026-03-08	张翔	归档 HLD-技术架构设计文档，内容整合到 T-ILD 文档体系

一、文档概述

本文档列出了健身房管理系统项目的所有文档，包括产品需求文档、设计文档、模块文档、计划文档、客户文档和归档文档。文档按类型和版本进行分类，便于查找和管理。

1.1 文档分类

产品需求文档（PRD）: 描述产品功能需求和用户故事
业务概要设计文档（B-HLD）: 描述业务范围、核心业务流程、业务规则
业务详细设计文档（B-LLD）: 描述详细业务流程、业务数据流转、业务指标
技术实现详细设计文档（T-ILD）: 描述系统架构、技术选型、实现细节
高层设计文档（HLD）: 描述系统架构和业务流程（已废弃，由B-HLD和T-ILD替代）
详细设计文档（LLD）: 描述技术实现细节（已废弃，由T-ILD替代）
计划文档: 描述项目计划和设计方案
客户文档: 面向客户的产品介绍文档
归档文档: 历史版本文档
部署运维文档: 系统部署和运维指南

1.2 文档编号规则

PRD文档: GYM-PRD-{VERSION}-001
B-HLD文档: GYM-B-HLD-{VERSION}-001
B-LLD文档: GYM-B-LLD-{VERSION}-001
T-ILD文档: GYM-T-ILD-{VERSION}-001
HLD文档: GYM-HLD-{VERSION}-001（已废弃）
LLD文档: GYM-LLD-{VERSION}-001（已废弃）
审查报告: GYM-DOC-REVIEW-001
文档清单: GYM-DOC-LIST-001

1.3 文档状态管理

文档状态流转遵循以下规范：

状态	说明	可转换状态
初稿	文档创建阶段，内容可能不完整	评审中、已发布
评审中	文档正在评审，内容基本完整	已发布、初稿
已发布	文档已通过评审，可正式使用	已归档
已归档	文档已过时，仅作历史记录	-

状态更新规则：

新建文档默认状态为"初稿"
文档内容完整后，提交评审，状态更新为"评审中"
评审通过后，状态更新为"已发布"
文档被新版本替代后，旧版本状态更新为"已归档"

二、产品需求文档（PRD）

2.1 基础版PRD

属性	值
文档编号	GYM-PRD-BASIC-001
文档名称	健身房管理系统基础版产品设计文档
文件路径	docs/product/PRD-基础版产品设计文档.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已发布
适用版本	基础版

内容概要:

产品概述和定位
功能模块（会员管理、预约管理、签到管理、数据统计、系统管理）
用户故事和验收标准
业务规则和约束

依赖文档:

GYM-B-HLD-BASIC-001
GYM-T-ILD-BASIC-001

2.2 付费订阅版PRD

属性	值
文档编号	GYM-PRD-SUBSCRIPTION-001
文档名称	健身房管理系统付费订阅版产品设计文档
文件路径	docs/product/PRD-付费订阅版产品设计文档.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已发布
适用版本	付费订阅版

内容概要:

产品概述和定位
订阅模块体系（业务扩展类、体验升级类、营销增长类、数据智能类）
功能模块和用户故事
业务规则和验收标准

依赖文档:

GYM-B-HLD-SUBSCRIPTION-001
GYM-T-ILD-SUBSCRIPTION-001

三、业务概要设计文档（B-HLD）

3.1 基础版B-HLD

属性	值
文档编号	GYM-B-HLD-BASIC-001
文档名称	健身房管理系统基础版业务概要设计文档
文件路径	docs/design/B-HLD-基础版-业务概要设计.md
版本	v1.0
日期	2026-03-08
作者	张翔
状态	已发布
适用版本	基础版

内容概要:

业务概述和用户角色
业务范围和核心业务流程
业务规则和异常处理（包含规则+示例格式）
用户角色和权限

参考文档:

GYM-PRD-BASIC-001

被参考文档:

GYM-B-LLD-BASIC-001
GYM-T-ILD-BASIC-001

3.2 付费订阅版B-HLD

属性	值
文档编号	GYM-B-HLD-SUBSCRIPTION-001
文档名称	健身房管理系统付费订阅版业务概要设计文档
文件路径	docs/design/B-HLD-付费订阅版-业务概要设计.md
版本	v1.0
日期	2026-03-08
作者	张翔
状态	已发布
适用版本	付费订阅版

内容概要:

业务概述和用户角色
业务范围和核心业务流程
订阅流程和配置继承流程
业务规则和异常处理

参考文档:

GYM-PRD-SUBSCRIPTION-001

被参考文档:

GYM-B-LLD-SUBSCRIPTION-001
GYM-T-ILD-SUBSCRIPTION-001

四、业务详细设计文档（B-LLD）

4.1 基础版B-LLD

属性	值
文档编号	GYM-B-LLD-BASIC-001
文档名称	健身房管理系统基础版业务详细设计文档
文件路径	docs/design/B-LLD-基础版-业务详细设计.md
版本	v1.0
日期	2026-03-08
作者	张翔
状态	已发布
适用版本	基础版

内容概要:

详细业务流程
业务数据流转
业务指标
业务规则补充

参考文档:

GYM-PRD-BASIC-001
GYM-B-HLD-BASIC-001

被参考文档:

GYM-T-ILD-BASIC-001

4.2 付费订阅版B-LLD

属性	值
文档编号	GYM-B-LLD-SUBSCRIPTION-001
文档名称	健身房管理系统付费订阅版业务详细设计文档
文件路径	docs/design/B-LLD-付费订阅版-业务详细设计.md
版本	v1.0
日期	2026-03-08
作者	张翔
状态	已发布
适用版本	付费订阅版

内容概要:

详细业务流程
业务数据流转
业务指标
业务规则补充

参考文档:

GYM-PRD-SUBSCRIPTION-001
GYM-B-HLD-SUBSCRIPTION-001

被参考文档:

GYM-T-ILD-SUBSCRIPTION-001

五、技术实现详细设计文档（T-ILD）

5.1 基础版T-ILD

属性	值
文档编号	GYM-T-ILD-BASIC-001
文档名称	健身房管理系统基础版技术实现详细设计文档
文件路径	docs/design/T-ILD-基础版-技术实现详细设计.md
版本	v1.0
日期	2026-03-08
作者	张翔
状态	已发布
适用版本	基础版

内容概要:

架构决策和技术选型
系统架构设计（分层架构、模块化设计）
响应式编程架构
数据库设计（表结构、索引）
API接口设计
部署架构
监控与运维
安全设计
测试策略

参考文档:

GYM-PRD-BASIC-001
GYM-B-HLD-BASIC-001
GYM-B-LLD-BASIC-001

5.2 付费订阅版T-ILD

属性	值
文档编号	GYM-T-ILD-SUBSCRIPTION-001
文档名称	健身房管理系统付费订阅版技术实现详细设计文档
文件路径	docs/design/T-ILD-付费订阅版-技术实现详细设计.md
版本	v1.0
日期	2026-03-08
作者	张翔
状态	已发布
适用版本	付费订阅版

内容概要:

系统架构设计（分层架构、模块化设计）
订阅与配置模块设计
业务扩展模块设计（私教管理、场地预约、线上课程）
体验升级模块设计（人脸识别签到、NFC签到、智能储物柜）
营销增长模块设计（营销活动、会员推荐奖励、会员互动社区、智能获客工具）
数据智能模块设计（营销精算模型、自定义促销预测、高级数据分析、智能体测数据联动）

参考文档:

GYM-PRD-SUBSCRIPTION-001
GYM-B-HLD-SUBSCRIPTION-001
GYM-B-LLD-SUBSCRIPTION-001

六、高层设计文档（HLD）

6.1 技术架构 HLD（已归档）

属性	值
文档编号	GYM-HLD-TECH-001
文档名称	健身房管理系统技术架构设计文档
文件路径	docs/design/HLD-技术架构设计.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已归档（内容已整合到 T-ILD 文档）
归档日期	2026-03-08
归档原因	文档架构优化，技术架构内容整合到 T-ILD 文档体系

参考文档:

GYM-T-ILD-BASIC-001
GYM-T-ILD-SUBSCRIPTION-001

6.2 基础版 HLD

属性	值
文档编号	GYM-HLD-BASIC-001
文档名称	健身房管理系统基础版业务概要设计文档
文件路径	docs/design/HLD-基础版系统概要设计.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已归档
适用版本	基础版

注意: 本文档已被 B-HLD 和 T-ILD 文档替代，仅作历史记录。

内容概要:

业务概述和用户角色
业务范围和核心业务流程
业务规则和异常处理
系统架构设计

参考文档:

GYM-PRD-BASIC-001

被参考文档:

GYM-B-HLD-BASIC-001（已替代）
GYM-B-LLD-BASIC-001（已替代）
GYM-T-ILD-BASIC-001（已替代）

6.3 付费订阅版 HLD

属性	值
文档编号	GYM-HLD-SUBSCRIPTION-001
文档名称	健身房管理系统付费订阅版业务概要设计文档
文件路径	docs/design/HLD-付费订阅版系统概要设计.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已归档
适用版本	付费订阅版

注意: 本文档已被 B-HLD 和 T-ILD 文档替代，仅作历史记录。

内容概要:

业务概述和用户角色
业务范围和核心业务流程
订阅流程和配置继承流程
业务规则和异常处理

参考文档:

GYM-PRD-SUBSCRIPTION-001

被参考文档:

GYM-B-HLD-SUBSCRIPTION-001（已替代）
GYM-B-LLD-SUBSCRIPTION-001（已替代）
GYM-T-ILD-SUBSCRIPTION-001（已替代）

七、详细设计文档（LLD）

7.1 基础版 LLD

属性	值
文档编号	GYM-LLD-BASIC-001
文档名称	健身房管理系统基础版详细设计文档
文件路径	docs/design/LLD-基础版系统详细设计.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已归档
适用版本	基础版

注意: 本文档已被T-ILD文档替代，仅作历史记录。

内容概要:

系统架构设计（分层架构、模块化设计）
技术架构（前端、后端、部署）
模块设计（会员模块、预约模块、签到模块、数据模块、系统模块）
数据模型设计
API设计
业务逻辑实现

参考文档:

GYM-PRD-BASIC-001
GYM-HLD-BASIC-001

被参考文档:

GYM-T-ILD-BASIC-001（已替代）

7.2 付费订阅版 LLD

属性	值
文档编号	GYM-LLD-SUBSCRIPTION-002
文档名称	健身房管理系统付费订阅版详细设计文档
文件路径	docs/design/LLD-付费订阅版系统详细设计.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	已归档
适用版本	付费订阅版

注意: 本文档已被T-ILD文档替代，仅作历史记录。

内容概要:

系统架构设计（分层架构、模块化设计）
订阅与配置模块设计
业务扩展模块设计（私教管理、场地预约、线上课程）
体验升级模块设计（人脸识别签到、NFC签到、智能储物柜）
营销增长模块设计（营销活动、会员推荐奖励、会员互动社区、智能获客工具）
数据智能模块设计（营销精算模型、自定义促销预测、高级数据分析、智能体测数据联动）

参考文档:

GYM-PRD-SUBSCRIPTION-001
GYM-HLD-SUBSCRIPTION-001

被参考文档:

GYM-T-ILD-SUBSCRIPTION-001（已替代）

九、计划文档

9.1 系统设计计划

属性	值
文档编号	-
文档名称	健身房管理系统设计
文件路径	docs/plans/2026-02-28-gym-manage-design.md
版本	-
日期	2026-02-28
作者	-
状态	需更新

内容概要:

系统设计方案
功能模块设计
数据模型设计
接口设计

注意: 本文档包含2024年的过时日期，需要更新为2026年。

十、客户文档

10.1 产品介绍手册

属性	值
文档编号	-
文档名称	健身房管理系统产品介绍手册
文件路径	docs/customer/产品介绍手册.md
版本	-
日期	-
作者	-
状态	正常

内容概要:

产品介绍
功能特性
版本对比
价格信息（已替换为¥XXX）

十一、归档文档

11.1 历史PRD文档

属性	值
文档编号	GYM-PRD-001
文档名称	健身房管理系统产品设计文档
文件路径	docs/archive/v1.0/PRD-产品设计文档.md
版本	-
日期	-
作者	-
状态	归档

注意: 本文档为历史版本，已被基础版和付费订阅版PRD替代。

11.2 历史HLD文档

属性	值
文档编号	GYM-HLD-001
文档名称	健身房管理系统业务概要设计文档
文件路径	docs/archive/v1.0/HLD-系统概要设计.md
版本	-
日期	-
作者	-
状态	归档

注意: 本文档为历史版本，已被基础版和付费订阅版HLD替代。

十二、部署运维文档

12.1 部署运维指南

属性	值
文档编号	-
文档名称	部署运维文档
文件路径	docs/design/OPS-部署运维文档.md
版本	-
日期	-
作者	-
状态	需更新

内容概要:

系统部署
运维管理
监控告警
备份恢复

注意: 本文档包含2024年的过时日期，需要更新为当前日期。

十三、审查和管理文档

13.1 文档审查报告

属性	值
文档编号	GYM-DOC-REVIEW-001
文档名称	健身房管理系统文档审查报告
文件路径	docs/文档审查报告.md
版本	v1.0
日期	2026-03-05
作者	张翔
状态	完成

内容概要:

文档审查概述
各类文档审查结果
文档间引用关系分析
过时/冗余内容识别
改进建议和行动计划

13.2 文档清单

属性	值
文档编号	GYM-DOC-LIST-001
文档名称	健身房管理系统文档清单
文件路径	docs/文档清单.md
版本	v1.6
日期	2026-03-08
作者	张翔
状态	完成

内容概要:

所有文档的完整列表
文档分类和编号规则
文档依赖关系
文档状态和注意事项

13.3 文档管理规范

属性	值
文档编号	GYM-DOC-STANDARD-001
文档名称	健身房管理系统文档管理规范
文件路径	docs/文档管理规范.md
版本	v1.0
日期	2026-03-04
作者	张翔
状态	正式发布

内容概要:

文档编号规则
文档版本管理
文档引用规范
文档更新规范
文档审查机制
文档归档规范
文档质量标准
文档安全规范
文档协作规范

十四、文档依赖关系图

┌─────────────────────────────────────────────────────────────────────────┐
│                        文档依赖关系                                    │
├─────────────────────────────────────────────────────────────────────────┤
│                                                                         │
│  ┌─────────────────────────────────────────────────────────────────┐   │
│  │ 产品需求文档（PRD）                                          │   │
│  ├─────────────────────────────────────────────────────────────────┤   │
│  │ GYM-PRD-BASIC-001 ──────┐                                     │   │
│  │ GYM-PRD-SUBSCRIPTION-001 ─┼───→ 业务概要设计文档（B-HLD）     │   │
│  └───────────────────────────┘                                     │   │
│                              │                                       │   │
│                              ▼                                       │   │
│  ┌─────────────────────────────────────────────────────────────────┐   │
│  │ 业务概要设计文档（B-HLD）                                    │   │
│  ├─────────────────────────────────────────────────────────────────┤   │
│  │ GYM-B-HLD-BASIC-001 ───────┐                                 │   │
│  │ GYM-B-HLD-SUBSCRIPTION-001 ─┼───→ 业务详细设计文档（B-LLD）  │   │
│  └────────────────────────────┘                                 │   │
│                              │                                       │   │
│                              ▼                                       │   │
│  ┌─────────────────────────────────────────────────────────────────┐   │
│  │ 业务详细设计文档（B-LLD）                                    │   │
│  ├─────────────────────────────────────────────────────────────────┤   │
│  │ GYM-B-LLD-BASIC-001 ───────┐                                 │   │
│  │ GYM-B-LLD-SUBSCRIPTION-001 ─┼───→ 技术实现详细设计文档（T-ILD）│   │
│  └────────────────────────────┘                                 │   │
│                              │                                       │   │
│                              ▼                                       │   │
│  ┌─────────────────────────────────────────────────────────────────┐   │
│  │ 技术实现详细设计文档（T-ILD）                                │   │
│  ├─────────────────────────────────────────────────────────────────┤   │
│  │ GYM-T-ILD-BASIC-001                                         │   │
│  │ GYM-T-ILD-SUBSCRIPTION-001                                  │   │
│  └─────────────────────────────────────────────────────────────────┘   │
│                                                                         │
└─────────────────────────────────────────────────────────────────────────┘

十五、文档状态汇总

文档类型	总数	已发布	需更新	归档
产品需求文档（PRD）	2	2	0	0
业务概要设计文档（B-HLD）	2	2	0	0
业务详细设计文档（B-LLD）	2	2	0	0
技术实现详细设计文档（T-ILD）	2	2	0	0
高层设计文档（HLD）	2	0	0	2
详细设计文档（LLD）	2	0	0	2
计划文档	1	1	0	0
客户文档	1	1	0	0
归档文档	2	0	0	2
部署运维文档	1	0	1	0
审查和管理文档	3	3	0	0
总计	21	16	1	4

十六、注意事项

15.1 文档管理规范

已创建文档管理规范，包含：

文档编号规则
文档版本管理
文档引用规范
文档更新规范
文档审查机制
文档归档规范
文档质量标准
文档安全规范
文档协作规范

15.2 文档架构优化

已完成文档架构优化，实现业务设计和技术设计分离：

新增BLD文档 ✅ 已完成
- 创建GYM-BLD-BASIC-001业务设计文档
- 包含完整的业务流程、业务规则（规则+示例格式）
- 聚焦业务层面，便于产品经理和业务分析师使用
新增TLD文档 ✅ 已完成
- 创建GYM-TLD-BASIC-001技术设计文档
- 包含系统架构、技术选型、数据库设计、API设计
- 聚焦技术层面，便于架构师和开发工程师使用
归档HLD文档 ✅ 已完成
- 将GYM-HLD-BASIC-001标记为已归档
- 保留历史记录，但不再作为主要参考文档
更新文档清单 ✅ 已完成
- 添加BLD和TLD文档条目
- 更新文档分类和编号规则
- 更新文档依赖关系图
- 更新文档状态汇总

15.3 已完成的修复

所有P0和P1优先级的修复任务已完成：

文档引用关系修复 ✅ 已完成
- ~~移除对GYM-PRD-001、GYM-HLD-001、GYM-LLD-000的引用~~
- ~~更新为正确的文档编号~~
- 修复说明：经核实，核心文档（PRD、HLD、LLD）中的引用关系均为正确编号，无需修改。文档审查报告中的引用关系表格已更新为正确状态。
过时日期更新 ✅ 已完成
- ~~计划文档：2024年日期更新为2026年~~
- ~~部署运维文档：2024年日期更新为2026年~~
- 修复说明：经核实，计划文档和部署运维文档中不存在2024年日期，文档日期均为2026年，无需修改。
文档状态不一致修复 ✅ 已完成
- ~~核心文档状态标记为"初稿"~~
- 修复说明：已将所有核心文档（PRD、HLD、LLD）的状态从"初稿"更新为"已发布"，与文档清单保持一致。
UI模版定制功能补充 ✅ 已完成
- ~~PRD-基础版缺少UI模版定制功能描述~~
- 修复说明：已在PRD-基础版中补充完整的UI模版定制功能模块，包括品牌定制、布局调整、预设模板、配置历史和可视化配置器五个子模块，与HLD-基础版保持一致。
产品介绍手册定价信息更新 ✅ 已完成
- ~~产品介绍手册中定价信息为占位符¥XXX~~
- 修复说明：已将产品介绍手册中所有定价占位符替换为具体定价信息，包括基础版¥299/月、各订阅模块定价（¥199-¥499/月）以及所有套餐的具体价格。

15.4 归档文档

以下文档已归档，仅供参考：

PRD-产品设计文档.md (GYM-PRD-001)
HLD-基础版系统概要设计.md (GYM-HLD-BASIC-001) - 已被BLD和TLD替代
HLD-系统概要设计.md (GYM-HLD-001)
HLD-系统概要设计.md (GYM-HLD-001)

十四、文档维护建议

定期审查: 每季度进行一次文档审查，确保文档与项目状态一致
版本管理: 严格按照版本号规则进行文档版本管理
引用更新: 文档更新时，同步更新所有引用关系
日期检查: 定期检查文档中的日期信息，确保时效性
清单维护: 文档增删改时，及时更新本文档清单

清单结束

28 KiB Raw Blame History Unescape Escape

健身房管理系统文档清单

文档修订历史

一、文档概述

1.1 文档分类

1.2 文档编号规则

1.3 文档状态管理

二、产品需求文档（PRD）

2.1 基础版PRD

2.2 付费订阅版PRD

三、业务概要设计文档（B-HLD）

3.1 基础版B-HLD

3.2 付费订阅版B-HLD

四、业务详细设计文档（B-LLD）

4.1 基础版B-LLD

4.2 付费订阅版B-LLD

五、技术实现详细设计文档（T-ILD）

5.1 基础版T-ILD

5.2 付费订阅版T-ILD

六、高层设计文档（HLD）

6.1 技术架构 HLD（已归档）

6.2 基础版 HLD

6.3 付费订阅版 HLD

七、详细设计文档（LLD）

7.1 基础版 LLD

7.2 付费订阅版 LLD

九、计划文档

9.1 系统设计计划

十、客户文档

10.1 产品介绍手册

十一、归档文档

11.1 历史PRD文档

11.2 历史HLD文档

十二、部署运维文档

12.1 部署运维指南

十三、审查和管理文档

13.1 文档审查报告

13.2 文档清单

13.3 文档管理规范

十四、文档依赖关系图

十五、文档状态汇总

十六、注意事项

15.1 文档管理规范

15.2 文档架构优化

15.3 已完成的修复

15.4 归档文档

十四、文档维护建议

28 KiB

Raw Blame History