Docs Sync After Edits

精选按需触发

依赖维护最多 3 轮

关于 Docs Sync After Edits

这个循环用于在代码修改后补齐文档。每一轮先对比当前分支与 main 找出改动文件，再更新受影响的文档，并核对内容是否与代码相符。

主要功能

01通过 git diff main...HEAD --name-only 定位改动范围
02手动触发，由使用者决定何时开始
03最多 3 轮，避免无限修改
04文档更新后还要经过核对才算完成

适用场景

01功能分支开发完成后补写文档
02重构或重命名之后清理过时说明
03提交合并请求前确认文档没有遗漏

目标: 文档内容与当前分支的代码改动一致。
退出条件: 所有受影响的文档都已更新并通过核对时停止。
每轮之间运行: git diff main...HEAD --name-only

启动提示词

在 Cursor 中粘贴运行，Agent 会按下面的步骤循环执行，直到满足退出条件。

prompt.md

开始运行“Docs Sync After Edits”循环。
目标：文档内容与当前分支的代码改动一致。
最大轮数：3。
第 1 步：列出改动文件 — 以 git diff main...HEAD --name-only 的结果为准，找出分支相对 main 改动过的文件。据此判断哪些文档可能受到影响。
第 2 步：更新受影响文档 — 针对每个受影响的文档，按最新代码修改说明、示例和引用。没有受影响的内容则不做改动。
第 3 步：核对文档与代码 — 把更新后的文档与实际代码逐项对照。若仍有不一致就进入下一轮，全部一致则结束循环。
每轮之间运行：`git diff main...HEAD --name-only`
退出条件：所有受影响的文档都已更新并通过核对时停止。

步骤

每一轮按顺序执行；未满足退出条件会进入下一轮，最多重复 3 轮。

列出改动文件

以 git diff main...HEAD --name-only 的结果为准，找出分支相对 main 改动过的文件。据此判断哪些文档可能受到影响。

更新受影响文档

针对每个受影响的文档，按最新代码修改说明、示例和引用。没有受影响的内容则不做改动。

核对文档与代码

把更新后的文档与实际代码逐项对照。若仍有不一致就进入下一轮，全部一致则结束循环。

未通过 → 下一轮满足条件即退出

支持的 Agent

可以直接运行这个 Loop 的编码 Agent。

Cursor

支持 Markdown

登录后评论