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(接口文档)
每个文档都应该明确说明其参考的上层文档~
This commit is contained in:
张翔
2026-02-28 17:19:30 +08:00
parent e67d1c5767
commit 90a57ae7b6
4 changed files with 38 additions and 0 deletions
+8
View File
@@ -16,6 +16,14 @@
---
## 参考文档
- 《健身房管理系统概要设计文档》 GYM-HLD-001
- RESTful API 设计规范
- JSON API 规范
---
## 一、接口规范
### 1.1 基础信息
@@ -16,6 +16,16 @@
---
## 参考文档
- 《健身房管理系统产品设计文档》 GYM-PRD-001
- 《健身房管理系统概要设计文档》 GYM-HLD-001
- Spring Boot 3 官方文档
- R2DBC 规范文档
- PostgreSQL 官方文档
---
## 一、模块概述
### 1.1 模块定位
@@ -16,6 +16,16 @@
---
## 参考文档
- 《健身房管理系统产品设计文档》 GYM-PRD-001
- 《健身房管理系统概要设计文档》 GYM-HLD-001
- Spring Boot 3 官方文档
- R2DBC 规范文档
- PostgreSQL 官方文档
---
## 一、模块概述
### 1.1 模块定位
@@ -16,6 +16,16 @@
---
## 参考文档
- 《健身房管理系统产品设计文档》 GYM-PRD-001
- 《健身房管理系统概要设计文档》 GYM-HLD-001
- Spring Boot 3 官方文档
- R2DBC 规范文档
- PostgreSQL 官方文档
---
## 一、模块概述
### 1.1 模块定位