doc-updates
在代码变更后自动更新文档，确保文档质量与代码同步
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：doc-updates。 它的用途是：在代码变更后自动更新文档，确保文档质量与代码同步 完整的 Skill 内容见：https://321skill.com/skills/doc-updates-x-2/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“检查我刚提交的API代码变更，并据此更新对应的OpenAPI接口文档。”，它会自动分析代码变更，提取新的接口参数和返回值，生成更新的文档草稿，并运行质量检查，最后提示你审核通过或指出需要手动修正的问题。
介绍
该技能旨在解决代码频繁迭代后，文档更新滞后或质量下降的普遍痛点。它通过自动化流程，在代码提交或合并后触发文档更新任务，并内置质量门禁、内容准确性检查和“马虎”（slop）检测机制，确保生成的文档不仅及时，而且内容准确、格式规范。
使用时，开发者只需将其集成到CI/CD流水线或版本控制钩子中。当代码发生变更时，该技能会自动分析变更内容，识别出需要更新的文档部分，并生成或更新相应的文档草稿。随后，它会执行预设的质量检查，如术语一致性、格式规范、链接有效性等，确保文档达到发布标准。
它非常适合需要维护高质量技术文档的团队，尤其是后端开发、全栈开发、文档工程师和项目经理。这些角色通常面临文档与开发进度脱节的挑战，此技能能显著减轻他们的维护负担。
建议在集成前，团队应明确定义文档的质量标准（如术语表、模板），并将其配置到技能中。同时，虽然技能能处理大部分常规更新，但对于涉及复杂业务逻辑或架构决策的重大变更，仍建议人工进行最终审核和润色，以确保文档的深度和可读性。
核心特点
与仅生成文档草稿的工具不同，它集成了严格的质量门禁和“马虎”检测，能主动识别并拦截低质量、不准确或敷衍的文档更新，确保产出物符合团队标准。
注意事项
不适合需要深度业务逻辑阐述或创造性内容编写的全新文档创作场景。
常见问题
它能自动更新哪些类型的文档？
主要适用于API文档、代码注释、README、变更日志等与技术代码强关联的文档。
质量门禁具体检查什么？
通常包括术语一致性、代码示例正确性、格式规范、无死链、以及通过“slop检测”避免内容空洞或复制粘贴错误。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/doc-updates-x-2/raw/index.md 读取 doc-updates 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/doc-updates-x-2/raw/index.md（查看排版版本）