From 90a57ae7b6bd748d0998cb99f0affc02aa545527 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E7=BF=94?= Date: Sat, 28 Feb 2026 17:19:30 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=B8=BA=E6=89=80=E6=9C=89LLD=E5=92=8C?= =?UTF-8?q?API=E6=96=87=E6=A1=A3=E6=B7=BB=E5=8A=A0=E5=8F=82=E8=80=83?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 为以下文档补充参考文档部分，明确文档依赖关系： 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（接口文档） 每个文档都应该明确说明其参考的上层文档~ --- docs/api/API接口文档.md | 8 ++++++++ docs/design/LLD-会员模块详细设计.md | 10 ++++++++++ docs/design/LLD-签到模块详细设计.md | 10 ++++++++++ docs/design/LLD-预约模块详细设计.md | 10 ++++++++++ 4 files changed, 38 insertions(+) diff --git a/docs/api/API接口文档.md b/docs/api/API接口文档.md index 747af04..4e8aa1a 100644 --- a/docs/api/API接口文档.md +++ b/docs/api/API接口文档.md @@ -16,6 +16,14 @@ --- +## 参考文档 + +- 《健身房管理系统概要设计文档》 GYM-HLD-001 +- RESTful API 设计规范 +- JSON API 规范 + +--- + ## 一、接口规范 ### 1.1 基础信息 diff --git a/docs/design/LLD-会员模块详细设计.md b/docs/design/LLD-会员模块详细设计.md index aa6add0..d961511 100644 --- a/docs/design/LLD-会员模块详细设计.md +++ b/docs/design/LLD-会员模块详细设计.md @@ -16,6 +16,16 @@ --- +## 参考文档 + +- 《健身房管理系统产品设计文档》 GYM-PRD-001 +- 《健身房管理系统概要设计文档》 GYM-HLD-001 +- Spring Boot 3 官方文档 +- R2DBC 规范文档 +- PostgreSQL 官方文档 + +--- + ## 一、模块概述 ### 1.1 模块定位 diff --git a/docs/design/LLD-签到模块详细设计.md b/docs/design/LLD-签到模块详细设计.md index 9854dd6..ad83d74 100644 --- a/docs/design/LLD-签到模块详细设计.md +++ b/docs/design/LLD-签到模块详细设计.md @@ -16,6 +16,16 @@ --- +## 参考文档 + +- 《健身房管理系统产品设计文档》 GYM-PRD-001 +- 《健身房管理系统概要设计文档》 GYM-HLD-001 +- Spring Boot 3 官方文档 +- R2DBC 规范文档 +- PostgreSQL 官方文档 + +--- + ## 一、模块概述 ### 1.1 模块定位 diff --git a/docs/design/LLD-预约模块详细设计.md b/docs/design/LLD-预约模块详细设计.md index d33ae65..023637f 100644 --- a/docs/design/LLD-预约模块详细设计.md +++ b/docs/design/LLD-预约模块详细设计.md @@ -16,6 +16,16 @@ --- +## 参考文档 + +- 《健身房管理系统产品设计文档》 GYM-PRD-001 +- 《健身房管理系统概要设计文档》 GYM-HLD-001 +- Spring Boot 3 官方文档 +- R2DBC 规范文档 +- PostgreSQL 官方文档 + +--- + ## 一、模块概述 ### 1.1 模块定位