コード変更に影響を受ける md ドキュメントを検出し、ユーザー承認後に更新する。
フロー
- •
scripts/doc-check.shを実行する - •出力を解釈し、影響ドキュメント一覧をユーザーに提示する
- •ドキュメントごとにユーザーの判断を確認する
- •承認されたドキュメントを更新し、差分を提示する
スクリプト実行
スキルディレクトリからの相対パスで実行する:
bash
# デフォルト: staged + unstaged の変更に対してチェック bash "$(dirname "$SKILL_PATH")/scripts/doc-check.sh" # コミット範囲を指定 bash "$(dirname "$SKILL_PATH")/scripts/doc-check.sh" --range HEAD~3..HEAD # ファイルを直接指定 bash "$(dirname "$SKILL_PATH")/scripts/doc-check.sh" --files src/api.ts src/handler.ts
終了コード
- •
0: 影響なし → 「影響を受けるドキュメントはありません」と報告して終了 - •
1: 影響あり → 次のステップへ - •
2: エラー → エラー内容を報告して終了
ユーザー確認
影響を受ける各ドキュメントについて、AskUserQuestion で以下を確認する:
- •更新する — ドキュメントと変更コードを読み込み、更新差分を提示する
- •スキップ — このドキュメントは更新不要と判断
- •後で対応 — 今回は更新せず、次回のチェックで再検出される
更新処理
「更新する」が選ばれた場合:
- •対象ドキュメントを Read で読み込む
- •変更されたコードファイルを Read で読み込む
- •コード変更の内容に基づきドキュメントを更新する
- •Edit で更新差分を適用する前に、変更内容をユーザーに提示する
- •ユーザー承認後に書き込む
連鎖影響(参照リンク経由)のドキュメントも同じ手順で処理する。
制約
- •
doc-check.shスクリプトの出力をそのまま解釈する。独自にファイル走査しない - •ドキュメント更新前に必ずユーザー承認を得る。自動更新は禁止
- •設定されている言語で出力する