SuperAPI AI 工具集

docs-review

写作与研究

查看项目

更新于 11-04 23:09

技能介绍

docs-review 是一个文档审核技能,主要用途是审核 langchain-ai/docs 仓库中发生变更的文档叙述文字(prose),对照 Vale 与 AGENTS.md 风格指南作出报告,并注明每条发现所违反的规则。它适合在撰写或编辑完页面之后使用。

目标解析:可通过 $ARGUMENTS 指定 PR 编号或 GitHub PR URL、分支名;如果为空且存在未提交改动,则使用工作树;如果为空且工作树干净,则使用当前 HEAD 相对 main 的差异。范围收窄到 src//*.mdx 与 src//*.md;无变更则说明并停止;绝不审核 build/ 下的内容。对 PR 或分支模式,会先检出目标再检查,并给出目标、解析到的 SHA(或“working tree”)及文件数。

Vale 检查:运行 make lint_prose FILES="<files>",报告每条违规的文件与行号;带 --fix 时修正,否则列出。还会对每个改动文件的合并基线版本运行 lint 并报告差异,区分既有债务与本 diff 引入的 CI 阻塞项。Vale 覆盖术语、缩写、第一人称、将来时、牛津逗号、带空格破折号、导航路径箭头与标题大小写;但它不扫描 MDX 中 JSX 组件(如 <Note>、<Tip>、<Tab>、<Step>、<Accordion>)与表格单元格内的内容,因此需用 grep 自行检查带空格破折号、缩写、第一人称与将来时、导航箭头等机械规则。

结构检查:阅读 AGENTS.md 的“Structure conventions”并逐条对照改动块,包括新章节是否以一句话定义开头、步骤是否有冒号引导且为祈使句、三项以上选项是否用列表、重复提及链接与首次提及链接、权限/套餐/预览要求是否前置于步骤、硬约束是否被模糊化等;不转换长短两种指针短语。

风格检查(Vale 覆盖不到):已知施动者时的被动语态、填充与模糊词、因删改而失去先行词的代词/this/the above、被删掉的条件的默认值或要求、产品名与普通名词大小写、正文加粗、diff 内重复、链接文字描述性、版本下限写法(应写 v0.153.4 or later,>= 仅用于包说明符)等。报告前需度量:若认为某约定被违反,先用 grep 统计仓库中该形式的出现频次;广泛使用的形式视为既定实践。还需对比改动前后同一形式并统计两种拼写,判断改动是遵循还是破坏约定;对重复块需同时检查组件、措辞、位置三部分,并在三页及以上重复时建议放入 src/snippets/。

机制检查(仅在 diff 触发时):新页是否加入 src/docs.json 的正确产品、标签与分组;重命名或删除页的入站链接与 docs.json 条目是否更新;新内部链接是否根相对且不含 /python/ 或 /javascript/;新代码块是否有真实语言标记且导入有序;URL 变化的页是否有重定向;新 JSX 标签是否为 Mintlify 内置或在页面导入;PR 描述是否用 Closes DOC-N 或 Refs DOC-N 引用 Linear 议题、是否以平实的 AI 披露句结尾且无 Generated with 徽章。页面机制细节指向 add-docs-page 技能。

报告:按文件分组,每条发现给出文件与行号、所依据的规则、问题说明与建议,最后给出一行结论,区分阻塞合并项(Vale 违规、缺少导航条目、断链)与建议项;无发现时明确说明“无发现”。在创作类技能之后运行时,它处于工作树模式,只审核刚改动完成且尚未提交的文件,不扩大到分支其余部分。

限制:仅适用于 langchain-ai/docs 仓库及其 src 下的 Markdown/MDX 文档;依赖 Vale、make lint_prose、git、gh 等工具与网络访问;不对已经存在的文字负责(只审 diff);不处理 build/ 目录。