generating-mermaid-diagrams

Generate Salesforce architecture diagrams in Mermaid syntax with ASCII fallback.

803|289|Updated Nov 7, 2025

Search Tags:#mermaid #oauth #sequence diagram #architecture visualization #erd #salesforce diagrams #ascii fallback

Ready to run

npx skills add https://github.com/forcedotcom/sf-skills --skill generating-mermaid-diagrams

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: generating-mermaid-diagrams
Source: https://github.com/forcedotcom/sf-skills/tree/main/skills/generating-mermaid-diagrams
Command: npx skills add https://github.com/forcedotcom/sf-skills --skill generating-mermaid-diagrams

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

It solves the problem of communicating complex Salesforce architecture, OAuth flows, data models, and integrations using clean, text-first diagrams that are easy to edit and share.

Core Features & Use Cases

Mermaid + ASCII output: Produces Mermaid diagrams for rich rendering and an ASCII fallback for plaintext/terminal compatibility.
Salesforce-focused diagram families: Covers OAuth flows (multiple grant types), ERDs/data models, integration sequence patterns, system landscapes, role hierarchies, and Agentforce structure.
Grounding and conventions: Encourages consistent diagram structure (actors, steps, relationship types) and supports optional grounding for ERDs via org metadata querying and related skills for object/field discovery.

Quick Start

Ask for a Mermaid diagram and an ASCII fallback by saying: "Create a JWT Bearer OAuth flow diagram for our CI/CD integration and include an ASCII fallback."

Frequently Asked Questions about generating-mermaid-diagrams

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate Mermaid sequence diagrams for Salesforce OAuth flows?▼

Salesforce OAuth flow diagrams are generated using Mermaid syntax with an ASCII fallback for plaintext compatibility. It covers multiple grant types like JWT Bearer flows for CI/CD integrations and provides sequence ordering guardrails.

Can I create an ERD data model diagram from Salesforce org metadata?▼

ERD data model diagrams support optional grounding by querying Salesforce org metadata and delegating object/field discovery to related skills. This ensures your entity relationship diagrams accurately reflect your Salesforce data structure.

Does the Mermaid diagram output work in terminal environments without rendering?▼

The output includes an ASCII fallback specifically for terminal or plaintext compatibility. While Mermaid syntax requires a Mermaid-capable rendering environment for rich previews, the ASCII version displays correctly in standard terminals.

What is the best way to visualize Salesforce architecture across markdown-friendly contexts?▼

Generating Mermaid diagrams is an effective way to visualize Salesforce architecture across markdown-friendly contexts. It covers system landscapes, role hierarchies, and Agentforce structures with consistent relationship notation conventions.

Do I need a Mermaid-capable renderer to view the generated Salesforce integration sequence patterns?▼

A Mermaid-capable rendering environment is required to preview the rich Mermaid diagram output for integration sequence patterns. However, the included ASCII fallback allows you to view sequence patterns directly in plaintext or terminal contexts.