Mermaid syntax tutorial

Mermaid Wardley Map Tutorial

Wardley maps connect user needs to capabilities and their evolution. They help with strategy, platform planning, and build-versus-buy decisions.

Platform strategyBuild-versus-buy analysisCapability planning
Syntax

wardley

Examples

1 starter pattern

Review

5 production checks

Diagram preview

Rendered Mermaid example

Wardley Map
Mermaid Wardley Map example

What You Will Learn

How to recognize when Wardley Map is the right Mermaid diagram, write the opening declaration, and shape a readable first version.

Best Fit

Platform strategy, Build-versus-buy analysis, Capability planning.

Start Here

Copy the starter example, replace labels with your domain language, then simplify anything that does not help the reader.

Syntax Basics

Start with the diagram declaration, then add the smallest set of labels, relationships, and annotations needed to communicate the idea.

  • Identify the user need first.
  • Place components by visibility and evolution.
  • Connect dependencies from user need to capabilities.
  • Use annotations to explain strategic movement.

Official Documentation Coverage

The Mermaid documentation for Wardley Map covers the following syntax areas. This tutorial condenses those topics into practical guidance for day-to-day documentation.

Diagram declaration

Diagram declaration is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Coordinate system

Coordinate system is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Components and anchors

Components and anchors is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Decorators

Decorators is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Links and dependencies

Links and dependencies controls how elements connect. Treat these connections as the main information layer, and label them when direction, ownership, or meaning is not obvious.

Evolution and movement

Evolution and movement is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Pipelines

Pipelines is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Custom evolution stages

Custom evolution stages is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

How This Tutorial Uses The Official Docs

Mermaid syntax evolves, so the official page remains the primary reference. This tutorial turns that reference material into an authoring workflow, review checklist, and production guidance.

Start with the official grammar

The official Mermaid Wardley Map page is the source of truth for syntax changes. Use this tutorial to choose the right authoring pattern, then confirm exact keywords and edge cases in the official reference.

Prioritize the core sections

For the first pass, focus on Diagram declaration, Coordinate system, Components and anchors, Decorators. These sections usually explain the minimum structure required for a valid Wardley Map.

Add advanced syntax only when it earns its space

Treat Links and dependencies, Evolution and movement, Pipelines, Custom evolution stages as optional layers. They are valuable when the diagram needs precision, but they should not make the first version harder to read.

Syntax Reference Map

Use this map as a practical reading order for the official syntax page. It separates the first concepts to learn from the advanced details that are better added after the diagram already communicates the right idea.

Phase
How to use it
Start
Diagram declaration

Diagram declaration is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this diagram declaration detail make the wardley map easier to understand or maintain?

Start
Coordinate system

Coordinate system is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this coordinate system detail make the wardley map easier to understand or maintain?

Refine
Components and anchors

Components and anchors is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this components and anchors detail make the wardley map easier to understand or maintain?

Refine
Decorators

Decorators is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this decorators detail make the wardley map easier to understand or maintain?

Refine
Links and dependencies

Links and dependencies controls how elements connect. Treat these connections as the main information layer, and label them when direction, ownership, or meaning is not obvious.

Does this links and dependencies detail make the wardley map easier to understand or maintain?

Polish
Evolution and movement

Evolution and movement is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this evolution and movement detail make the wardley map easier to understand or maintain?

Polish
Pipelines

Pipelines is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this pipelines detail make the wardley map easier to understand or maintain?

Polish
Custom evolution stages

Custom evolution stages is part of the official Mermaid Wardley Map syntax surface. Add it when the starter example needs more precision for production documentation.

Does this custom evolution stages detail make the wardley map easier to understand or maintain?

How To Study The Official Syntax

The official Mermaid page is broad because it documents the full parser surface. For a working tutorial, read it in passes instead of trying to memorize every option at once.

Step 1

Skim the official Wardley Map documentation once to understand the full syntax surface before copying examples into production docs.

Step 2

Focus first on Diagram declaration, Coordinate system, Components and anchors, Decorators, Links and dependencies because these topics usually explain the core authoring model.

Step 3

After the first diagram renders, revisit the official styling, configuration, and advanced sections only when the diagram needs that extra precision.

Authoring Workflow

This workflow turns the official syntax reference into a repeatable writing process for docs, specs, and product pages.

Step 1

Frame the reader question

Before writing syntax, decide what question the Wardley Map should answer. Good diagrams usually answer one question clearly instead of answering several partially.

Step 2

Draft the smallest valid diagram

Start with the declaration for wardley, add only the required elements, and render it before introducing advanced styling or configuration.

Step 3

Add semantic labels

Replace placeholder names with business or system language that readers already know. Labels should reduce explanation work.

Step 4

Review for maintenance

Remove details that are likely to drift quickly. If a value, date, or dependency changes often, explain who owns the update.

Quick Syntax Cheat Sheet

Use this compact reference when you already know the goal and need to write a valid Mermaid Wardley Map quickly.

Declaration
wardley

Start the code block with wardley so Mermaid selects the Wardley Map renderer.

Core content
Identify the user need first.

Add the smallest number of statements that express the main idea before adding visual polish.

Connections
Connect dependencies from user need to capabilities.

