docs: 创建文档索引中心
- 创建文档导航首页(README.md) - 创建按类型索引(需求/架构/评估/实施/计划/客户/规范) - 创建按阶段索引(需求分析/架构设计/评估验证/实施部署) - 创建按场景索引(预约高峰期/支付流程/故障恢复/数据统计/会员签到) - 创建文档关系图谱(Mermaid依赖关系图) 建立多维索引体系,提升文档可访问性和可维护性
This commit is contained in:
@@ -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#文档审查机制)
|
||||
Reference in New Issue
Block a user