用途:检测并修复文档与实际实现之间的不一致,适用于 README、docs 目录、API 文档、安装指南、设计说明等项目文档。
工作流:先确定文档范围,优先使用用户提供的路径,否则检查 README.md、docs/、API 文档、安装指南、设计笔记等常见文档。随后对照实现核验各项声明,包括引用的文件和目录、脚本与命令、包管理器用法与安装步骤、依赖、配置名称、环境变量、测试命令,以及文档中的 API、公开函数、CLI 选项、路由和面向用户的工作流。
报告按严重程度分级:严重指错误路径、命令、API 名称或安装步骤导致无法使用;警告指过时或重复的文档可能误导维护者;提示指缺失文档或轻微偏差。
修复:提出聚焦的修改建议,除非用户明确要求,变更仅限文档,保持原有文档风格与结构,不把审查过程记录写入文档。仅在仓库当前指令允许编辑时才应用修改;如需批准,先列出目标文件与计划修改。修改后重新运行相关检查,或至少重读改动部分。
输出总结包含:检查的文档文件、核验的实现范围、发现的不一致、改动的文件(如有)、执行的检查。
限制:本技能聚焦文档一致性,不主动改动实现代码;具体命令、平台与收费信息资料未提供。