Why does this skill prioritize Mermaid diagrams over images?

Mermaid diagrams are text-based, which makes them more token-efficient for AI, easily editable without specialized tools, and readable in Git diffs.

How does this work with other AI image generation tools?

It follows a three-phase workflow: Mermaid is the mandatory source of truth (Phase 1), while Python charts or AI images are optional downstream additions (Phases 2 & 3).

Can I use this for standard software development tasks?

Yes, it includes templates for Pull Requests, Issue templates, Kanban boards, and Architecture Decision Records (ADRs).

Which diagram types are supported by this skill?

It supports 24 types, including flowcharts, sequence diagrams, ER diagrams, C4 models, Gantt charts, Sankey diagrams, radar charts, and more.

Markdown & Mermaid Documentation Standard

Name: Markdown & Mermaid Documentation Standard
Author: youyinnn

byyouyinnn

0•

Learning & Documentation

Establishes a standardized framework for creating scientific documents and visual relationships using Markdown and Mermaid diagrams.

This skill transforms technical documentation by enforcing a text-based, git-friendly standard using Markdown and embedded Mermaid diagrams. By prioritizing Mermaid over binary images, it ensures documentation is version-controllable, token-efficient, and fully accessible. The skill provides a comprehensive library covering 24 distinct diagram types—from flowcharts and C4 models to Sankey and radar charts—along with nine professional templates and strict style guides. It is designed to act as the primary documentation layer for research papers, architecture decision records, and project reports, ensuring that the source of truth remains editable and machine-readable.

Key Features

010 GitHub stars

02Nine standardized templates for research papers, ADRs, and project management

03Accessibility-focused diagramming requirements with mandatory titles and descriptions

04Text-first documentation philosophy optimized for Git diffs and version control

05Strict Markdown style guide for consistent heading, emoji, and citation usage

06Library of 24 Mermaid diagram types including C4, Gantt, and State machines

Use Cases

01Drafting peer-reviewed scientific manuscripts and technical research reports

02Visualizing complex system architectures and data pipelines within Git repositories

03Standardizing team documentation including ADRs, PR descriptions, and project roadmaps

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add youyinnn/skills-collection markdown-mermaid-writing

For use in Claude.ai and ChatGPT

Key Features

010 GitHub stars

02Nine standardized templates for research papers, ADRs, and project management

03Accessibility-focused diagramming requirements with mandatory titles and descriptions

04Text-first documentation philosophy optimized for Git diffs and version control

05Strict Markdown style guide for consistent heading, emoji, and citation usage

06Library of 24 Mermaid diagram types including C4, Gantt, and State machines

Use Cases

01Drafting peer-reviewed scientific manuscripts and technical research reports

02Visualizing complex system architectures and data pipelines within Git repositories

03Standardizing team documentation including ADRs, PR descriptions, and project roadmaps