doc-updates

代码变更后自动更新文档,含质量门

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:doc-updates。
它的用途是:代码变更后自动更新文档,含质量门
完整的 Skill 内容见:https://321skill.com/skills/doc-updates-x-6/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'根据最近三次代码提交,自动更新项目文档中的API接口说明,并确保质量门通过。' doc-updates 会分析代码变更,识别受影响的文档段落,生成更新建议并执行准确性检查,最终输出通过质量门的文档版本。

介绍

在代码频繁迭代的过程中,文档滞后是团队协作的常见痛点。doc-updates 专为解决这一问题而设计:它能在每次代码变更后自动检测受影响的文档区域,并执行更新操作,同时内置质量门(quality gates)、松散内容检测(slop detection)和准确性检查,确保文档与代码始终保持一致,避免因文档过时引发误解或故障。

使用方式非常简单:将 doc-updates 集成到你的 CI/CD 流水线或本地开发工作流中。当代码提交或合并时,它会自动分析变更范围,识别需要更新的文档片段,并生成更新建议。你只需审查并通过质量门,即可一键应用更新。整个过程无需手动搜索和比对,大幅提升文档维护效率。

适合所有需要维护项目文档的开发者,尤其是后端开发、全栈开发以及文档工程师。对于频繁变更的代码库(如微服务、API 接口),该技能能显著降低文档维护成本。同时,也适合团队中负责技术文档同步的成员,确保文档与代码的版本一致。

使用建议:首次使用时,建议先在小规模项目上测试,熟悉质量门阈值和准确性检查的触发条件。对于大型代码库,可配置增量更新模式,避免一次性扫描影响性能。注意,该技能主要针对技术文档(如 API 文档、注释、README),不适合处理非结构化或纯文本类文档。

核心特点

与普通文档生成工具不同,doc-updates 内置了质量门(如覆盖率、准确率阈值)和 slop 检测,能自动过滤掉低质量或冗余的更新内容,并强制要求准确性检查,确保文档更新不仅是自动的,更是可靠的。

注意事项

仅适用于代码变更驱动的技术文档更新,不适合独立编写全新文档或处理非代码关联的文档内容。

常见问题

支持哪些代码仓库和文档格式?

支持 Git 仓库,文档格式包括 Markdown、AsciiDoc、RST 等常见文本格式,以及 JSDoc、Swagger 等结构化文档。

如何配置质量门?

通过配置文件设置质量门参数,如最低准确率(0-1)、允许的 slop 阈值、必须通过的检查项等。默认配置即可满足大多数场景。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/doc-updates-x-6/raw/index.md 读取 doc-updates 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。