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

Chapter 13: Presenting User Behavior with User Journey Diagrams

A user journey diagram is a graphical representation of a user experience (UX) journey through a series of steps or tasks involved in a process, system, or a website. It can also be used to describe a high level of detail of the various steps a user takes to complete an activity. This is a widely used technique when assessing the customer experience as it helps in revealing areas of improvement in the overall workflow the user goes through. It is also called a customer journey map.

In this chapter you will learn how to use Mermaid to generate User Journey Diagrams, which is one of the newer diagram types supported by Mermaid. You will learn how to create steps and how to group them into sections, how to add multiple actors, and how to add a satisfaction score to a given step. You will also learn how to customize your user journey diagram, overriding the theme variables.

This chapter will cover the following topics...