Now liveThe Skillselion MCP - thousands of ranked skills, loaded into your agent mid-task. No install.Get it →
forcedotcom avatar

Generating Mermaid Diagrams

  • 531 installs
  • 787 repo stars
  • Updated August 5, 2026
  • forcedotcom/afv-library

This is a copy of generating-mermaid-diagrams by forcedotcom - installs and ranking accrue to the original listing.

generating-mermaid-diagrams is a Salesforce documentation skill that produces Mermaid syntax and ASCII fallback diagrams for architecture, OAuth flows, ERDs, integration sequences, and Agentforce structures in markdown.

About

generating-mermaid-diagrams is version 1.0 of the afv-library skill for text-based Salesforce visual documentation. It generates Mermaid flowcharts, sequence diagrams, class diagrams, and ERDs covering OAuth flows, integration sequences, data models, and Agentforce structures, with ASCII fallbacks when renderers lack Mermaid support. Triggers include requests to diagram, visualize, or draft ERD and sequence views inside Salesforce projects. The skill requires a Mermaid-capable preview environment for live rendering but ships portable source text. Developers choose it over generating-visual-diagrams when they need editable markdown diagrams rather than Nano Banana Pro PNG or SVG mockups for slides and stakeholder decks.

  • Produces Mermaid syntax for architecture, sequence, flowchart, class, and ERD diagrams
  • Includes ASCII fallback for plain-text compatibility in READMEs and issues
  • Triggers automatically on keywords: diagram, visualize, ERD, sequence, flowchart
  • Optimized specifically for Salesforce and Agentforce systems
  • Markdown-friendly output that lives directly in docs and GitHub

Generating Mermaid Diagrams by the numbers

  • 531 all-time installs (skills.sh)
  • Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/forcedotcom/afv-library --skill generating-mermaid-diagrams

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

Listed on Skillselion
Installs531
repo stars787
Last updatedAugust 5, 2026
Repositoryforcedotcom/afv-library

How do you diagram Salesforce architecture in Mermaid?

Generate clean Mermaid diagrams and ASCII fallbacks for Salesforce architecture, OAuth flows, ERDs, integration sequences, and Agentforce structures directly in m

Who is it for?

Salesforce developers documenting integrations, data models, or Agentforce layouts as version-controlled Mermaid in markdown.

Skip if: Requests for PNG, SVG, UI mockups, wireframes, or diagrams for non-Salesforce systems.

When should I use this skill?

User asks for Mermaid diagrams, ERDs, sequence charts, flowcharts, or architecture visualizations for a Salesforce project.

What you get

Mermaid diagram blocks and ASCII fallbacks for OAuth, ERD, sequence, and Agentforce structures.

  • mermaid diagram blocks
  • ascii diagram fallbacks

By the numbers

  • Skill metadata version 1.0 in afv-library

Files

SKILL.mdMarkdownGitHub ↗

generating-mermaid-diagrams: Salesforce Diagram Generation

Use this skill when the user needs text-based diagrams: Mermaid diagrams for architecture, OAuth, integration flows, ERDs, or Agentforce structure, plus ASCII fallback when plain-text compatibility matters.

Scope

In Scope

Use generating-mermaid-diagrams when the user wants:

  • Mermaid output
  • ASCII fallback diagrams
  • architecture, sequence, flowchart, or ERD views in markdown-friendly form
  • diagrams that can live directly in docs, READMEs, or issues

Out of Scope — Delegate elsewhere when the user wants:

  • rendered PNG/SVG images or polished mockups → generating-visual-diagrams
  • non-Salesforce systems only → use a more general diagramming skill
  • object discovery before an ERD → generating-custom-object or generating-custom-field

---

Supported Diagram Families

TypePreferred Mermaid formTypical use
OAuth / auth flowssequenceDiagramAuthorization Code, JWT, PKCE, Device Flow
ERD / data modelflowchart LRobject relationships and sharing context
integration sequencesequenceDiagramrequest/response or event choreography
system landscapeflowcharthigh-level architecture
role / access hierarchyflowchartusers, profiles, permissions
Agentforce behavior mapflowchartagent → topic → action relationships

---

Required Context to Gather First

Ask for or infer:

  • diagram type
  • scope and entities / systems involved
  • output preference: Mermaid only, ASCII only, or both
  • whether styling should be minimal, documentation-first, or presentation-friendly
  • for ERDs: whether org metadata is available for grounding

---

Recommended Workflow

1. Pick the right diagram structure

  • use sequenceDiagram for time-ordered interactions
  • use flowchart LR for ERDs and capability maps
  • keep a single primary story per diagram when possible

2. Gather data

For ERDs and grounded diagrams:

  • use generating-custom-object or generating-custom-field when real schema discovery is needed
  • optionally use the local metadata helper script for counts / relationship context when appropriate

3. Generate Mermaid first

Apply:

  • accurate labels
  • simple readable node text
  • consistent relationship notation
  • restrained styling that renders cleanly in markdown viewers

4. Add ASCII fallback when useful

Provide an ASCII version when the user wants terminal compatibility or plaintext documentation.

5. Explain the diagram briefly

Call out the key relationships, flow direction, and any assumptions.

---

High-Signal Rules

For sequence diagrams

  • use autonumber when step order matters
  • distinguish requests vs responses clearly
  • use notes sparingly for protocol detail

For ERDs

  • prefer flowchart LR
  • keep object cards simple
  • use clear relationship arrows
  • avoid field overload unless the user explicitly asks for field-level detail
  • color-code object types only when it improves readability

