/external-diagram-mermaid-generate

name: external-diagram-mermaid-generate
description: "Salesforce architecture diagrams using Mermaid with ASCII fallback. Use this skill when generating text-based diagrams for Salesforce architecture, OAuth flows, ERDs, integration sequences, or Agentforce structure. TRIGGER when: user says \"diagram\", \"visualize\", \"ERD\", or asks for sequence diagrams, flowcharts, class diagrams, or architecture visualizations in Mermaid. DO NOT TRIGGER when: user asks about non-Salesforce systems."
metadata:
  cliTools:
    - tool: ["curl"]
      semver: ">=7.0.0"
    - tool: ["jq"]
      semver: ">=1.6.0"
    - tool: ["python"]
      semver: ">=3.10.0"
    - tool: ["python3"]
      semver: ">=3.10.0"
    - tool: ["sf"]
      semver: ">=2.0.0"
  relatedSkills:
    - "agentforce-generate"
    - "automation-flow-generate"
    - "integration-connectivity-connected-app-configure"
    - "integration-connectivity-generate"
    - "platform-apex-generate"
    - "platform-custom-field-generate"
    - "platform-custom-object-generate"
    - "platform-data-manage"
    - "platform-metadata-deploy"
  version: "1.0"
  domains: ["External"]

external-diagram-mermaid-generate: 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 `external-diagram-mermaid-generate` 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:

• non-Salesforce systems only → use a more general diagramming skill
• object discovery before an ERD → [platform-custom-object-generate](../platform-custom-object-generate/SKILL.md) or [platform-custom-field-generate](../platform-custom-field-generate/SKILL.md)

---

Supported Diagram Families

| Type | Preferred Mermaid form | Typical use | |---|---|---| | OAuth / auth flows | `sequenceDiagram` | Authorization Code, JWT, PKCE, Device Flow | | ERD / data model | `flowchart LR` | object relationships and sharing context | | integration sequence | `sequenceDiagram` | request/response or event choreography | | system landscape | `flowchart` | high-level architecture | | role / access hierarchy | `flowchart` | users, profiles, permissions | | Agentforce behavior map | `flowchart` | agent → 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 [platform-custom-object-generate](../platform-custom-object-generate/SKILL.md) or [platform-custom-field-generate](../platform-custom-field-generate/SKILL.md) 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

## <Diagram Title>

### Mermaid Diagram
```mermaid
<diagram>

ASCII Fallback

<ascii>

Notes

• <key point>
• <assumption or limitation>

---

## Cross-Skill Integration

| Need | Delegate to | Reason |
|---|---|---|
| real object / field definitions | [platform-custom-object-generate](../platform-custom-object-generate/SKILL.md) / [platform-custom-field-generate](../platform-custom-field-generate/SKILL.md) | grounded ERD generation |
| connected-app auth setup context | [integration-connectivity-connected-app-configure](../integration-connectivity-connected-app-configure/SKILL.md) | accurate OAuth flows |
| Agentforce logic visualization | [agentforce-generate](../agentforce-generate/SKILL.md) | source-of-truth behavior details |
| Flow behavior diagrams | [automation-flow-generate](../automation-flow-generate/SKILL.md) | actual Flow logic grounding |

---

## Gotchas

| Issue | Resolution |
|---|---|
| Mermaid renderer not available | Provide ASCII fallback automatically; note that the Mermaid block still carries the diagram for copy-paste into a renderer |
| ERD becomes unreadable with too many objects | Split into sub-diagrams by domain (Sales, Service, etc.) and link them in prose |
| Sequence diagram step order unclear | Use `autonumber` directive to make step ordering explicit |
| OAuth flow actors differ by grant type | Read the relevant asset template first before generating to avoid actor mismatch |

---

## Reference File Index

### Conventions & rules —