doc-updates
代码变更后自动更新文档，并执行质量门禁、准确性检查
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：doc-updates。 它的用途是：代码变更后自动更新文档，并执行质量门禁、准确性检查 完整的 Skill 内容见：https://321skill.com/skills/doc-updates-x-3/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“检查我刚提交的关于用户认证模块的代码变更，并更新对应的API文档。” 它会自动分析代码diff，定位到相关的API接口文档，根据新的参数和逻辑更新文档内容，并执行质量检查，最后提示你审查变更。或者，在合并请求时触发它，它会作为质量关卡，确保只有文档同步完成后才允许合并。
介绍
该Skill旨在解决开发过程中代码与文档不同步的常见痛点。当代码库发生变更后，它能够自动识别需要更新的文档部分，确保技术文档始终反映最新的代码逻辑和功能。
用户只需在代码提交或合并后触发该Skill，它会扫描代码变更，关联受影响的文档文件，并生成更新建议或直接进行内容修订。整个过程集成了质量门禁，例如检查文档的完整性、术语一致性，并利用“slop detection”机制识别低质量或模糊的描述，确保生成的文档清晰准确。
它非常适合需要维护大量技术文档的团队，如后端开发、全栈开发和文档工程师，能显著减轻他们手动同步文档的负担。对于追求开发流程自动化、重视代码与文档一致性的项目尤为有益。
使用建议是将其集成到CI/CD流水线中，作为代码合并前的检查环节。注意事项是，对于高度创意性或非结构化的文档内容，可能需要人工复核以确保语气和风格的统一。
核心特点
与单纯生成文档的Skill不同，它专注于代码变更后的精准同步，并内置了质量门禁和“slop detection”（可理解为检测文档中的模糊、低质或无关内容），能主动识别并修正文档中的不准确或冗余描述，确保更新后的文档质量。
注意事项
不适合用于更新创意文案、营销内容等非技术性文档，或对文档风格和叙事性有极高要求的场景。
常见问题
它能自动更新哪些类型的文档？
主要适用于API文档、代码注释、README、技术设计文档等与代码结构紧密相关的技术文档。
质量门禁具体检查什么？
检查文档完整性（如必填章节）、术语一致性、链接有效性，并利用准确性检查对比代码逻辑与文档描述是否匹配。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/doc-updates-x-3/raw/index.md 读取 doc-updates 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/doc-updates-x-3/raw/index.md（查看排版版本）