SuperAPI AI 工具集

docs-editor

写作与研究

查看项目

更新于 10-16 07:27

技能介绍

用途:对 OpenAI Cookbook 内容做保守式审阅与编辑,在提升正确性与可读性的同时,不改变作者意图、不编造事实、不产生无关改动。

主要能力:检查技术表述、API 与模型名称、标识符、命令、路径和 URL;核对正文、代码、示例输入与预期输出是否一致;检查前置条件、依赖、环境变量与运行步骤;检查文件与 notebook 名称、标题、列表、编号、交叉引用和链接;检查语法、拼写、标点、术语、大小写和简洁性;核对 registry.yaml 的发布元数据与 authors.yaml 的作者元数据。按 P0 至 P3 分级列出发现的问题。

使用方式:先限定范围,优先使用明确路径或 PR 中改动的文件;PR 场景审阅改动的 .md、.mdx 以及 .ipynb 中的 Markdown 单元格,内容新增、移动、删除或署名变更时审阅 registry.yaml 和 authors.yaml,不把聚焦审阅扩大为全仓库改写。编辑时仅改 notebook 的 Markdown 单元格,保留代码单元格、输出、执行计数、附件、单元格顺序、单元格 ID 及 notebook 和单元格元数据,避免为小改动重新序列化整个 notebook,并检查 diff 是否产生意外 JSON 变动。不应执行 notebook 代码,除非用户要求或代码改动在范围内;纯 Markdown 编辑只需结构校验。不得加入硬编码密钥,应记录所需环境变量如 OPENAI_API_KEY。加载 resources/style-guide.md 作为检查依据。不确定的技术表述需经权威来源核实或标记待审,不应猜测。

验证与报告:改动的 notebook 运行 env -u VIRTUAL_ENV uv run --with nbformat python .github/scripts/check_notebooks.py,再运行 git diff --check,检查 diff 确认改动仅限目标 Markdown 单元格;registry.yaml 或 authors.yaml 改动时运行可用的 YAML linter;仅在可执行内容变化且依赖可用时运行相关示例或测试。报告包含范围与编辑摘要、自动修复项、按优先级分组的剩余问题(含文件与行或单元格引用)、所运行的验证命令及结果;若无问题需明确说明。

适用场景:OpenAI Cookbook 文档与 notebook 的审阅、编辑和 PR 检查。限制:不执行 notebook 代码(除非要求),不做全仓库格式统一,不改变含义或凭产品知识猜测修改,仅聚焦内容审阅。