platform-docs-get について
Salesforceの公式ドキュメントを検索し、回答の根拠を得るためのスキルです。開発者や管理者向けに、文書の種類を見極め、対象の概念がページに記載されているか確認します。
主な機能
- 01Salesforce公式情報のみを使用
- 02文書の種類に応じた分類
- 03概念を絞った検索
- 04内容の乏しいページを除外
- 05任意のPlaywright抽出スクリプト
活用シーン
- 01ApexやAPIのリファレンス確認
- 02Salesforce設定記事の検索
- 03LWCやAgentforce文書の確認
- 04公式設計指針に基づく回答
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ forcedotcom/ sf-skills --skill platform-docs-getインストール後、Claude Code で/platform-docs-getを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdscripts/extract_help_salesforce.pyextract_salesforce_doc.pyrequirements.txtruntime_bootstrap.py詳細
platform-docs-get
このスキルは、公開ウェブ上のSalesforce公式ドキュメントを取得し、回答の根拠として使うためのものです。
このスキルでは、特に取得が難しいSalesforceドキュメント(help.salesforce.com、JavaScriptを多用するdeveloper.salesforce.com、lightningdesignsystem.comのLightning Design Systemドキュメント、architect.salesforce.comやadmin.salesforce.comなど、Salesforceが所有するその他の公式ドキュメントページ)を対象に、信頼性の高いオンライン取得手順を提供します。
scripts/にはオプションの抽出スクリプトがあります。詳細は下記の「参考ファイルの一覧」を参照してください。
対象範囲
| 対象 | Salesforce公式ドキュメントの取得:Apex、API、LWC、メタデータ、Agentforce、設定記事、SLDS、アーキテクト/管理者向けガイダンス |
| 対象外 | サードパーティのブログ、PDFによる代替、ローカルコーパスのインデックス作成、ベンチマークのワークフロー、コードやメタデータの生成 |
必要な入力
取得を開始する前に、以下を特定してください。
- 求められている正確な概念、識別子、クラス、メソッド、または機能名
- 該当する可能性が高いドキュメントの種類(開発者向けドキュメント、ヘルプ記事、デザインシステム、アーキテクト/管理者向け)
このスキルの取得手順を使うために、追加のセットアップは必要ありません。オプションの抽出スクリプトにはplaywrightが必要です。scripts/requirements.txtを参照してください。
公式ソースのみを使用
Salesforceが所有するドキュメントソースを優先してください。
developer.salesforce.comhelp.salesforce.comarchitect.salesforce.comadmin.salesforce.comlightningdesignsystem.com- Salesforceが信頼できる情報源として使用しているその他の公式ドキュメントページ
ユーザーから明示的に依頼された場合を除き、サードパーティのブログ、動画、要約記事は避けてください。
PDFにはフォールバックしないでください。
取得ワークフロー
1. まずリクエストを分類する
何かを取得する前に、該当する可能性が高いドキュメントの種類を特定してください。
| 種類 | 代表的なソース | 用途 |
|---|---|---|
| 開発者向けドキュメント | developer.salesforce.com/docs/... | Apex、API、LWC、メタデータ、Agentforce開発者向けドキュメント |
| ヘルプドキュメント | help.salesforce.com/... | 設定、管理者向け情報、製品の構成 |
| アーキテクト/管理者向けドキュメント | architect.salesforce.com/...、admin.salesforce.com/... | ベストプラクティス、パターン、優れたアーキテクチャに関するガイダンス、管理者向けイネーブルメント |
| デザインシステムのドキュメント | lightningdesignsystem.com/... | SLDS、Cosmos、デザイントークン、コンポーネントとスタイルに関するガイダンス |
| 旧Atlasドキュメント | developer.salesforce.com/docs/atlas.en-us.* | 旧版の公式ガイドおよびリファレンスドキュメント |
2. 正確な概念を特定する
検索する前に、実際の対象を抽出してください。
- 正確なAPI/クラス/メソッド名
- 正確な機能名
- 正確な製品名
- 正確な設定項目
例:
Lightning Message ServiceWire ServiceSystem.StubProviderAgentforce ActionsMessaging for In-App and Web allowed domains
3. 対象を絞って公式ドキュメントを取得する
Salesforceドキュメントを広範囲にクロールしないでください。
代わりに、次の手順に従います。
- 該当する可能性が最も高い公式ガイドのトップページまたは記事を特定する
- 検索が必要な場合は、検索対象をSalesforce公式ドメインのみに限定する
- その公式ページを取得する
- 正確な概念が実際にそのページに記載されているか確認する
- 記載されていない場合は、最も関連性の高い公式の子ページへのリンクを1~3件確認してたどる
- 根拠を確認できた時点で終了する
4. 概要ページだけで終わらせない
ガイドのトップページに、求められている概念が明確に記載されていない限り、そのページだけでは不十分です。
特に、以下の場合は重要です。
- LWCドキュメント
- Agentforceドキュメント
- プラットフォームガイドの大まかなトップページ
- 実際の記事へのリンクが掲載されているヘルプのトップページ
5. developer.salesforce.comの場合
次の手順に従ってください。
- 該当する可能性が最も高い公式ガイドのトップページから始める
- ページがJavaScriptを多用している場合は、ブラウザーでレンダリングしたコンテンツの抽出を優先する
- 正確な概念がページに記載されているか確認する
- 概念が見つからない場合は、公式の子ページへのリンクを確認し、最も適したリンクを1~3件たどる
- 大まかなガイドのトップページより、概念に直接対応するページを優先する
- その概念を説明する実際の公式リファレンスであれば、旧Atlasページも有効です
6. help.salesforce.com の場合
ヘルプページは、単純な取得方法では失敗することがよくあります。
次の手順に従ってください。
- 利用できる場合は、正確な
articleView?id=...URL を優先します - 通常の取得でシェルコンテンツが返される場合は、ブラウザーでレンダリングした内容を抽出します
Loading、Sorry to interrupt、CSS Error、または大部分がブラウザーの枠組みやナビゲーションテキストで占められている出力は、証拠ではなく抽出失敗として扱います- ヘッダー、ナビゲーション、フッターのテキストだけでなく、実際の記事本文を探します
- 次のようなシェルページやソフト404ページは除外します。
- "We looked high and low but couldn't find that page"
- 一般的な空のヘルプシェル
- 関連するガイドやハブページから調査を始めた場合は、実際の記事本文にたどり着くまで、リンク先のヘルプ記事をたどります
- 対象を絞った再試行を行っても抽出に失敗する場合は、見つかった最も適切な公式ヘルプ URL を提示し、記事本文の抽出に失敗したことを明記します
受け入れルール
次のいずれかを満たす場合に限り、そのページを回答の根拠として十分とみなします。
- 正確な識別子がページに記載されている
- 正確な概念フレーズがページに記載されている
- クエリに固有の複数のフレーズが、適切な公式コンテキストに記載されている
次の場合、そのページは十分ではありません。
- 広範なランディングページにすぎない
- 実際の記事テキストがほとんどないシェルページである
- 対象の製品領域が異なる
- 要求された識別子や概念が含まれていない
- 公式ページがあるはずなのに、サードパーティの説明である
却下ルール
次のものは最終的な証拠として却下します。
- 正確な概念が記載されていない広範なガイドのトップページ
- 概念やリファレンスページが期待される場合のリリースノート
- 開発者向けドキュメントが求められている場合の管理者向けブログ記事
- 公式ドキュメントが利用できる場合のサードパーティのブログ
- 実際の記事本文がないシェル表示のページ
- タイトルは適切に見えても、本文に要求された概念が含まれていないページ
根拠の要件
回答には次の項目を含めてください。
- ガイドまたは記事のタイトル
- 正確な公式 URL
- ソースの種類:
- 開発者向けドキュメントページ
- atlas リファレンスページ
- ヘルプ記事ページ
- 抽出が部分的だった場合やブラウザーでレンダリングした場合は、その注意事項
根拠が弱い場合は、その旨を明確に伝えてください。
例
例:Lightning Message Service
一般的な LWC ガイドのトップページで調査を終えないでください。 Lightning Message Service の正確な LWC ページを見つけるか、正確な概念が記載されたページにたどり着くまで、LWC ドキュメント内の最も関連性の高い子ページへのリンクをたどってください。
例:Wire Service
Wire Service が実際に記載されていない限り、LWC のホームページを根拠に回答しないでください。
wire service または wire adapter に関する該当の子ドキュメントページをたどってください。
例:Agentforce Actions
広範な Agentforce のランディングページやブログ記事を根拠に回答しないでください。 アクションに関する公式の Agentforce 開発者向けページを見つけるか、公式の Agentforce ドキュメントから最も関連性の高い子ページをたどってください。
例:アプリ内およびウェブ向けメッセージングの許可ドメイン
公式ヘルプ記事を優先し、ブラウザーでレンダリングした内容を抽出してください。 一般的なヘルプシェルは除外してください。必要に応じて、近接する公式メッセージングドキュメントからリンク先のヘルプ記事をたどってください。
例:System.StubProvider
正確な識別子が記載された公式の Salesforce リファレンスページまたは開発者向けページを優先してください。 識別子が記載されていない場合、より広範な Apex のトップページで代用しないでください。
対象外
このスキルでは、次のことを行いません。
- ローカルのドキュメントコーパスを維持する
- ローカルインデックスに依存する
- PDF にフォールバックする
- ベンチマークのワークフローを実行する
- 有用であるためにリポジトリ固有のスクリプトに依存する
出力要件
取得ごとに、次の項目を含めてください。
- ガイドまたは記事のタイトル
- 正確な公式 URL
- ソースの種類(開発者向けドキュメントページ/atlas リファレンスページ/ヘルプ記事ページ)
- 抽出が部分的だった場合やブラウザーでレンダリングした場合は、その注意事項
根拠が弱い場合は、無理に回答せず、その旨を明確に伝えてください。
参照ファイル一覧
| ファイル | 読み込むタイミング |
|---|---|
scripts/extract_salesforce_doc.py | Salesforce の公式ドキュメントの URL を取得する際に使用します。help.salesforce.com を専用の Help 抽出スクリプトに自動的に振り分け、Salesforce が所有するすべてのドキュメントホストでブラウザー描画後の抽出に対応しています |
scripts/extract_help_salesforce.py | help.salesforce.com の articleView URL を対象にする場合に直接使用します。ラッパーが適切でない場合に使用します |
scripts/runtime_bootstrap.py | 抽出スクリプトからインポートされ、分離された platform-docs-get Python ランタイムと Playwright ブラウザーパスを解決します。直接呼び出すことはありません |
scripts/requirements.txt | 抽出スクリプトの実行に必要な Python 依存関係(playwright、playwright-stealth)を記載しています |