Use connections only where they explain ownership, sequence, flow, dependency, or hierarchy.

Advanced topic
Diagram declaration

Use official syntax topics as optional layers, not as requirements for every diagram.

Practice Prompts

Use these prompts after reading the official syntax sections. They force the diagram to stay practical instead of becoming a syntax inventory.

Exercise 1

Create a Wardley Map for platform strategy using no more than eight visible elements.

Exercise 2

Rewrite the starter example with labels from your own product or engineering domain, then remove any line that does not change the reader's understanding.

Exercise 3

Add one official syntax feature from Diagram declaration, Coordinate system, Components and anchors and explain why that feature makes the diagram clearer.

Exercise 4

Compare the result with architecture and c4 and write one sentence explaining why Wardley Map is still the better fit.

Examples

Copy the example into the Mermaid editor, then adjust labels and relationships for your own documentation.

Platform Capability Map

A lightweight strategy map outline.

flowchart TD
  U[User need: create diagrams] --> E[Editor]
  E --> R[Rendering]
  E --> X[Export]
  R --> M[Mermaid engine]
  X --> S[Storage]

Example Walkthrough

Read Mermaid examples from top to bottom. The first meaningful line usually selects the diagram parser; the following lines add labels, relationships, values, states, or layout hints.

flowchart TD

This line declares the Mermaid diagram type, which tells Mermaid which parser and renderer to use.

U[User need: create diagrams] --> E[Editor]

This line adds a relationship, transition, message, data value, or visual item to the diagram.

E --> R[Rendering]

This line adds a relationship, transition, message, data value, or visual item to the diagram.

E --> X[Export]

This line adds a relationship, transition, message, data value, or visual item to the diagram.

R --> M[Mermaid engine]

This line adds a relationship, transition, message, data value, or visual item to the diagram.

X --> S[Storage]

This line adds a relationship, transition, message, data value, or visual item to the diagram.

When To Use Wardley Map

Platform strategy
Build-versus-buy analysis
Capability planning
Architecture investment discussions

Diagram Choice Guide

A strong Mermaid tutorial should also explain when not to use the diagram type. Use this guide before adding a Wardley Map to a public page or technical design document.

Use this diagram when

Wardley Map works best for platform strategy, build-versus-buy analysis, capability planning. It should make the reader's next decision easier, not merely decorate the page.

Choose a different diagram when

Your main question is better answered by another structure, such as architecture, c4, quadrant-chart. For example, use a sequence diagram for message order and a flowchart for branching process logic.

Keep it maintainable by

Keeping the first version small, naming every important element with business language, and linking back to the official Mermaid syntax page when advanced syntax is required.

Production Checklist

Before publishing a Mermaid Wardley Map, run through this checklist so the diagram remains useful after the immediate conversation is over.

Confirm that Wardley Map is the right diagram type for the problem.
Start from the smallest example that communicates the idea clearly.
Use consistent names for nodes, actors, states, or data labels.
Check the diagram in the Mermaid editor before publishing.
Add surrounding text that explains assumptions, scale, or business context.

Production Review Questions

Before shipping the diagram in public docs, compare it against the official syntax page and then ask whether each line helps the reader make a better decision.

Does the first line clearly select the Mermaid Wardley Map renderer with wardley?
Are names and labels short, stable, and meaningful to the target reader?
Do the links and dependencies details show real meaning instead of visual decoration?
Could a teammate update this diagram next month without rereading the whole surrounding document?

Troubleshooting

Most Mermaid issues come from an incorrect declaration, a syntax feature used before the base diagram works, or a diagram that is trying to communicate too many ideas at once.

The diagram does not render

Check that the first line is the correct declaration for Wardley Map: wardley. Then remove advanced lines until the smallest version renders.

The diagram renders but is hard to read

Shorten labels, reduce the number of visible items, and split separate ideas into separate diagrams.

The meaning is ambiguous

Add edge labels, relationship names, axis labels, or surrounding explanatory text so readers know what the diagram is proving.

The diagram becomes stale

Prefer stable concepts over volatile implementation details, and add ownership notes when the diagram documents a changing system.

Publishing Notes

For SEO and long-term documentation quality, keep the Mermaid code close to the explanation. Search engines can understand the surrounding text, while engineers can copy the exact syntax into their own editor.

If the diagram is used in a product page, add a short caption that states what decision the diagram supports. If it is used in internal docs, add ownership and update expectations so the diagram does not become stale after the system changes.

Best Practices

  • -Start from a real user need.
  • -Use evolution stages consistently.
  • -Keep dependencies visible.
  • -Treat the map as a strategic conversation tool.

Common Mistakes

  • -Mapping technology without user need.
  • -Confusing hierarchy with dependency.
  • -Overfitting exact positions.

Choosing Related Diagram Types

If Wardley Map does not quite match your communication goal, compare it with these nearby Mermaid diagram types.

FAQ

Is Mermaid Wardley Map rendered on the server?

This tutorial page is server-rendered for SEO. The Mermaid syntax is shown as plain text so search engines and readers can inspect it without waiting for client-side rendering.

Can I edit this Wardley Map example?

Yes. Open the Mermaid editor, paste the example, and modify the labels, relationships, or values for your own use case.