mcpField
G
generating-mermaid-diagrams

generating-mermaid-diagrams

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

关于 generating-mermaid-diagrams

面向 Salesforce 场景的图表生成技能,可根据需求生成 Mermaid 图,并在需要时提供 ASCII 版本。适用于架构、OAuth、集成流程、ERD 和 Agentforce 结构等文档图示。

主要功能

  1. 01生成 Mermaid 文本图表
  2. 02覆盖架构、时序与流程图
  3. 03支持数据模型 ERD
  4. 04提供 ASCII 图表回退
  5. 05通过模板和元数据辅助图表生成

适用场景

  1. 01在文档或 README 中展示系统架构
  2. 02绘制 OAuth 或集成交互时序
  3. 03呈现 Salesforce 对象关系
  4. 04以纯文本形式分享图表

安装

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

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

安装后在 Claude Code 中输入/generating-mermaid-diagrams确认已加载。

包含的文件

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

CREDITS.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 图表:Salesforce 图表生成

当用户需要基于文本的图表时,使用此技能:例如用于架构、OAuth、集成流程、ERD 或 Agentforce 结构的 Mermaid 图表;如果需要兼容纯文本,则提供 ASCII 备用版本。

范围

适用范围

当用户需要以下内容时,使用 generating-mermaid-diagrams:

  • Mermaid 输出
  • ASCII 备用图表
  • 适合以 Markdown 格式呈现的架构、时序图、流程图或 ERD 视图
  • 可直接放入文档、README 或 issue 的图表
不适用范围 — 用户需要以下内容时,请委派给其他技能:

支持的图表类型

类型首选 Mermaid 形式典型用途
OAuth / 身份验证流程sequenceDiagram授权码、JWT、PKCE、设备流程
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>

跨技能集成

需求委派给原因
真实对象/字段定义generating-custom-object / generating-custom-field基于实际信息生成 ERD
渲染后的图表/图像输出generating-visual-diagrams获得超越 Mermaid 的视觉润色
已连接应用的身份验证设置背景configuring-connected-apps确保 OAuth 流程准确
Agentforce 逻辑可视化developing-agentforce获取源事实行为详情
Flow 行为图generating-flow基于实际 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