用途:根据代码库与文档需求,生成采用 C4 模型的软件架构文档,图使用 Mermaid C4 语法,并写入 Markdown 文件。工作流程为:先确定受众与所需 C4 层级,再分析代码库识别组件、容器与关系,然后生成对应抽象层级的图,最后附说明上下文写入文档。
主要能力与层级:C4Context(系统与外部参与者,通常必做)、C4Container(应用、数据库、服务,通常必做)、C4Component(内部组件,仅在有价值时)、C4Deployment(基础设施节点,生产系统)、C4Dynamic(带编号的请求流程,复杂工作流)。资料指出上下文与容器图对多数团队已足够。支持人物/系统、容器(含数据库、队列)、组件、边界、关系(双向及上下左右方向)、部署节点以及样式与布局调整等语法。
使用方式:按受众选择图种,按需生成并写入 docs/architecture/,命名如 c4-context.md、c4-containers.md、c4-components-{feature}.md、c4-deployment.md、c4-dynamic-{flow}.md。
最佳实践与限制:每个元素需有名称、类型、技术(适用时)和描述;使用单向箭头,避免双向歧义;关系标注动作动词并包含技术(如 JSON/HTTPS、JDBC);单图元素不超过 20 个,复杂系统拆分多图;每文件一张图,保持同一抽象层级;别名有意义,描述尽量 50 字符内,始终带标题。避免混淆容器与组件、把共享库当容器、把消息中间件画成单一容器、引入未定义层级、删除类型标签;事件驱动架构应按主题/队列分别建模。微服务归属单团队时建模为容器,跨团队时提升为软件系统。受众对应:高管仅 context,产品经理 context+container,架构师加关键组件,开发者按需全部,DevOps 为 container+deployment。关于安装命令、收费与价格,资料未提供。