docs: 创建文档索引中心

- 创建文档导航首页(README.md)
- 创建按类型索引(需求/架构/评估/实施/计划/客户/规范)
- 创建按阶段索引(需求分析/架构设计/评估验证/实施部署)
- 创建按场景索引(预约高峰期/支付流程/故障恢复/数据统计/会员签到)
- 创建文档关系图谱(Mermaid依赖关系图)

建立多维索引体系,提升文档可访问性和可维护性
This commit is contained in:
张翔
2026-04-04 14:05:49 +08:00
parent 84f77c3bc1
commit a66443a7c1
5 changed files with 419 additions and 0 deletions
+118
View File
@@ -0,0 +1,118 @@
# 文档索引 - 按业务场景
> 文档编号: GYM-INDEX-SCENARIO-001
> 版本: v1.0
> 日期: 2026-04-04
> 作者: 张翔
> 状态: 正式发布
---
## 场景1:会员预约高峰期
**场景描述**:每天18:00-20:00,会员集中预约团课,系统需要支持高并发请求。
**相关文档**
### 需求文档
- [PRD-基础版产品设计文档](../01-REQUIREMENTS/PRD-基础版产品设计文档.md) - 预约管理模块
- [业务KPI定义](../01-REQUIREMENTS/业务KPI定义.md) - 预约转化率、并发用户数
### 架构文档
- [B-LLD-基础版-业务详细设计](../02-ARCHITECTURE/业务架构/B-LLD-基础版-业务详细设计.md) - 预约业务流程
- [T-ILD-基础版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) - 预约模块技术实现
- [DB-数据库设计](../02-ARCHITECTURE/技术架构/DB-数据库设计.md) - 预约表设计
- [API-接口设计规范](../02-ARCHITECTURE/技术架构/API-接口设计规范.md) - 预约接口设计
### 评估报告
- [EVAL-002-性能与可扩展性评估报告](../03-EVALUATION/EVAL-002-性能与可扩展性评估报告.md) - 高并发性能评估
- [EVAL-004-资源利用率评估报告](../03-EVALUATION/EVAL-004-资源利用率评估报告.md) - 资源瓶颈分析
### 改进方案
- [改进路线图](../05-PLANS/改进路线图.md) - 预约高峰期性能优化
---
## 场景2:支付流程
**场景描述**:会员购买会员卡或续费,系统需要保障支付安全和数据一致性。
**相关文档**
### 需求文档
- [PRD-付费订阅版产品设计文档](../01-REQUIREMENTS/PRD-付费订阅版产品设计文档.md) - 订阅管理模块
- [业务KPI定义](../01-REQUIREMENTS/业务KPI定义.md) - 支付成功率、客单价
### 架构文档
- [B-LLD-付费订阅版-业务详细设计](../02-ARCHITECTURE/业务架构/B-LLD-付费订阅版-业务详细设计.md) - 支付业务流程
- [T-ILD-付费订阅版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-付费订阅版-技术实现详细设计.md) - 支付模块技术实现
- [SEC-安全设计](../02-ARCHITECTURE/技术架构/SEC-安全设计.md) - 支付安全设计
- [API-接口设计规范](../02-ARCHITECTURE/技术架构/API-接口设计规范.md) - 支付接口设计
### 评估报告
- [EVAL-003-安全性与容错能力评估报告](../03-EVALUATION/EVAL-003-安全性与容错能力评估报告.md) - 支付安全评估
- [EVAL-001-架构合理性评估报告](../03-EVALUATION/EVAL-001-架构合理性评估报告.md) - 事务一致性评估
### 改进方案
- [改进路线图](../05-PLANS/改进路线图.md) - 支付接口幂等性校验
---
## 场景3:系统故障恢复
**场景描述**:系统出现故障时,需要快速检测、隔离和恢复,保障业务连续性。
**相关文档**
### 架构文档
- [T-ILD-基础版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) - 容错机制设计
- [SEC-安全设计](../02-ARCHITECTURE/技术架构/SEC-安全设计.md) - 数据备份与恢复
- [OPS-部署运维文档](../04-IMPLEMENTATION/部署运维/OPS-部署运维文档.md) - 故障处理流程
### 评估报告
- [EVAL-003-安全性与容错能力评估报告](../03-EVALUATION/EVAL-003-安全性与容错能力评估报告.md) - 容错能力评估
- [EVAL-004-资源利用率评估报告](../03-EVALUATION/EVAL-004-资源利用率评估报告.md) - 资源瓶颈分析
### 改进方案
- [改进路线图](../05-PLANS/改进路线图.md) - 监控告警完善、缓存穿透防护
---
## 场景4:数据统计分析
**场景描述**:管理员查看业务数据统计报表,系统需要支持复杂查询和数据分析。
**相关文档**
### 需求文档
- [PRD-基础版产品设计文档](../01-REQUIREMENTS/PRD-基础版产品设计文档.md) - 数据统计模块
- [业务KPI定义](../01-REQUIREMENTS/业务KPI定义.md) - 各类KPI指标
### 架构文档
- [B-LLD-基础版-业务详细设计](../02-ARCHITECTURE/业务架构/B-LLD-基础版-业务详细设计.md) - 统计业务流程
- [T-ILD-基础版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) - 统计模块技术实现
- [DB-数据库设计](../02-ARCHITECTURE/技术架构/DB-数据库设计.md) - 统计表设计
### 评估报告
- [EVAL-002-性能与可扩展性评估报告](../03-EVALUATION/EVAL-002-性能与可扩展性评估报告.md) - 查询性能评估
---
## 场景5:会员签到
**场景描述**:会员到店签到,系统需要支持多种签到方式(人脸、NFC、二维码)。
**相关文档**
### 需求文档
- [PRD-基础版产品设计文档](../01-REQUIREMENTS/PRD-基础版产品设计文档.md) - 签到管理模块
- [业务KPI定义](../01-REQUIREMENTS/业务KPI定义.md) - 签到率、DAU
### 架构文档
- [B-LLD-基础版-业务详细设计](../02-ARCHITECTURE/业务架构/B-LLD-基础版-业务详细设计.md) - 签到业务流程
- [T-ILD-基础版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) - 签到模块技术实现
- [DB-数据库设计](../02-ARCHITECTURE/技术架构/DB-数据库设计.md) - 签到表设计
- [API-接口设计规范](../02-ARCHITECTURE/技术架构/API-接口设计规范.md) - 签到接口设计
### 评估报告
- [EVAL-002-性能与可扩展性评估报告](../03-EVALUATION/EVAL-002-性能与可扩展性评估报告.md) - 签到高峰期性能评估