c4-component
Provides a structured framework for documenting software components using the C4 model.
Install
mkdir -p .claude/skills/c4-component && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/3436" && unzip -o skill.zip -d .claude/skills/c4-component && rm skill.zipInstalls to .claude/skills/c4-component
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Expert C4 Component-level documentation specialist. Synthesizes C4 Code-level documentation into Component-level architecture, defining component boundaries, interfaces, and relationships.Key capabilities
- →Synthesize code into logical components
- →Define component boundaries and interfaces
- →Map component relationships
- →Generate C4 component diagrams
- →Create component-level technical specs
How it works
Aggregates code-level documentation into a standardized C4 format to visualize logical boundaries and dependencies.
Inputs & outputs
When to use c4-component
- →Documenting system architecture
- →Mapping component relationships
- →Creating component-level technical specs
- →Defining interface contracts
About this skill
C4 Component Level: [Component Name]
Use this skill when
- Working on c4 component level: [component name] tasks or workflows
- Needing guidance, best practices, or checklists for c4 component level: [component name]
Do not use this skill when
- The task is unrelated to c4 component level: [component name]
- You need a different domain or tool outside this scope
Instructions
- Clarify goals, constraints, and required inputs.
- Apply relevant best practices and validate outcomes.
- Provide actionable steps and verification.
- If detailed examples are required, open
resources/implementation-playbook.md.
Overview
- Name: [Component name]
- Description: [Short description of component purpose]
- Type: [Component type: Application, Service, Library, etc.]
- Technology: [Primary technologies used]
Purpose
[Detailed description of what this component does and what problems it solves]
Software Features
Code Elements
This component contains the following code-level elements:
- c4-code-file-1.md - [Description]
- c4-code-file-2.md - [Description]
Interfaces
[Interface Name]
- Protocol: [REST/GraphQL/gRPC/Events/etc.]
- Description: [What this interface provides]
- Operations:
operationName(params): ReturnType- [Description]
Dependencies
Components Used
- [Component Name]: [How it's used]
External Systems
- [External System]: [How it's used]
Component Diagram
Use proper Mermaid C4Component syntax. Component diagrams show components within a single container:
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")
**Key Principles** (from [c4model.com](https://c4model.com/diagrams/component)):
- Show components **within a single container** (zoom into one container)
- Focus on **logical components** and their responsibilities
- Show **component interfaces** (what they expose)
- Show how components **interact** with each other
- Include **external dependencies** (other containers, external systems)
Master Component Index Template
# C4 Component Level: System Overview
## System Components
### [Component 1]
- **Name**: [Component name]
- **Description**: [Short description]
- **Documentation**: c4-component-name-1.md
### [Component 2]
- **Name**: [Component name]
- **Description**: [Short description]
- **Documentation**: c4-component-name-2.md
## Component Relationships
[Mermaid diagram showing all components and their relationships]
Example Interactions
- "Synthesize all c4-code-*.md files into logical components"
- "Define component boundaries for the authentication and authorization code"
- "Create component-level documentation for the API layer"
- "Identify component interfaces and create component diagrams"
- "Group database access code into components and document their relationships"
Key Distinctions
- vs C4-Code agent: Synthesizes multiple code files into components; Code agent documents individual code elements
- vs C4-Container agent: Focuses on logical grouping; Container agent maps components to deployment units
- vs C4-Context agent: Provides component-level detail; Context agent creates high-level system diagrams
Output Examples
When synthesizing components, provide:
- Clear component boundaries with rationale
- Descriptive component names and purposes
- Comprehensive feature lists for each component
- Complete interface documentation with protocols and operations
- Links to all contained c4-code-*.md files
- Mermaid component diagrams showing relationships
- Master component index with all components
- Consistent documentation format across all components
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
When not to use it
- →For high-level system context diagrams
- →For deployment-level mapping
Limitations
- →Requires existing code-level documentation
- →Not a substitute for functional testing
How it compares
It focuses on logical component grouping rather than just documenting individual files or deployment units.
Compared to similar skills
c4-component side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| c4-component (this skill) | 1 | 4mo | No flags | Intermediate |
| deepwiki-rs | 25 | 9mo | Review | Intermediate |
| repo-research-analyst | 1 | 6mo | Review | Intermediate |
| agent-pseudocode | 1 | 6mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by sickn33
View all by sickn33 →You might also like
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
repo-research-analyst
parcadei
Analyze repository structure, patterns, conventions, and documentation for understanding a new codebase
agent-pseudocode
ruvnet
Agent skill for pseudocode - invoke with $agent-pseudocode
spec
matteocervelli
>
cs-arch
wildlily1021
维护 `codestable/architecture/` 这份只记现状的系统地图,三种模式 update / check / backfill。触发:用户说"刷新 architecture"、"做架构检查"、"补这个模块的架构文档"、"方案和代码对得上吗",或 feature 阶段需要先做架构动作。不写未来规划(走 cs-roadmap)。
agui-dotnet-feature-workflow
ag-ui-protocol
>