关于 sf-diagram-mermaid
sf-diagram-mermaid 是用于为 Salesforce 系统和工作流生成文本图表的技能,可创建适合文档的 Mermaid 图表,并在需要纯文本兼容时提供 ASCII 版本。
主要功能
- 01生成 Mermaid 图表
- 02创建 ASCII 备用图
- 03支持时序图、流程图和 ERD
- 04呈现 OAuth 与集成流程
- 05绘制 Agentforce 行为关系
适用场景
- 01记录 OAuth 授权时序
- 02展示 Salesforce 对象关系
- 03说明集成或 Agentforce 流程
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jaganpro/ sf-skills --skill sf-diagram-mermaid安装后在 Claude Code 中输入/sf-diagram-mermaid确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
CREDITS.mdREADME.mdassets/agentforce/agent-flow.mdassets/architecture/system-landscape.mdassets/datamodel/b2b-commerce-erd.mdcampaigns-erd.mdconsent-erd.mdfiles-erd.mdforecasting-erd.mdfsl-erd.mdparty-model-erd.mdquote-order-erd.mdrevenue-cloud-erd.mdsales-cloud-erd.mdsalesforce-erd.mdscheduler-erd.mdservice-cloud-erd.mdterritory-management-erd.mdassets/integration/api-sequence.mdassets/oauth/authorization-code-pkce.mdauthorization-code.mdclient-credentials.mddevice-authorization.mdjwt-bearer.mdrefresh-token.mduser-agent-social-sign-on.mdassets/role-hierarchy/user-hierarchy.mdreferences/color-palette.mddiagram-conventions.mderd-conventions.md详细介绍
sf-diagram-mermaid:Salesforce 图表生成
当用户需要基于文本的图表时使用此技能:用于架构、OAuth、集成流程、ERD 或 Agentforce 结构的 Mermaid 图表;在需要兼容纯文本时,也可提供 ASCII 备用版本。
此技能适用的任务
在用户需要以下内容时使用 sf-diagram-mermaid:
- Mermaid 输出
- ASCII 备用图表
- 适合 Markdown 的架构图、时序图、流程图或 ERD 视图
- 可直接放入文档、README 或 issue 的图表
在用户需要以下内容时委派给其他技能:
- 渲染后的 PNG/SVG 图像或精美的模型图 → sf-diagram-nanobananapro
- 仅涉及非 Salesforce 系统 → 使用更通用的图表绘制技能
- 在绘制 ERD 前发现对象 → sf-metadata
支持的图表类型
| 类型 | 首选 Mermaid 格式 | 典型用途 |
|---|---|---|
| OAuth / 身份验证流程 | sequenceDiagram | Authorization Code、JWT、PKCE、Device Flow |
| ERD / 数据模型 | flowchart LR | 对象关系和共享上下文 |
| 集成时序 | sequenceDiagram | 请求/响应或事件编排 |
| 系统全景 | flowchart | 高层架构 |
| 角色 / 访问层级 | flowchart | 用户、配置文件、权限 |
| Agentforce 行为图 | flowchart | Agent → 主题 → 操作之间的关系 |
开始前需收集的上下文
询问或推断:
- 图表类型
- 范围以及涉及的实体 / 系统
- 输出偏好:仅 Mermaid、仅 ASCII,或两者兼有
- 样式应简洁、以文档为先,还是适合演示
- 对于 ERD,是否可以使用组织元数据作为依据
推荐工作流
1. 选择合适的图表结构
- 对按时间排序的交互使用
sequenceDiagram - 对 ERD 和能力图使用
flowchart LR - 尽可能让每张图只呈现一个主要故事
2. 收集数据
对于 ERD 和基于实际数据的图表:
- 需要发现真实架构时,使用 sf-metadata
- 适当时,可使用本地元数据辅助脚本获取计数 / 关系上下文
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>
跨技能协作
| 需求 | 委派给 | 原因 |
|---|---|---|
| 真实对象 / 字段定义 | sf-metadata | 基于实际数据生成 ERD |
| 渲染图表 / 图像输出 | sf-diagram-nanobananapro | 实现超越 Mermaid 的视觉效果 |
| connected app 身份验证配置上下文 | sf-connected-apps | 确保 OAuth 流程准确 |
| Agentforce 逻辑可视化 | sf-ai-agentscript | 获取行为详情的事实来源 |
| Flow 行为图 | sf-flow | 基于实际 Flow 逻辑生成图表 |
参考索引
从这里开始
样式 / ERD 详情
预览
评分指南
| 分数 | 含义 |
|---|---|
| 72–80 | 可用于生产环境的图表 |
| 60–71 | 清晰实用,只需稍作润色 |
| 48–59 | 功能正常,但可以更清晰 |
| 35–47 | 需要改进结构 |
| < 35 | 不准确或不完整 |
评论
支持 Markdown