Book Image

The Official Guide to Mermaid.js

By : Knut Sveidqvist, Ashish Jain
Book Image

The Official Guide to Mermaid.js

By: Knut Sveidqvist, Ashish Jain

Overview of this book

Mermaid is a JavaScript-based charting and diagramming tool that lets you represent diagrams using text and code, which simplifies the maintenance of complex diagrams. This is a great option for developers as they’re more familiar with code, rather than using special tools for generating diagrams. Besides, diagrams in code simplify maintenance and ensure that the code is supported by version control systems. In some cases, Mermaid makes refactoring support for name changes possible while also enabling team collaboration for review distribution and updates. Developers working with any system will be able to put their knowledge to work with this practical guide to using Mermaid for documentation. The book is also a great reference for looking up the syntax for specific diagrams when authoring diagrams. You’ll start by learning the importance of accurate and visual documentation. Next, the book introduces Mermaid and establishes how to use it to create effective documentation. By using different tools, editors, or a custom documentation platform, you’ll also understand how to use Mermaid syntax for various diagrams. Later chapters cover advanced configuration settings and theme options to manipulate your diagram as per your needs. By the end of this book, you’ll be well-versed with Mermaid diagrams and how they can be used in your workflows.
Table of Contents (19 chapters)
1
Section 1: Getting Started with Mermaid
7
Section 2: The Most Popular Diagrams
12
Section 3: Powerful Diagrams for the Advanced User

Defining a User Journey Diagram

In this section, you will learn about how the steps in a UX journey are represented in a user journey diagram. You will learn the syntax of defining a step using Mermaid code, and you will learn how to add a satisfaction score to a step.

User journey diagrams are extremely useful for business analysts, UX designers, and product owners, to illustrate the user's experience and their satisfaction level over a series of steps/tasks during the fulfillment of a user's story or goals. One big advantage of using Mermaid to create user journey diagrams, for you as an author, is that you do not have to worry about the positioning of individual steps or the score indicator while rendering a diagram—Mermaid takes care of it. You just need to define the steps in a pre-defined syntax, and Mermaid will render a nice-looking diagram for you based on your input.

Now, let's first understand what a user journey diagram looks like, and in the...