mirror of
https://github.com/K-Dense-AI/claude-scientific-skills.git
synced 2026-03-27 07:09:27 +08:00
e05e5373d0
All 40 references to borealBytes/opencode updated to the correct source: https://github.com/SuperiorByteWorks-LLC/agent-project Affected files: SKILL.md, all 24 diagram guides, 9 templates, issue and PR docs, plus assets/examples/example-research-report.md (new file). The example report demonstrates full skill usage: flowchart, sequence, timeline, xychart, radar diagrams — all with accTitle/accDescr and classDef colors, no %%{init}. Covers HEK293T CRISPR editing efficiency as a realistic scientific context.
72 lines
2.2 KiB
Markdown
72 lines
2.2 KiB
Markdown
<!-- 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](../mermaid_style_guide.md)** — 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](sequence.md) for most use cases — ZenUML requires an external plugin and has limited GitHub support.
|
|
|
|
> ⚠️ **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.
|
|
>
|
|
> ⚠️ **Accessibility:** ZenUML does **not** support `accTitle`/`accDescr`. Always place a descriptive _italic_ Markdown paragraph directly above the code block.
|
|
|
|
---
|
|
|
|
## Exemplar Diagram
|
|
|
|
_ZenUML sequence diagram showing a user authentication flow with credential validation and token generation using programming-style syntax:_
|
|
|
|
```mermaid
|
|
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
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## 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
|
|
- `return` keyword draws return arrows
|
|
- **Prefer standard `sequenceDiagram`** for GitHub compatibility
|
|
- Use ZenUML only when the code-style syntax is specifically desired
|
|
|
|
---
|
|
|
|
## Template
|
|
|
|
_Description of the interaction flow:_
|
|
|
|
```mermaid
|
|
zenuml
|
|
@Actor User
|
|
@Boundary Server
|
|
@Entity DB
|
|
|
|
User->Server.request(data) {
|
|
Server->DB.query(params) {
|
|
return results
|
|
}
|
|
return response
|
|
}
|
|
```
|