技术文档事实核查
输入README、API文档或代码注释,逐项核对源码与示例,找出错误引用、行为漂移和无法验证的技术声明。
功能与用途
用于发布前检查技术文档是否真实、完整且可执行。你可以提供README、API参考、docstring、PHPDoc、JSDoc、变更日志、教程或文档站内容,以及相关代码库。它会核对函数、参数、命令、配置项、接口、文件路径和代码示例,发现文档与代码不一致、失效链接、错误版本信息及夸大或无依据的声明,并按文件和位置给出修改建议。进行审查时需要能访问对应源码、命令帮助、路由表或配置定义。
适用场景
- 发布前审查README:核对安装命令、依赖版本、配置项和快速示例,避免用户照文档操作失败。
- 同步API参考与实现:检查接口路径、参数签名、返回结构和错误类型是否与当前源码一致。
- 检查代码注释与类型标签:验证docstring、PHPDoc或JSDoc中的参数、返回值、异常和副作用说明。
- 审计教程与变更日志:发现失效链接、过时功能、未标版本行为及缺少失败路径的示例。
适用人群
- 软件工程师
- 开源项目维护者
- 技术写作者
- 代码审查人员
使用步骤
- 提供文档内容、代码变更或项目路径
- 说明要审查的文档范围和发布版本
- 核对文档中的符号、示例、链接和行为声明
- 按规则输出带文件位置证据的发现与修改建议
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- ffa2603
- 最近更新
- 2026-11-08
- 文件数
- 9
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过