SuperAPI AI 工具集

docs-tooling-notion

办公与效率

查看项目

更新于 11-04 22:08

技能介绍

用途

该技能把文档团队(Docs Team)内部工具文档的变更路由到 Notion 上正确的页面,并安全地执行编辑。团队的工具文档由父页面下的五个 Notion 页面组成,每个主题只能有一个归属页面,重复会导致内容漂移。技能还要求将新工具登记到父页面的 Detailed list 数据库中,以便被发现。

主要能力

  • 主题路由:根据内容决定归属页面。五个页面分别是:Docs tooling and agents(父目录,含页面表、外部归属列表、快速问答)、Docs tech stack(仅生产站点相关)、Local setup and quality gates(贡献者本地环境与 PR 门禁)、Docs automation and agents(工作流、脚本、智能体、技能、MCP 服务器)、Reference docs(LangSmith OpenAPI 源与链接映射)。
  • 写前查重:在写入前搜索其余四个页面,若主题已存在则更新原位置,不新增副本。
  • 判断是否应写入 Notion:仓库中已文档化且用户能在原处找到的内容不写入 Notion(如 IDE_SETUP.md、贡献指南、PR 模板、issue 模板、导航映射等)。技能本身是权威参考,Notion 页面只记录名称、覆盖范围和一两个决策所需事实。被 gitignore 的个人工具不写入团队页面。
  • 写作规范:遵循 docs-team-voice 技能,Notion 页面特别注意:不使用第一人称、不使用带空格的破折号、定义列表写成 - **Term**: Explanation.(冒号在加粗外,句末有句号)。段落结构:一句话说明是什么,再说能做什么,然后写步骤;重要页面以 ## See also 结尾。
  • 安全编辑:每次编辑前用 notion-fetch 获取页面,再用 notion-update-page 的 command: "update_content" 和窄范围 content_updates 对更新,而不是重写整页。规避五种已知失败模式:old_str 缩进必须完全匹配(表格无前导制表符,callout 有制表符);含上传图片的页面不得用 replace_content(图片 URL 是短期签名链接);超时或异步更新可能已生效,重试前先获取验证,避免重复块;加粗内含行内代码会渲染为多余星号,需调整措辞;页内锚点链接不生效,用文字引用章节名。
  • 登记 Detailed list 数据库:父页面内嵌一个 Detailed list 数据库(collection://3ce80852-7b17-8004-8735-000bc758a8cd),每个新工作流、脚本、技能、智能体、MCP 服务器或 git hook 都要新增一行。字段为 Title、Description、Docs page(解释该工具的页面 URL)、Source(仓库路径)、Type(可选值:GH Actions (scheduled)、GH Actions (PR/CI)、Fleet agent、Deep agent、External bot、Skill、MCP server、Manual script、Git hook)。添加前先用 notion-query-data-sources 查询,避免重命名时产生重复行;文件重命名或移动时,需同步更新 Source,而不仅是正文。
  • 闭环:页面范围变化时更新父页面的页面表,修正过时的 ## See also 条目,并报告编辑了哪个页面、刻意省略了什么,使路由决策可审查。

使用方式

需要 Notion MCP 服务器,提供 notion-fetch 和 notion-update-page 两个工具。流程:路由主题 → 判断是否应写入 Notion → 按写作规范撰写 → 安全编辑 → 在 Detailed list 数据库添加行 → 更新父页面与 See also 并报告。

适用场景

适用于文档团队在 Notion 上维护内部工具文档:新增或变更工作流、脚本、智能体、技能、MCP 服务器、git hook,或本地开发环境与质量门禁相关工具。

限制

依赖 Notion MCP 服务器。仓库中已有文档且用户能在原处找到的内容不写入 Notion。个人工具(gitignore 路径下)不写入。变更日志系统由 LangSmith release notes 页面所有,本页面只保留运行手册(部署 ID、HTTP 路由、必需环境变量、恢复路径),不重复解释。该技能不重复 docs-team-voice 的规则,仅强调最常被遗漏的三条。作者、版本、许可等信息暂未提供。