SuperAPI AI 工具集

docs-sync

写作与研究

查看项目

更新于 10-16 03:05

技能介绍

用途:在指定主题或分支 diff 范围内,用实现证据审计或更新仓库自撰的英文 SDK 文档,找出文档缺口与不准确内容。

主要能力:确认范围与基线分支;从所选范围构建功能清单,聚焦公开导出、配置项、环境变量、CLI 命令、默认值和运行时行为,并记录文件路径与符号/设置作为证据;用 rg "Options"、rg "process.env"、rg "export" 等定向搜索查找选项类型与功能开关;先做文档优先检查 docs/src/content/docs 下相关页面(排除 openai 目录),再做代码优先检查,把功能映射到合适页面或章节;识别缺失、错误/过时和结构性问题;按 AGENTS.md 的文档变更验证层级对完整 diff 分类。

使用方式:审计或仅提案请求只报告发现,不编辑;用户要求更新或已批准计划时,完成限定编辑与验证,不再重复询问。仅就未解决的行为、范围、发布时间或额外授权提问。涉及 OpenAI 平台功能时可调用 $openai-knowledge 从 OpenAI Developer Docs MCP 获取最新细节,出现分歧时以 SDK 源码为准;MCP SDK 或 Vercel AI SDK 主题可选使用 Deepwiki MCP 快速查询,仍以源码为准。避免切换分支干扰本地改动,优先用 git show main:<path> 只读检查;确需单独检出时须先按 AGENTS.md 获得明确批准。

限制:仅编辑 docs/src/content/docs/** 下的英文文档,排除 openai 目录,不编辑 ja、ko、zh 目录;不得在 MDX 中直接添加 TypeScript 或 TSX 围栏代码块,须放入 examples/docs/<doc-area>/ 下可编译源文件,用 ?raw 导入并按现有模式渲染;代码不足以作为完整示例维护时改用文字说明。当完整 diff 改动渲染的 TS/TSX 片段源或其 MDX 导入/渲染时,须运行 pnpm -F docs-code build-check 并修复问题。报告使用 Docs Sync Report 模板,参考 references/doc-coverage-checklist.md。