doc-naming について
doc-naming は、8 層の SDD フローを使うチーム向けの文書命名検証スキルです。命名規則に照らして ID とタグを確認し、旧形式を検出します。成果物は生成しません。
主な機能
- 01文書 ID 形式の検証
- 02要素 ID としきい値タグの検証
- 03旧形式の検出と移行先の提示
- 04ファイル名規則の確認
活用シーン
- 01成果物の作成・編集前の ID 確認
- 02文書保守時の廃止 ID の検出
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ vladm3105/ aidoc-flow-framework --skill doc-namingインストール後、Claude Code で/doc-namingを入力して読み込まれたか確認します。
詳細
doc-naming
目的
8 層の SDD フローにおける命名規則の管理元です。doc-naming は、ドキュメント ID、要素 ID、しきい値タグ、ファイル名を ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md に照らして検証し、削除済み/レガシーのパターンにフラグを立てます。成果物は生成しません。フレームワークには実行時コードが含まれていないため、宣言的な ID 検証ツールとして機能します。
レイヤー:横断的ユーティリティ(8 層すべてに適用)。
使用するタイミング
使用する:成果物を作成または編集する前に、以下を行います。
- ドキュメント ID または要素 ID の形式を確認する。
@threshold:タグを確認する。- 削除済み/レガシーの ID パターンを検出し、移行先を確認する。
使用しない:ドキュメント間のトレーサビリティや内容のレビューには使用しません。../doc-validator/SKILL.md を使用してください。
動作
1. ドキュメント ID — TYPE-NN
^[A-Z]{2,8}-[0-9]{2,}$ — 大文字のタイプ、単一のハイフン、2 桁以上の連番(2 桁を超える余分な先頭ゼロは不可:BRD-01、ADR-99、IPLAN-102)。ファイル名:TYPE-NN_descriptive_slug.md。
2. 要素 ID — TYPE.NN.SS.xxxx(4 セグメント)
^[A-Z]+\.[0-9]{2,}\.[0-9]{2,}\.[a-f0-9]{4,8}$
| セグメント | 意味 | 形式 |
|---|---|---|
| TYPE | 成果物のプレフィックス | BRD PRD EARS BDD ADR TDD |
| NN | ドキュメント番号 | 2 桁以上 |
| SS | ソースセクション番号 | 2 桁以上 |
| xxxx | 安定した内容識別子、16 進数 4 桁(重複時は 8 桁)— 詳細は以下を参照 | [a-f0-9]{4,8} |
例:BRD.01.07.a7f3。要素 ID は Markdown の見出しとして記述します(### BRD.01.07.a7f3: Title)。
3. 参照の粒度(要素とドキュメント)
数値の要素タイプコードはありません。ID はセクションとハッシュで識別され、固定コードではありません。
| レイヤー | 参照形式 | 例 |
|---|---|---|
| BRD、PRD、EARS、BDD、TDD | 要素(ドット区切り)TYPE.NN.SS.xxxx | PRD.01.09.1dbc |
| ADR | 両方:ドキュメント ADR-NN と要素 ADR.NN.SS.xxxx | ADR-05、ADR.05.03.e5b1 |
| SPEC、IPLAN | ドキュメント(ハイフン区切り)TYPE-NN | SPEC-06、IPLAN-01 |
トレーサビリティタグにはこれらの参照を記述します:@brd: BRD.01.07.a7f3、@spec: SPEC-06、@iplan: IPLAN-01。
4. しきい値タグ
@threshold: {TYPE}.{NN}.{key}。key は category.subcategory.attribute[.qualifier] です。カテゴリ:perf timeout rate retry circuit alert cache pool queue batch。ドキュメント参照は必須で、ドット区切りです — @threshold: PRD.035.timeout.partner.bridge(有効)、@threshold: timeout.partner.bridge(ドキュメント参照がないため無効)。しきい値の参照元:BRD(ビジネス SLA)、PRD(プロダクト指標)、ADR(技術的制限)。
5. 予約済み ID と REF の適用除外
TYPE-00_*(インデックス、テンプレート、用語集)— フレームワークのインフラストラクチャです。要素 ID とトレーサビリティのチェックをスキップします。TYPE-REF-NN_{slug}.md(BRD/ADR のみ、../doc-ref/SKILL.md経由)— 自由形式の参照先です。要素 ID と品質ゲートはありません。
6. 削除済み/レガシーのパターン(拒否)
該当するものはすべて TYPE.NN.SS.xxxx(または SPEC/IPLAN の場合はハイフン区切りのドキュメント参照)に移行します。
| 削除済み | 対象 |
|---|---|
AC-XXX、FR-XXX、BC-XXX、BA-XXX、QA-XXX、BO-XXX、RISK-XXX、METRIC-XXX、Feature F-XXX | BRD、PRD |
Event-XXX、State-XXX | EARS |
DEC-XXX、ALT-XXX、CON-XXX | ADR |
3 セグメントの TYPE.NN.xxxx | すべての要素レイヤー |
grep で検出します。例:grep -E "(AC|FR|BC|BA|QA|BO|NFR|RISK|METRIC)(-[A-Za-z0-9]+)*-[0-9]+" file.md(省略可能な (-[A-Za-z0-9]+)* は、FR-CICD-001 のような複合形式を検出します)。
移行:ファイル名から TYPE/NN、ソースセクションから SS を導き、xxxx にはそのセクション内で重複しない安定した 4 桁の 16 進数識別子を指定します。すべての出現箇所を置き換えて、再検証してください。SHA-256 を手動で計算しないでください。BRD §7 — フィールド抽出の境界が定義されている唯一のレイヤー — では、ジェネレーターを呼び出します:python -m sdd_doc_lint.rehash --compute --doc-id NN --section-id SS --title T --description D。準拠基準:framework/governance/ID_NAMING_STANDARDS.md。
7. ISO 8601 タイムスタンプ
日時フィールド(フロントマターの last_updated、created_date、review_date、
fix_date、approval_date、decision_date)には
YYYY-MM-DDTHH:MM:SS(Z または ±HH:MM を任意で付加)を使用し、
同日内の変更を検出できるようにします。日付のみの値は非推奨です。
事前チェックリスト
- ドキュメント ID は
TYPE-NN、ファイル名はTYPE-NN_slug.mdです。 - 要素 ID は 4 セグメントの
TYPE.NN.SS.xxxxで、4~8 桁の 16 進数ハッシュを含み、ドキュメント内で一意です。SPEC/IPLAN ではハイフン区切りのドキュメント参照を使用します。 -
@threshold:タグにはドキュメント参照と承認済みカテゴリが含まれています。 - 削除済み/レガシーパターンや、3 セグメントの要素 ID はありません。
- トレーサビリティタグのプレフィックス(
@brd:…@tdd:)が正しく、参照先が存在します。
関連リソース
- ID とタグの規定:
${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md - しきい値の規則:
${CLAUDE_PLUGIN_ROOT}/framework/governance/THRESHOLD_NAMING_RULES.md - レイヤーレジストリ(一覧、チェーン、フォルダー):
${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml - レイヤー別テンプレートと README:
${CLAUDE_PLUGIN_ROOT}/framework/layers/NN_<X>/ - ドキュメント間の検証:
../doc-validator/SKILL.md - ワークフローのルーティング:
../doc-flow/SKILL.md - 図表:
../charts-flow/SKILL.md