技术架构方法论 · 参考文档

文档化速查:C4 · ADR · arc42

画图和写文档时的速查页。方法详解见第 4 课第 5 课

类型:参考 / 可打印

C4 四层速查

层级回答什么受众画不画
上下文系统在世界中的位置:用户、外部系统所有人必画,先画
容器哪些可独立部署运行的单元(服务/库/总线/前端)研发+运维必画,评审主图
组件复杂容器内部的模块划分该容器开发者仅复杂容器
代码类/函数结构——不画(IDE 可生成)

每张图四项检查:□ 标题含层级与范围 □ 每框「名字+类型+技术」 □ 每箭头带动词 □ 有图例。补充视角:动态图(调用序列)、部署图(机器分布)。规范出处:c4model.com

Nygard ADR 模板

# ADR-NNNN: 【决策的一句话陈述】

## 状态
提议 | 已接受(日期) | 已被 ADR-NNNN 取代

## 背景
- 驱动属性排序中的相关项
- 面临的问题与力量拉扯
- 备选方案 A / B / C

## 决策
采用【X】:【怎么做,一段话】

## 后果
+ 【收益,对应哪个驱动属性】
- 【代价,具体到可验证】
- 否掉【B】:【一句话理由】
- 否掉【C】:【一句话理由】

三项检查:□ 背景引用驱动排序 □ 被否选项+理由 □ 后果栏有减号。
约定:存 docs/adr/NNNN-短横线标题.md;顺序编号不重用;走 PR 评审;只取代不修改。模板出处:Nygard 格式adr.github.io

arc42 最小骨架(7 节)

内容来源
1. 目标与质量驱动属性排序 + 质量属性场景第 1 课产物
2. 约束技术/组织/合规约束第 1 课产物
3. 上下文C4 上下文图第 4 课产物
4. 方案策略风格选择与理由(一段话)第 2 课产物
5. 构建块视图C4 容器图(+关键组件图)第 4 课产物
9. 架构决策ADR 索引第 5 课产物
11. 风险与技术债评审风险清单第 3 课产物

完整 12 节见 docs.arc42.org;官方立场即按需裁剪,填满不是目标。

→ 第 4 课:C4 分层画图 → 评审清单