ドキュメント更新ワークフロー

コード変更に伴い、影響を受けるドキュメントを特定して更新します。

ワークフロー

1. 変更ファイルの特定

bash

# 最新コミットの変更ファイル
git diff --name-only HEAD~1

# ステージング済みの変更
git diff --name-only --cached

# 特定のファイル（引数指定）
echo "$ARGUMENTS"

2. 影響を受けるドキュメントの特定

bash

# 単一ファイル
doc-tracer impact $ARGUMENTS

# 複数ファイル
git diff --name-only HEAD~1 | while read file; do
  echo "=== $file ==="
  doc-tracer impact "$file"
done

3. ドキュメントの内容を確認

影響を受けるドキュメントを読み、どの部分を更新すべきか判断:

•プログラム設計書: コードの構造・ロジック変更を反映
•詳細設計書: アルゴリズム・データフロー変更を反映
•基本設計書: アーキテクチャ・インターフェース変更を反映
•仕様書: 機能・振る舞い変更を反映

4. ドキュメント更新

変更内容に応じてドキュメントを更新:

プログラム設計書の更新例

markdown

## 変更履歴
- YYYY-MM-DD: XXX機能を追加（コンポーネント名）

## コンポーネント構成
- `ComponentName.vue`: 説明を更新

詳細設計書の更新例

markdown

## 処理フロー
1. ステップ1（変更あり）
2. ステップ2（新規追加）

5. 整合性チェック

bash

doc-tracer check

問題があれば修正:

•リンク切れ: 参照先が存在しない → IDを修正
•孤立ドキュメント: parentを追加

6. 再スキャン（必要な場合）

ドキュメント構造を変更した場合:

bash

doc-tracer scan docs --docs-only

更新の原則

何を更新するか

コード変更の種類	更新すべきドキュメント
UIコンポーネント変更	プログラム設計書
API変更	プログラム設計書、詳細設計書
ビジネスロジック変更	詳細設計書、基本設計書
新機能追加	全層（必要に応じて）
バグ修正	プログラム設計書（必要なら）

更新しないもの

•軽微なリファクタリング（動作変更なし）
•コメント・ドキュメント文字列のみの変更
•テストコードの変更

出力

更新したドキュメントの一覧と変更内容を報告:

code

更新したドキュメント:
- docs/05_プログラム設計/LoginForm設計書.md: UIロジック変更を反映
- docs/04_詳細設計/認証詳細設計書.md: エラーハンドリング追加

整合性チェック: OK