SuperAPI AI 工具集

c4-model

通用与其它

查看项目

更新于 10-15 23:41

技能介绍

用途:在编写或更新 ADR 时,同步生成或维护 C4 架构图,输出符合规范 C4(Canonical C4)的 LikeC4 模型。默认生成 Context 和 Container 视图,可选 Deployment 视图。

主要能力:生成 model.c4(规格说明 + 模型)、<system>.c4(聚焦单个系统)、views.c4(一个 Context 视图、一个 Container 视图,可选一个 Deployment 视图)和 likec4.config.js。遵循锁定规格说明块,元素类型仅限 actor、externalSystem、system、container;关系类型仅限 uses、reads、writes、publishes、consumes。每条关系必须有一行描述。元素名称沿用架构师确认的写法,不翻译、缩写或复数化。未解决的细节可用 #open-question 标签,描述以 OPEN Q<N>: 前缀。

使用方式:若 docs/architecture/discovery-brief.md 存在且含 CONFIRMED 元素则直接使用,否则逐项向架构师确认。查找 **/.c4 与 **/likec4.config.,已有文件则读取并识别聚焦系统,无文件则在指定路径(默认仓库根目录 likec4/)搭建骨架。生成后先执行 11 项规范 C4 检查,打印 PASS 或 FAIL;FAIL 不继续。以 diff 形式逐块展示变更,经架构师逐块批准后再写入。随后运行 npx likec4 validate 校验语法,失败时向架构师暴露错误而不自动修复。查看图表:npx likec4 start(交互式浏览器,http://localhost:5173);npx likec4 serve(静态导出)。最后做漂移检查:扫描 ADR 目录,比对文本中组件名与 LikeC4 模型中的名称,报告不匹配项,由架构师决定哪边为准,不自动重命名。

适用场景:需要与 ADR 同步维护、且严格限定在规范 C4 范围内的架构图。

限制:拒绝 Component 视图、Dynamic 视图、自定义元素种类、自定义关系种类、自定义样式、嵌套系统、同一文件多个聚焦系统。希望使用完整 LikeC4 自由度的架构师不应使用此技能。规范 C4 特性在 LikeC4 版本间较稳定,可用 npx likec4 validate 针对已安装版本复核。