For ASCII output

  • keep width reasonable
  • align arrows and boxes consistently
  • optimize for readability over decoration

---

Output Format

````markdown

<Diagram Title>

Mermaid Diagram

<diagram>

ASCII Fallback

<ascii>

Notes

  • <key point>
  • <assumption or limitation>

````

---

Cross-Skill Integration

NeedDelegate toReason
real object / field definitionsgenerating-custom-object / generating-custom-fieldgrounded ERD generation
rendered diagram / image outputgenerating-visual-diagramsvisual polish beyond Mermaid
connected-app auth setup contextconfiguring-connected-appsaccurate OAuth flows
Agentforce logic visualizationdeveloping-agentforcesource-of-truth behavior details
Flow behavior diagramsgenerating-flowactual Flow logic grounding

---

Gotchas

IssueResolution
Mermaid renderer not availableProvide ASCII fallback automatically; note that the Mermaid block still carries the diagram for copy-paste into a renderer
ERD becomes unreadable with too many objectsSplit into sub-diagrams by domain (Sales, Service, etc.) and link them in prose
Sequence diagram step order unclearUse autonumber directive to make step ordering explicit
OAuth flow actors differ by grant typeRead the relevant asset template first before generating to avoid actor mismatch

---

Reference File Index

Conventions & rules — read before generating

  • references/diagram-conventions.md — consistency rules for all diagram types
  • references/mermaid-reference.md — Mermaid syntax quick reference
  • references/usage-examples.md — worked examples per diagram type

Styling

  • references/mermaid-styling.md — theming and annotation patterns
  • references/color-palette.md — color-blind-friendly palette with hex values
  • references/erd-conventions.md — ERD-specific layout and notation rules

Preview

  • references/preview-guide.md — how to render Mermaid locally
  • scripts/README.md — setup and usage instructions for all scripts in this skill
  • scripts/mermaid_preview.py — live-reload preview server; run to preview diagrams in browser
  • scripts/query-org-metadata.py — queries org schema to ground ERD generation

OAuth flow templates — load the matching template when generating OAuth diagrams

  • assets/oauth/authorization-code.md — Authorization Code grant
  • assets/oauth/authorization-code-pkce.md — PKCE variant for mobile/SPA
  • assets/oauth/jwt-bearer.md — JWT Bearer server-to-server
  • assets/oauth/client-credentials.md — Client Credentials service accounts
  • assets/oauth/device-authorization.md — Device Flow for CLI/IoT
  • assets/oauth/refresh-token.md — Refresh Token renewal flow
  • assets/oauth/user-agent-social-sign-on.md — User-Agent / Social Sign-On

Data model ERD templates — load the matching template when generating ERDs

  • assets/datamodel/salesforce-erd.md — core Salesforce objects
  • assets/datamodel/sales-cloud-erd.md — Sales Cloud objects
  • assets/datamodel/service-cloud-erd.md — Service Cloud objects
  • assets/datamodel/b2b-commerce-erd.md — B2B Commerce objects
  • assets/datamodel/campaigns-erd.md — Campaigns and campaign member model
  • assets/datamodel/consent-erd.md — Consent and privacy objects
  • assets/datamodel/files-erd.md — Files and ContentDocument model
  • assets/datamodel/forecasting-erd.md — Forecasting objects
  • assets/datamodel/fsl-erd.md — Field Service Lightning objects
  • assets/datamodel/party-model-erd.md — Party model objects
  • assets/datamodel/quote-order-erd.md — Quote and Order objects
  • assets/datamodel/revenue-cloud-erd.md — Revenue Cloud objects
  • assets/datamodel/scheduler-erd.md — Scheduler objects
  • assets/datamodel/territory-management-erd.md — Territory Management objects

Other diagram templates

  • assets/architecture/system-landscape.md — system landscape overview template
  • assets/integration/api-sequence.md — API callout sequence template
  • assets/agentforce/agent-flow.md — Agentforce agent → topic → action flow
  • assets/role-hierarchy/user-hierarchy.md — role and permission hierarchy template

---

Output Expectations

Deliverables produced by this skill for each request:

  • Mermaid code block — fenced `mermaid block ready to paste into GitHub, Confluence, or any Mermaid-capable renderer
  • ASCII fallback (when requested or when Mermaid renderer is unavailable) — text-only diagram using box/arrow characters
  • Brief explanation — 2-5 bullet points calling out key relationships, flow direction, and any assumptions or limitations in the diagram
  • For ERDs: object cards with field labels and relationship type annotations
  • For sequence diagrams: numbered steps (autonumber) with clear actor labels

---

Score Guide

ScoreMeaning
72–80production-ready diagram
60–71clear and useful with minor polish left
48–59functional but could be clearer
35–47needs structural improvement
< 35inaccurate or incomplete

Related skills

How it compares

Use generating-mermaid-diagrams for editable markdown diagrams; choose generating-visual-diagrams when stakeholders need PNG or SVG mockups.

FAQ

Does generating-mermaid-diagrams output images?

generating-mermaid-diagrams outputs Mermaid source and ASCII text for markdown; rendered PNG or SVG mockups require the generating-visual-diagrams skill instead.

Which Salesforce diagram types does generating-mermaid-diagrams cover?

generating-mermaid-diagrams covers architecture views, OAuth flows, ERDs, integration sequences, flowcharts, class diagrams, and Agentforce structure diagrams with ASCII fallback.

Documentationintegrationsdocs

This week in AI coding

Five minutes, every Monday - the tools, releases and tactics for developers.

unsubscribe anytime.