| name | sync-docs |
| description | 設計ドキュメント同期チェック。ソースコード変更時にrouting.md/wireframe.md/database.md/README.mdを更新する。 |
| when_to_use | src/配下のソースコードを実際に編集した後、または「ドキュメント更新」「設計同期」と明示された時。Issue作成・調査・閲覧などソースコードを変更しない作業では発火しない。 |
設計ドキュメント同期ルール
前提: このスキルは「ソースコードを実際に変更した」場合にのみ適用する。 Issue 作成・調査・仕様確認など、ソースコードを変更しない作業では発火しない(それらはドキュメントを参照するだけで同期は不要)。
バグ修正や仕様変更などにより 既存のソースコードを修正した場合、
その内容に応じて 以下の設計ドキュメントも必ず更新すること。
- @routing.md
- @wireframe.md
- @database.md
- @README.md
判断基準
以下のいずれかに該当する場合は、必ず該当する md ファイルを更新すること。
- 認証フロー・全体仕様・前提条件・利用方法が変わった →
README.md
- 画面遷移・URL・ルーティングが変わった →
routing.md
- 画面構成・UI要素・表示項目が変わった →
wireframe.md
- テーブル構成・カラム・リレーション・利用方法が変わった →
database.md
原則
- ソースコードと設計ドキュメントの内容は 常に一致している状態を保つこと
- 実装だけが先行し、設計ドキュメントが古くなる状態を禁止する
禁止事項
- 「軽微な修正だから」という理由でドキュメント更新を省略すること
- ソースコードと md ファイルの内容が矛盾した状態で PR を作成すること
- ドキュメント更新を後回しにして忘れること
作業完了の条件
- 修正したソースコードの内容が、該当する md ファイルに正しく反映されていること
- 作業完了時点で 「コードを読まなくても md を見れば仕様が分かる状態」 になっていること
- この条件を満たさない場合、作業完了とはみなさない