Expert C4 Component-level documentation specialist. Synthesizes C4
Add this skill
npx mdskills install sickn33/c4-componentWell-structured template for synthesizing C4 code-level docs into component architecture
1---2name: c4-component3description: Expert C4 Component-level documentation specialist. Synthesizes C44 Code-level documentation into Component-level architecture, defining component5 boundaries, interfaces, and relationships. Creates component diagrams and6 documentation. Use when synthesizing code-level documentation into logical7 components.8metadata:9 model: sonnet10---1112# C4 Component Level: [Component Name]1314## Use this skill when1516- Working on c4 component level: [component name] tasks or workflows17- Needing guidance, best practices, or checklists for c4 component level: [component name]1819## Do not use this skill when2021- The task is unrelated to c4 component level: [component name]22- You need a different domain or tool outside this scope2324## Instructions2526- Clarify goals, constraints, and required inputs.27- Apply relevant best practices and validate outcomes.28- Provide actionable steps and verification.29- If detailed examples are required, open `resources/implementation-playbook.md`.3031## Overview3233- **Name**: [Component name]34- **Description**: [Short description of component purpose]35- **Type**: [Component type: Application, Service, Library, etc.]36- **Technology**: [Primary technologies used]3738## Purpose3940[Detailed description of what this component does and what problems it solves]4142## Software Features4344- [Feature 1]: [Description]45- [Feature 2]: [Description]46- [Feature 3]: [Description]4748## Code Elements4950This component contains the following code-level elements:5152- [c4-code-file-1.md](./c4-code-file-1.md) - [Description]53- [c4-code-file-2.md](./c4-code-file-2.md) - [Description]5455## Interfaces5657### [Interface Name]5859- **Protocol**: [REST/GraphQL/gRPC/Events/etc.]60- **Description**: [What this interface provides]61- **Operations**:62 - `operationName(params): ReturnType` - [Description]6364## Dependencies6566### Components Used6768- [Component Name]: [How it's used]6970### External Systems7172- [External System]: [How it's used]7374## Component Diagram7576Use proper Mermaid C4Component syntax. Component diagrams show components **within a single container**:7778```mermaid79C4Component80 title Component Diagram for [Container Name]8182 Container_Boundary(container, "Container Name") {83 Component(component1, "Component 1", "Type", "Description")84 Component(component2, "Component 2", "Type", "Description")85 ComponentDb(component3, "Component 3", "Database", "Description")86 }87 Container_Ext(externalContainer, "External Container", "Description")88 System_Ext(externalSystem, "External System", "Description")8990 Rel(component1, component2, "Uses")91 Rel(component2, component3, "Reads from and writes to")92 Rel(component1, externalContainer, "Uses", "API")93 Rel(component2, externalSystem, "Uses", "API")94```95````9697**Key Principles** (from [c4model.com](https://c4model.com/diagrams/component)):9899- Show components **within a single container** (zoom into one container)100- Focus on **logical components** and their responsibilities101- Show **component interfaces** (what they expose)102- Show how components **interact** with each other103- Include **external dependencies** (other containers, external systems)104105````106107## Master Component Index Template108109```markdown110# C4 Component Level: System Overview111112## System Components113114### [Component 1]115- **Name**: [Component name]116- **Description**: [Short description]117- **Documentation**: [c4-component-name-1.md](./c4-component-name-1.md)118119### [Component 2]120- **Name**: [Component name]121- **Description**: [Short description]122- **Documentation**: [c4-component-name-2.md](./c4-component-name-2.md)123124## Component Relationships125[Mermaid diagram showing all components and their relationships]126````127128## Example Interactions129130- "Synthesize all c4-code-\*.md files into logical components"131- "Define component boundaries for the authentication and authorization code"132- "Create component-level documentation for the API layer"133- "Identify component interfaces and create component diagrams"134- "Group database access code into components and document their relationships"135136## Key Distinctions137138- **vs C4-Code agent**: Synthesizes multiple code files into components; Code agent documents individual code elements139- **vs C4-Container agent**: Focuses on logical grouping; Container agent maps components to deployment units140- **vs C4-Context agent**: Provides component-level detail; Context agent creates high-level system diagrams141142## Output Examples143144When synthesizing components, provide:145146- Clear component boundaries with rationale147- Descriptive component names and purposes148- Comprehensive feature lists for each component149- Complete interface documentation with protocols and operations150- Links to all contained c4-code-\*.md files151- Mermaid component diagrams showing relationships152- Master component index with all components153- Consistent documentation format across all components154
Full transparency — inspect the skill content before installing.