採番ルール
本ドキュメントは、TASHIKAプラットフォームのドキュメント全体で使用するIDの採番ルールを定義します。
共通ルール
フォーマット
{PREFIX}-{3桁連番}- プレフィックス: 2〜3文字の英大文字。カテゴリを一意に識別する
- 連番: 001から開始、ゼロ埋め3桁（最大999）
- 区切り: ハイフン（
-）で統一
基本原則
| ルール | 説明 |
|---|---|
| 一意性 | 同一プレフィックス内でIDは一意。プレフィックスが異なれば同一番号は許容（例: DM-101 と BF-101 は別のID） |
| 不変性 | 一度付与したIDは原則として変更しない |
| 欠番許容 | 廃止されたIDは欠番とし、再利用しない |
| 単一定義 | 各IDは1つのドキュメント内で正式に定義される（他ドキュメントからは参照のみ） |
グルーピングルール
百番台ブロック（階層型）
IDの数が多いカテゴリ（目安: 30個以上、または明確なドメイン分割があるもの）は百番台ブロックでグルーピングする:
1xx,2xx,3xx... のブロック単位でドメインを分類- ブロック内は連番（例: 101, 102, ... 199）
- 各ブロックに最大99個のIDを収容可能
- ブロック間に拡張余地を確保
連番（フラット型）
IDの数が少ないカテゴリ（30個未満）は連番:
001,002,003... の単純連番- 将来的にIDが増加した場合、百番台ブロックへの移行を検討
カテゴリ一覧
既存カテゴリ
| プレフィックス | カテゴリ | グルーピング | 定義場所 |
|---|---|---|---|
| BF | 業務フロー (Business Flows) | 百番台ブロック | requirements/business-flows/ |
| DM | データモデル (Data Model) | 百番台ブロック | requirements/data-model.md |
| AV | 可用性 (Availability) | 連番 | requirements/nonfunctional/availability.md |
| PE | 性能・拡張性 (Performance & Extensibility) | 連番 | requirements/nonfunctional/performance.md |
| OP | 運用・保守性 (Operations & Maintainability) | 連番 | requirements/nonfunctional/operations.md |
| SR | セキュリティ要件 (Security Requirements) | 連番 | requirements/nonfunctional/security.md |
| CR | コンプライアンス要件 (Compliance Requirements) | 連番 | requirements/nonfunctional/compliance.md |
| AC | アクセシビリティ要件 (Accessibility) | 連番 | requirements/nonfunctional/accessibility.md |
| QA | 品質保証 (Quality Assurance) | 連番 | requirements/nonfunctional/quality.md |
| ADR | Architecture Decision Record | 連番 | conventions/decisions/ |
| UC | ユースケース (Use Cases) | 百番台ブロック | requirements/use-cases/ |
| GL | 用語集 (Glossary) | 連番 | domain/glossary/ |
将来カテゴリ
| プレフィックス | カテゴリ | グルーピング | 用途 |
|---|---|---|---|
| AR | アーキテクチャ設計 (Architecture) | 連番 | バックエンド・フロントエンド・セキュリティ設計の設計判断にIDを付与 |
| TC | テストケース (Test Cases) | 百番台ブロック | E2E・結合・単体テストのケースID |
| API | APIエンドポイント (API Endpoints) | 百番台ブロック | REST APIエンドポイントの識別 |
| UI | 画面・コンポーネント (UI Screens) | 百番台ブロック | 画面設計・UIコンポーネントの識別 |
| RI | リスク (Risks) | 連番 | プロジェクトリスクの識別・追跡 |
百番台ブロック定義
BF（業務フロー）
| ブロック | ドメイン | 例 |
|---|---|---|
| 0xx | エンドツーエンド（概要レベル） | BF-001 年始調整エンドツーエンドフロー |
| 1xx | 年度サイクル詳細 | BF-101 年度準備フロー |
| 2xx | オンボーディング | BF-201 テナントオンボーディングフロー |
| 3xx | プラットフォーム運用 | BF-301 税制改正対応フロー |
UC（ユースケース）
| ブロック | 領域 | 例 |
|---|---|---|
| 0xx | 横断ユースケース | UC-001 年度準備ウィザードを実行する |
| 1xx | 代行 | UC-101 顧問先を登録する |
| 2xx | 組織 | UC-201 従業員を登録する |
| 3xx | 家族 | UC-301 親族を登録する |
| 4xx | 申告（ライフサイクル・判定） | UC-401 申告書を作成する |
| 5xx | 申告（控除計算・証憑・通知） | UC-501 生命保険料控除を計算する |
| 6xx | 給与 | UC-601 給与データをインポートする |
| 7xx | アイデンティティ | UC-701 ユーザーを登録する |
| 8xx | 国税・地方税 | UC-801 源泉徴収票を生成する |
| 9xx | サブスクリプション | UC-901 代行事業者のトライアルを申請する |
DM（データモデル）
| ブロック | 領域 | 例 |
|---|---|---|
| 1xx | 代行 | DM-101 Agency |
| 2xx | 組織 | DM-201 Tenant |
| 3xx | 家族 | DM-301 FamilyMember |
| 4xx | 申告 | DM-401 Declaration |
| 5xx | 給与 | DM-501 TaxCalculationResult |
| 6xx | アイデンティティ | DM-601 User |
| 7xx | サブスクリプション | DM-701 Contract |
| 8xx | 設定・マスタ系 | DM-801 AnnualSetting |
| 9xx | 監査・運用系 | DM-901 AuditLog |
変更管理ルール
ID の廃止
- 廃止するIDを「廃止」として変更履歴に記録する
- 該当IDの番号は欠番とし、新しいIDに再利用しない
- 他ドキュメントからの参照を削除または更新する
ID の新規追加
- 該当ブロック内の最終番号 +1 を使用する
- ブロックが満杯（x99まで使用済み）の場合、次のブロック（空きがあれば）を使用する
リナンバリング（ID番号の変更）
- 原則禁止。IDの安定性がトレーサビリティの基盤である
- 例外: 初期整備段階での一括統一（BFリナンバリング、DM領域別リナンバリング）
クロスリファレンス
- 他ドキュメントからのID参照は
→ [ID名](リンク)の形式で記載する - 例:
→ 満たす要件: [SR-002 認証要件](../requirements/nonfunctional/security.md)