c4-architecture

Topics in the source

• C4 Architecture Documentation
• Workflow
• C4 Diagram Levels
• Quick Start Examples
• System Context (Level 1)
• Container Diagram (Level 2)
• Component Diagram (Level 3)
• Dynamic Diagram (Request Flow)

Generate software architecture documentation using C4 model diagrams in Mermaid syntax. 1. Understand scope - Determine which C4 level(s) are needed based on audience 2. Analyze codebase - Explore the system to identify components, containers, and relationships 3. Generate diagrams - Create Mermaid C4 diagrams at appropriate abstraction levels 4. Document - Write diagrams to markdown files with explanatory context Select the appropriate level based on the documentation need: | Level | Diagram Type | Audience | Shows | When to Create | |-------|-------------|----------|-------|----------------| | 1 | C4Context | Everyone | System + external actors | Always (required) | | 2 | C4Container | Technical | Apps, databases, services | Always (required) | | 3 | C4Component | Developers | Internal components | Only if adds value | | 4 | C4Deployment | DevOps | Infrastructure nodes | For production systems | | - | C4Dynamic | Technical | Request flows (numbered) | For complex workflows | Key Insight: "Context + Container diagrams are sufficient for most software development teams." Only create Component/Code diagrams when they genuinely add value. $c4ShapeInRow - Number of shapes per row (def

This is an excerpt. Refer to the complete source and its current requirements.