Skills › Scientific Agent Skills › markdown-mermaid-writing › zenuml.md
zenuml.md
76 lines · skills/markdown-mermaid-writing/references/diagrams/zenuml.md at 5f2bc03
1<!-- Source: https://github.com/SuperiorByteWorks-LLC/agent-project | License: Apache-2.0 | Author: Clayton Young / Superior Byte Works, LLC (Boreal Bytes) -->
3# ZenUML Sequence Diagram
5> **Back to [Style Guide](../mermaid_style_guide.md)** — Read the style guide first for emoji, color, and accessibility rules.
7**Syntax keyword:** `zenuml`
8**Best for:** Code-like sequence diagrams, method-call-style interactions, developers familiar with programming syntax
9**When NOT to use:** Prefer standard [Sequence Diagrams](sequence.md) for most use cases — ZenUML requires an external plugin and has limited GitHub support.
11> ⚠️ **GitHub support:** ZenUML requires the `@mermaid-js/mermaid-zenuml` external module. It may **not render** on GitHub natively. Use standard `sequenceDiagram` syntax for GitHub compatibility.
12>
13> ⚠️ **Accessibility:** ZenUML does **not** support `accTitle`/`accDescr`. Always place a descriptive _italic_ Markdown paragraph directly above the code block.
15---
<!-- Source: https://github.com/SuperiorByteWorks-LLC/agent-project | License: Apache-2.0 | Author: Clayton Young / Superior Byte Works, LLC (Boreal Bytes) -->
ZenUML Sequence Diagram
Back to Style Guide — Read the style guide first for emoji, color, and accessibility rules.
Syntax keyword: zenuml Best for: Code-like sequence diagrams, method-call-style interactions, developers familiar with programming syntax When NOT to use: Prefer standard Sequence Diagrams for most use cases — ZenUML requires an external plugin and has limited GitHub support.
⚠️ GitHub support: ZenUML requires the@mermaid-js/mermaid-zenumlexternal module. It may not render on GitHub natively. Use standardsequenceDiagramsyntax for GitHub compatibility. ⚠️ Accessibility: ZenUML does not supportaccTitle/accDescr. Always place a descriptive italic Markdown paragraph directly above the code block.
Raw lines 1 to 16
17## Exemplar Diagram
19_ZenUML sequence diagram showing a user authentication flow with credential validation and token generation using programming-style syntax:_
21```mermaid
22zenuml
23 @Actor User
24 @Boundary AuthAPI
25 @Entity Database
27 // User initiates login
28 User->AuthAPI.login(credentials) {
29 AuthAPI->Database.findUser(email) {
30 return user
31 }
32 if (user.valid) {
33 return token
34 } else {
35 return error
36 }
37 }
38```
40---
Exemplar Diagram
ZenUML sequence diagram showing a user authentication flow with credential validation and token generation using programming-style syntax:
zenuml
@Actor User
@Boundary AuthAPI
@Entity Database
// User initiates login
User->AuthAPI.login(credentials) {
AuthAPI->Database.findUser(email) {
return user
}
if (user.valid) {
return token
} else {
return error
}
}Raw lines 17 to 41
42## Tips
44- Uses **programming-style syntax** with method calls: `A->B.method(args)`
45- Curly braces `{}` create natural nesting (activation bars)
46- Control flow: `if/else`, `while`, `for`, `try/catch/finally`, `par`
47- Participant types: `@Actor`, `@Boundary`, `@Entity`, `@Database`, `@Control`
48- Comments with `//` render above messages
49- `return` keyword draws return arrows
50- **Prefer standard `sequenceDiagram`** for GitHub compatibility
51- Use ZenUML only when the code-style syntax is specifically desired
53---
Tips
- Uses programming-style syntax with method calls:
A->B.method(args) - Curly braces
{}create natural nesting (activation bars) - Control flow:
if/else,while,for,try/catch/finally,par - Participant types:
@Actor,@Boundary,@Entity,@Database,@Control - Comments with
//render above messages returnkeyword draws return arrows- **Prefer standard
sequenceDiagram** for GitHub compatibility - Use ZenUML only when the code-style syntax is specifically desired
Raw lines 42 to 54
55## Template
57_Description of the interaction flow:_
59```mermaid
60zenuml
61 @Actor User
62 @Boundary Server
63 @Entity DB
65 User->Server.request(data) {
66 Server->DB.query(params) {
67 return results
68 }
69 return response
70 }
71```
Template
Description of the interaction flow:
zenuml
@Actor User
@Boundary Server
@Entity DB
User->Server.request(data) {
Server->DB.query(params) {
return results
}
return response
}74## Verified reference
76Syntax examples reviewed against [official Mermaid documentation](https://mermaid.js.org/syntax/zenuml.html) and rendered with Mermaid 12.0.0 (2026-10-01). Check the destination version; appearance and accessibility are not guaranteed by a successful parse.
Verified reference
Syntax examples reviewed against official Mermaid documentation and rendered with Mermaid 12.0.0 (2026-10-01). Check the destination version; appearance and accessibility are not guaranteed by a successful parse.
Raw lines 74 to 76