SuperAPI AI 工具集

c4-diagrams

编程与开发

查看项目

更新于 10-16 06:19

技能介绍

用途:在详细设计之前澄清软件架构,聚焦边界、职责、参与者、依赖和数据流,只绘制真正能回答问题的层级。适合解释现有代码架构、为新系统做设计前可视化、梳理软件边界等场景。

主要能力与级别选择:提供系统上下文、容器、组件、代码、动态、部署等 C4 层级,按需取用。系统上下文用于识别用户、外部系统与范围;容器展示可部署/可运行单元、数据存储、API、CLI、队列;组件解释单个容器内部;代码级仅在关键类/模块时使用;动态图展示请求、事件或工作流时序;部署图展示基础设施、节点、网络与运行时位置。小系统可建议更小的图集;若仍要全部四级,需把低价值层级标为轻量草图并说明维护成本。

使用方式:先确定用途(现有代码、新系统、设计评审)、格式(ASCII、Mermaid)与严谨度(严格 C4、轻量 C4 风格、混合)。用户已指定则遵循,多个选择含糊时合并为一个简问;若用户要求跳过提问,仍把未决选项作为显式假设保留,并先出轻量图。现有代码需先探查:入口点、运行时边界、集成与持久化;快速通行时至少识别语言/框架、启动入口、主要目录、外部集成与数据存储,其余标为未知。随后选最小有用的图集,从系统上下文或容器开始,仅在回答真实问题时加入组件、动态或部署。用 ASCII 或纯 Mermaid 绘制,再用 3 至 6 条要点解释边界、职责、关键关系、假设与未决问题;未经用户确认图表并同意继续前,不进入详细设计。

限制与注意:Mermaid 须用普通 flowchart 或 sequenceDiagram 语法以保证可移植,不要用 C4 专用 Mermaid 语法;ASCII 用可读方框与箭头,标签要具体(参与者、系统、容器、组件、数据库、队列、外部服务);不要混淆层级,容器是可运行/可部署单元,组件位于某个容器内部;为未来系统或不完整代码库画图时必须写明假设;边界、归属、数据流或部署不确定时必须列未决问题。避免默认画满四级、直接跳入详细设计、把模块当容器、隐藏不确定性。模板见该技能目录中的 templates.md。