메뉴
コード変更後に影響を受けるドキュメントを特定し、更新する。コード修正後やPR作成前にドキュメントの整合性を保つために使用。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
Markdownドキュメントにトレーサビリティ用のYAMLフロントマターを追加する。新規ドキュメント作成時や、既存ドキュメントにトレース情報を追加する際に使用。
プロジェクトのドキュメントとコードをスキャンしてトレーサビリティグラフを構築する。新しいプロジェクトで最初に実行するか、大きな変更後に再スキャンする際に使用。
ドキュメントとコードのトレーサビリティ整合性をチェックする。リンク切れ、孤立ドキュメント、構造の問題を検出して修正案を提示。
SOC 직업 분류 기준
| name | doc-tracer-update-docs |
| description | コード変更後に影響を受けるドキュメントを特定し、更新する。コード修正後やPR作成前にドキュメントの整合性を保つために使用。 |
| allowed-tools | Bash(doc-tracer:*), Read, Edit, Glob, Grep |
コード変更に伴い、影響を受けるドキュメントを特定して更新します。
# 最新コミットの変更ファイル
git diff --name-only HEAD~1
# ステージング済みの変更
git diff --name-only --cached
# 特定のファイル（引数指定）
echo "$ARGUMENTS"
# 単一ファイル
doc-tracer impact $ARGUMENTS
# 複数ファイル
git diff --name-only HEAD~1 | while read file; do
echo "=== $file ==="
doc-tracer impact "$file"
done
影響を受けるドキュメントを読み、どの部分を更新すべきか判断:
変更内容に応じてドキュメントを更新:
## 変更履歴
- YYYY-MM-DD: XXX機能を追加（コンポーネント名）
## コンポーネント構成
- `ComponentName.vue`: 説明を更新
## 処理フロー
1. ステップ1（変更あり）
2. ステップ2（新規追加）
doc-tracer check
問題があれば修正:
ドキュメント構造を変更した場合:
doc-tracer scan docs --docs-only
| コード変更の種類 | 更新すべきドキュメント |
|---|---|
| UIコンポーネント変更 | プログラム設計書 |
| API変更 | プログラム設計書、詳細設計書 |
| ビジネスロジック変更 | 詳細設計書、基本設計書 |
| 新機能追加 | 全層（必要に応じて） |
| バグ修正 | プログラム設計書（必要なら） |
更新したドキュメントの一覧と変更内容を報告:
更新したドキュメント:
- docs/05_プログラム設計/LoginForm設計書.md: UIロジック変更を反映
- docs/04_詳細設計/認証詳細設計書.md: エラーハンドリング追加
整合性チェック: OK