| name | update-docs |
| description | 実装完了後にすべてのドキュメント(README・設計書・CLAUDE.md)を最新化する。新機能の追加、バグ修正、リファクタリング後に使用する。 |
ドキュメント一括最新化
機能の実装が完了した後、関連するすべてのドキュメントを最新の状態に更新する。
以下の4つのフェーズを順番に実行する:
- 変更内容の把握
- 開発ドキュメントの更新(設計書)
- README.md の更新
- CLAUDE.md の更新と一貫性チェック
Phase 1: 変更内容の把握(共通)
git diff HEAD~5 --name-only
git log --oneline -10
変更されたソースファイルから、どの機能が実装・変更されたかを特定する。
Phase 2: 開発ドキュメントの更新
対象ドキュメント
- 設計書 (
docs/design/<feature>.md) - 変換仕様、型定義、モジュール設計
Step 2-1: 設計書の更新 (docs/design/)
該当する設計書が存在する場合、以下を更新:
該当する設計書が存在しない場合、新規作成:
# <機能名> 設計書
## 実装ステータス
> **✅ 実装完了** (YYYY-MM-DD)
> 実装内容の説明
## 1. 概要
### 1.1 目的
### 1.2 スコープ
### 1.3 設計原則
## 2. 変換仕様
## 3. 実装詳細
Phase 3: README.md の更新
対象ファイル
Step 3-1: 新機能の追加
新しい機能やCLIオプションが実装された場合:
- Features セクション: 新しい特徴を追加
- Usage セクション:
npx askp convert のコマンド例やオプションを更新
- Input Format / Output Structure セクション: 入出力仕様の変更を反映
- Installation セクション: インストール手順に変更があれば更新
Step 3-2: 既存機能の変更
CLIオプションや変換仕様が変更された場合:
- 使用方法をソースコード (
src/cli.ts) と一致させる
- コード例が動作することを確認する
Step 3-3: コード例の検証
README内のコード例が最新の実装で動作するか確認:
src/index.ts のエクスポートと一致しているか
- CLIオプションが
src/cli.ts の Commander 定義と一致しているか
package.json の version / description と一致しているか
Phase 4: CLAUDE.md の更新と一貫性チェック
Step 4-1: CLAUDE.md の更新
以下のセクションを確認・更新:
- Architecture セクション:
src/ 配下のファイル構成が実態と一致しているか
- Common Commands セクション:
package.json の scripts と一致しているか
- Tech Stack: 依存関係の追加・変更があれば反映
Step 4-2: 一貫性チェック(全体)
すべてのドキュメントを更新した後、以下を確認:
src/index.ts でエクスポートされている全モジュールがREADMEに記載されているか
- CLIオプション(
src/cli.ts)とREADMEのUsageセクションが一致しているか
package.json の version と README/設計書の記述が矛盾していないか
- 設計書のステータスが実装の実態と矛盾していないか
- ドキュメント内の日付が正しいこと
- ファイルパスの参照が実際のディレクトリ構成と一致すること
記述ルール
README.md は英語で記述する
- 開発ドキュメント(設計書)は日本語で記述する
CLAUDE.md は英語で記述する
- コード例は TypeScript で記述する
- 既存のマークダウンスタイル・インデントを維持する
- コード例は完全に動作するものにする(断片的なコードを避ける)