This document establishes a company-wide standard for creating user flow diagrams. User flows are essential artifacts that help us visualize the complete path a user takes to accomplish a task.

❓ Why do we need a standard?

🧑‍💻 Mermaid

Mermaid is a text-based tool for generating diagrams and charts. We use it as the "source of truth" for our user flows because it is:

Standard Shapes and Meanings

The following table defines the official shapes and their corresponding intents for all user flow diagrams. Sticking to these conventions is crucial for maintaining clarity and consistency.

Mermaid Intent Type Description Shape
[/…/] UI Trigger UI action initiated by user (click, submit, etc.) Parallelogram
[\…\] UI Prompt Request for user input or confirmation Parallelogram alt
[…] System Output UI feedback shown to user Rectangle
[[…]] Processing System logic or computational task Double rectangle
{…} Decision Condition or branching logic (yes/no or success/fail) Diamond
(((…))) Error Error state or user-facing error message Double circle (octagon in Figma)
flowchart TD
	A[/UI Trigger/]
	B[\\UI Prompt\\]
	C[System output]
	D[[Processing]]
	E{Decision}
	F(((Error)))

👨‍🎨 FigJam

FigJam is our collaborative whiteboarding tool. While Mermaid is our source of truth, FigJam is our space for ideation, collaboration, and presentation.

The official FigJam template contains pre-built components for all our standard shapes, making it easy to build and discuss flows visually with the team. Use FigJam when: