SuperAPI AI 工具集

c4-architecture-c4-architecture

通用与其它

查看项目

更新于 10-15 22:09

技能介绍

用途:为已有代码仓库生成完整 C4 架构文档(Context、Container、Component、Code),采用自底向上分析,从最深代码目录开始逐层合成。适用于需要架构文档、最佳实践或检查清单的 C4 文档任务;任务与 C4 文档无关时不应使用。

主要能力:按四层生成文档。Code 层:对每个子目录生成 c4-code-*.md,记录函数签名、类/模块、内外部依赖与位置。Component 层:将代码文档合成为逻辑组件,含接口、依赖与 Mermaid 图,并生成主组件索引 c4-component.md。Container 层:结合 Dockerfile、K8s、Compose、Terraform 等部署定义映射容器,生成容器接口、OpenAPI 规范(C4-Documentation/apis/[容器]-api.yaml)及容器图。Context 层:生成 c4-context.md,含系统概述、人物角色、功能、用户旅程、外部系统依赖及 C4Context 图。

使用方式:运行 /c4-architecture:c4-architecture,依次完成目录遍历、各层文档生成。可配置 target_directory(默认仓库根)、exclude_patterns(默认 node_modules、.git、build、dist 等)、output_directory(默认 C4-Documentation/)、include_tests(默认 true)、api_format(默认 openapi)。

限制:输出不能替代环境相关的验证、测试或专家评审;所需输入、权限、安全边界或成功标准缺失时应停止并请求澄清。C4 模型并非必须使用全部四层,多数团队上下文图与容器图已足够,本技能为完整性生成全部层级。