---

name: c4-component description: C4 组件级文档专家。将 C4 代码级文档综合为组件级架构，定义组件边界、接口和关系。 risk: unknown source: community date_added: '2026-02-27'

C4 组件级别：[组件名称]

使用此技能的场景

• 处理 C4 组件级别：[组件名称] 的任务或工作流
• 需要 C4 组件级别：[组件名称] 的指导、最佳实践或检查清单

不要使用此技能的场景

• 任务与 C4 组件级别：[组件名称] 无关
• 你需要此范围之外的不同领域或工具

说明

• 明确目标、约束和所需输入。
• 应用相关最佳实践并验证结果。
• 提供可操作的步骤和验证方法。
• 如需详细示例，请打开 resources/implementation-playbook.md。

概述

• 名称：[组件名称]
• 描述：[组件用途的简短描述]
• 类型：[组件类型：应用、服务、库等]
• 技术：[使用的主要技术]

目的

[详细描述此组件的功能及其解决的问题]

软件功能

• [功能 1]：[描述]
• [功能 2]：[描述]
• [功能 3]：[描述]

代码元素

此组件包含以下代码级元素：

• c4-code-file-1.md - [描述]
• c4-code-file-2.md - [描述]

接口

[接口名称]

• 协议：[REST/GraphQL/gRPC/Events/等]
• 描述：[此接口提供什么]
• 操作：
  • operationName(params): ReturnType - [描述]

依赖

使用的组件

• [组件名称]：[如何使用]

外部系统

• [外部系统]：[如何使用]

组件图

使用正确的 Mermaid C4Component 语法。组件图显示单个容器内的组件：

C4Component
    title Component Diagram for [Container Name]

    Container_Boundary(container, "Container Name") {
        Component(component1, "Component 1", "Type", "Description")
        Component(component2, "Component 2", "Type", "Description")
        ComponentDb(component3, "Component 3", "Database", "Description")
    }
    Container_Ext(externalContainer, "External Container", "Description")
    System_Ext(externalSystem, "External System", "Description")

    Rel(component1, component2, "Uses")
    Rel(component2, component3, "Reads from and writes to")
    Rel(component1, externalContainer, "Uses", "API")
    Rel(component2, externalSystem, "Uses", "API")

关键原则（来自 c4model.com）：

• 显示单个容器内的组件（放大一个容器）
• 关注逻辑组件及其职责
• 显示组件接口（它们暴露什么）
• 显示组件之间如何交互
• 包含外部依赖（其他容器、外部系统）

主组件索引模板

# C4 组件级别：系统概述

## 系统组件

### [组件 1]
- **名称**：[组件名称]
- **描述**：[简短描述]
- **文档**：c4-component-name-1.md

### [组件 2]
- **名称**：[组件名称]
- **描述**：[简短描述]
- **文档**：c4-component-name-2.md

## 组件关系
[显示所有组件及其关系的 Mermaid 图]

交互示例

• "将所有 c4-code-*.md 文件综合为逻辑组件"
• "为认证和授权代码定义组件边界"
• "为 API 层创建组件级文档"
• "识别组件接口并创建组件图"
• "将数据库访问代码分组为组件并记录其关系"

关键区别

• 与 C4-Code 代理对比：将多个代码文件综合为组件；Code 代理记录单个代码元素
• 与 C4-Container 代理对比：关注逻辑分组；Container 代理将组件映射到部署单元
• 与 C4-Context 代理对比：提供组件级细节；Context 代理创建高级系统图

输出示例

综合组件时，提供：

• 带有理由的清晰组件边界
• 描述性的组件名称和用途
• 每个组件的完整功能列表
• 包含协议和操作的完整接口文档
• 所有包含的 c4-code-*.md 文件的链接
• 显示关系的 Mermaid 组件图
• 包含所有组件的主组件索引
• 所有组件的一致文档格式

限制

• 仅在任务明确匹配上述范围时使用此技能。
• 不要将输出视为特定环境验证、测试或专家审查的替代品。
• 如果所需的输入、权限、安全边界不明确，请停下来寻求澄清。