mcpField
E
external-diagram-mermaid-generate

external-diagram-mermaid-generate

github.com/forcedotcom开发1.1k5.5k 次安装1 天前更新
代码仓库

关于 external-diagram-mermaid-generate

该技能帮助 Salesforce 用户生成适用于 Markdown 的 Mermaid 图，并在需要时提供 ASCII 备选。它涵盖架构、OAuth、集成流程、ERD 和 Agentforce 结构，并按图表类型提供模板与规则。

主要功能

  1. 01生成多种类型的 Mermaid 图
  2. 02按需提供 ASCII 图表备选
  3. 03使用 Salesforce 对象和流程模板
  4. 04遵循图表类型的结构与标注规则
  5. 05提供关系、方向和假设说明

适用场景

  1. 01绘制 OAuth 授权时序
  2. 02展示系统架构与集成流程
  3. 03生成 Salesforce 数据模型 ERD
  4. 04说明 Agentforce 的行为关系

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/forcedotcom/sf-skills --skill external-diagram-mermaid-generate

安装后在 Claude Code 中输入/external-diagram-mermaid-generate确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

README.md
assets/agentforce/
agent-flow.md
assets/architecture/
system-landscape.md
assets/datamodel/
b2b-commerce-erd.md
campaigns-erd.md
consent-erd.md
files-erd.md
forecasting-erd.md
fsl-erd.md
party-model-erd.md
quote-order-erd.md
revenue-cloud-erd.md
sales-cloud-erd.md
salesforce-erd.md
scheduler-erd.md
service-cloud-erd.md
territory-management-erd.md
assets/integration/
api-sequence.md
assets/oauth/
authorization-code-pkce.md
authorization-code.md
client-credentials.md
device-authorization.md
jwt-bearer.md
refresh-token.md
user-agent-social-sign-on.md
assets/role-hierarchy/
user-hierarchy.md
references/
color-palette.md
diagram-conventions.md
erd-conventions.md
mermaid-reference.md

详细介绍

external-diagram-mermaid-generate：Salesforce 图表生成

当用户需要基于文本的图表时使用此技能：用于架构、OAuth、集成流程、ERD 或 Agentforce 结构的 Mermaid 图表，以及在需要兼容纯文本时提供 ASCII 备用图表。

范围

适用范围

当用户需要以下内容时，使用 external-diagram-mermaid-generate：

  • Mermaid 输出
  • ASCII 备用图表
  • 适合在 Markdown 中使用的架构图、时序图、流程图或 ERD 视图
  • 可直接放入文档、README 或 issue 的图表
不适用范围 — 当用户需要以下内容时，委派给其他技能：

支持的图表类型

类型首选 Mermaid 格式典型用途
OAuth / 身份验证流程sequenceDiagramAuthorization Code、JWT、PKCE、Device Flow
ERD / 数据模型flowchart LR对象关系和共享上下文
集成时序图sequenceDiagram请求/响应或事件编排
系统全景图flowchart高层架构
角色 / 访问权限层级flowchart用户、配置文件、权限
Agentforce 行为图flowchartAgent → 主题 → 操作的关系

首先需要收集的上下文

询问或推断：

  • 图表类型
  • 涉及的范围和实体 / 系统
  • 输出偏好：仅 Mermaid、仅 ASCII 或两者都要
  • 样式是否应保持简洁、优先考虑文档用途，或适合演示
  • 对于 ERD，是否有组织元数据可用于提供依据

推荐工作流

1. 选择合适的图表结构
  • 对于按时间排序的交互，使用 sequenceDiagram
  • 对于 ERD 和能力图，使用 flowchart LR
  • 尽可能让每张图只呈现一个主要内容
2. 收集数据

对于 ERD 和基于实际数据的图表：

3. 首先生成 Mermaid

确保：

  • 标签准确
  • 节点文本简洁易读
  • 关系表示法一致
  • 样式适度，确保在 Markdown 查看器中清晰呈现
4. 在适用时添加 ASCII 备用图表

用户需要兼容终端或纯文本文档时，提供 ASCII 版本。

5. 简要说明图表

指出关键关系、流程方向和任何假设。

高价值规则

时序图
  • 步骤顺序重要时，使用 autonumber
  • 清楚区分请求和响应
  • 谨慎使用注释来说明协议细节
ERD
  • 优先使用 flowchart LR
  • 保持对象卡片简洁
  • 使用清晰的关系箭头
  • 除非用户明确要求字段级细节，否则避免塞入过多字段
  • 仅在有助于提升可读性时，才按对象类型使用不同颜色
ASCII 输出
  • 保持合理的宽度
  • 让箭头和方框对齐一致
  • 优先保证可读性，而非装饰性

输出格式

## <Diagram Title>

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

### ASCII Fallback
```text
<ascii>
```

### Notes
- <key point>
- <assumption or limitation>

跨技能集成

需求委派给原因
真实的对象／字段定义platform-custom-object-generate / platform-custom-field-generate基于实际信息生成 ERD
已连接应用的身份验证设置上下文integration-connectivity-connected-app-configure准确的 OAuth 流程
Agentforce 逻辑可视化agentforce-generate真实行为的详细信息
Flow 行为图automation-flow-generate基于实际 Flow 逻辑

注意事项

问题解决方案
Mermaid 渲染器不可用自动提供 ASCII 备用方案；注明 Mermaid 代码块仍包含图表，可复制粘贴到渲染器中
对象过多导致 ERD 难以阅读按领域（Sales、Service 等）拆分为子图，并在正文中链接这些子图
时序图步骤顺序不清晰使用 autonumber 指令明确步骤顺序
OAuth 流程中的参与者因授权类型而异生成前先阅读相关资源模板，以避免参与者不匹配

参考文件索引

规范与规则——生成前请先阅读
样式
预览
OAuth 流程模板——生成 OAuth 图表时加载匹配的模板
数据模型 ERD 模板 — 生成 ERD 时加载匹配的模板
其他图表模板

输出要求

此技能针对每个请求生成的交付内容：

  • Mermaid 代码块 — 已加上围栏的 ```mermaid 代码块，可直接粘贴到 GitHub、Confluence 或任何支持 Mermaid 的渲染器中
  • ASCII 备用图（用户要求时或 Mermaid 渲染器不可用时）— 使用框线／箭头字符绘制的纯文本图表
  • 简要说明 — 用 2-5 个项目符号指出关键关系、流程方向以及图表中的任何假设或限制
  • 对于 ERD：包含字段标签和关系类型注释的对象卡片
  • 对于序列图：使用 autonumber 标注编号步骤，并清楚标识参与者

评分指南

分数含义
72–80可用于生产环境的图表
60–71清晰实用，仅需少量润色
48–59功能正常，但可以更清晰
35–47需要改进结构
< 35不准确或不完整

评论

支持 Markdown