SuperAPI AI 工具集

c4-code

写作与研究

查看项目

更新于 10-16 06:22

技能介绍

用途:该技能面向 C4 模型中的代码级(Code Level)文档,用于分析指定代码目录,产出结构化的代码级说明,帮助团队理解单个组件内部的实现结构。

主要能力:整理函数/方法签名(含参数与返回类型)、类与模块说明、代码元素位置(文件路径与行号)、内部与外部依赖清单,并在结构复杂时生成 Mermaid 关系图。图类型按编程范式选择:面向对象代码用 classDiagram 展示类、接口与继承;函数式或过程式代码可用 classDiagram 以 <<module>> 表示模块结构,或用 flowchart 展示数据流水线与函数依赖。

使用方式:在需要为某目录编写代码级文档时调用,先明确目标、约束与所需输入,再按 C4 代码级模板输出概述(名称、描述、位置、语言、用途)、代码元素、依赖、关系与备注。若需详细示例,可打开 resources/implementation-playbook.md。

适用场景:为 src/api、service 层、repository 层、认证模块、ETL 转换器、utils 目录、Rust 模块、Elixir GenServer、Go handlers 等生成代码级文档;也适用于混合范式代码库。

限制与区分:该技能聚焦单个代码元素,与 C4-Component(将多个文件综合为组件)、C4-Container(映射到部署单元)、C4-Context(高层系统图)不同。按 C4 模型说明,代码图通常仅在组件复杂时才创建,多数团队认为系统上下文图与容器图已足够。具体安装命令、收费与平台信息暂未提供。