arc42

一个免费开源的软件架构文档模板,分为十二个章节,从目标和上下文一直到风险和术语表。

什么是 arc42?

arc42 由 Peter Hruschka 和 Gernot Starke 创建,把架构文档组织为十二个章节:引言与目标、约束、上下文与范围、解决方案策略、构建块视图、运行时视图、部署视图、横切概念、架构决策、质量需求、风险与技术债务,以及术语表。它不规定图的记法,因此团队经常在其中绘制 C4 图:上下文图放在第 3 章,容器图和组件图放在构建块视图(第 5 章),动态图放在运行时视图(第 6 章)。它自己的建议是只记录读者需要的内容,而不是把每个章节都填满。

又称: arc42 template.

相关术语

  • C4 模型 — 一种轻量级的架构可视化方法,从四个层级描述软件系统:System Context(系统上下文)、Container(容器)、Component(组件)和 Code(代码)。
  • 架构决策记录(ADR) — 一份简短文档,记录某一项具有架构重要性的决策、其背景及其后果。
  • 活文档(Living Documentation) — 由运行中的系统生成或校验的文档,因而能随系统演进而保持准确。

了解更多