novalon/gym-manage
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
14 Commits 6 Branches 0 Tags
50dc275ec52465d6b2ae0fddd2415276eee1b4f9
Commit Graph

9 Commits

Author SHA1 Message Date
张翔 104fa7e7c8 docs: reorganize documentation structure 2026-03-05 13:48:13 +08:00
张翔 349b0a754f 重构HLD和LLD文档，明确业务概要设计与详细设计的职责分工 
主要变更：
- 重构HLD-系统概要设计.md为业务概要设计文档
  * 聚焦于业务范围、业务流程、业务规则、业务场景
  * 移除技术架构、模块设计、接口设计等技术内容
  * 新增核心业务流程图（会员注册、课程预约、签到、会员卡购买）
  * 新增详细业务规则（会员管理、预约管理、签到管理、财务管理、数据分析）
  * 新增典型业务场景和特殊业务场景描述
  * 新增业务约束和业务指标

- 新增LLD-系统详细设计.md作为系统技术详细设计文档
  * 整合从HLD移出的技术架构设计（总体架构、技术架构、部署架构）
  * 整合模块设计（模块划分、模块职责、模块交互）
  * 整合接口设计（接口规范、接口分组、接口版本管理）
  * 整合安全设计（认证机制、权限控制、数据安全、接口安全）
  * 整合性能设计（性能目标、性能优化策略、高并发场景处理）
  * 整合可扩展性设计（水平扩展、功能扩展）
  * 整合监控与运维（监控体系、日志规范）

- 更新所有LLD模块文档的参考文档
  * 更新HLD文档引用为业务概要设计文档
  * 新增LLD-系统详细设计.md作为参考文档

- 删除docs/api/API接口文档.md（接口设计已整合到LLD-系统详细设计.md）

文档职责分工：
- PRD：产品需求文档，描述产品需求和功能
- HLD：业务概要设计文档，描述业务范围、流程、规则、场景
- LLD：详细设计文档，描述技术架构、模块设计、接口设计等实现细节~
 2026-03-04 11:43:21 +08:00
张翔 c1d7660aac 修复所有设计文档中ASCII图表右侧边框对齐问题 
- 修复HLD-系统概要设计.md中所有ASCII图表的右侧边框对齐
- 修复LLD-签到模块详细设计.md中ASCII图表的右侧边框对齐
- 修复LLD-会员模块详细设计.md中ASCII图表的右侧边框对齐
- 修复LLD-预约模块详细设计.md中ASCII图表的右侧边框对齐
- 确保所有ASCII图表的右侧边框纵向靠右对齐
 2026-03-04 11:20:36 +08:00
张翔 97c5c08513 refactor: 将设计文档中的Mermaid图表转换为ASCII格式 
为提高兼容性，避免Mermaid版本兼容问题，将所有设计文档中的
Mermaid图表转换为ASCII格式。

修改文件:
- HLD-系统概要设计.md
  • 业务范围图 (mindmap → ASCII)
  • 总体架构图 (graph → ASCII)
  • 技术架构图 (graph → ASCII)
  • 部署架构图 (graph → ASCII)
  • 模块划分图 (graph → ASCII)
  • 模块交互图 (sequenceDiagram → ASCII)
  • 接口分组图 (graph → ASCII)

- LLD-会员模块详细设计.md
  • 模块边界图 (graph → ASCII)
  • 实体关系图 (erDiagram → ASCII)

- LLD-预约模块详细设计.md
  • 模块边界图 (graph → ASCII)
  • 实体关系图 (erDiagram → ASCII)

- LLD-签到模块详细设计.md
  • 模块边界图 (graph → ASCII)
  • 实体关系图 (erDiagram → ASCII)

所有ASCII图表采用统一的边框样式，左右两侧对齐，提高可读性。~
 2026-03-04 10:20:11 +08:00
张翔 9f8fdd9368 fix: 修复LLD预约模块文档中的重复标题 
删除LLD-预约模块详细设计.md中第71行的重复标题
'### 2.1 实体关系图'，修复Markdown语法错误。

修复前：
### 2.1 实体关系图
### 2.1 实体关系图

修复后：
### 2.1 实体关系图
 2026-03-03 18:00:00 +08:00
张翔 d9192765ff docs: 为LLD会员和预约模块添加版本历史章节 
为以下文档补充版本历史章节，保持文档结构一致性：

1. LLD-会员模块详细设计.md (GYM-LLD-001)
2. LLD-预约模块详细设计.md (GYM-LLD-002)

添加的章节：
- 十一、版本历史

现在所有LLD文档都具有完整的章节结构，包括：
- 参考文档
- 模块概述
- 数据模型设计
- 领域模型设计
- 业务流程设计
- 接口设计
- 核心代码设计
- 高并发处理（签到模块有）
- 缓存设计
- 定时任务（签到模块有）
- 异常处理
- 附录
- 版本历史
 2026-02-28 17:30:30 +08:00
张翔 90a57ae7b6 docs: 为所有LLD和API文档添加参考文档 
为以下文档补充参考文档部分，明确文档依赖关系：

1. LLD-会员模块详细设计.md (GYM-LLD-001)
2. LLD-预约模块详细设计.md (GYM-LLD-002)
3. LLD-签到模块详细设计.md (GYM-LLD-003)
4. API接口文档.md (GYM-API-001)

添加的参考文档：
- 《健身房管理系统产品设计文档》 GYM-PRD-001
- 《健身房管理系统概要设计文档》 GYM-HLD-001
- Spring Boot 3 官方文档
- R2DBC 规范文档
- PostgreSQL 官方文档
- RESTful API 设计规范
- JSON API 规范

正确的文档层级关系：
PRD（产品需求）→ HLD（概要设计）→ LLD（详细设计）→ API（接口文档）
每个文档都应该明确说明其参考的上层文档~
 2026-02-28 17:19:30 +08:00
张翔 e89f5f1f7f docs: 将所有设计文档中的ASCII图转换为Mermaid格式 
- HLD-系统概要设计.md: 转换业务范围、总体架构、技术架构、部署架构、模块划分、模块交互、API接口分组等图
- LLD-会员模块详细设计.md: 转换模块边界、实体关系图
- LLD-预约模块详细设计.md: 转换模块边界、实体关系图
- LLD-签到模块详细设计.md: 转换模块边界、实体关系图

Mermaid格式优势:
- 更好的可维护性和可读性
- 支持在Markdown编辑器中实时预览
- 更容易进行版本对比和修改
- 支持多种图表类型(mindmap, graph, erDiagram, sequenceDiagram)~
 2026-02-28 16:49:19 +08:00
张翔 8a7936ba4e docs: 添加预约模块和签到模块详细设计文档及API接口文档 
- 添加预约模块详细设计文档（LLD-预约模块详细设计.md）
- 添加签到模块详细设计文档（LLD-签到模块详细设计.md）
- 添加API接口文档（API接口文档.md）

文档包含：
- 模块概述与边界定义
- 数据模型设计（含SQL建表语句）
- 领域模型设计
- 业务流程设计
- 接口设计
- 核心代码设计
- 高并发处理方案
- 缓存设计
- 定时任务设计
- 异常处理
- 附录（枚举定义、错误码）~
 2026-02-28 14:29:30 +08:00