Skip to main content

markdown-mermaid-writing

Category: research-writing · License: Apache-2.0 · Version: 1.1 Tags: Markdown, Mermaid diagrams, technical writing, documentation, diagrams

When to use it

Writes scientific documents and documentation as markdown with embedded Mermaid diagrams as the canonical, git-diffable source format. Covers a markdown style guide, a Mermaid style guide, 24 Mermaid diagram type references (flowchart, sequence, ER, Gantt, state, mindmap, radar, sankey, XY chart, and others), and 9 templates (research paper, status report, decision record, how-to, pull request, issue, kanban, presentation, project documentation). Use when writing a report, manuscript, README, or analysis in markdown. Use when adding a workflow, pipeline, timeline, or architecture diagram to a document. Use when choosing the right Mermaid diagram type or fixing Mermaid syntax such as radar-beta or xychart-beta. Use when starting from a document template or checking citations and heading rules. Not for scatter plots of real data or photorealistic images; use Python plotting or scientific-schematics for those.

Example requests

Ask your agent in plain language, for example:
  • “Can you turn my pipeline notes into a README with a diagram of the steps?”
  • “I’m drafting analysis_report.md for our RNA-seq differential expression results (12 samples, DESeq2). I want it to be git-diffable, with a methods section, a footnoted reference list, and a figure showing how the reads go from FASTQ to the count matrix. I tried radar for comparing three aligners across five metrics and GitHub says there’s a parse error. Please fix it.”
  • “We have a grant proposal with milestones spread over 18 months and overlapping work packages, and I’d like reviewers to see the schedule at a glance in the doc itself, without pasting in an image.”

Install

In Claude Code you can also add the marketplace with /plugin marketplace add KalarisLabs/research-agent-skills and install the whole research-writing category with /plugin install research-writing@research-agent-skills.

Full playbook

Read SKILL.md for the complete workflow, references and any scripts. The agent installer copies the full skill folder.
Last modified on October 19, 2026