platform-docs-get

platform-docs-get

使用此技能检索并基于 公共网络上的官方 Salesforce 文档 来回答问题。

此技能为难以抓取的 Salesforce 文档提供了 可靠的在线检索方案，特别是 help.salesforce.com、JavaScript 繁重的 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 官方文档页面（当 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

使用此方案：

• 从最可能的官方指南根目录开始
• 如果页面 JavaScript 繁重，优先使用浏览器渲染提取
• 检查确切概念是否出现在页面上
• 如果概念缺失，检查官方子链接并跟进最匹配的 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）