doc-updates
代码变更后自动更新文档并检查质量
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：doc-updates。 它的用途是：代码变更后自动更新文档并检查质量 完整的 Skill 内容见：https://321skill.com/skills/doc-updates-x-7/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'帮我用 doc-updates 更新这次代码变更对应的 API 文档，要求质量门分数不低于90分'，它会自动分析代码 diff，修改相关 Markdown 文件，并运行 slop 检测和准确性校验，最终输出一份更新后的文档审查报告。
介绍
开发中经常遇到代码改了但文档没同步的问题，导致团队成员或下游使用者产生困惑。doc-updates 专门解决这个痛点：在每次代码变更后自动识别受影响的文档区域，执行更新，并通过质量门（quality gates）、草率内容检测（slop detection）和准确性校验（accuracy checks）三道关卡，确保文档与代码保持同步且高质量。
使用方式非常简单：将其集成到你的 CI/CD 流程或开发工作流中，当代码提交或合并时，doc-updates 会自动扫描变更文件，对比现有文档，生成差异补丁或直接更新文档内容。你还可以配置自定义的质量阈值，比如要求文档覆盖率、术语一致性等，不达标则阻止合并。
适合所有需要维护代码文档的团队，尤其是后端开发、全栈开发和文档工程师。如果你正在使用 Git 协作开发，并希望减少文档维护的体力活，同时避免因文档过期导致的沟通成本，这个工具会非常实用。
建议在项目初期就引入该 Skill，并配合团队文档规范（如 API 文档、架构说明、使用指南等）一起使用。注意它更适用于结构化文档（如 Markdown、AsciiDoc），对于纯图片或视频形式的文档支持有限。
核心特点
同类工具只做简单替换，doc-updates 内置了草率内容检测和准确性校验，能识别出 AI 生成的废话或与代码矛盾的地方，并自动拒绝不合格的更新。
注意事项
不适合非代码驱动的纯文档项目（如政策文档、创意文案），也无法处理手绘示意图或视频中的文字更新。
常见问题
如何集成到 CI/CD 中？
在 pipeline 中增加一个步骤，运行 `npx doc-updates` 即可，支持 GitHub Actions、GitLab CI、Jenkins 等。默认读取当前分支与目标分支的差异。
支持哪些文档格式？
主要支持 Markdown、AsciiDoc、reStructuredText，以及常见注释格式（JSDoc、Javadoc 等）。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/doc-updates-x-7/raw/index.md 读取 doc-updates 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/doc-updates-x-7/raw/index.md（查看排版版本）