Menü
ドキュメントとコードのトレーサビリティ整合性をチェックする。リンク切れ、孤立ドキュメント、構造の問題を検出して修正案を提示。
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Basierend auf der SOC-Berufsklassifikation
| name | doc-tracer-check |
| description | ドキュメントとコードのトレーサビリティ整合性をチェックする。リンク切れ、孤立ドキュメント、構造の問題を検出して修正案を提示。 |
| allowed-tools | Bash(doc-tracer:*), Read, Edit, Glob, Grep |
ドキュメントとコードの整合性をチェックし、問題があれば修正します。
doc-tracer check
症状: エッジの参照先ノードが存在しない
⚠️ リンク切れ (3件):
- doc:docs/03_基本設計/認証設計書.md -> component:LoginForm (uses)
定義元: docs/03_基本設計/認証設計書.md
原因:
対処:
# コンポーネントを探す
doc-tracer serve # Web UIで検索
# または
grep -r "LoginForm" --include="*.vue"
uses:
- component:LoginFormNew # 正しい名前に修正
症状: どこからも参照されていないドキュメント
⚠️ 孤立ドキュメント（参照なし）(2件):
- 新機能設計書.md
パス: docs/03_基本設計/新機能設計書.md
原因:
対処:
# 同じ機能領域の上位層を探す
ls docs/02_仕様書/
---
trace:
parent:
- doc:docs/02_仕様書/該当仕様書.md
---
症状: A → B → C → A のような循環
対処: 通常は問題ないが、意図しない場合は関係を見直す
checkコマンドは統計情報も表示:
📊 統計情報:
ノード:
- document: 150
- component: 80
- controller: 30
- model: 25
エッジ:
- contains: 200
- uses: 150
- calls: 50
確認ポイント:
# 03_基本設計のドキュメント一覧
find docs/03_基本設計 -name "*.md" -type f
# 各ファイルのフロントマターを確認
for f in docs/03_基本設計/*.md; do
echo "=== $f ==="
head -20 "$f"
done
# uses/implementsの参照先を抽出
grep -r "uses:" docs --include="*.md" -A 10 | grep "component:"
問題なしの場合:
✅ 整合性チェック完了: 問題なし
→ そのままコミット可能
問題ありの場合:
整合性チェックで問題が見つかりました
→ 上記の対処法で修正後、再チェック
# GitHub Actions例
- name: Check documentation consistency
run: |
doc-tracer scan .
doc-tracer check
# 問題があればCI失敗
Markdownドキュメントにトレーサビリティ用のYAMLフロントマターを追加する。新規ドキュメント作成時や、既存ドキュメントにトレース情報を追加する際に使用。
プロジェクトのドキュメントとコードをスキャンしてトレーサビリティグラフを構築する。新しいプロジェクトで最初に実行するか、大きな変更後に再スキャンする際に使用。
コード変更後に影響を受けるドキュメントを特定し、更新する。コード修正後やPR作成前にドキュメントの整合性を保つために使用。