実装とドキュメントのズレを防ぐ同期スキル

---

name: implementation-docs-sync
description: CodexやClaude Codeで機能追加・設定変更・コマンド変更を行った後、README、AGENTS.md、CLAUDE.md、API docs、.env.exampleなど関連ドキュメントを実装と同期するスキル。実装完了前の最終確認で使う。

Implementation Docs Sync

目的

コードは更新されたのにREADMEやエージェント向け指示が古いまま残る状態を防ぎ、次の人や次のAIセッションが正しい情報から作業できるようにする。

手順

1. 今回の差分から、外部から見える変更と開発者向け変更を抽出する。
2. リポジトリ内の次のファイルを必要な範囲で確認する。
   • README*
   • AGENTS.md
   • CLAUDE.md
   • CONTRIBUTING*
   • docs/
   • .env.example
   • API仕様・schema
   • セットアップや運用スクリプトの説明
3. 次の変更があれば対応する説明を更新する。
   • コマンドや引数
   • 環境変数
   • ディレクトリ構成
   • 新機能・削除機能
   • API契約
   • 開発・テスト・デプロイ手順
4. 実装から自明に分かる内容を長々と重複記述せず、利用者が必要とする情報に絞る。
5. 新しい詳細ドキュメントを追加した場合は、AGENTS.mdやREADMEなど適切な入口から辿れるようにする。
6. ドキュメント内のコマンド、ファイル名、リンク先が現在のリポジトリと一致するか確認する。

ルール

• 実装していない予定機能を完了済みのように書かない。
• 古い手順を残したまま新手順を追記しない。置き換えるべき箇所は整理する。
• AGENTS.mdは巨大なマニュアルにせず、プロジェクト概要・重要コマンド・参照先を中心に保つ。
• 今回追加した詳細ファイルや重要な運用資料は、AGENTS.mdなどから辿れるようにする。
• ドキュメント変更が不要なら、なぜ不要かを簡潔に判断する。

完了条件

実装、設定、テスト方法、エージェント向け案内の間に明確な矛盾がなく、次の作業者が古い情報に誘導されない。