SuperAPI AI 工具集

c4-architecture-c4-architecture

通用与其它

查看项目

更新于 10-16 02:30

技能介绍

用途:为已有仓库或代码库生成一套完整的 C4 架构文档(Context、Container、Component、Code),采用自底向上的分析方式,先记录最深层代码元素,再逐级综合为更高层抽象。仅在处理 C4 架构文档任务、需要相关指导或清单时使用;与 C4 架构文档无关或属于其他领域的任务不适用。

主要能力:编排 c4-code、c4-component、c4-container、c4-context 四个专用代理,覆盖四个层级。代码层分析每个子目录,记录函数签名、类/模块、内部与外部依赖、源码位置及关系图;组件层按领域/技术/组织边界划分逻辑组件,编写接口与依赖,并生成组件索引与关系图;容器层结合 Dockerfile、K8s manifests、Docker Compose、Terraform/CloudFormation、云服务定义、CI/CD 等部署定义,把组件映射到容器,输出接口说明与 OpenAPI 3.1+ 规范;上下文层面向非技术读者,描述系统概述、人物角色(含程序化用户与外部系统)、功能、用户旅程、外部依赖,并使用 Mermaid C4Context 图。

使用方式:按阶段执行。第 1 阶段用代码库搜索发现所有子目录,按深度从深到浅排序,过滤 node_modules、.git、build、dist 等非代码目录,对每个目录调用 Task 工具且 subagent_type="c4-architecture::c4-code",输出 C4-Documentation/c4-code-[directory-name].md(目录名需净化,斜杠替换为连字符并去特殊字符)。第 2 阶段汇总代码文档,按业务、技术或团队边界识别组件,调用 c4-architecture::c4-component,生成 c4-component-*.md,再生成总索引 c4-component.md。第 3 阶段搜索部署定义,调用 c4-architecture::c4-container,生成 c4-container.md 和 C4-Documentation/apis/[container-name]-api.yaml。第 4 阶段搜索 README、架构、需求、设计、测试、API、用户文档,调用 c4-architecture::c4-context,生成 c4-context.md。示例入口:/c4-architecture:c4-architecture。

配置项:target_directory(默认当前仓库根目录)、exclude_patterns(默认 node_modules、.git、build、dist 等)、output_directory(默认 C4-Documentation/)、include_tests(默认 true)、api_format(默认 openapi)。

限制:资料未提供支持的平台、费用、价格或性能数据;C4 模型本身说明并非必须使用全部四层,系统上下文图与容器图已可满足多数团队,本工作流为完整性生成全部层级,团队可自行取舍。所有输出写入仓库根目录的 C4-Documentation/ 下。