collab/mermaid/docs/syntax/userJourney.mdblame
View source
6dd74de1> **Warning**
6dd74de2>
6dd74de3> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
6dd74de4>
6dd74de5> ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/userJourney.md](../../packages/mermaid/src/docs/syntax/userJourney.md).
6dd74de6
6dd74de7# User Journey Diagram
6dd74de8
6dd74de9> User journeys describe at a high level of detail exactly what steps different users take to complete a specific task within a system, application or website. This technique shows the current (as-is) user workflow, and reveals areas of improvement for the to-be workflow. (Wikipedia)
6dd74de10
6dd74de11Mermaid can render user journey diagrams:
6dd74de12
6dd74de13```mermaid-example
6dd74de14journey
6dd74de15 title My working day
6dd74de16 section Go to work
6dd74de17 Make tea: 5: Me
6dd74de18 Go upstairs: 3: Me
6dd74de19 Do work: 1: Me, Cat
6dd74de20 section Go home
6dd74de21 Go downstairs: 5: Me
6dd74de22 Sit down: 5: Me
6dd74de23```
6dd74de24
6dd74de25```mermaid
6dd74de26journey
6dd74de27 title My working day
6dd74de28 section Go to work
6dd74de29 Make tea: 5: Me
6dd74de30 Go upstairs: 3: Me
6dd74de31 Do work: 1: Me, Cat
6dd74de32 section Go home
6dd74de33 Go downstairs: 5: Me
6dd74de34 Sit down: 5: Me
6dd74de35```
6dd74de36
6dd74de37Each user journey is split into sections, these describe the part of the task
6dd74de38the user is trying to complete.
6dd74de39
6dd74de40Tasks syntax is `Task name: <score>: <comma separated list of actors>`
6dd74de41
6dd74de42Score is a number between 1 and 5, inclusive.