sf-diagram-mermaid_skill

Overview

This skill creates production-ready Salesforce architecture diagrams as Mermaid code with an ASCII fallback for terminal-friendly output. It targets OAuth flows, ERDs, integration sequences, system landscapes, role hierarchies, and Agentforce agent architectures with clear styling and validation scoring. Templates and sf-metadata integration accelerate diagram generation and ensure accuracy.

How this skill works

I gather the diagram type, scope, and output preference, then select a matching template and collect any needed metadata (record counts, relationships, system names). I generate a Mermaid diagram (flowchart or sequenceDiagram) with color coding and annotations, produce an ASCII fallback using box-drawing characters, and run a five-category validation score for quality. Optional preview and iterative editing are supported.

When to use it

• Document OAuth flows like Authorization Code, JWT Bearer, PKCE, Device Flow for architecture reviews.
• Visualize Salesforce data models (ERDs) showing objects, relationships, LDV indicators, and OWD.
• Map integration sequences between Salesforce and external systems (sync/async patterns).
• Show system landscapes and component relationships for solution architecture diagrams.
• Represent role hierarchies, profile/permission structures, or Agentforce agent flows.

Best practices

• Use flowchart LR for ERDs with object name + record count only; avoid listing fields.
• Color-code nodes by object type (Standard/Custom/External) and label relationship arrows (--> for Lookup, ==> for Master-Detail).
• Include autonumber and Note over blocks for OAuth sequence diagrams to clarify protocol steps.
• Query org metadata when available to display LDV and OWD details; use API names for objects.
• Keep ASCII fallback under 80 characters width and use consistent box sizes and arrow alignment.

Example use cases

• Generate a JWT Bearer sequence diagram for a CI/CD integration between a backend service and Salesforce.
• Create a left-to-right ERD for Account, Contact, Opportunity and display record counts and LDV indicators.
• Diagram Salesforce → SAP integration showing request/response, error paths, and async patterns.
• Produce an Agentforce flowchart mapping Agent → Topic → Action for an AI assistant architecture.
• Render a role hierarchy flowchart for user management and permission review.