platform-docs-get

platform-docs-get

使用此技能來檢索並將答案基於公開網路上的官方 Salesforce 文件。

此技能提供了一個可靠的線上檢索操作手冊，適用於難以抓取的 Salesforce 文件，特別是 help.salesforce.com、JS 密集型的 developer.salesforce.com、lightningdesignsystem.com 上的 Lightning Design System 文件，以及其他官方 Salesforce 擁有的文件頁面，如 architect.salesforce.com 和 admin.salesforce.com。

可選的提取腳本位於 scripts/ 中——請參閱下方的參考檔案索引。

範圍

範圍內	官方 Salesforce 文件檢索：Apex、API、LWC、中繼資料、Agentforce、設定文章、SLDS、架構師/管理員指南
範圍外	第三方部落格、PDF 備援、本地語料庫索引、基準測試工作流程、產生程式碼或中繼資料

必要輸入

在擷取之前，請確認：

• 被請求的具體概念、識別碼、類別、方法或功能名稱
• 可能的文件系列（開發者文件、說明文章、設計系統、架構師/管理員）

使用此技能中的檢索操作手冊無需額外設定。可選的提取腳本需要 playwright——請參閱 requirements.txt。

僅限官方來源

優先使用 Salesforce 擁有的文件來源：

• developer.salesforce.com
• help.salesforce.com
• architect.salesforce.com
• admin.salesforce.com
• lightningdesignsystem.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 Service
• Wire Service
• System.StubProvider
• Agentforce Actions
• Messaging for In-App and Web allowed domains

3. 優先進行有目標的官方檢索

不要廣泛爬取 Salesforce 文件。

相反地：

1. 確認最可能的官方指南根目錄或文章
2. 如果需要搜尋，僅限於官方 Salesforce 網域
3. 擷取該官方頁面
4. 檢查具體概念是否確實出現在頁面上
5. 如果沒有，檢查並跟隨最相關的 1–3 個官方子連結
6. 一旦獲得有根據的證據就停止

4. 不要停留在廣泛的登陸頁面

指南登陸頁面不夠，除非它清楚包含所請求的具體概念。

這對於以下情況尤其重要：

• LWC 文件
• Agentforce 文件
• 廣泛的平台指南首頁
• 連結到實際文章的說明登陸頁面

5. 對於 developer.salesforce.com

使用此操作手冊：

• 從最可能的官方指南根目錄開始
• 如果頁面是 JS 密集型，優先使用瀏覽器渲染的提取
• 檢查具體概念是否出現在頁面上
• 如果概念缺失，檢查官方子連結並跟隨最匹配的 1–3 個連結
• 優先選擇具體概念頁面而非廣泛的指南根目錄
• 如果舊版 atlas 頁面是該概念的真正官方參考，則視為有效

6. 對於 help.salesforce.com

說明頁面經常在簡單抓取時失敗。

使用此操作手冊：

• 如果可用，優先使用確切的 articleView?id=... URL
• 當簡單擷取返回 shell 內容時，使用瀏覽器渲染的提取
• 將 Loading、Sorry to interrupt、CSS Error 或大部分是 chrome/導航文字的輸出視為提取失敗，而非證據
• 尋找真正的文章主體，而不僅僅是標頭、導航或頁尾文字
• 拒絕 shell 頁面和軟 404 頁面，例如：
  • "We looked high and low but couldn't find that page"
  • 通用的空說明 shell
• 如果從附近的指南或中心頁面開始，請跟隨連結的說明文章，直到到達真正的文章主體
• 如果在有目標的重試後提取仍然失敗，則返回找到的最佳官方說明 URL，並明確說明文章主體提取未成功

接受規則

僅當以下至少一項為真時，頁面才足以回答問題：

• 確切的識別碼出現在頁面上
• 確切的概念詞組出現在頁面上
• 多個查詢特定的詞組出現在正確的官方上下文中

當以下情況時，頁面不夠：

• 它只是一個廣泛的登陸頁面
• 它是一個 shell 頁面，幾乎沒有真正的文章文字
• 它來自錯誤的產品領域
• 它不包含請求的識別碼或概念
• 它是第三方解釋，而官方頁面應該存在

拒絕規則

拒絕以下內容作為最終證據：

• 沒有具體概念的廣泛指南首頁
• 當預期是概念/參考頁面時的發行說明
• 當請求開發者文件時的管理員部落格文章
• 當官方文件可用時的第三方部落格
• 沒有真正文章主體的 shell 渲染頁面
• 標題聽起來正確但主體不包含請求概念的頁面

根據要求

回答時，請包含：

1. 指南/文章標題
2. 確切的官方 URL
3. 來源類型：
   • 開發者文件頁面
   • atlas 參考頁面
   • 說明文章頁面
4. 如果提取是部分或瀏覽器渲染的，請附上任何注意事項

如果證據薄弱，請直接說明。

範例

範例：Lightning Message Service

不要停留在一般的 LWC 指南根目錄。
找到 Lightning Message Service 的確切 LWC 頁面，或從 LWC 文件中跟隨最相關的子連結，直到具體概念出現。

範例：Wire Service

不要從 LWC 首頁回答，除非 Wire Service 確實出現在那裡。
跟隨有關 wire service 或 wire adapter 的相關子文件頁面。

範例：Agentforce Actions

不要從廣泛的 Agentforce 登陸頁面或部落格文章回答。
找到有關 actions 的官方 Agentforce 開發者頁面，或從官方 Agentforce 文件中跟隨最匹配的子頁面。

範例：Messaging for In-App and Web allowed domains

優先使用官方說明文章和瀏覽器渲染的提取。
拒絕通用的說明 shell。如果需要，從附近的官方訊息傳送文件跟隨連結的說明文章。

範例：System.StubProvider

優先使用確切識別碼出現的官方 Salesforce 參考/開發者頁面。
如果識別碼不存在，不要用更廣泛的 Apex 登陸頁面替代。

非目標

此技能不應：

• 維護本地文件語料庫
• 依賴本地索引
• 使用 PDF 備援
• 執行基準測試工作流程
• 依賴儲存庫特定的腳本才能有用

輸出期望

對於每次檢索，請包含：

1. 指南或文章標題
2. 確切的官方 URL
3. 來源類型（開發者文件頁面 / atlas 參考頁面 / 說明文章頁面）
4. 如果提取是部分或瀏覽器渲染的，請附上任何注意事項

如果證據薄弱，請直接說明，而不是強迫給出答案。

---

參考檔案索引

檔案	何時讀取
scripts/extract_salesforce_doc.py	用於擷取任何官方 Salesforce 文件 URL；自動將 help.salesforce.com 路由到專用的說明提取器，並支援所有 Salesforce 擁有的文件主機的瀏覽器渲染提取
scripts/extract_help_salesforce.py	當目標是 help.salesforce.com 的 articleView URL 時直接使用；當包裝器不適用時使用
scripts/runtime_bootstrap.py	由提取腳本匯入，用於解析隔離的 platform-docs-get Python 執行環境和 Playwright 瀏覽器路徑；不直接呼叫
requirements.txt	列出執行提取腳本所需的 Python 依賴項（playwright、playwright-stealth）