mermaid-diagrams
Skill1 starsChanged 10 months agoMITView on GitHub
Expert guidance on creating accurate, visually polished Mermaid diagrams for architecture documentation.
69 other projects use a version of this.
Adopted by
Most recently taken up by
- radiovisual/claude-skillstheir own version, first seen Nov 16, 2026
- Ivan-propio/claude-skillstheir own version, first seen Nov 16, 2026
- pantheon-org/tekhnetheir own version, first seen Nov 15, 2026
- mikejhill/agent-skillstheir own version, first seen Nov 15, 2026
- MADTeacher/skillstheir own version, first seen Nov 15, 2026
- compozy/compozytheir own version, first seen Nov 13, 2026
Used with
Projects with it also use analytics-metrics, aws-account-management and 9 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
hoodiniSkillanalytics-metrics
Build data visualization and analytics dashboards. Use when creating charts, KPI displays, metrics dashboards, or data visualization components. Triggers on analytics, dashboard, charts, metrics, KPI, data visualization, Recharts.
Also in 3 projects that use this
hoodiniSkillaws-account-management
Manage AWS accounts, organizations, IAM, and billing. Use when setting up AWS Organizations, managing IAM policies, controlling costs, or implementing multi-account strategies. Triggers on AWS Organizations, AWS IAM, AWS billing, Cost Explorer, SCPs, multi-account, AWS SSO, Identity Center.
Also in 3 projects that use this
wpankSkillprofessional-communication
Write effective professional messages for software teams. Use when drafting emails, Slack/Teams messages, meeting agendas, status updates, or translating technical concepts for non-technical audiences. Triggers on email, slack, teams, message, meeting agenda, status update, stakeholder communication, escalation, jargon translation.
Also in 3 projects that use this
LangChainSkilllangchain
Build agents with a prebuilt architecture and integrations for any model or tool. Use when creating tool-calling agents, switching model providers, or adding structured output.
Also in 3 projects that use this
imehrSkillrailway
Railway.com deployment and management - deployment, logs, migrations, troubleshooting, monorepo strategies, security, and CLI reference. Use when deploying to Railway, configuring services, managing environment variables, or debugging deployment issues.
Also in 3 projects that use this
- +6 more from hoodini
Other versions69 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 69
- The-Vibe-Company/quivr★ 40ksame name
- QuivrHQ/quivr★ 40ksame name
- langchain-ai/openwiki★ 18ksame name
- compozy/compozy★ 2.9ksame name
- pedronauck/skills★ 655same name
- openclaw/openclaw-enterprise★ 472same name
- hoodini/ai-agents-skills★ 295same name
- shep-ai/shep★ 277same name
- veelenga/claude-mermaid★ 221same name
- magnus919/agent-skills★ 177same name
59 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository13 other files it gives its agents.
- AGENTS.mdAGENTS.md
- ai-orchestration-patternsSkill
- architecture-decision-recordSkill
- clean-architectureSkill
- doclingSkill
- docs-standardSkill
- mongodbSkill
- pydantic-aiSkill
- python-async-patternsSkill
- skill-creatorSkill
- software-architectureSkill
- supabaseSkill
- workflow-creatorSkill
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 3 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 64 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 145
Match the code: Use actual method/class names from the implementation
- Very specific: line 146
Show parallelism: Use par blocks for concurrent operations
- Very specific: line 149
Add context: Use Note annotations for non-obvious logic
- Distinctive: line 150
Test rendering: Verify in mermaid.live before committing
- Distinctive: line 154
When documenting a service, include:
“Common” is measured: kept by at least 6 in 10 of the 64 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Mermaid Diagrams Skill
This skill provides patterns and best practices for creating high-quality Mermaid diagrams that accurately document software architecture.
When to Use
- Creating C4 zoom-in diagrams for services
- Documenting sequence flows with parallel execution
- Visualizing component dependencies
- Building flowcharts for decision logic
Diagram Types
1. Sequence Diagrams (Temporal Flow)
Best for showing how components interact over time.
sequenceDiagram
autonumber
participant A as ComponentA
participant B as ComponentB
participant C as ExternalService
A->>B: method_call(args)
activate B
par Parallel Operations
B->>C: async_operation_1()
C-->>B: result_1
and
B->>C: async_operation_2()
C-->>B: result_2
end
B-->>A: combined_result
deactivate BKey elements:
autonumber: Adds step numbers for referenceactivate/deactivate: Shows component lifecyclepar/and/end: Visualizes parallel executionNote over X: Adds contextual annotations
2. Flowchart (Component Diagram)
Best for showing static dependencies between components.
flowchart TB
subgraph Service["ServiceName"]
direction TB
method1["public_method()"]
method2["_private_method()"]
method1 --> method2
end
subgraph Interfaces["Abstractions"]
direction LR
IInterface1([Interface1])
IInterface2[(Interface2)]
end
method1 -.->|uses| IInterface1
method2 -.->|calls| IInterface2
%% Styling
style Service fill:#1a1a2e,stroke:#16213e,stroke-width:2px,color:#eaeaea
style Interfaces fill:#0f3460,stroke:#1a1a2e,stroke-width:2px,color:#eaeaea
style method1 fill:#e94560,stroke:#1a1a2e,color:#fff
style method2 fill:#533483,stroke:#1a1a2e,color:#fffKey elements:
subgraph: Groups related componentsdirection TB/LR: Controls flow direction-.->: Dashed arrows for dependenciesstyle: Custom colors per node
3. C4 Container Diagram
For high-level system architecture:
flowchart TB
subgraph System["System Boundary"]
subgraph Layer1["Presentation Layer"]
UI[Web UI]
CLI[CLI Tool]
end
subgraph Layer2["Service Layer"]
SVC[Core Service]
end
subgraph Layer3["Data Layer"]
DB[(Database)]
Cache[(Cache)]
end
end
UI --> SVC
CLI --> SVC
SVC --> DB
SVC --> Cache
%% Layer colors
style Layer1 fill:#2d3436,stroke:#636e72
style Layer2 fill:#0984e3,stroke:#74b9ff
style Layer3 fill:#00b894,stroke:#55efc4Styling Guidelines
Color Palette (Dark Theme)
| Layer | Fill | Stroke | Text |
| Container | #1a1a2e | #16213e | #eaeaea |
| Interfaces | #0f3460 | #1a1a2e | #eaeaea |
| Public Methods | #e94560 | #1a1a2e | #fff |
| Private Methods | #533483 | #1a1a2e | #fff |
| External | #0f4c75 | #1b262c | #bbe1fa |
Node Shapes
| Shape | Syntax | Use Case |
| Rectangle | [Label] | Methods, components |
| Stadium | ([Label]) | Interfaces |
| Cylinder | [(Label)] | Databases, repositories |
| Circle | ((Label)) | Entry/exit points |
| Hexagon | {{Label}} | Decision nodes |
Best Practices
- Match the code: Use actual method/class names from the implementation
- Show parallelism: Use
parblocks for concurrent operations - Layer by abstraction: Group by architectural layer (UI, Service, Data)
- Consistent styling: Apply the same color scheme across all diagrams
- Add context: Use
Noteannotations for non-obvious logic - Test rendering: Verify in mermaid.live before committing
Documentation Template
When documenting a service, include:
- Responsibility: One-paragraph description of the component's role
- Sequence Diagram: For the primary use case flow
- Component Diagram: For static dependencies
- Method Table: Key methods with brief descriptions
Verification Checklist
- Diagram renders without errors in Mermaid preview
- All node names match actual code identifiers
- Parallel operations are properly visualized
- Colors are consistent with the project palette
- Arrows correctly show dependency direction
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

