Documentation Sync Skill

このスキルは、コードベースの実装状況を分析し、プロジェクトドキュメントを最新状態に同期します。

目的

• •コードベースの真実の状態をドキュメントに反映
• •ロードマップと実装進捗の可視化
• •ドキュメント間の整合性維持

実行タイミング

以下のようなリクエストで自動的に適用されます：

• •「ドキュメントを更新して」
• •「ロードマップをまとめて」
• •「進捗を反映して」
• •「README を最新化して」

分析対象

1. •Git履歴: コミットメッセージから機能追加・変更を抽出
2. •コードベース: 実装済み機能の確認
3. •既存ドキュメント: 現在のドキュメント状態
4. •TODO/FIXME: コード内の未完了タスク

更新対象ドキュメント

1. docs/roadmap.md（必須）

• •✅ 完了した機能
• •🚧 進行中の機能
• •📋 計画中の機能
• •💡 検討中のアイデア

2. README.md（必要に応じて）

• •プロジェクト概要
• •クイックスタートガイド
• •主要機能の説明

3. docs/architecture.md（必要に応じて）

• •システム構成の変更
• •新しいコンポーネントの追加

実行手順

ステップ1: コードベース分析

# 1. 最近のコミット履歴を確認（直近20件）
git log --oneline -20

# 2. 現在のブランチと変更状況
git status
git branch -a

# 3. プロジェクト構造のスキャン

以下のファイルを確認：

• •backend/app/main.py - API エンドポイント
• •frontend/src/ - UI コンポーネント
• •worker/app/pipeline.py - ドッキングロジック
• •docker-compose.yml - サービス構成
• •protein_library/manifest.json - タンパク質ライブラリ

ステップ2: 機能マッピング

コミットメッセージとコードから以下をマッピング：

完了済み機能の判定基準

• •✅ コードが実装されている
• •✅ テストが通過している（存在する場合）
• •✅ docker-compose.yml に反映されている
• •✅ コミット済み

進行中機能の判定基準

• •🚧 ブランチが存在
• •🚧 TODO/FIXME コメントがある
• •🚧 部分的に実装されている

計画中機能の判定基準

• •📋 AGENTS.md や既存 roadmap に記載
• •📋 issue/PR の discussion に記載

ステップ3: ドキュメント生成・更新

docs/roadmap.md のフォーマット

# Roadmap and Progress

最終更新: YYYY-MM-DD

## ✅ 完了済み (Completed)

### v0.1 - MVP基盤
- [x] Docker Compose 環境構築
- [x] FastAPI バックエンド
- [x] React フロントエンド
- [x] Celery ワーカー
- [x] PostgreSQL + Valkey/Redis

### v0.2 - 実装
- [x] AutoDock Vina による実ドッキング計算
- [x] PDB ファイルからの結合部位検出
- [x] 5つのキナーゼ構造追加
- [x] セキュリティ強化（CORS、レート制限）

## 🚧 進行中 (In Progress)

### v0.3 - デプロイメント
- [ ] デプロイ手順のドキュメント化
- [ ] クラウドデプロイ対応

## 📋 計画中 (Planned)

### v0.4 - 機能拡張
- [ ] 認証・認可システム
- [ ] タンパク質ライブラリの拡充
- [ ] 結果の可視化強化

## 💡 検討中 (Under Consideration)

- [ ] API のバージョニング
- [ ] ジョブキューの監視ダッシュボード
- [ ] バッチ処理対応

README.md の更新ポイント

• •新機能の追加を反映
• •クイックスタートの修正（ポート番号、URL など）
• •依存関係の更新

docs/architecture.md の更新ポイント

• •新しいサービス・コンポーネントの追加
• •データフローの変更
• •技術スタックの更新

ステップ4: 検証

更新後、以下を確認：

• • ドキュメント内のリンクが正しい
• • コマンド例が実行可能
• • ポート番号/URL が最新
• • Markdown フォーマットが正しい

出力形式

更新内容を以下の形式でユーザーに報告：

## ドキュメント更新完了

### 更新されたファイル
- docs/roadmap.md: ロードマップと進捗を最新化
- README.md: [変更内容]
- docs/architecture.md: [変更内容]

### 検出された主な変更
- ✅ 完了: [機能名]
- 🚧 進行中: [機能名]
- 📋 新規計画: [機能名]

### 次のステップ
- コミットして変更を保存してください
- または追加の修正をリクエストしてください

制約事項

• •ドキュメント更新のみ実行（コード変更はしない）
• •既存のドキュメント構造を尊重
• •手動で追加された情報は保持
• •自動生成部分は明示的にマーク

カスタマイズ可能な項目

• •分析するコミット数（デフォルト: 20件）
• •roadmap のセクション構造
• •優先して更新するドキュメント

使用例

ユーザー: ドキュメント更新して
→ このスキルが自動適用され、全ドキュメントを分析・更新

ユーザー: ロードマップだけ更新
→ docs/roadmap.md のみ更新

ユーザー: 最近の機能追加をREADMEに反映
→ README.md を中心に更新