- 📌Skill基础信息
- Skill名称:C4架构文档生成器
- 简称:c4-architecture
- 来源:社区第三方(inskillflow/claude-code-skills)
- 运行宿主:仅限 Claude-Code CLI
- 核心定位:通过自底向上分析代码库,自动生成符合C4模型(Context/Container/Component/Code)的完整架构文档,适用于软件系统架构可视化与文档化场景。
- 🧩内部核心组成
- 子Agent集合:
- c4-code:代码级分析
- c4-component:组件级合成
- c4-container:容器级映射
- c4-context:上下文级抽象
- 工作流程:
```mermaid
graph LR
A[代码分析] --> B[组件合成]
B --> C[容器映射]
C --> D[上下文抽象]
```
- 输出文件:
| 文件类型 | 路径格式 | 内容描述 |
|---|---|---|
| 代码文档 | C4-Documentation/c4-code-*.md | 函数/类级详细说明 |
| 组件文档 | C4-Documentation/c4-component-*.md | 功能模块定义 |
| 容器文档 | C4-Documentation/c4-container.md | 部署单元与API规范 |
| 上下文文档 | C4-Documentation/c4-context.md | 系统级全景视图 |
- 🛠安装与启用方式
- 安装命令:
```bash
skills install --user inskillflow/claude-code-skills
```
- 前置要求:
- 需在代码仓库根目录执行
- 需读取权限的代码文件
- 支持识别:Dockerfile/K8s配置等部署描述文件
- 📋标准工作流
- 启动:在代码库根目录运行Skill
- Phase1:深度优先扫描代码目录 → 生成函数/类级文档
- Phase2:聚合代码单元 → 输出组件文档(含Mermaid关系图)
- Phase3:结合部署配置 → 生成容器文档与OpenAPI规范
- Phase4:综合系统信息 → 输出上下文文档与用户旅程地图
- ⚠️关键限制、缺陷、注意事项
- 平台限制:仅支持单代码仓库分析,微服务多仓库需手动整合
- Token消耗:大型代码库可能触发LLM长上下文限制
- 已知缺陷:
- 对非结构化代码(如脚本)识别精度较低
- 动态语言类型推断可能不准确
- 生产建议:建议作为辅助工具,人工校验关键架构决策
- ✅适用场景 & ❌不适合场景
- 推荐场景:
- 遗留系统架构重建
- 新成员入职培训材料生成
- 合规性架构文档自动化
- 不推荐场景:
- 未完成的原型项目(结构不稳定)
- 纯前端项目(缺乏容器级要素)
- 需要严格架构评审的关键系统(需人工复核)
如何安装
skills install --user inskillflow/claude-code-skills通用安装教程:在哪里输入上面的命令
上面的命令本质是在「终端 / 命令行」中调用技能管理器,把该 Skill 下载并注册到你的 AI 工具。各主流工具打开终端的位置不同,按下面操作即可:
- 打开工具自带的终端面板,或系统终端(macOS「终端」、Windows「PowerShell」、Linux「Terminal」)。
- 把上面的安装命令复制进去,回车运行,等待下载与注册完成。
- 重启或重新加载 AI 工具,让新安装的 Skill 被识别。
- 新建对话并触发:直接描述用途,或通过该工具的技能 / 斜杠菜单选中此 Skill。
Claude 桌面版(macOS / Windows)
桌面版没有内置命令行,Skill 需通过 Claude Code CLI 安装。打开系统终端,先执行 npm install -g @anthropic-ai/claude-code,再运行上面的安装命令;完成后完全退出并重新打开 Claude。
Claude Code(终端 CLI)
直接在项目目录的终端里运行上面的命令即可。也可先输入 claude 启动交互界面,再在对话中引用该 Skill(/ 斜杠菜单或直接描述用途)。
VS Code(含 GitHub Copilot)
打开终端面板:菜单「终端 → 新建终端」,或快捷键 Ctrl+`(macOS 为 ⌃+`)。在终端里运行上面的命令;装完后执行「重新加载窗口」(Ctrl+Shift+P → Reload Window),让 Copilot 等扩展识别新技能。
Cursor
底部「终端」面板(Ctrl+`)即是内置终端。粘贴运行上面的命令,完成后在命令面板执行「Reload Window」刷新,再开始对话。
Windsurf
底部「终端」面板运行命令;也可直接使用其内置 Agent 终端,在对话侧执行安装。
其他工具(ChatGPT、本地脚本等)
不支持本地终端的产品,可先在本机终端完成安装,再在对话中描述该 Skill 的能力让其调用;不同工具的命令格式请以其官方文档为准。
风险提示
自动扫描未发现高危命令、隐私抓取或数据外传行为。仍建议安装前快速浏览仓库代码。
Aitishiku.com