|
| 1 | +# Diagrams Skills |
| 2 | + |
| 3 | +Visual documentation and diagramming with Mermaid.js and other tools. |
| 4 | + |
| 5 | +## Available Skills |
| 6 | + |
| 7 | +### Mermaid.js Core Diagrams |
| 8 | + |
| 9 | +**mermaid-flowcharts.md** |
| 10 | +- Process flow visualization |
| 11 | +- Node shapes and connections |
| 12 | +- Decision trees and branching |
| 13 | +- Subgraphs and organization |
| 14 | +- Common patterns: API flows, data pipelines, authentication |
| 15 | + |
| 16 | +**mermaid-sequence-diagrams.md** |
| 17 | +- Interaction and message flows |
| 18 | +- Participants and actors |
| 19 | +- Message arrow types |
| 20 | +- Activation boxes and control flow |
| 21 | +- Common patterns: REST API, microservices, retry logic |
| 22 | + |
| 23 | +**mermaid-class-state-diagrams.md** |
| 24 | +- UML class diagrams |
| 25 | +- Object relationships and hierarchies |
| 26 | +- State machines and transitions |
| 27 | +- Composite states and choice nodes |
| 28 | +- Common patterns: API models, repositories, workflows |
| 29 | + |
| 30 | +**mermaid-er-diagrams.md** |
| 31 | +- Entity-relationship diagrams |
| 32 | +- Database schema design |
| 33 | +- Cardinality and relationships |
| 34 | +- Keys and attributes |
| 35 | +- Common patterns: E-commerce, auth systems, CMS |
| 36 | + |
| 37 | +### Mermaid.js Advanced Diagrams |
| 38 | + |
| 39 | +**mermaid-architecture-diagrams.md** |
| 40 | +- C4 diagrams (Context, Container, Component) |
| 41 | +- Block diagrams |
| 42 | +- System architecture visualization |
| 43 | +- Infrastructure and deployment |
| 44 | +- Common patterns: Microservices, serverless, Kubernetes |
| 45 | + |
| 46 | +**mermaid-charts.md** |
| 47 | +- Data visualization charts |
| 48 | +- Pie charts for distributions |
| 49 | +- XY charts (line and bar) |
| 50 | +- Quadrant charts for prioritization |
| 51 | +- Radar charts for multi-dimensional comparison |
| 52 | + |
| 53 | +**mermaid-project-diagrams.md** |
| 54 | +- Gantt charts for project timelines |
| 55 | +- Task dependencies and critical path |
| 56 | +- Timeline diagrams for chronology |
| 57 | +- Milestone tracking |
| 58 | +- Common patterns: Release plans, sprints, migrations |
| 59 | + |
| 60 | +**mermaid-specialized.md** |
| 61 | +- Git graphs for version control workflows |
| 62 | +- Sankey diagrams for data flows |
| 63 | +- Mindmaps for concept hierarchies |
| 64 | +- Requirement diagrams |
| 65 | +- Common patterns: Gitflow, budget allocation, learning paths |
| 66 | + |
| 67 | +## Quick Reference |
| 68 | + |
| 69 | +### When to Use Which Diagram |
| 70 | + |
| 71 | +**Process & Logic**: |
| 72 | +- Flowchart: Algorithm, decision tree, workflow |
| 73 | +- Sequence: API interaction, protocol, communication |
| 74 | + |
| 75 | +**Structure & Design**: |
| 76 | +- Class: Object model, API structure, OOP design |
| 77 | +- ER: Database schema, data relationships |
| 78 | +- Architecture: System design, infrastructure, deployment |
| 79 | + |
| 80 | +**Data & Metrics**: |
| 81 | +- Pie: Distribution, percentages, breakdown |
| 82 | +- XY: Trends, comparisons, time series |
| 83 | +- Quadrant: Prioritization, risk assessment |
| 84 | +- Radar: Skill assessment, multi-dimensional comparison |
| 85 | +- Sankey: Flow analysis, conversion funnels |
| 86 | + |
| 87 | +**Planning & History**: |
| 88 | +- Gantt: Project schedule, dependencies, critical path |
| 89 | +- Timeline: Product roadmap, history, milestones |
| 90 | +- GitGraph: Branching strategy, release workflow |
| 91 | + |
| 92 | +**Ideation & Organization**: |
| 93 | +- Mindmap: Brainstorming, concept breakdown, learning paths |
| 94 | +- State: Lifecycle, protocol states, FSM |
| 95 | + |
| 96 | +## Usage Patterns |
| 97 | + |
| 98 | +### Documentation |
| 99 | +```bash |
| 100 | +# In markdown files |
| 101 | +```mermaid |
| 102 | +graph TD |
| 103 | + A --> B |
| 104 | +``` |
| 105 | +``` |
| 106 | + |
| 107 | +### Live Preview |
| 108 | +- Use https://mermaid.live for development |
| 109 | +- Auto-renders in GitHub/GitLab markdown |
| 110 | +- VS Code: Install "Mermaid Preview" extension |
| 111 | + |
| 112 | +### Combining Diagrams |
| 113 | + |
| 114 | +**Start broad, drill down**: |
| 115 | +1. Architecture diagram → System context |
| 116 | +2. Sequence diagram → Runtime behavior |
| 117 | +3. Class/ER diagram → Data/object structure |
| 118 | +4. Flowchart → Business logic detail |
| 119 | + |
| 120 | +**Example workflow**: |
| 121 | +- C4 Context → What systems exist? |
| 122 | +- C4 Container → What technologies? |
| 123 | +- Sequence → How do they interact? |
| 124 | +- Class → What's the data model? |
| 125 | +- Flowchart → What's the algorithm? |
| 126 | + |
| 127 | +## Best Practices |
| 128 | + |
| 129 | +1. **One diagram, one purpose**: Don't mix abstraction levels |
| 130 | +2. **Label everything**: Axes, relationships, transitions |
| 131 | +3. **Limit complexity**: Split large diagrams into focused views |
| 132 | +4. **Use consistent styling**: Establish patterns for colors, shapes |
| 133 | +5. **Document assumptions**: Add notes for non-obvious details |
| 134 | +6. **Version control**: Track diagram changes like code |
| 135 | + |
| 136 | +## Integration |
| 137 | + |
| 138 | +These skills integrate with: |
| 139 | +- **api-*** skills: Document API design with sequence/class diagrams |
| 140 | +- **database-*** skills: Schema design with ER diagrams |
| 141 | +- **testing-*** skills: Test flows with sequence/flowcharts |
| 142 | +- **containers-*** skills: Deployment with architecture diagrams |
| 143 | +- **git-*** skills: Workflow visualization with Git graphs |
| 144 | + |
| 145 | +## Resources |
| 146 | + |
| 147 | +- Mermaid.js: https://mermaid.js.org |
| 148 | +- Live Editor: https://mermaid.live |
| 149 | +- GitHub Docs: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams |
| 150 | +- C4 Model: https://c4model.com |
| 151 | +- UML Reference: https://www.uml-diagrams.org |
0 commit comments