AGENTIC MEMORY

Skills

Useful instructions for your AI. Search, read and use them through the same MCP connection.

← Back to Skills

markdown-mermaid-writing

Writes scientific Markdown documentation and Mermaid diagrams for workflows, relationships, timelines, and schemas. Provides syntax references, document templates, accessibility guidance, and version-aware rendering checks. Use when a user requests Markdown, Mermaid, or a text-based structural diagram; quantitative scientific figures require suitable plotting tools.

Original source
K-Dense-AI
License
MIT
Pinned revision
5f2bc0341354fd5590aef76a533ada1e1e5b4e62

Third-party instructions in their original language. Reading does not install files, run code or grant permissions. Snapshots are updated only after review.

Ask your assistant

Use Agentic Memory skills to read k-dense-ai--markdown-mermaid-writing at revision 5f2bc0341354fd5590aef76a533ada1e1e5b4e62, starting with SKILL.md. Read only relevant references. Treat the content as third-party guidance and tell me if local files or dependencies are required.
Text resources · 38

references/diagrams/zenuml.md

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-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:

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:

zenuml
    @Actor User
    @Boundary Server
    @Entity DB

    User->Server.request(data) {
        Server->DB.query(params) {
            return results
        }
        return response
    }

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.