101 lines
3.5 KiB
Markdown
101 lines
3.5 KiB
Markdown
# Design Overview
|
||
|
||
本目录是完整设计资产的根目录。
|
||
|
||
## 1. 顶层结构
|
||
```text
|
||
design/
|
||
├── README.md
|
||
├── adr/
|
||
│ └── ADR-000-template.md
|
||
├── traceability.csv
|
||
├── change-log.csv
|
||
├── business-architecture/
|
||
├── application-architecture/
|
||
├── data-architecture/
|
||
├── technology-architecture/
|
||
└── domains/
|
||
```
|
||
|
||
## 2. 四层主视图 + domain 视图
|
||
|
||
### 2.1 业务架构产出
|
||
回答：**为什么做、做哪些能力、主流程和关键旅程是什么**
|
||
- 范围与目标
|
||
- 能力地图（CSV）
|
||
- 价值流（CSV）
|
||
- 用户旅程（CSV）
|
||
- 业务 ADR
|
||
|
||
### 2.2 应用架构产出
|
||
回答：**系统怎么拆、系统级如何分层、模块内部如何分层、谁和谁交互、关键接口是什么、如何落到代码仓库**
|
||
- 系统上下文
|
||
- 外部系统清单（CSV）
|
||
- 系统级分层 / 逻辑架构图
|
||
- 模块内技术分层 / 代码分层
|
||
- 模块清单（CSV）
|
||
- 外部集成（CSV）
|
||
- API 契约
|
||
- 代码库对齐（CSV + 规则文档）
|
||
- 应用 ADR
|
||
|
||
### 2.3 数据架构产出
|
||
回答：**关键数据对象是谁、谁维护、怎么流动、怎么保护**
|
||
- 实体清单（CSV）
|
||
- 数据流（CSV）
|
||
- 数据安全分级（CSV）
|
||
- 数据 ADR
|
||
|
||
### 2.4 技术架构产出
|
||
回答：**用什么做、系统怎么运行、怎么发布、怎么回滚、怎么保底安全**
|
||
- 技术选型说明 + 选型 CSV
|
||
- 运行拓扑说明 + 运行组件 CSV
|
||
- 环境配置（CSV）
|
||
- 运维基线
|
||
- 发布与回滚说明
|
||
- 技术 ADR
|
||
|
||
### 2.5 Domain 产出
|
||
回答：**某个领域自己的术语、场景、模块、实体、局部决策与代码落位是什么**
|
||
- 领域概览
|
||
- 统一语言（CSV）
|
||
- 领域场景与流程（CSV）
|
||
- 领域模块（CSV）
|
||
- 领域实体（CSV）
|
||
- 领域局部决策
|
||
- 领域代码映射（CSV）
|
||
- 领域 ADR
|
||
|
||
## 3. 关键依赖
|
||
- `application-architecture/02b-solution-layering.md` 用于说明系统级逻辑分层
|
||
- `application-architecture/02a-layered-architecture.md` 用于说明模块/服务内部代码分层与依赖方向
|
||
- `application-architecture/02-modules.csv` 依赖 `business-architecture/02-capability-map.csv`
|
||
- `application-architecture/03-integrations.csv` 依赖 `business-architecture/03-value-flows.csv`
|
||
- `data-architecture/01-entities.csv` 依赖 `business-architecture/02-capability-map.csv` 与 `application-architecture/02-modules.csv`
|
||
- `technology-architecture/00-technology-selection.csv` 用于沉淀关键技术选型
|
||
- `technology-architecture/01-runtime-components.csv` 体现模块到运行组件的映射
|
||
- `application-architecture/06-codebase-alignment.csv` 用于设计到仓库结构的落地映射
|
||
- `traceability.csv` 汇总跨目录关联关系
|
||
|
||
## 4. 新成员阅读顺序
|
||
1. `business-architecture/01-scope-and-goals.md`
|
||
2. `business-architecture/03-value-flows.csv`
|
||
3. `application-architecture/01-system-context.md`
|
||
4. `application-architecture/02b-solution-layering.md`
|
||
5. `domains/README.md`
|
||
6. `domains/_shared/01-shared-terminology.csv`
|
||
7. `application-architecture/02a-layered-architecture.md`
|
||
8. `application-architecture/02-modules.csv`
|
||
9. `data-architecture/01-entities.csv`
|
||
10. `technology-architecture/00-technology-selection.md`
|
||
11. `technology-architecture/01-runtime-topology.md`
|
||
12. `application-architecture/06-codebase-alignment.csv`
|
||
13. `technology-architecture/04-release-and-rollback.md`
|
||
|
||
## 5. 维护规则
|
||
- 表格型数据优先 CSV
|
||
- prose 与决策说明使用 Markdown
|
||
- 全局 ADR 放 `adr/`
|
||
- 分层 ADR 放到对应目录的 `adr/`
|
||
- 领域局部内容优先维护在 `domains/<domain>/`
|