系统架构
项目概述
这个项目解决什么问题?
主要用户 / 调用方是谁?
不解决什么问题?
三角色关注点
产品负责人关注:
- 核心用户 / 调用方:
- 核心路径:
技术负责人关注:
- 架构 owner:
- 高风险模块:
平台 / 资深工程师关注:
- 本地运行入口:
- CI / 发布 / 监控入口:
系统边界
上游调用方
-> 本系统
-> 下游依赖
本系统负责:
本系统不负责:
架构图
flowchart LR
User["用户 / 上游系统"] --> API["API / 入口层"]
API --> Domain["业务 / Domain"]
Domain --> DB["数据库"]
Domain --> External["外部依赖"]
分层说明
| 层 | 职责 | 主要代码位置 |
|---|---|---|
| API / Transport | HTTP/RPC/webhook/CLI 入口 | |
| Application | use case、事务边界、权限检查 | |
| Domain | 核心业务规则、状态机 | |
| Persistence | DB、cache、queue、object storage | |
| Integration | 外部服务 adapter、provider client |
核心模块
| 模块 | 职责 | Owner | 依赖 | 禁止做什么 |
|---|---|---|---|---|
核心数据流
流程 1:名称
输入
-> 校验
-> 状态变化
-> 持久化
-> 事件 / 响应
状态机
state_a -> state_b -> state_c
-> failed
-> cancelled
数据存储
| 数据 | 存储位置 | Owner | 保留策略 | 备注 |
|---|---|---|---|---|
API / 事件
| 接口 / 事件 | 调用方 | 作用 | 契约位置 |
|---|---|---|---|
运行路径
本地启动:
检查命令:
部署入口:
风险边界
哪些变更必须人工 review / approval?
后续 Agent 注意事项
人类架构文档稳定后再填这一节。
Agent 可以改:
Agent 不应改:
Agent 必须运行的检查:
下一步阅读
读完或填完这份文档后,通常继续看:
- 41-项目架构文档包-project-architecture-pack.md:系统架构完成后,回到架构文档包检查缺口。
- 依赖图-dependency-map.md:涉及上下游时继续补依赖图。