Menu
Markdownドキュメントにトレーサビリティ用のYAMLフロントマターを追加する。新規ドキュメント作成時や、既存ドキュメントにトレース情報を追加する際に使用。
Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.
プロジェクトのドキュメントとコードをスキャンしてトレーサビリティグラフを構築する。新しいプロジェクトで最初に実行するか、大きな変更後に再スキャンする際に使用。
ドキュメントとコードのトレーサビリティ整合性をチェックする。リンク切れ、孤立ドキュメント、構造の問題を検出して修正案を提示。
コード変更後に影響を受けるドキュメントを特定し、更新する。コード修正後やPR作成前にドキュメントの整合性を保つために使用。
Basé sur la classification professionnelle SOC
| name | doc-tracer-add-frontmatter |
| description | Markdownドキュメントにトレーサビリティ用のYAMLフロントマターを追加する。新規ドキュメント作成時や、既存ドキュメントにトレース情報を追加する際に使用。 |
| allowed-tools | Read, Edit, Glob, Grep |
Markdownドキュメントにトレーサビリティ用のYAMLフロントマターを追加します。
---
trace:
id: doc:docs/XX_レイヤー名/ドキュメント名.md
parent:
- doc:docs/上位レイヤー/親ドキュメント.md
children:
- doc:docs/下位レイヤー/子ドキュメント1.md
- doc:docs/下位レイヤー/子ドキュメント2.md
implements:
- doc:docs/01_要件定義/機能要件定義書.md
uses:
- component:コンポーネント名
- api:/api/v1/endpoint
---
| レイヤー | 役割 | 親レイヤー |
|---|---|---|
| 01_要件定義 | WHY（なぜ作るか） | なし（最上位） |
| 02_仕様書 | WHAT（何を作るか） | 01_要件定義 |
| 03_基本設計 | HOW概要（どう作るか） | 02_仕様書 または 01_要件定義 |
| 04_詳細設計 | HOW詳細 | 03_基本設計 |
| 05_プログラム設計 | 実装設計 | 04_詳細設計 |
$ARGUMENTS
ファイルパスからレイヤーを判定:
01_要件定義/ → 最上位層、parentなし02_仕様書/ → parent: 01_要件定義03_基本設計/ → parent: 02_仕様書 または 01_要件定義04_詳細設計/ → parent: 03_基本設計05_プログラム設計/ → parent: 04_詳細設計同じ機能領域の上位層ドキュメントを探す:
# 例: 認証関連なら
ls docs/02_仕様書/ | grep -i 認証
ls docs/01_要件定義/ | grep -i 要件
IDは doc: プレフィックス + ファイルパス（docs/から）:
---
trace:
id: doc:docs/03_基本設計/認証基本設計書.md
parent:
- doc:docs/02_仕様書/認証仕様書.md
---
ファイルの先頭にフロントマターを追加。既存のフロントマターがある場合は trace: セクションをマージ。
parent を書く方が運用しやすいid: フィールドは省略可能parent と children は同じエッジを生成するため、どちらか一方だけ使用doc-tracer check で検出されるuses: フィールドでハマらないために❌ 存在しないノードIDを uses: に書く
# これはリンク切れになる
uses:
- module:scan # ← まだスキャンしてないのに書いた
先にスキャンを実行してノードIDを確認
./doc-tracer scan .
curl -s http://localhost:8888/api/graph | jq '.nodes[] | .id'
確認したIDのみを uses: に書く
uses:
- module:scan # ← スキャン結果で存在を確認済み
再スキャンしてチェック
./doc-tracer scan . && ./doc-tracer check
| コードタイプ | ノードID形式 | 例 |
|---|---|---|
| Goファイル (cmd/) | module:ファイル名 | module:scan |
| Goファイル (internal/db/) | module:db/ファイル名 | module:db/schema |
| Vueコンポーネント | component:コンポーネント名 | component:Header |
| TypeScript | module:ファイル名 | module:utils |
| Composable | composable:関数名 | composable:useAuth |
./doc-tracer scan . && ./doc-tracer check
# 「問題なし」が出るまで uses: を修正する