mermaid-expert

Generates Mermaid diagrams for modulith architecture, business flows, ADRs, and technical documentation.

Updated Apr 4, 2026
One-click install
npx skills add https://github.com/SleyiW/iWana-neXt --skill mermaid-expert-sleyiw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mermaid-expert
Source: https://github.com/SleyiW/iWana-neXt/tree/main/.agents/skills/mermaid-expert
Command: npx skills add https://github.com/SleyiW/iWana-neXt --skill mermaid-expert-sleyiw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation often lacks clear, consistent diagrams that accurately reflect the approved architecture, leading to confusion between aspirational designs and the real system. This Skill produces Mermaid diagrams that stay aligned with the modulith, multi-tenancy, and stack decisions already documented in the repository. ## Core Features & Use Cases - Architecture and flow diagrams: Create flowcharts, sequence diagrams, ERDs, state diagrams, and Gantt timelines for modules, authentication flows, domain events, and delivery phases. - Architecture-aligned conventions: Enforces rules such as explicit tenant resolution, bounded context separation, and no undocumented microservices, so diagrams never contradict approved ADRs. - Quality checklist and anti-pattern review: Detects illegible diagrams, generic boxes, cross-module data coupling, and missing actors before the diagram ships. - Use Case: While writing an ADR for the authentication module, ask for a sequence diagram of the login and refresh token flow that explicitly shows where tenant resolution and auditing occur. ## Quick Start Ask the assistant to create a Mermaid sequence diagram of the login flow showing where authentication, tenant resolution, and auditing happen in the modulith.

Frequently Asked Questions about mermaid-expert

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a Mermaid sequence diagram for an authentication flow?

Define the actors (user, UI, API, modules, persistence) and the question the diagram answers, then request a sequence diagram showing login, refresh token, and MFA steps. The Skill outputs a render-ready Mermaid block with a short explanatory note.

What Mermaid diagram types work for architecture documentation?

Flowcharts suit operational flows and decisions, sequence diagrams suit API and event interactions, ERDs suit entities within a module, state diagrams suit business lifecycles, and Gantt charts suit phases and milestones. Choose the type based on the question the reader must answer.

Can I use one ERD to document the entire system data model?

A global ERD is discouraged because it erases bounded context limits and can justify cross-module coupling. Instead, create one ERD per module showing its entities and cardinalities, keeping modulith boundaries explicit.

When should a Mermaid diagram be split into multiple diagrams?

Split a diagram when it contains too many nodes to read comfortably or mixes distinct concerns such as tenancy, security, and data flow. The Skill recommends dividing growing diagrams and flags this in its delivery note.

Why should diagrams avoid showing microservices in a modulith project?

Diagrams must represent the real approved system, not an aspirational architecture. Drawing microservices, brokers, or layers the repository has not approved contradicts ADRs and misleads readers of the documentation.