Community生产力与协作github.com

chukaofili/agent-plugins

在PR阶段或功能完成后、PR打开前使用;当文件、包、路由、命令、环境变量、API或约定被添加、重命名、移动或删除时,或者当被要求“更新文档”、“同步文档”、“刷新README/AGENTS.md”,或被告知“文档过时”时使用。审计每个文档与代码的对应关系,修复漂移,重新生成生成的文档,并将结果提交到当前分支。

agent-plugins 是什么?

该技能旨在解决文档与代码之间常见的“静默漂移”问题。当代码发生变化但文档未同步更新时,产品说明、API参考或开发者指南会变得不准确。此技能提供了一个结构化的工作流,用于审计、验证和修复文档漂移,确保文档与代码库行为一致。它适用于基于文件的文档(如README、AGENTS.md、OpenAPI规范)以及自动生成的文档。技能维护一个集中的 `docs/DOCS.md` 清单,跟踪哪些文档涵盖哪些内容以及如何生成它们。工作流包括对比差异、读取实际代码验证文档声明、修复不匹配、重新运行生成命令,最后将更改作为一个原子提交推送到当前分支。该技能专为Claude Code等AI代理设计,提供自动化文档同步的标准操作程序。

兼容平台✓Claude Code~Codex CLI~Cursor✓Gemini CLI
npx skills add https://github.com/chukaofili/agent-plugins/tree/HEAD/plugins/coding-protocol/skills/sync-docs

Installed? Explore more 生产力与协作 skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

同步文档

文档在悄然漂移。当一个 README 中引用的一个文件被移动时,没有任何失败。在每个堆叠式 PR 阶段或完成的功能之后、PR 打开之前运行此技能。

此技能的定义包括提交。 它可能在不询问的情况下进行提交,始终提交到当前分支,绝不提交到 main。

何时跳过

  • 文档引用的内容没有变化(纯内部逻辑)。仍然在 PR 的“测试”部分写上“文档已检查,无漂移”,以便审查者知道它已经运行过。
  • 用户明确表示暂时不想提交文档更改。

清单:docs/DOCS.md

范围内的文档列表存放在 docs/DOCS.md 中,而不是在 AGENTS.md 中,这样常驻上下文不会随着每次同步而增长。

# 文档清单

| 路径 | 归属 | 生成方式 |
|---|---|---|
| README.md | 定位、设置、环境变量、布局 | |
| AGENTS.md | 代理规则 + 项目门禁 | |
| packages/api/README.md | 端点、脚本、环境变量 | |
| docs/api/openapi.json | API 参考 | `pnpm generate:openapi` |

## 冻结(同步时绝不编辑)
- docs/plans/

## 漂移检查
<!-- 每行 grep 对应一个实际发生过的问题,并附上为什么这样做的注释 -->

首次运行: 构建它。扫描根目录和每个包中的 README.md / AGENTS.md / CLAUDE.md、贡献者文档、API 文档(OpenAPI 描述、llms.txt)、技能和规则目录以及环境变量引用(.env.example、配置模式)。记录每个文档涵盖的内容。

每次运行: 你找到的但未列出的文档将被添加,并在同一次提交中完成。

流程

  1. 审计。 将分支与其基础版本进行差异比较(git diff <base>...HEAD --stat),并列出文档可能提及的变更:路径、包名、路由、命令和脚本、环境变量、导出的 API、行为、约定。
  2. 验证。 对于清单中的每个文档,对照代码检查每一个具体声明:每个命名的文件是否存在于该路径,每个命令是否存在于清单中,每个环境变量是否实际被读取,每个路由和导出是否如描述那样存在。阅读代码;不要相信描述文本,包括你之前写的描述。
  3. 编辑。 修复漂移。描述代码实际做了什么,切勿为了让文档看起来更好而发明行为。如果代码和文档不一致且你无法判断哪个是错误的,则将其标记出来,而不是猜测。
  4. 重新生成。 运行清单中列出的每个生成器命令。切勿手动编辑生成的文档。
  5. 运行 docs/DOCS.md 中列出的漂移检查。 当同步发现一个可能再次发生的错误(例如旧路径、重命名的命令)时,为此添加一个 grep,并附上解释原因。
  6. 提交。 按路径暂存文件,切勿使用 git add -A。创建一个原子提交,格式为 docs(<scope>): sync <what> with <change>,在当前分支上。
  7. 如果分支已跟踪远程仓库,则推送(先执行 git pull --rebase)。 切勿推送到 main。

规则

  • 冻结的历史: docs/plans/ 中的设计、计划和工作交接是当时决策的快照。它们在 grep 中会出现;这是预期的,不是漂移。切勿在同步期间编辑它们。
  • 探索和技术方案一旦其方向发布或被放弃,就会被删除, 不会作为参考保留。一旦产品知识更深入,探索的结论就是仓库中最不可靠的文本。任何仍然值得了解的内容都会移动到已发布代码的文档中。
  • 大小预算: 文档行数计入 PR 预算。如果同步将某个阶段推向超过 500 行,则将其作为堆栈顶部的纯文档阶段落地(参见 stacked-prs)。
  • 指针文件保持简短。 一个仅指向 AGENTS.md 的 CLAUDE.md 或 GEMINI.md 应该保持这种方式。不要将内容复制进去。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

chukaofili/agent-plugins

Use when starting a feature, refactor or bug fix; when asked to plan, spec, design or debug something; when writing a plan or handoff document; when choosing, adopting or upgrading a dependency, framework or external API; or when starting work that will become its own branch. Covers propose-before-building, scoping work to the PR size budget, debugging discipline, reading current docs instead of trusting memory, and when and how to use a git worktree.

chukaofili/agent-plugins

Use when a change is likely to exceed ~300 changed lines, when work spans several commits or stages, when opening a pull request, when receiving or responding to review feedback on any pull request, or when rebasing or landing a stack of dependent PRs. Covers the PR size budget and what counts toward it, how to split and stack PRs, sequential stage-by-stage review, and how to handle review findings by verifying each one, then fixing it or pushing back.

chukaofili/agent-plugins

Use when executing an approved plan end to end without a human watching. Typical cues are "here's the plan, go", "work on this overnight", "run autonomously", "I'll be back in a few hours", or a long session started before a meeting. Covers what the agent may decide alone, the four checkpoints it must never pass, keeping work durable (commit and push often), delegating to subagents, and how to leave blockers so the work is reviewable when the human returns.

chukaofili/agent-plugins

Use when a change touches anything a user sees, such as components, pages, views, screens, styles, templates, dialogs, forms or copy, and before opening a PR for it. Covers driving the change in a real browser through every state, running a review sweep against the repo's design and framework guidelines, and capturing screenshots for the PR, including what to do when no browser is available.

相关技能