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/requirement.md

Requirement Diagram

Back to Style Guide — Read the style guide first for emoji, color, and accessibility rules.

Syntax keyword: requirementDiagram Best for: System requirements traceability, compliance mapping, formal requirements engineering When NOT to use: Informal task tracking (use Kanban), general relationships (use ER)


Exemplar Diagram

requirementDiagram
    accTitle: Requirement Traceability
    accDescr: Illustrative requirements linked to design components; edges are claims to verify.

    requirement high_availability {
        id: 1
        text: "System shall maintain 99.9 percent uptime"
        risk: high
        verifymethod: test
    }

    requirement data_encryption {
        id: 2
        text: "All data at rest shall be AES-256 encrypted"
        risk: medium
        verifymethod: inspection
    }

    requirement session_timeout {
        id: 3
        text: "Sessions expire after 30 minutes idle"
        risk: low
        verifymethod: test
    }

    element auth_service {
        type: service
        docref: "auth-service-v2"
    }

    element crypto_module {
        type: module
        docref: "crypto-lib-v3"
    }

    auth_service - satisfies -> high_availability
    auth_service - satisfies -> session_timeout
    crypto_module - satisfies -> data_encryption

Tips

  • Each requirement needs: id, text, risk, verifymethod
  • id may be text; quote punctuation-bearing values, for example id: "REQ-001"
  • Risk levels: low, medium, high (all lowercase)
  • Verify methods: analysis, inspection, test, demonstration (all lowercase)
  • Use element for design components that satisfy requirements
  • Relationship types: - satisfies ->, - traces ->, - contains ->, - derives ->, - refines ->, - copies ->, - verifies ->
  • Keep to 3–5 requirements per diagram. A satisfies/verifies edge records a claimed relationship, not proof that a test passed
  • Quote free-text text, id, and docref fields, especially hyphens and percent signs
  • Use 4-space indentation inside { } blocks

Template

requirementDiagram
    accTitle: Requirement Traceability
    accDescr: Illustrative requirements linked to design components; edges are claims to verify.

    requirement your_requirement {
        id: 1
        text: "The requirement statement here"
        risk: medium
        verifymethod: test
    }

    element your_component {
        type: service
        docref: "component-ref"
    }

    your_component - satisfies -> your_requirement

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.