01_Overview 总体设计目录说明

目录定位

docs/design/01_Overview/ 仅用于承载“总体层”文档,重点描述系统边界、架构分层、子系统职责与概要设计主稿,不承载详细实现细节。

文件职责矩阵

文件 角色 维护要求
01_System_Overview.md 系统概述(背景、术语、引用) 保持引言性质,不扩展实现细节
02_System_Architecture.md 总体架构说明(分层、技术栈、边界) 与主文档架构口径保持一致
03_Summary_Design.md 概要设计主文档(单一真源) 优先维护;涉及范围变更时同步其余文档
04_System_Diagrams.md 图谱文档(图文配套) 只维护图示与图注,不重复大段正文
05_Module_Inventory.md 模块清单(架构图模块枚举与详设承接映射) 用于模块编号核对与详设对齐,不替代概要主稿

与目录外文档的关系

  • docs/design/01_Project_Overview.md 为“项目导览文档”,用于跨目录导航与接手说明;
  • 该文件不是总体设计主稿,不替代 03_Summary_Design.md

建议阅读顺序

  1. 03_Summary_Design.md(先建立主口径)
  2. 01_System_Overview.md(查看背景与术语)
  3. 02_System_Architecture.md(查看架构细节)
  4. 04_System_Diagrams.md(对照图示核对一致性)
  5. 05_Module_Inventory.md(核对子系统与模块承接关系)

维护规则

  • 概要层文档禁止新增“最终版/修订版/新-xxx”平行稿
  • 涉及编号、模块边界、接口边界变更时,需同步检查本目录全部文件;
  • 修改后至少执行:make validate-file FILE=docs/design/01_Overview/<文件名>make check-linksmake validate-mermaid