mcpField

Docs Sync After Edits

おすすめ手動実行
依存関係の保守最大 3 ラウンド

Docs Sync After Edits について

コードを編集した後にドキュメントを整合させるループです。各ラウンドで現在のブランチと main を比較して変更ファイルを特定し、影響を受けるドキュメントを修正して、コードと照合します。

主な機能

  1. 01git diff main...HEAD --name-only で変更範囲を特定
  2. 02手動トリガーで開始時期を選べる
  3. 03最大3ラウンドで修正の繰り返しを制限
  4. 04更新後に検証を通って初めて完了
  5. 05Cursor に対応

活用シーン

  1. 01機能ブランチの完成後にドキュメントを仕上げる
  2. 02リファクタリングや名称変更後に古い説明を整理する
  3. 03プルリクエスト前にドキュメントの漏れを確認する
目標
ドキュメントが現在のブランチのコード変更と一致していること。
終了条件
影響を受けるドキュメントがすべて更新され、検証を通過した時点で終了します。
各ラウンドの間に実行
git diff main...HEAD --name-only

起動プロンプト

Cursor に貼り付けて実行すると、終了条件を満たすまでエージェントが以下の手順を繰り返します。

prompt.md
「Docs Sync After Edits」ループを開始します。
目標:ドキュメントが現在のブランチのコード変更と一致していること。
最大ラウンド数:3。
ステップ 1:変更ファイルを一覧化 — git diff main...HEAD --name-only の出力から、main に対してブランチで変更されたファイルを確認します。そのうえで影響を受けそうなドキュメントを判断します。
ステップ 2:対象ドキュメントを更新 — 影響を受けるドキュメントごとに、説明・例・参照を最新のコードに合わせて修正します。関係のない箇所は変更しません。
ステップ 3:ドキュメントをコードと照合 — 修正後のドキュメントを実際のコードと項目ごとに突き合わせます。不一致が残れば次のラウンドへ進み、すべて一致すればループを終了します。
各ラウンドの間に実行:`git diff main...HEAD --name-only`
終了条件:影響を受けるドキュメントがすべて更新され、検証を通過した時点で終了します。

手順

各ラウンドは順番に実行され、終了条件を満たさなければ次のラウンドへ進みます(最大 3 ラウンド)。

01
変更ファイルを一覧化

git diff main...HEAD --name-only の出力から、main に対してブランチで変更されたファイルを確認します。そのうえで影響を受けそうなドキュメントを判断します。

02
対象ドキュメントを更新

影響を受けるドキュメントごとに、説明・例・参照を最新のコードに合わせて修正します。関係のない箇所は変更しません。

03
ドキュメントをコードと照合

修正後のドキュメントを実際のコードと項目ごとに突き合わせます。不一致が残れば次のラウンドへ進み、すべて一致すればループを終了します。

未達 → 次のラウンド条件を満たせば終了

対応エージェント

この Loop をそのまま実行できるコーディングエージェントです。

Cursor

コメント