SuperAPI AI 工具集

c4-architecture

写作与研究

查看项目

更新于 10-16 09:59

技能介绍

用途:依据代码库生成 C4 模型架构文档,图表使用 Mermaid 语法,输出到 Markdown 文件。

主要能力:支持 C4Context、C4Container、C4Component、C4Deployment、C4Dynamic 五类图;支持 Person、System、Container、Component、ContainerQueue、Deployment_Node、各类 Boundary 等元素,以及 Rel、BiRel、方向关系、UpdateLayoutConfig、UpdateElementStyle、UpdateRelStyle 等样式与布局设置。

使用方式:先确定受众需要的 C4 层级,再分析代码库识别组件、容器与关系,然后生成对应层级的 Mermaid 图并写入 Markdown。文档默认放在 docs/architecture/,命名如 c4-context.md、c4-containers.md、c4-components-{feature}.md、c4-deployment.md、c4-dynamic-{flow}.md。

适用场景:为开发团队、架构师、产品经理或运维编写系统架构说明;微服务、事件驱动、生产部署等场景均有对应模式;多团队拥有微服务时可将服务提升为 System。

限制与规范:每图元素不超过 20 个,只使用单向箭头,关系需写动作动词并标注技术;每个元素需含名称、类型、技术(适用时)和描述;避免把共享库当作容器、把消息代理画成单个容器;Component/Code 图仅在确有价值时创建。其他收费、平台支持等信息暂未提供。