mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-03 20:34:20 +01:00 
			
		
		
		
	docs: small improvements
This commit is contained in:
		
							
								
								
									
										36
									
								
								docs/syntax/userJourney.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								docs/syntax/userJourney.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,36 @@
 | 
			
		||||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit the corresponding file in src/docs.
 | 
			
		||||
 | 
			
		||||
# User Journey Diagram
 | 
			
		||||
 | 
			
		||||
> 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)
 | 
			
		||||
 | 
			
		||||
Mermaid can render user journey diagrams:
 | 
			
		||||
 | 
			
		||||
```mermaid-example
 | 
			
		||||
journey
 | 
			
		||||
    title My working day
 | 
			
		||||
    section Go to work
 | 
			
		||||
      Make tea: 5: Me
 | 
			
		||||
      Go upstairs: 3: Me
 | 
			
		||||
      Do work: 1: Me, Cat
 | 
			
		||||
    section Go home
 | 
			
		||||
      Go downstairs: 5: Me
 | 
			
		||||
      Sit down: 5: Me
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```mermaid
 | 
			
		||||
journey
 | 
			
		||||
    title My working day
 | 
			
		||||
    section Go to work
 | 
			
		||||
      Make tea: 5: Me
 | 
			
		||||
      Go upstairs: 3: Me
 | 
			
		||||
      Do work: 1: Me, Cat
 | 
			
		||||
    section Go home
 | 
			
		||||
      Go downstairs: 5: Me
 | 
			
		||||
      Sit down: 5: Me
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Each user journey is split into sections, these describe the part of the task
 | 
			
		||||
the user is trying to complete.
 | 
			
		||||
 | 
			
		||||
Tasks syntax is `Task name: <score>: <comma separated list of actors>`
 | 
			
		||||
		Reference in New Issue
	
	Block a user