novalon/gym-manage
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
30 Commits 6 Branches 0 Tags
735f9d399ae7463b786d04bd21ac78c1c8cba6be
Commit Graph

30 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
张翔 735f9d399a docs: 添加系统评估与文档整理设计方案 
- 采用敏捷迭代式评估方案
- 四个迭代完成全面评估和文档体系重构
- 强调可执行性和实用性
- 包含详细的评估维度和文档结构设计
 2026-04-04 13:42:54 +08:00
张翔 d971fc21c6 docs: 完成文档优化项目总结报告 2026-03-08 22:06:19 +08:00
张翔 182ecddac2 docs: 完成阶段三文档标准化 2026-03-08 22:03:23 +08:00
张翔 22de3ced83 docs: 更新文档清单到 v1.9，新增技术专题文档章节 2026-03-08 22:01:55 +08:00
张翔 b9995785ab docs: 统一文档日期和状态规范 2026-03-08 22:00:52 +08:00
张翔 0087a90b89 docs: 完成阶段二技术专题文档 2026-03-08 21:48:04 +08:00
张翔 383aaacf5b docs: 创建安全设计文档 2026-03-08 21:47:09 +08:00
张翔 7c1c9e5fe5 docs: 创建 API 接口设计规范 2026-03-08 21:44:07 +08:00
张翔 ad56253552 docs: 创建数据库设计文档 2026-03-08 21:41:16 +08:00
张翔 d0cbc4b258 docs: 完成阶段一紧急修复 2026-03-08 21:36:01 +08:00
张翔 bb17946a30 docs: 补充成功费模式详细计算规则和示例 2026-03-08 21:34:50 +08:00
张翔 6e8ff61e10 docs: 补充 UI 模版定制模块业务详细设计 2026-03-08 21:33:50 +08:00
张翔 08a265ac52 docs: 归档 HLD-技术架构设计文档，整合到 T-ILD 体系 2026-03-08 21:30:47 +08:00
张翔 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
张翔 559bfe56e3 feat: 添加可视化配置器详细设计 
- 新增可视化配置器架构设计（品牌配置区、布局配置区、模板选择区）
- 新增交互设计（拖拽交互、实时预览、智能提示、快捷操作）
- 新增配置器组件设计（Logo上传、颜色选择器、模块顺序、模板选择）
- 新增配置器技术实现（前端技术栈、状态管理、预览渲染、配置导出）
- 更新开发优先级，将可视化配置器核心功能提升为P0
 2026-03-07 16:53:18 +08:00
张翔 612e0951ed feat: 添加UI模版定制功能设计文档 
- 新增UI模版定制功能设计文档
- 包含功能概述、架构设计、数据模型、核心功能、数据流、错误处理、测试设计
- 支持品牌定制、布局调整、预设模板三个层次
- 适用于小程序和管理后台的UI定制
 2026-03-07 16:51:08 +08:00
张翔 50dc275ec5 feat: add CheckinRecord DTO classes 2026-03-05 13:55:01 +08:00
张翔 b079bc7aed feat: add CheckinRecord entity and repository 2026-03-05 13:53:46 +08:00
张翔 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
张翔 e67d1c5767 docs: 修正PRD参考文档，移除对HLD/LLD的引用 
PRD是产品需求文档，不应参考技术设计文档（HLD/LLD）。
正确的文档层级关系：
- PRD（产品需求）→ HLD（概要设计）→ LLD（详细设计）
- PRD是需求源头，指导技术设计，而非被技术设计指导

修改内容：
- 移除对GYM-HLD-001的引用
- 移除对GYM-LLD-001/002/003的引用
- 移除对Spring Boot和PostgreSQL官方文档的引用
- 添加行业相关的参考文档：
  - 健身房行业数字化转型趋势报告
  - 健身房管理系统竞品分析报告
  - 用户体验设计规范
  - 移动应用设计指南
  - 数据安全与隐私保护规范
 2026-02-28 17:13:31 +08:00
张翔 2f1f83ee72 docs: 添加PRD产品设计文档 
- 创建GYM-PRD-001产品设计文档
- 包含产品概述、功能需求、非功能需求
- 包含用户故事、验收标准、项目里程碑
- 包含风险应对和成功标准

文档结构:
- 产品概述: 背景、目标、目标用户
- 功能需求: 9大模块详细功能描述
- 非功能需求: 性能、可用性、安全性等
- 用户故事: 会员端和管理端用户故事
- 项目里程碑: 4个阶段交付计划
- 风险与应对: 主要风险识别和应对措施
- 成功标准: 5个维度的量化指标
 2026-02-28 17:07:04 +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
张翔 e7c0c8a1c2 docs: 添加健身房管理系统产品设计文档 
- 系统架构设计（多租户、响应式、事件驱动）
- 会员权益引擎（时长/次数/储值/等级）
- 预约服务模块（团课/私教/场地/线上）
- 签到服务模块（扫码/刷脸/NFC/教练代签）
- 计划中心模块（训练计划/课程排期/会员目标/教练排班）
- 会员端与管理后台功能设计
- 数据库设计（PostgreSQL + R2DBC + Flyway）
- 前端技术架构（uniapp + Vue3）
- 项目实施规划与里程碑~
 2026-02-28 13:36:07 +08:00