SuperAPI AI 工具集

c4-codebase-architecture

编程与开发

查看项目

更新于 10-16 00:01

技能介绍

用途:该技能帮助智能体检查代码仓库,产出 C4 风格的架构文档,适合理解既有代码库架构、生成系统上下文/容器/组件视图、帮助新工程师上手、从代码与基础设施定义逆向系统结构,以及对比预期架构与实际实现。

主要能力:可产出系统上下文(系统、用户或角色、外部系统与依赖、关键关系)、容器视图(可部署或可运行单元、数据库、队列、前端、API、worker、无服务器函数、数据存储及其协议与交互)、组件视图(选定容器内的主要组件、职责与关系),以及支撑性叙述(假设、未解决歧义、待确认问题、架构风险或不一致)。可选输出 Mermaid、PlantUML、Structurizr DSL 或纯文本图描述;除非明确要求,不必生成完整代码级图。

使用方式:先确定仓库范围,再识别运行时构建块与交互,推断参与者与外部系统,对重要容器做组件拆分,最后按范围、代码观察、假设与推断、系统上下文、容器视图、组件视图、开放问题、后续改进建议的结构输出。代码不足以判断系统边界、职责、运行时拓扑或业务意图时,应批量提出高价值问题(建议 3 至 7 个)。

适用场景:单体、前后端 monorepo、无服务器系统、微服务等;若仓库主要是库或 SDK,完整 C4 文档可能不合适,应说明其并非完整运行时系统。

限制:需以仓库可观察证据为依据,推断须明确标注,不得把猜测当事实;仓库不一定是完整系统,需明确文档范围;避免把包误当可部署单元、编造无证据的参与者或堆砌无标签箭头。默认交付一份系统上下文、一份容器视图、一份核心容器的组件视图及简短叙述。