docs-drift-guard

仓库创建 2026年7月4日最近提交 21 天前SkillHot 收录 20 天前
▸ 精选理由

保证变更后的可用性和用户文档同步

这个 Skill 做什么

检测代码变更是否同步更新 README/CHANGELOG/--help 等文档。

当代码改了对外可见的东西(改名、加删 flag、改默认值、改配置键等)时,会检查 README、CHANGELOG、docs、examples、--help 和注释等文档是否也同步更新,发现遗漏就不能把改动标为完成。适合在发布或改 API、命令行界面时作为一道保护,防止文档滞后误导用户。它的特别之处是把“文档也是完成条件”自动化,减少发布时的盲点。

▸ 展开 SKILL.md 英文原文

Blocks calling a code change "done" when it renamed, added, removed, or changed a public name, flag, command, default value, count, config key, or behavior but left the docs (README, CHANGELOG, docs/, examples, --help text, code comments/docstrings) still referencing the old surface. Best used reactively after code changes a public name, flag, command, default value, count, config key, or behavior. Use when the user says "rename", "change the flag", "update the API", "add a command", "bump the version", or after any change to a user-facing surface. DO NOT USE for pure internal refactors with no public surface, or for verifying tests (test-code quality is out of proofguard's scope; a test-quality-guard is in `deferred/`, not yet shipped); this guard checks that DOCS match the code after a change.

Skill 开发管理文档一致性变更检测自动化校验通用
1
Stars
0
Forks
8
仓库内 Skill
+0
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/mohamedzhioua/proofguard/main/skills/docs-drift-guard/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/mohamedzhioua/proofguard/main/skills/docs-drift-guard/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# docs-drift-guard

"Docs are part of done." A change that renames a flag, adds a command, or
flips a default is not finished the moment the code compiles — it is
finished when every doc that describes the old surface has been found and
updated to describe the new one. This guard blocks the completion claim
until that grep has actually been run.

The failure mode this guard targets is AI-slop documentation: grammatically
perfect JSDoc/README prose that describes what the model *thinks* the code
does — inferred from the function/flag/command *name* — rather than what it
actually does after the rename. A renamed flag silently drifts from its own
docs because nothing forced the two to be checke
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有