generating-mermaid-diagrams について
Salesforce の用途に合わせて Mermaid 図を生成し、必要に応じて ASCII 版も提供する図表生成スキルです。アーキテクチャ、OAuth、連携フロー、ERD、Agentforce の構造などを文書向けに図示します。
主な機能
- 01テキスト形式の Mermaid 図を生成
- 02アーキテクチャ・シーケンス・フローチャートに対応
- 03データモデル ERD に対応
- 04ASCII 図による代替出力
- 05テンプレートとメタデータを使った図の作成
活用シーン
- 01README でシステムアーキテクチャを説明
- 02OAuth や連携シーケンスを図示
- 03Salesforce オブジェクト間の関係を表示
- 04プレーンテキストで図を共有
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ forcedotcom/ sf-skills --skill generating-mermaid-diagramsインストール後、Claude Code で/generating-mermaid-diagramsを入力して読み込まれたか確認します。
同梱ファイル
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詳細
generating-mermaid-diagrams:Salesforce 図の生成
ユーザーがテキストベースの図を必要としている場合に、このスキルを使用します。アーキテクチャ、OAuth、統合フロー、ERD、Agentforce の構造を示す Mermaid 図に加え、プレーンテキストとの互換性が重要な場合は ASCII 形式の代替図も作成します。
対象範囲
対象となる内容
ユーザーが次のものを求めている場合は、generating-mermaid-diagrams を使用します。
- Mermaid の出力
- ASCII 形式の代替図
- Markdown に適した形式のアーキテクチャ図、シーケンス図、フローチャート、ERD
- ドキュメント、README、issue に直接掲載できる図
対象外 — ユーザーが次のものを求めている場合は、別のスキルに委任します。
- レンダリング済み PNG/SVG 画像や仕上げたモックアップ → generating-visual-diagrams
- Salesforce 以外のシステムのみ → より汎用的な図作成スキルを使用します
- ERD 作成前のオブジェクト探索 → generating-custom-object または generating-custom-field
対応する図の種類
| 種類 | 推奨する Mermaid 形式 | 主な用途 |
|---|---|---|
| OAuth/認証フロー | sequenceDiagram | Authorization Code、JWT、PKCE、Device Flow |
| ERD/データモデル | flowchart LR | オブジェクト間の関係と共有コンテキスト |
| 統合シーケンス | sequenceDiagram | リクエスト/レスポンスまたはイベントの連携 |
| システム全体像 | flowchart | 高レベルのアーキテクチャ |
| 役割/アクセス階層 | flowchart | ユーザー、プロファイル、権限 |
| Agentforce の動作マップ | flowchart | エージェント → トピック → アクションの関係 |
最初に確認する必要がある情報
次の内容を尋ねるか、推測します。
- 図の種類
- 対象範囲と、関係するエンティティ/システム
- 出力形式の希望:Mermaid のみ、ASCII のみ、または両方
- スタイルの希望:最小限、ドキュメント重視、またはプレゼンテーション向け
- ERD の場合、根拠として使用できる組織のメタデータがあるか
推奨ワークフロー
1. 適切な図の構造を選ぶ
- 時系列のやり取りには
sequenceDiagramを使用します - ERD や機能マップには
flowchart LRを使用します - 可能な場合は、図ごとに主要なストーリーを 1 つに絞ります
2. データを収集する
ERD や実データに基づく図の場合:
- 実際のスキーマを調べる必要がある場合は、generating-custom-object または generating-custom-field を使用します
- 必要に応じて、ローカルのメタデータヘルパースクリプトを使い、件数や関係のコンテキストを確認します
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 フローのアクターがグラントタイプごとに異なる | アクターの不一致を避けるため、生成前に該当するアセットテンプレートを確認します |
参考ファイル一覧
規約とルール — 生成前に確認
- references/diagram-conventions.md — すべての図の種類に適用される一貫性のルール
- references/mermaid-reference.md — Mermaid 構文のクイックリファレンス
- references/usage-examples.md — 図の種類ごとの実例
スタイル
- references/mermaid-styling.md — テーマ設定と注釈のパターン
- references/color-palette.md — 色覚多様性に配慮した、16 進数値付きパレット
- references/erd-conventions.md — ERD 固有のレイアウトと表記ルール
プレビュー
- references/preview-guide.md — Mermaid をローカルでレンダリングする方法
- scripts/README.md — このスキルのすべてのスクリプトのセットアップと使用方法
- scripts/mermaid_preview.py — ライブリロード対応のプレビューサーバー。実行すると、ブラウザーで図をプレビューできます
- scripts/query-org-metadata.py — 組織のスキーマを照会して、ERD の生成を実際の情報に基づかせます
OAuth フローテンプレート — OAuth 図の生成時に該当するテンプレートを読み込む
- assets/oauth/authorization-code.md — Authorization Code グラント
- assets/oauth/authorization-code-pkce.md — モバイル/SPA 向けの PKCE バリアント
- assets/oauth/jwt-bearer.md — JWT Bearer のサーバー間認証
- assets/oauth/client-credentials.md — サービスアカウント向けの Client Credentials
- assets/oauth/device-authorization.md — CLI/IoT 向けの Device Flow
- assets/oauth/refresh-token.md — Refresh Token の更新フロー
- assets/oauth/user-agent-social-sign-on.md — User-Agent/ソーシャルサインオン
データモデル ERD テンプレート — ERD の生成時に該当するテンプレートを読み込んでください
- assets/datamodel/salesforce-erd.md — Salesforce の主要オブジェクト
- assets/datamodel/sales-cloud-erd.md — Sales Cloud のオブジェクト
- assets/datamodel/service-cloud-erd.md — Service Cloud のオブジェクト
- assets/datamodel/b2b-commerce-erd.md — B2B Commerce のオブジェクト
- assets/datamodel/campaigns-erd.md — キャンペーンとキャンペーンメンバーのモデル
- assets/datamodel/consent-erd.md — 同意およびプライバシー関連のオブジェクト
- assets/datamodel/files-erd.md — Files と ContentDocument のモデル
- assets/datamodel/forecasting-erd.md — 予測関連のオブジェクト
- assets/datamodel/fsl-erd.md — Field Service Lightning のオブジェクト
- assets/datamodel/party-model-erd.md — パーティモデルのオブジェクト
- assets/datamodel/quote-order-erd.md — 見積もりと注文のオブジェクト
- assets/datamodel/revenue-cloud-erd.md — Revenue Cloud のオブジェクト
- assets/datamodel/scheduler-erd.md — Scheduler のオブジェクト
- assets/datamodel/territory-management-erd.md — Territory Management のオブジェクト
その他の図のテンプレート
- assets/architecture/system-landscape.md — システムランドスケープの概要テンプレート
- assets/integration/api-sequence.md — API 呼び出しシーケンスのテンプレート
- assets/agentforce/agent-flow.md — Agentforce のエージェント → トピック → アクションのフロー
- assets/role-hierarchy/user-hierarchy.md — ロールと権限の階層テンプレート
出力要件
このスキルで各リクエストに対して作成する成果物:
- Mermaid コードブロック — GitHub、Confluence、または Mermaid 対応のレンダラーにそのまま貼り付けられるフェンス付きの
```mermaidブロック - ASCII 形式の代替図(リクエストされた場合、または Mermaid レンダラーが利用できない場合)— ボックスや矢印の文字を使ったテキストのみの図
- 簡潔な説明 — 図の主要な関係、フローの方向、前提条件や制限事項を示す箇条書き 2~5 項目
- ERD の場合:フィールドラベルと関係タイプの注釈を含むオブジェクトカード
- シーケンス図の場合:明確なアクターラベルと番号付きステップ(
autonumber)
評価ガイド
| スコア | 意味 |
|---|---|
| 72–80 | 本番環境で使用できる図 |
| 60–71 | 明確で有用だが、多少の調整が必要 |
| 48–59 | 機能するが、さらに分かりやすくできる |
| 35–47 | 構造の改善が必要 |
| < 35 | 不正確または不完全 |
コメント
Markdown 対応