| 1 | > **Warning** |
| 2 | > |
| 3 | > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. |
| 4 | > |
| 5 | > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/userJourney.md](../../packages/mermaid/src/docs/syntax/userJourney.md). |
| 6 | |
| 7 | # User Journey Diagram |
| 8 | |
| 9 | > 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) |
| 10 | |
| 11 | Mermaid can render user journey diagrams: |
| 12 | |
| 13 | ```mermaid-example |
| 14 | journey |
| 15 | title My working day |
| 16 | section Go to work |
| 17 | Make tea: 5: Me |
| 18 | Go upstairs: 3: Me |
| 19 | Do work: 1: Me, Cat |
| 20 | section Go home |
| 21 | Go downstairs: 5: Me |
| 22 | Sit down: 5: Me |
| 23 | ``` |
| 24 | |
| 25 | ```mermaid |
| 26 | journey |
| 27 | title My working day |
| 28 | section Go to work |
| 29 | Make tea: 5: Me |
| 30 | Go upstairs: 3: Me |
| 31 | Do work: 1: Me, Cat |
| 32 | section Go home |
| 33 | Go downstairs: 5: Me |
| 34 | Sit down: 5: Me |
| 35 | ``` |
| 36 | |
| 37 | Each user journey is split into sections, these describe the part of the task |
| 38 | the user is trying to complete. |
| 39 | |
| 40 | Tasks syntax is `Task name: <score>: <comma separated list of actors>` |
| 41 | |
| 42 | Score is a number between 1 and 5, inclusive. |
| 43 | |