用途:检查文档是否与当前代码状态保持一致,用于验证文档与代码匹配、发现过时文档或审计文档准确性。
主要能力:查找近期代码变更、定位相关文档、核对文档准确性,并输出需要更新的文档清单。
使用方式:先查找近期代码变更,命令为 git log --since="30 days ago" --name-only --pretty=format: -- ".py" ".ts" "*.tsx" | sort -u;再查找相关文档,包括在 /docs/ 中搜索提及变更代码的文件、检查变更代码附近的 README 文件、查看变更文件中的 docstring;随后验证文档准确性,检查代码示例是否仍可运行、API 签名是否正确、字段类型是否最新;最后仅报告实际问题,只标记错误内容而非缺失内容,不为文档而文档,输出需要更新的文档清单。
适用场景:用户希望核对文档与当前代码是否一致、找出过时文档或进行文档审计时。
限制:资料未提供更多平台、收费、价格或效果信息;该技能聚焦于检查文档与代码同步,不负责自动修改文档。