System Design Skill
Create Mermaid diagrams for System Design and Architecture.
Directory
code
.concepts/ ├── architecture/ # C4, Deployment, Infrastructure ├── flows/ # Auth, Data, User Journey └── data-models/ # ER, Class, State Diagrams
Workflow
- •Analyze request: What needs to be visualized?
- •Choose diagram type: Appropriate for the use case
- •Document business logic: Text before diagram
- •Create Mermaid: Syntactically correct
- •Save in .concepts/: Correct category
Diagram Types
Architecture
- •C4Context: System overview with actors
- •C4Container: Technical containers (services)
- •Flowchart: Deployment, Infrastructure
Flows
- •Sequence: API calls, service interactions
- •Flowchart: Processes, decisions
- •State: Object states, state machines
- •User Journey: UX flows
Data Models
- •ER Diagram: Database relations
- •Class Diagram: Domain models
- •Mind Map: Hierarchies, brainstorming
Template
markdown
# [Title] ## Business Context [Description of business logic] ## [Diagram Name] \`\`\`mermaid [Diagram Code] \`\`\` ## Details [Tables, explanations, etc.]
Mermaid Syntax Quick Reference
Flowchart
code
flowchart TD
A[Start] --> B{Decision}
B -->|Yes| C[Action]
B -->|No| D[Other]
Sequence
code
sequenceDiagram
A->>B: Request
B-->>A: Response
ER Diagram
code
erDiagram
ENTITY1 ||--o{ ENTITY2 : relationship
State Diagram
code
stateDiagram-v2
[*] --> State1
State1 --> State2: event
C4 Context
code
C4Context
Person(user, "User")
System(app, "App")
Rel(user, app, "Uses")
File Naming
- •
kebab-case.md - •Descriptive name
- •Use category folders
Examples:
- •
.concepts/architecture/deployment.md - •
.concepts/flows/auth-flow.md - •
.concepts/data-models/er-diagram.md