| name | update-docs |
| description | 機能実装後にドキュメントを一括最新化。設計書・README・CLAUDE.mdを実装と同期し、矛盾がないことを最終確認する。 |
ドキュメント一括最新化
機能実装が完了した直後に実行する。
変更内容を把握し、関連するドキュメントを体系的に更新する。
ultrathink
Phase 1: 変更内容の把握
Step 1-1: 変更されたファイルの特定
git diff --name-only HEAD~5
git log --oneline -10
Step 1-2: 変更の影響範囲を分析
変更内容を以下のカテゴリに分類する:
- API変更: ルート追加・変更・削除(
src/app.ts)
- DB変更: スキーマ変更・マイグレーション追加(
migrations/)
- UI変更: フロントエンド変更(
public/)
- 設定変更: 設定ファイル・CI/CD変更
- 依存関係変更: package.json の変更
Phase 2: 開発ドキュメントの更新
Step 2-1: 設計書の更新(docs/design/)
設計書が存在する場合、以下を更新する:
- 実装ステータスを「✅ 実装完了」に変更
- 新しいAPI エンドポイントの追加
- DB スキーマ変更の反映
- 型定義の更新
Step 2-2: README.md の更新
以下のセクションを確認・更新する:
- アーキテクチャ図がAPI構成と一致しているか
- セットアップ手順が最新か
- 設定ファイルの記述が実際のファイルと一致しているか
- コード例が最新の実装で動作するか
Phase 3: CLAUDE.md の更新
Step 3-1: コマンド一覧の確認
package.json の scripts と CLAUDE.md の Development Commands が一致しているか確認する。
Step 3-2: アーキテクチャ記述の確認
新しいファイルやディレクトリが追加された場合、Architecture セクションを更新する。
Step 3-3: コード規約の確認
新しいパターンや規約が導入された場合、Code Conventions セクションを更新する。
Phase 4: 一貫性チェック
Step 4-1: ドキュメント間の整合性
Step 4-2: コード例の動作確認
Step 4-3: 問題が見つかった場合
矛盾が見つかった場合:
- 問題箇所を特定する
- ドキュメントを修正する(実装を正とする)
- 再度 Step 4-1 〜 4-2 を実行する
Phase 5: 更新結果の報告
## ドキュメント更新レポート
### 更新対象
- [ ] 設計書 (`docs/design/`)
- [ ] README.md
- [ ] CLAUDE.md
### 更新内容
- <更新1>
- <更新2>
- ...
### 一貫性チェック結果
- ドキュメント間整合性: ✅ / ⚠️(詳細)
- コード例の動作確認: ✅ / ⚠️(詳細)
記述ルール
- README.md は英語
- 設計書は日本語
- CLAUDE.md は英語(日本語セクションは既存のまま維持)
- コード例は完全に動作する TypeScript
- 既存のマークダウンスタイルとインデントを維持