ドキュメント同期(実装との整合性チェック)
プロジェクトの仕様ドキュメントを実装コードと比較し、差異を修正します。
対象ドキュメント構造
text
docs/ ├── sequence/ # シーケンス図(実装フロー) │ ├── api/ # APIエンドポイント別 │ │ ├── post/ │ │ ├── portfolio/ │ │ ├── crm/ │ │ ├── chat/ │ │ ├── email/ │ │ ├── inquiry/ │ │ └── integration/ │ ├── web/ # Webフロントエンド │ │ ├── blog/ │ │ ├── portfolio/ │ │ └── api/ │ └── admin/ # 管理画面 │ ├── posts/ │ ├── portfolios/ │ ├── inquiries/ │ ├── crm/ │ └── dashboard/ ├── specs/ # API・DB仕様書 │ ├── api/ # API仕様 │ └── db/ # DB仕様 ├── user-stories/ # ユーザーストーリー │ ├── visitor/ │ ├── admin/ │ └── crm-user/ ├── architecture/ # アーキテクチャ設計 └── development/ # 開発ガイドライン
引数による対象指定
$ARGUMENTS で対象を絞り込み可能:
| 引数 | 対象ディレクトリ | 対応する実装 |
|---|---|---|
sequence | docs/sequence/ | apps/api/src/, apps/web/, apps/admin/ |
specs | docs/specs/ | apps/api/src/interface/rest/, packages/db/prisma/schema/ |
user-stories | docs/user-stories/ | apps/web/e2e/large/, apps/admin/e2e/ |
architecture | docs/architecture/ | プロジェクト全体構成 |
development | docs/development/ | 開発規約・ツール設定 |
| (省略) | docs/ 全体 | 全実装コード |
チェック項目
シーケンス図 (docs/sequence/)
| チェック | 実装参照先 |
|---|---|
| エンドポイントパス | apps/api/src/interface/rest/*.ts |
| リクエスト/レスポンス形式 | packages/validation/src/ |
| UseCase呼び出しフロー | apps/api/src/application/usecases/ |
| Repository操作 | apps/api/src/infrastructure/repositories/ |
API仕様書 (docs/specs/api/)
| チェック | 実装参照先 |
|---|---|
| エンドポイント一覧 | apps/api/src/interface/rest/ |
| HTTPメソッド・パス | Honoルーター定義 |
| バリデーションルール | packages/validation/src/ |
| エラーレスポンス | apps/api/src/interface/error-handler.ts |
DB仕様書 (docs/specs/db/)
| チェック | 実装参照先 |
|---|---|
| テーブル定義 | packages/db/prisma/schema/*.prisma |
| リレーション | Prismaスキーマの @relation |
| インデックス | Prismaスキーマの @@index |
ユーザーストーリー (docs/user-stories/)
| チェック | 実装参照先 |
|---|---|
| シナリオの実装状態 | apps/web/e2e/large/, apps/admin/e2e/ |
| 受け入れ条件 | E2Eテストのアサーション |
作業手順
- •差異調査: Exploreエージェントでドキュメントと実装の差異を網羅的に調査
- •差異一覧作成: 発見した差異をカテゴリ別(クリティカル/中/低)にまとめる
- •修正実行: Editツールでドキュメントを修正
- •サマリー報告: 変更内容を報告
差異の優先度基準
| 優先度 | 説明 | 例 |
|---|---|---|
| クリティカル | 実装と完全に矛盾 | エンドポイントパスの相違、存在しないファイル参照 |
| 中 | 情報の欠落・不足 | 新規追加されたパラメータ未記載 |
| 低 | 表記揺れ・軽微な差異 | バージョン番号、フォーマット |
修正方針
- •実装が正: ドキュメントを実装に合わせて修正
- •未実装機能:
## 今後の拡張セクションに移動 - •削除された機能: ドキュメントから削除(履歴はgitで管理)
出力例
markdown
## sync-docs 実行結果 ### クリティカル(即修正) - [ ] `docs/sequence/api/crm/customer-create.md`: エンドポイント `/api/crm/customers` → `/api/customers` に修正 ### 中(要確認) - [ ] `docs/specs/api/post.md`: `publishedAt` パラメータの記載漏れ ### 低(任意) - [ ] `docs/architecture/overview.md`: Node.jsバージョン 20.x → 22.x