Skip to content

Mermaid Chart Selection

FieldValue
TypeSkill Resource
Source~/.copilot/skills/technical-writing/references/mermaid/chart-selection.md
DescriptionNot specified

Source Content

Mermaid Chart Selection

Use the chart type that answers the reader’s question.

GoalDiagram typeOpening keyword
Actor handoff over timeSequencesequenceDiagram
Process, logic flow, decision treeFlowchartflowchart TD or flowchart LR
Lifecycle and allowed transitionsStatestateDiagram-v2
End-to-end user experience with emotionUser journeyjourney
Durable records, ownership, audit evidenceERerDiagram
Roles, capabilities, interfacesClassclassDiagram
A service in its ecosystem (who and what it touches)C4 contextC4Context
Deployment topology (services, stores, edges)Architecturearchitecture-beta
Trend, count, rate, ordered bucketsXY chartxychart-beta
Volume through a funnel, with drop-offSankeysankey-beta
Two-axis prioritisation (impact vs. effort)QuadrantquadrantChart
Discovery map of a whole serviceMindmapmindmap
Phases or milestones without exact datesTimelinetimeline
Project timeline with dated tasksGanttgantt
Requirement-to-component traceabilityRequirementrequirementDiagram
ProportionsPiepie
Git branchingGitgraphgitGraph

Digital service teams

For a full catalog geared to service delivery — sixteen types grouped by lifecycle phase (understand users, design, connect, deliver, measure), each with when-to-use and when-not guidance and a worked example — read service-team-diagrams.md. It ships with a rendered gallery at ../gallery/index.html so a team can look at every type side by side and agree the house look before anyone draws the next one.

InteractiveMermaid Support

The design-system InteractiveMermaid wrapper uses beautiful-mermaid. Its rich supported chart types are flowcharts, state diagrams, sequence diagrams, class diagrams, ER diagrams, and XY charts.

Do not assume gitGraph, gantt, pie, journey, timeline, mindmap, quadrantChart, sankey-beta, architecture-beta, block-beta, C4Context, or requirementDiagram will render in InteractiveMermaid. Use a static Mermaid surface, an existing UI component, or prose/table guidance for those.

GitOps Mapping

GitOps questionPreferred chartWhy
What does the developer or reviewer do next?Flowchart or sequenceFlowchart gives role color; sequence gives strict time order.
How does a change move from branch to cluster?FlowchartShows branch, PR, CI, Git state, ArgoCD, and runtime result.
Which environment state is allowed next?StateShows gates, waiting states, and recovery loops.
Who owns policy, repo settings, environments, and evidence?ERShows durable records and ownership relationships.
Which role can approve or override?Class or flowchartClass shows capabilities; flowchart shows decisions.
Is delivery getting healthier?XY chartShows deployment count, failed syncs, lead time, MTTR, or incident trend.