SuperAPI AI 工具集

c4-code

写作与研究

查看项目

更新于 10-16 09:50

技能介绍

用途:帮助为某个具体代码目录编写 C4 代码级文档。适用于需要梳理某目录内代码元素、签名与依赖关系,或需要该领域的实践指导与核对清单时;与该目录代码级文档无关的任务不适用。

主要能力:输出包含概述(名称、描述、位置、语言、用途)、代码元素(函数/方法的签名、说明、位置、依赖;类/模块的说明、位置、方法列表、依赖)、依赖(内部与外部)以及关系图。复杂结构可选用 Mermaid:面向对象用 classDiagram 表现类、接口与继承;函数式/过程式可选模块结构图(classDiagram 配合 module 标注)、数据流图或函数依赖图(flowchart)。图类型按编程范式选择,混合范式可组合多种图。

使用方式:明确目标、约束与输入,套用相关最佳实践并验证结果,给出可执行步骤与验证方式。可按目录产出结构化文档,包含完整函数/方法签名与参数、返回类型,代码元素说明,源码位置链接,完整依赖清单,以及复杂关系的 Mermaid 图,并保持命名与格式一致。

适用场景:如分析 src/api、service 层、repository 层;记录认证模块函数与数据流;为 ETL transformers 画数据管线图;分析 utils 纯函数及组合模式;记录 Rust 模块或 Elixir GenServer;记录 Go handlers 包、混合类与函数式工具的 TypeScript 代码库。

限制:资料提示 C4 代码图通常仅在组件复杂时才需要,多数团队使用系统上下文与容器图即可;本技能侧重单个代码元素,与组件、容器、上下文层级的职责不同。具体安装命令、收费与价格信息暂未提供。