cheatsheet / current

ZenUML

Use Mermaid zenuml when you want a more code-like sequence description, especially for method-call style interactions.

ZenUML

Use Mermaid zenuml when you want a more code-like sequence description, especially for method-call style interactions.

Basic template

zenuml
    title Simple Call
    Alice->Bob: hello()

Core syntax

  • Start with zenuml
  • Add title if helpful
  • Describe calls with Caller->Callee: method()
  • Use nested calls to show deeper interaction

Common example

zenuml
    title Order Submission
    User->UI: submitOrder()
    UI->API: createOrder()
    API->DB: saveOrder()
    API->Queue: publishOrderCreated()
    API-->UI: orderId
    UI-->User: confirmation

Good for

  • Call-flow documentation
  • API and service interaction sketches
  • Developers who prefer a code-like sequence style

Watch for

  • If your Mermaid renderer does not support zenuml, use sequenceDiagram instead
  • Keep it focused on calls, not every tiny implementation detail