Skip to content

NetFabric/NetFabric.Numerics / .agents/skills/mermaid-diagrams

mermaid-diagrams

Verified

Author Mermaid diagrams inside ```mermaid fenced code blocks in markdown files (README, AGENTS.md, PR descriptions, chat responses). Covers every stable, non-experimental diagram type: flowchart, sequence, class, state, entity relationship, user journey, Gantt, pie, quadrant, requirement, gitGraph, block, packet, kanban, XY chart, event modeling. Use when: picking a diagram type; writing correct fence syntax; documenting architecture, processes, timelines, schemas, or data relationships compactly for humans and agents alike, since a diagram conveys structure in far fewer tokens than prose. DO NOT USE FOR: the Mermaid Live Editor or mermaid.ai chat (fence syntax only); experimental or beta diagrams (swimlanes, mindmap, timeline, sankey, architecture, radar, treemap, venn, ishikawa, wardley, cynefin, treeView, ZenUML, C4); general Markdown formatting (use markdown-best-practices).

Mermaid Diagrams

Mermaid diagrams render natively in GitHub, VS Code, and Copilot Chat markdown from a plain ```mermaid fenced code block — no image files, no external tools. For an agent, a diagram is also a token-efficient way to convey structure: a 10-line flowchart replaces a paragraph of prose while staying unambiguous for both the human reader and the next agent that reads the file.

Every diagram in this skill is stable in current Mermaid — none require the -beta suffix keyword or carry an "experimental/may evolve" warning in the official docs. Experimental diagram types are deliberately excluded (see frontmatter).

Anatomy

FilePurpose
SKILL.mdDecision table, fence basics, reference index
references/structure-and-data.mdFlowchart, Class, State, Entity Relationship, Block
references/process-and-time.mdSequence, GitGraph, Event Modeling, User Journey
references/planning-and-tracking.mdGantt, Kanban, Requirement
references/charts-and-comparison.mdPie, Quadrant, XY Chart, Packet

Fence Basics

```mermaid
flowchart LR
    A --> B
```

The first line inside the fence is always the diagram's keyword (flowchart, sequenceDiagram, classDiagram, ...) — this is what selects the diagram type; everything else is that diagram's own syntax.

This skill only covers syntax inside the fence — run markdown-best-practices over the surrounding file (blank lines around the fence, heading/list hygiene) before treating the edit as finished.

Which Diagram? (Quick Reference)

DiagramKeywordUse When
Flowchartflowchart / graphShow branching logic, a process, or a decision tree
SequencesequenceDiagramShow ordered messages/calls between actors or systems over time
ClassclassDiagramModel OOP classes: attributes, methods, and relationships
StatestateDiagram-v2Model the states of one entity and its transitions
Entity RelationshiperDiagramModel database entities and their relationships/cardinality
User JourneyjourneyShow a user's steps and satisfaction across a task
GanttganttShow a project schedule: task durations and dependencies over calendar time
PiepieShow proportions of a whole across categories
QuadrantquadrantChartPlot items on two axes to prioritize or categorize them
RequirementrequirementDiagramTrace SysML-style requirements to the elements that satisfy/verify them
GitGraphgitGraphVisualize a branch/commit/merge history
BlockblockFreeform architecture/system diagram needing manual layout control
PacketpacketShow the byte/bit layout of a network packet or binary format
KanbankanbanShow a task board with columns (Todo/In Progress/Done)
XY ChartxychartPlot numeric bar/line data across two axes
Event ModelingeventmodelingShow a UI → Command → Event timeline for an event-sourced system

Reference Files

FileLoad When
references/structure-and-data.mdDocumenting code structure, a data model, or a component layout
references/process-and-time.mdDocumenting an interaction, a history, or a flow over time
references/planning-and-tracking.mdDocumenting a schedule, a task board, or formal requirements
references/charts-and-comparison.mdDocumenting proportions, prioritization, numeric series, or packet layout
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall