From a66443a7c1ce225f1d4a1454117ba930cc44ad98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E7=BF=94?= Date: Sat, 4 Apr 2026 14:05:49 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=88=9B=E5=BB=BA=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=B4=A2=E5=BC=95=E4=B8=AD=E5=BF=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 创建文档导航首页（README.md） - 创建按类型索引（需求/架构/评估/实施/计划/客户/规范） - 创建按阶段索引（需求分析/架构设计/评估验证/实施部署） - 创建按场景索引（预约高峰期/支付流程/故障恢复/数据统计/会员签到） - 创建文档关系图谱（Mermaid依赖关系图） 建立多维索引体系，提升文档可访问性和可维护性 --- docs/00-INDEX/README.md | 58 +++++++++++++++ docs/00-INDEX/文档关系图谱.md | 51 +++++++++++++ docs/00-INDEX/文档索引-按场景.md | 118 +++++++++++++++++++++++++++++++ docs/00-INDEX/文档索引-按类型.md | 107 ++++++++++++++++++++++++++++ docs/00-INDEX/文档索引-按阶段.md | 85 ++++++++++++++++++++++ 5 files changed, 419 insertions(+) create mode 100644 docs/00-INDEX/README.md create mode 100644 docs/00-INDEX/文档关系图谱.md create mode 100644 docs/00-INDEX/文档索引-按场景.md create mode 100644 docs/00-INDEX/文档索引-按类型.md create mode 100644 docs/00-INDEX/文档索引-按阶段.md diff --git a/docs/00-INDEX/README.md b/docs/00-INDEX/README.md new file mode 100644 index 0000000..c665599 --- /dev/null +++ b/docs/00-INDEX/README.md @@ -0,0 +1,58 @@ +# 📚 健身房管理系统文档中心 + +> 文档编号: GYM-INDEX-001 +> 版本: v1.0 +> 日期: 2026-04-04 +> 作者: 张翔 +> 状态: 正式发布 + +--- + +## 快速导航 + +### 按角色导航 +- **产品经理** → [需求文档](../01-REQUIREMENTS/) | [产品迭代计划](../05-PLANS/产品迭代计划.md) +- **架构师** → [架构文档](../02-ARCHITECTURE/) | [评估报告](../03-EVALUATION/) +- **开发工程师** → [技术架构](../02-ARCHITECTURE/技术架构/) | [API设计](../02-ARCHITECTURE/技术架构/API-接口设计规范.md) +- **测试工程师** → [测试文档](../04-IMPLEMENTATION/测试文档/) | [评估报告](../03-EVALUATION/) +- **运维工程师** → [部署运维](../04-IMPLEMENTATION/部署运维/) | [安全设计](../02-ARCHITECTURE/技术架构/SEC-安全设计.md) +- **客户** → [产品介绍](../06-CUSTOMER/产品介绍手册.md) | [定价策略](../06-CUSTOMER/定价策略.md) + +### 按阶段导航 +- **需求分析阶段** → [PRD文档](../01-REQUIREMENTS/) | [竞品分析](../01-REQUIREMENTS/竞品分析与系统能力评估报告.md) +- **架构设计阶段** → [业务架构](../02-ARCHITECTURE/业务架构/) | [技术架构](../02-ARCHITECTURE/技术架构/) +- **评估验证阶段** → [评估报告](../03-EVALUATION/) | [改进路线图](../05-PLANS/改进路线图.md) +- **实施部署阶段** → [部署运维](../04-IMPLEMENTATION/部署运维/) | [测试文档](../04-IMPLEMENTATION/测试文档/) + +### 按场景导航 +- **会员预约高峰期** → [性能评估](../03-EVALUATION/EVAL-002-性能与可扩展性评估报告.md) | [技术设计](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) +- **支付流程** → [安全评估](../03-EVALUATION/EVAL-003-安全性与容错能力评估报告.md) | [安全设计](../02-ARCHITECTURE/技术架构/SEC-安全设计.md) +- **系统故障恢复** → [容错评估](../03-EVALUATION/EVAL-003-安全性与容错能力评估报告.md) | [运维文档](../04-IMPLEMENTATION/部署运维/OPS-部署运维文档.md) + +--- + +## 文档统计 + +- 总文档数：40+ +- 需求文档：5 +- 架构文档：15 +- 评估报告：5 +- 实施文档：8 +- 计划文档：5 +- 客户文档：2 + +--- + +## 最近更新 + +- 2026-04-04：创建文档索引中心，建立多维索引体系 +- 2026-03-08：完成文档架构优化，建立三层文档体系（B-HLD、B-LLD、T-ILD） +- 2026-03-09：新增业务KPI定义、产品迭代计划、功能优先级矩阵文档 + +--- + +## 文档维护 + +- 文档管理规范：[查看](../08-STANDARDS/文档管理规范.md) +- 文档更新流程：[查看](../08-STANDARDS/文档管理规范.md#文档更新规范) +- 文档审查机制：[查看](../08-STANDARDS/文档管理规范.md#文档审查机制) diff --git a/docs/00-INDEX/文档关系图谱.md b/docs/00-INDEX/文档关系图谱.md new file mode 100644 index 0000000..47b0930 --- /dev/null +++ b/docs/00-INDEX/文档关系图谱.md @@ -0,0 +1,51 @@ +# 文档关系图谱 + +> 文档编号: GYM-INDEX-GRAPH-001 +> 版本: v1.0 +> 日期: 2026-04-04 +> 作者: 张翔 +> 状态: 正式发布 + +--- + +## 核心文档依赖关系 + +```mermaid +graph TD + A[PRD-基础版产品设计文档] --> B[B-HLD-基础版-业务概要设计] + A --> C[业务KPI定义] + B --> D[B-LLD-基础版-业务详细设计] + D --> E[T-ILD-基础版-技术实现详细设计] + E --> F[DB-数据库设计] + E --> G[API-接口设计规范] + E --> H[SEC-安全设计] + + I[PRD-付费订阅版产品设计文档] --> J[B-HLD-付费订阅版-业务概要设计] + J --> K[B-LLD-付费订阅版-业务详细设计] + K --> L[T-ILD-付费订阅版-技术实现详细设计] + + E --> M[EVAL-001-架构合理性评估报告] + E --> N[EVAL-002-性能与可扩展性评估报告] + H --> O[EVAL-003-安全性与容错能力评估报告] + E --> P[EVAL-004-资源利用率评估报告] + + M --> Q[EVAL-综合评估总结报告] + N --> Q + O --> Q + P --> Q + Q --> R[改进路线图] +``` + +--- + +## 文档版本依赖矩阵 + +| 文档 | 版本 | 依赖文档 | 版本要求 | +|------|------|---------|---------| +| T-ILD-基础版 | v1.0 | PRD-基础版 | v1.0+ | +| T-ILD-基础版 | v1.0 | B-HLD-基础版 | v1.0+ | +| T-ILD-基础版 | v1.0 | B-LLD-基础版 | v1.0+ | +| T-ILD-付费订阅版 | v1.0 | PRD-付费订阅版 | v1.0+ | +| T-ILD-付费订阅版 | v1.0 | B-HLD-付费订阅版 | v1.0+ | +| T-ILD-付费订阅版 | v1.0 | B-LLD-付费订阅版 | v1.0+ | +| EVAL-综合评估总结报告 | v1.0 | EVAL-001/002/003/004 | v1.0+ | diff --git a/docs/00-INDEX/文档索引-按场景.md b/docs/00-INDEX/文档索引-按场景.md new file mode 100644 index 0000000..6e11c0a --- /dev/null +++ b/docs/00-INDEX/文档索引-按场景.md @@ -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) - 签到高峰期性能评估 diff --git a/docs/00-INDEX/文档索引-按类型.md b/docs/00-INDEX/文档索引-按类型.md new file mode 100644 index 0000000..355ba87 --- /dev/null +++ b/docs/00-INDEX/文档索引-按类型.md @@ -0,0 +1,107 @@ +# 文档索引 - 按类型 + +> 文档编号: GYM-INDEX-TYPE-001 +> 版本: v1.0 +> 日期: 2026-04-04 +> 作者: 张翔 +> 状态: 正式发布 + +--- + +## 需求文档 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| PRD-基础版产品设计文档 | GYM-PRD-BASIC-001 | v1.0 | 正式发布 | [链接](../01-REQUIREMENTS/PRD-基础版产品设计文档.md) | +| PRD-付费订阅版产品设计文档 | GYM-PRD-SUBSCRIPTION-001 | v1.0 | 正式发布 | [链接](../01-REQUIREMENTS/PRD-付费订阅版产品设计文档.md) | +| 业务KPI定义 | GYM-BUSINESS-KPI-001 | v1.0 | 正式发布 | [链接](../01-REQUIREMENTS/业务KPI定义.md) | +| 竞品分析与系统能力评估报告 | GYM-ANALYSIS-001 | v1.0 | 正式发布 | [链接](../01-REQUIREMENTS/竞品分析与系统能力评估报告.md) | + +--- + +## 架构文档 + +### 业务架构 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| B-HLD-基础版-业务概要设计 | GYM-B-HLD-BASIC-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/业务架构/B-HLD-基础版-业务概要设计.md) | +| B-HLD-付费订阅版-业务概要设计 | GYM-B-HLD-SUBSCRIPTION-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/业务架构/B-HLD-付费订阅版-业务概要设计.md) | +| B-LLD-基础版-业务详细设计 | GYM-B-LLD-BASIC-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/业务架构/B-LLD-基础版-业务详细设计.md) | +| B-LLD-付费订阅版-业务详细设计 | GYM-B-LLD-SUBSCRIPTION-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/业务架构/B-LLD-付费订阅版-业务详细设计.md) | + +### 技术架构 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| T-ILD-基础版-技术实现详细设计 | GYM-T-ILD-BASIC-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) | +| T-ILD-付费订阅版-技术实现详细设计 | GYM-T-ILD-SUBSCRIPTION-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/技术架构/T-ILD-付费订阅版-技术实现详细设计.md) | +| DB-数据库设计 | GYM-DB-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/技术架构/DB-数据库设计.md) | +| API-接口设计规范 | GYM-API-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/技术架构/API-接口设计规范.md) | +| SEC-安全设计 | GYM-SEC-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/技术架构/SEC-安全设计.md) | + +### 架构决策记录 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| ADR-001-单体应用选型 | GYM-ADR-001 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/架构决策记录/ADR-001-单体应用选型.md) | +| ADR-002-响应式编程选型 | GYM-ADR-002 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/架构决策记录/ADR-002-响应式编程选型.md) | +| ADR-003-数据库选型 | GYM-ADR-003 | v1.0 | 正式发布 | [链接](../02-ARCHITECTURE/架构决策记录/ADR-003-数据库选型.md) | + +--- + +## 评估报告 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| EVAL-001-架构合理性评估报告 | GYM-EVAL-001 | v1.0 | 正式发布 | [链接](../03-EVALUATION/EVAL-001-架构合理性评估报告.md) | +| EVAL-002-性能与可扩展性评估报告 | GYM-EVAL-002 | v1.0 | 正式发布 | [链接](../03-EVALUATION/EVAL-002-性能与可扩展性评估报告.md) | +| EVAL-003-安全性与容错能力评估报告 | GYM-EVAL-003 | v1.0 | 正式发布 | [链接](../03-EVALUATION/EVAL-003-安全性与容错能力评估报告.md) | +| EVAL-004-资源利用率评估报告 | GYM-EVAL-004 | v1.0 | 正式发布 | [链接](../03-EVALUATION/EVAL-004-资源利用率评估报告.md) | +| EVAL-综合评估总结报告 | GYM-EVAL-SUMMARY-001 | v1.0 | 正式发布 | [链接](../03-EVALUATION/EVAL-综合评估总结报告.md) | + +--- + +## 实施文档 + +### 部署运维 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| OPS-部署运维文档 | GYM-OPS-001 | v1.0 | 正式发布 | [链接](../04-IMPLEMENTATION/部署运维/OPS-部署运维文档.md) | + +### 前端工程化 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| 前端工程化建设文档 | GYM-FRONTEND-001 | v1.0 | 正式发布 | [链接](../04-IMPLEMENTATION/前端工程化/前端工程化建设文档.md) | +| 前端技术架构详细设计 | GYM-FRONTEND-002 | v1.0 | 正式发布 | [链接](../04-IMPLEMENTATION/前端工程化/前端技术架构详细设计.md) | + +--- + +## 计划文档 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| 产品迭代计划 | GYM-PLAN-ITERATION-001 | v1.0 | 正式发布 | [链接](../05-PLANS/产品迭代计划.md) | +| 功能优先级矩阵 | GYM-PLAN-PRIORITY-001 | v1.0 | 正式发布 | [链接](../05-PLANS/功能优先级矩阵.md) | +| 技术复杂度评估 | GYM-PLAN-COMPLEXITY-001 | v1.0 | 正式发布 | [链接](../05-PLANS/技术复杂度评估.md) | +| 改进路线图 | GYM-PLAN-ROADMAP-001 | v1.0 | 正式发布 | [链接](../05-PLANS/改进路线图.md) | + +--- + +## 客户文档 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| 产品介绍手册 | GYM-CUSTOMER-001 | v1.0 | 正式发布 | [链接](../06-CUSTOMER/产品介绍手册.md) | +| 定价策略 | GYM-PRICING-001 | v1.0 | 正式发布 | [链接](../06-CUSTOMER/定价策略.md) | + +--- + +## 规范文档 + +| 文档名称 | 编号 | 版本 | 状态 | 路径 | +|---------|------|------|------|------| +| 文档管理规范 | GYM-DOC-STANDARD-001 | v1.0 | 正式发布 | [链接](../08-STANDARDS/文档管理规范.md) | +| 文档清单 | GYM-DOC-LIST-001 | v1.9 | 正式发布 | [链接](../08-STANDARDS/文档清单.md) | diff --git a/docs/00-INDEX/文档索引-按阶段.md b/docs/00-INDEX/文档索引-按阶段.md new file mode 100644 index 0000000..d71c240 --- /dev/null +++ b/docs/00-INDEX/文档索引-按阶段.md @@ -0,0 +1,85 @@ +# 文档索引 - 按项目阶段 + +> 文档编号: GYM-INDEX-STAGE-001 +> 版本: v1.0 +> 日期: 2026-04-04 +> 作者: 张翔 +> 状态: 正式发布 + +--- + +## 阶段1：需求分析 + +### 核心文档 +- [PRD-基础版产品设计文档](../01-REQUIREMENTS/PRD-基础版产品设计文档.md) +- [PRD-付费订阅版产品设计文档](../01-REQUIREMENTS/PRD-付费订阅版产品设计文档.md) +- [业务KPI定义](../01-REQUIREMENTS/业务KPI定义.md) +- [竞品分析与系统能力评估报告](../01-REQUIREMENTS/竞品分析与系统能力评估报告.md) + +### 辅助文档 +- [产品迭代计划](../05-PLANS/产品迭代计划.md) +- [功能优先级矩阵](../05-PLANS/功能优先级矩阵.md) + +--- + +## 阶段2：架构设计 + +### 业务架构 +- [B-HLD-基础版-业务概要设计](../02-ARCHITECTURE/业务架构/B-HLD-基础版-业务概要设计.md) +- [B-HLD-付费订阅版-业务概要设计](../02-ARCHITECTURE/业务架构/B-HLD-付费订阅版-业务概要设计.md) +- [B-LLD-基础版-业务详细设计](../02-ARCHITECTURE/业务架构/B-LLD-基础版-业务详细设计.md) +- [B-LLD-付费订阅版-业务详细设计](../02-ARCHITECTURE/业务架构/B-LLD-付费订阅版-业务详细设计.md) + +### 技术架构 +- [T-ILD-基础版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-基础版-技术实现详细设计.md) +- [T-ILD-付费订阅版-技术实现详细设计](../02-ARCHITECTURE/技术架构/T-ILD-付费订阅版-技术实现详细设计.md) +- [DB-数据库设计](../02-ARCHITECTURE/技术架构/DB-数据库设计.md) +- [API-接口设计规范](../02-ARCHITECTURE/技术架构/API-接口设计规范.md) +- [SEC-安全设计](../02-ARCHITECTURE/技术架构/SEC-安全设计.md) + +### 架构决策记录 +- [ADR-001-单体应用选型](../02-ARCHITECTURE/架构决策记录/ADR-001-单体应用选型.md) +- [ADR-002-响应式编程选型](../02-ARCHITECTURE/架构决策记录/ADR-002-响应式编程选型.md) +- [ADR-003-数据库选型](../02-ARCHITECTURE/架构决策记录/ADR-003-数据库选型.md) + +--- + +## 阶段3：评估验证 + +### 评估报告 +- [EVAL-001-架构合理性评估报告](../03-EVALUATION/EVAL-001-架构合理性评估报告.md) +- [EVAL-002-性能与可扩展性评估报告](../03-EVALUATION/EVAL-002-性能与可扩展性评估报告.md) +- [EVAL-003-安全性与容错能力评估报告](../03-EVALUATION/EVAL-003-安全性与容错能力评估报告.md) +- [EVAL-004-资源利用率评估报告](../03-EVALUATION/EVAL-004-资源利用率评估报告.md) +- [EVAL-综合评估总结报告](../03-EVALUATION/EVAL-综合评估总结报告.md) + +### 辅助文档 +- [技术复杂度评估](../05-PLANS/技术复杂度评估.md) +- [改进路线图](../05-PLANS/改进路线图.md) + +--- + +## 阶段4：实施部署 + +### 部署运维 +- [OPS-部署运维文档](../04-IMPLEMENTATION/部署运维/OPS-部署运维文档.md) + +### 前端工程化 +- [前端工程化建设文档](../04-IMPLEMENTATION/前端工程化/前端工程化建设文档.md) +- [前端技术架构详细设计](../04-IMPLEMENTATION/前端工程化/前端技术架构详细设计.md) + +### 客户文档 +- [产品介绍手册](../06-CUSTOMER/产品介绍手册.md) +- [定价策略](../06-CUSTOMER/定价策略.md) + +--- + +## 文档依赖关系 + +``` +需求分析 → 架构设计 → 评估验证 → 实施部署 + ↓ ↓ ↓ ↓ + PRD文档 业务架构 评估报告 部署文档 + ↓ ↓ ↓ ↓ + 业务KPI 技术架构 改进路线图 客户文档 +```