domains / families / documents / markdown-mermaid-writing

markdown-mermaid-writing

combined

Comprehensive markdown and Mermaid diagram writing skill. Use when creating any scientific document, report, analysis, or visualization. Establishes text-based diagrams as the default documentation standard with full style guides (markdown + mermaid), 24 diagram type references, and 9 document templates. 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.

When to use

• Creating **any scientific document** — reports, analyses, manuscripts, methods sections
• Writing **any documentation** — READMEs, how-tos, decision records, project docs
• Producing **any diagram** — workflows, data pipelines, architectures, timelines, relationships
• Generating **any output that will be version-controlled** — if it's going into git, it should be markdown
• Working with **any other skill** — this skill defines the documentation layer that wraps every other output
• Someone asks you to "add a diagram" or "visualize the relationship" — Mermaid first, always
• Writing a requested Markdown report, README, methods overview, or research note
• Diagramming a workflow, data pipeline, schema, state machine, or conceptual relationship

When not to use

• Python matplotlib structural diagrams
• Seaborn structural diagrams
• AI image generation for structural diagrams
• Scatter plots with real data
• Photorealistic images

Skill page

Conflict

The three copies share the same author, source, and core three-phase workflow, but they disagree on the skill's scope and on the number of diagram types. The K-Dense copy is an optional house style that explicitly defers to repository conventions and journal requirements, lists 23 diagram types, and includes version-aware rendering checks. The Vibe-Skills and OpenClaw copies are stricter, declaring Mermaid the default and canonical format for any scientific document, and list 24 diagram types. Because crowning one copy would hide the real alternative between an optional style guide and a mandatory documentation standard, the copies should be combined.