Commit Graph

2 Commits

Author SHA1 Message Date
张翔 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
张翔 8a7936ba4e docs: 添加预约模块和签到模块详细设计文档及API接口文档
- 添加预约模块详细设计文档(LLD-预约模块详细设计.md)
- 添加签到模块详细设计文档(LLD-签到模块详细设计.md)
- 添加API接口文档(API接口文档.md)

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