SuperAPI AI 工具集

documentation-verification

写作与研究

查看项目

更新于 10-16 03:47

技能介绍

用途:在文档合并或发布前,用证据而非仅靠润色来验证改动,覆盖完整性、链接、命令、代码示例与事实正确性。

适用触发场景:合并或发布前评审文档;核对 README、安装或配置说明的准确性;验证本地链接、命令与代码片段;确认用户可见行为变更时文档已同步更新。

验证流程:确认文档覆盖了被改动的行为;检查相对链接与被引用文件;在可行时验证命令与代码片段;明确报告缺失的覆盖与过时陈述。

跨客户端使用:面向 GitHub Copilot、Claude Code 与 Codex 保持可用。Copilot 需将文件夹放在可见 skill 路径,或在无法发现文件夹时把工作流写入项目说明;Claude Code 放在本地 skills 目录或兼容插件源;Codex 安装或同步到 $CODEX_HOME/skills/documentation-verification,并在重大变更后重启。

MCP:无需特定 MCP 服务器。缺少 MCP 时可用回退提示:“Use the Documentation Verification skill without MCP. Rely on its local instructions, bundled resources, standard shell or editor tools, and direct verification. Show the evidence used before concluding.” 宿主未暴露 MCP 时不得声称使用了 MCP 操作;以本地文件、测试、渲染输出、日志或截图作为回退证据。

资源:Validation Procedures(链接、示例、配置与覆盖的实用检查)、Doc Link Check(校验单个文件或整个文档树的相对 Markdown 链接)。相关技能:documentation-authoring、documentation-patterns、documentation-quality、notion-docs。

限制:继承 documentation-patterns 的共享栈,本技能聚焦最终证据检查而非重述完整栈;避免为作者而非读者写作、省略具体示例或命令、放任链接截图版本漂移等反模式。验证协议要求输出标明受众、目的、事实来源与时效要求,且未经验证的声明须显式标注。