sf-diagram-mermaid について
sf-diagram-mermaidは、Salesforceのシステムやワークフローをテキスト図にするスキルです。ドキュメント向けのMermaid図を生成し、プレーンテキスト互換性が必要な場合はASCII図も作成します。
主な機能
- 01Mermaid図の生成
- 02ASCII形式の代替図の作成
- 03シーケンス図、フローチャート、ERDへの対応
- 04OAuthと統合フローの可視化
- 05Agentforceの動作関係の図示
活用シーン
- 01OAuth認証シーケンスの文書化
- 02Salesforceオブジェクト関係の表示
- 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、課題に直接掲載できる図
次のものをユーザーが求めている場合は、別のスキルに委任します。
- レンダリング済みの PNG/SVG 画像や洗練されたモックアップ → sf-diagram-nanobananapro
- Salesforce 以外のシステムのみ → より汎用的な図表作成スキルを使用
- ERD 作成前のオブジェクト調査 → sf-metadata
対応する図の種類
| 種類 | 推奨する Mermaid 形式 | 主な用途 |
|---|---|---|
| OAuth/認証フロー | sequenceDiagram | 認可コード、JWT、PKCE、デバイスフロー |
| ERD/データモデル | flowchart LR | オブジェクトの関係と共有コンテキスト |
| 統合シーケンス | sequenceDiagram | リクエスト/レスポンスやイベントの連携 |
| システム全体図 | flowchart | 高レベルのアーキテクチャ |
| ロール/アクセス階層 | flowchart | ユーザー、プロファイル、権限 |
| Agentforce の動作マップ | flowchart | エージェント → トピック → アクションの関係 |
最初に確認する必要があるコンテキスト
次の内容を質問するか、推測します。
- 図の種類
- 対象範囲と関係するエンティティ/システム
- 出力形式の希望:Mermaid のみ、ASCII のみ、または両方
- スタイルの希望:最小限、ドキュメント優先、またはプレゼンテーション向け
- ERD の場合:根拠として使用できる組織のメタデータがあるか
推奨ワークフロー
1. 適切な図の構造を選ぶ
- 時系列のやり取りには
sequenceDiagramを使用します - ERD や機能マップには
flowchart LRを使用します - 可能であれば、1 つの図につき主要なストーリーを 1 つに絞ります
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 を超える視覚的な仕上げ |
| 接続アプリの認証設定に関するコンテキスト | sf-connected-apps | 正確な OAuth フロー |
| Agentforce ロジックの可視化 | sf-ai-agentscript | 動作の詳細に関する信頼できる情報源 |
| Flow の動作図 | sf-flow | 実際の Flow ロジックに基づく図の作成 |
リファレンスマップ
まずはこちら
スタイル/ERD の詳細
プレビュー
スコアガイド
| スコア | 意味 |
|---|---|
| 72–80 | 本番環境で利用できる図 |
| 60–71 | 明確で有用ですが、少し調整が必要です |
| 48–59 | 機能しますが、より明確にできます |
| 35–47 | 構造の改善が必要です |
| < 35 | 不正確または不完全です |
コメント
Markdown 対応