update-docs

update-docs

ソースコードの現状に基づき、すべてのドキュメントを一括で最新化するスキル。

Phase 1: ソースコードの現状把握

1. src/ 配下のRustソースコードを読み込む
   • src/main.rs — エントリポイント
   • src/cli/ — CLIコマンド定義
   • src/taskdef/ — タスク定義パーサ・型
   • src/docker/ — Docker APIクライアント
   • src/orchestrator/ — コンテナライフサイクル管理
   • src/metadata/ — メタデータエンドポイント
   • src/credentials/ — クレデンシャルプロバイダ
   • src/secrets/ — シークレットリゾルバ
2. Cargo.toml の依存クレート一覧を確認する
3. 公開API・構造体・トレイトの一覧を把握する

Phase 2: 各ドキュメントの更新

2-1. 設計書 (docs/design/<feature>.md)

1. 各設計書の内容をソースコードと照合する
2. 以下を更新する:
   • モジュール構成の変更
   • 構造体・トレイトの追加・変更・削除
   • 関数シグネチャの変更
   • 依存クレートの変更
3. 設計書が存在しない新機能がある場合、設計書の新規作成を提案する

2-2. 要件定義書 (docs/requirements.md)

1. 現在の実装状況に基づき、要件の達成状況を更新する
2. 新たに実装された要件を追加する
3. 未実装の要件を明記する

2-3. ロードマップ (docs/ROADMAP.md)

1. 完了した機能を更新する
2. 進行中の機能のステータスを更新する
3. 新たに計画された機能を追加する

Phase 3: README.md の更新

1. プロジェクト概要が最新か確認する
2. インストール・ビルド手順を確認する
   • cargo / make コマンドが正しいか
   • Cargo.toml との整合性を確認する
3. 使用方法・CLIコマンドの説明を確認する
   • src/cli/ の実装と一致しているか
4. アーキテクチャ図・モジュール構成が最新か確認する
   • src/main.rs のモジュール宣言と一致しているか

Phase 4: 一貫性チェック

すべてのドキュメント間で以下の一貫性を確認する:

1. モジュール名・構造体名の統一
   • すべてのドキュメントで同じ名前を使用しているか
2. コマンド参照の統一
   • cargo / make コマンドが正しく参照されているか
   • bun / npm 等の他言語コマンドが残っていないか
3. ファイルパス参照の統一
   • src/cli/, src/main.rs 等のパスが正しいか
   • 存在しないファイルへの参照がないか
4. 依存クレート情報の統一
   • Cargo.toml に記載されたクレートとドキュメントの記載が一致しているか
5. use 文の検証
   • ドキュメント中のコード例で使用されている use 文が実際のクレート構成と一致しているか

Phase 5: 更新レポートの出力

以下の形式で更新内容をレポートする:

## ドキュメント更新レポート

### 更新したドキュメント
| ファイル | 更新内容 |
|---------|---------|
| docs/design/xxx.md | [変更概要] |
| README.md | [変更概要] |
| ... | ... |

### 新規作成を提案するドキュメント
- [ファイル名]: [理由]

### 検出した不整合
- [不整合の詳細]

記述ルール

• コード例はRustで記述すること
• README.mdは英語で記述すること
• 開発ドキュメント（設計書・要件定義書）は日本語で記述すること
• 構造体名・関数名はRustの命名規則（snake_case / PascalCase）に従うこと