agentleFS
openclawopenclaw/openclaw-enterprise/.agents/skills/mermaid-diagrams/SKILL.md

mermaid-diagrams

Skill472 starsChanged 3 days agoMITView on GitHub

Create or refine readable Mermaid diagrams for changes, architecture, lifecycles, and dependencies in Markdown documents and PR descriptions.

69 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use analytics-metrics, aws-account-management and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • hoodiniSkill

    analytics-metrics

    Build data visualization and analytics dashboards. Use when creating charts, KPI displays, metrics dashboards, or data visualization components. Triggers on analytics, dashboard, charts, metrics, KPI, data visualization, Recharts.

    Also in 3 projects that use this

  • hoodiniSkill

    aws-account-management

    Manage AWS accounts, organizations, IAM, and billing. Use when setting up AWS Organizations, managing IAM policies, controlling costs, or implementing multi-account strategies. Triggers on AWS Organizations, AWS IAM, AWS billing, Cost Explorer, SCPs, multi-account, AWS SSO, Identity Center.

    Also in 3 projects that use this

  • wpankSkill

    professional-communication

    Write effective professional messages for software teams. Use when drafting emails, Slack/Teams messages, meeting agendas, status updates, or translating technical concepts for non-technical audiences. Triggers on email, slack, teams, message, meeting agenda, status update, stakeholder communication, escalation, jargon translation.

    Also in 3 projects that use this

  • LangChainSkill

    langchain

    Build agents with a prebuilt architecture and integrations for any model or tool. Use when creating tool-calling agents, switching model providers, or adding structured output.

    Also in 3 projects that use this

  • imehrSkill

    railway

    Railway.com deployment and management - deployment, logs, migrations, troubleshooting, monorepo strategies, security, and CLI reference. Use when deploying to Railway, configuring services, managing environment variables, or debugging deployment issues.

    Also in 3 projects that use this

  • +7 more from hoodini

The file

We split this skill into the rules it gives an agent

11 rules. 0 are common, 8 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 64 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use a diagram when relationships, phases, or boundaries are easier to understand visually.

    line 8
  2. Distinctive:

    Check the relevant implementation or design before drawing.

    line 14
  3. Distinctive:

    Use solid arrows for implemented connections and dashed arrows for pending or unconnected integration.

    line 18
  4. Very specific:

    Use a native Markdown mermaid code block.

    line 29
  5. Distinctive:

    Keep any alternate notation's meaning clear in the caption.

    line 31
  6. Distinctive:

    Avoid long single-line labels, fixed-width HTML containers, complex inline CSS, and excessive text.

    line 41
  7. Very specific:

    Use muted, desaturated fills with dark labels and thin borders.

    line 43
  8. Very specific:

    Start with 14–16px text and balanced spacing.

    line 46
  9. Distinctive:

    Keep its meaning and endpoints unchanged.

    line 51
  10. Distinctive:

    Check that every edge reflects the relevant evidence and that labels distinguish implemented behavior from pending work.

    line 63
  11. Distinctive:

    When available, render at the intended document width and inspect label contrast, phase-title clearance, node padding, large empty areas, …

    line 67

“Common” is measured: kept by at least 6 in 10 of the 64 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Mermaid diagrams

Use a diagram when relationships, phases, or boundaries are easier to understand visually. Keep the surrounding explanation short. A simple edit or single fact usually needs only prose.

Establish the meaning

  • Check the relevant implementation or design before drawing. State whether the diagram describes current behavior, a proposal, or a before/after comparison.
  • Show the important relationships and major boundaries, not every function. Name subgraphs for the phases or boundaries they explain.
  • Use solid arrows for implemented connections and dashed arrows for pending or unconnected integration. Label arrows with short verbs or conditions. Express asynchronous behavior in words rather than repurposing dashed arrows.
  • Make blockers, missing connections, and out-of-scope work explicit. A proposed connection stays dashed even when its components already exist.
  • Match claims to the evidence: implemented source does not by itself prove a working deployment. If that distinction matters, include it in the diagram or its caption. Do not infer a completed path from neighboring components.

Draw compactly

Use a native Markdown mermaid code block. Prefer flowchart TB; choose another diagram type when it better explains the relationship, such as sequence order. Keep any alternate notation's meaning clear in the caption.

For flowcharts, start from the flowchart template. Its sample behavior is illustrative; replace its nodes and connections with the actual subject.

  • Enable htmlLabels: true in Mermaid's YAML frontmatter.
  • Give nodes short bold headings with <b>...</b> and separate supporting lines with <br/>. Aim for roughly 15–25 characters per line and 2–3 lines per node where practical. Preserve precise names when shortening would obscure meaning.
  • Avoid long single-line labels, fixed-width HTML containers, complex inline CSS, and excessive text. Split an overfull diagram into focused views.
  • Use muted, desaturated fills with dark labels and thin borders; start with 1px strokes. Keep phase outlines neutral so they do not compete with the nodes. Define reusable classDef styles and reinforce color with words and line styles.
  • Start with 14–16px text and balanced spacing. Set subGraphTitleMargin separately from node padding so phase headings have room above their nodes. Tune nodeSpacing and rankSpacing rather than adding empty label lines.
  • Align parallel phases when practical. An extra hyphen on an existing solid arrow (--->) can span another layout rank without adding a relationship. Keep its meaning and endpoints unchanged; avoid inventing edges to force layout.
ColorMeaning
BlueAPIs, configuration, persisted state
PurpleOperator inputs, secrets, external dependencies
TealProcessing, protected operations, implemented capabilities
AmberGates, blockers, conditions requiring attention
Gray with a dashed borderPending or out-of-scope integration

Verify and report

Check that every edge reflects the relevant evidence and that labels distinguish implemented behavior from pending work. Keep confidential details out of diagrams destined for a public document or PR, just as in the surrounding text.

When available, render at the intended document width and inspect label contrast, phase-title clearance, node padding, large empty areas, and confusing crossings. Compare before/after views at the same viewport; a narrower SVG may be enlarged by its viewer. Prefer the destination's renderer; local rendering can differ from the published result. Adjust labels or layout when needed.

Report validation precisely: reviewing source text, passing a Mermaid syntax check, and visually inspecting a rendered diagram are separate checks. If rendering is unavailable, say so; do not describe the diagram as visually verified. Diagram checks do not establish runtime behavior.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.