c4-architecture_skill

Overview

This skill generates C4-model architecture documentation and Mermaid diagrams for software systems. It produces context, container, component, dynamic, and deployment diagrams plus Markdown files with explanatory text. Use it to standardize architecture docs and produce audience-appropriate visualizations quickly.

How this skill works

The skill inspects the requested scope and selects C4 levels appropriate for the audience (context, container, component, deployment, or dynamic). It analyzes provided system descriptions or codebase metadata to identify people, systems, containers, components, relationships, and deployment nodes. It then emits Mermaid C4 syntax and writes focused Markdown files to a docs/architecture/ layout with titles and short explanations.

When to use it

• You need an architecture diagram for planning or reviews
• Document system scope for stakeholders (System Context)
• Show application boundaries and runtime pieces (Container Diagram)
• Explain internal design to developers (Component Diagram)
• Describe infrastructure and runtime topology (Deployment Diagram)

Best practices

• Always start with a System Context diagram to frame scope
• Include name, type, technology and a concise description for every element
• Prefer unidirectional relationships labeled with action verbs
• Keep diagrams under ~20 elements; split into multiple diagrams when complex
• One diagram per file and include a clear title and audience note

Example use cases

• Create a System Context diagram for product kickoff slides
• Generate Container diagrams to hand to engineering for implementation
• Produce Component diagrams for new feature onboarding
• Author Deployment diagrams for production runbooks and runbook reviews
• Model event-driven microservices with topics as containers