SuperAPI AI 工具集

external-resource-context

办公与效率

查看项目

更新于 10-16 04:45

技能介绍

用途

仓库证据并不包含围绕一个系统的全部外部资源。本技能将仓库之外资源的访问方法记录在确定的位置,使下游工作(设计、规划、实现、评审)能够直接获取这些资源,而不必反复重新发现访问细节。

覆盖的资源

  • 设计源(规范视觉规格所在位置)
  • 设计系统(组件库与令牌)
  • 指南(使用文档、无障碍规则)
  • 视觉验证环境(如何确认渲染)
  • 数据库 schema 来源
  • 迁移历史
  • 密钥存储位置
  • API schema 来源(OpenAPI / proto / GraphQL SDL)
  • 模拟环境
  • IaC 来源
  • 环境配置

存储位置(两层)

层级 位置 存放内容 更新频率
项目层 docs/project-context/external-resources.md 环境稳定事实:本项目存在哪些资源以及如何访问它们(URL、MCP 名称、文件路径、命令) 很少——仅在项目环境变化时
功能层 相关 UI Spec 或 Design Doc 内的 ## External Resources Used 章节 该功能实际使用的项目层资源子集,以及功能专属标识符(例如设计工具中的特定节点 id、特定端点路径) 每个功能

单一事实来源规则

项目层拥有环境事实。功能层章节只列出功能专属标识符(设计源中的节点 id、API 中的特定端点路径、特定 IaC 模块名),并通过标签引用项目层条目;URL、MCP 名称和访问命令保留在项目层文件中。当环境变化时,只需更新项目层文件。

功能层条目的示例使用 references/template.md 中定义的表格式:第一列为项目层标签,第二列为功能专属标识符。

引用协议(面向下游消费者)

在调查仓库以获取外部事实之前,先检查它是否已被记录:

  1. 读取 docs/project-context/external-resources.md(如果存在),了解有哪些可用资源以及如何访问。
  2. 读取目标 UI Spec 或 Design Doc 的 ## External Resources Used 章节,获取功能专属标识符。
  3. 使用项目层声明的访问方式(例如指定的 MCP、URL、文件路径)获取实际资源内容。

当文件缺失或资源不可达时,从治理与仓库证据继续。每个消费者在其适用的输出中记录该限制。

捕获与更新记录

捕获记录需要交互式听取。使用本技能的工作流拥有交互机制与路由。请遵循 references/hearing.md 了解听取条件、领域路由、两阶段听取、存储协议和质量检查清单。

输出格式

项目层文件遵循 references/template.md 中的结构。项目层文件的标题层级和章节名称是固定的,以便下游代理能够确定性地定位章节。

对于 UI Spec 或 Design Doc 内的功能层章节,标题文本 "External Resources Used" 是固定的;标题层级与父文档的自然结构匹配(在 UI Spec 中为 h2,与其他顶层章节同级;在 Design Doc 中为 h3,位于 Background and Context 之下)。

参考文件

  • references/hearing.md — 听取条件、领域路由、存储协议、质量检查清单
  • references/frontend.md — 前端领域轴
  • references/backend.md — 后端领域轴
  • references/api.md — API 契约领域轴
  • references/infra.md — 基础设施领域轴
  • references/template.md — 项目层与功能层结构模板