specdojo 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +4 -1
- package/CHANGELOG.md +64 -0
- package/dist/catalog/catalog.js +16 -14
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +4 -2
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/timeline.js +14 -14
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +146 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +9 -0
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +31 -18
- package/dist/exec/events.js +34 -14
- package/dist/exec/evidence.js +13 -3
- package/dist/exec/parent-validation.js +56 -3
- package/dist/exec/plans-core.js +21 -2
- package/dist/exec/plans-generation.js +6 -7
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/reporter.js +2 -2
- package/dist/exec/results.js +24 -4
- package/dist/exec/review-kata.js +4 -1
- package/dist/exec/run/agent-pipeline.js +3 -2
- package/dist/exec/run/agent.js +12 -6
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +4 -1
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +56 -19
- package/dist/exec/run/lifecycle-commands.js +1 -1
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/register-command.js +8 -5
- package/dist/exec/run/register-mode.js +68 -8
- package/dist/exec/run/register-resume.js +68 -14
- package/dist/exec/run/register-state.js +13 -8
- package/dist/exec/run/register-worktree.js +140 -125
- package/dist/exec/run/schedule-mode.js +75 -14
- package/dist/exec/run/schedule-prepare.js +3 -0
- package/dist/exec/run/schedule-task.js +88 -38
- package/dist/exec/run/shared.js +5 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trial-commands.js +5 -2
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +9 -1
- package/dist/exec/worktree-ops-commit.js +2 -2
- package/dist/exec/worktree.js +13 -2
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +5 -3
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +5 -1
- package/dist/grade/run.js +64 -8
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +79 -23
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/maintenance-commands.js +2 -2
- package/dist/register/register.js +31 -7
- package/dist/routine/definition.js +9 -0
- package/dist/routine/routine.js +137 -43
- package/dist/routine/status.js +62 -0
- package/dist/schedule/schedule.js +38 -39
- package/dist/shared/agent-types.js +5 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +44 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/specdojo-config.js +34 -20
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +9 -1
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
- package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
- package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
- package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
- package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
- package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
- package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
- package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
- package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +257 -117
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bds-sample.md +58 -71
- package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
- package/docs/ja/specdojo/samples/bes-sample.md +43 -53
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +40 -52
- package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
- package/docs/ja/specdojo/samples/clis-sample.md +70 -77
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
- package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
- package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
- package/docs/ja/specdojo/samples/sf-sample.md +73 -85
- package/docs/ja/specdojo/samples/sld-sample.md +60 -79
- package/docs/ja/specdojo/samples/uis-sample.md +98 -121
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +9 -6
- package/templates/antigravity/orchestrator.md +4 -1
- package/templates/claude/agents/specdojo-orchestrator.md +4 -1
- package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
- package/templates/codex/orchestrator.md +4 -1
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
|
@@ -21,28 +21,14 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
21
21
|
- **適用範囲**: 業務分析・要求定義・設計で利用する `bdd-*.yaml` を対象とする。
|
|
22
22
|
- **実装重複の排除**: 実装詳細を再掲するのではなく、schema や実装(TypeScript 型)が存在するエンティティはそれらを正本として参照し、業務データ辞書にはスキーマから読み取れない業務上の意味(項目の業務的定義、enum 値が表す業務状態など)に特化して記述する。
|
|
23
23
|
- **完成条件**: 「本文要件」を満たし、「成果物の検証手順」の機械検証と手動照合をともに完了する。コマンドの成功だけで業務上の正しさを判定しない。
|
|
24
|
-
-
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
25
25
|
- **変更時の影響範囲**: BDD の検証スキーマ、成果物カタログ、参照するスキーマ・型定義、用語集、CCD、状態・業務ルールの正本を確認する。正本の変更と業務注釈の整合を別々に確認する。
|
|
26
26
|
|
|
27
|
-
## 2.
|
|
27
|
+
## 2. 位置づけ
|
|
28
28
|
|
|
29
29
|
- **成果物の種別**: 本ルールは `type: data` の成果物に適用する(成果物メタデータとしての `type` は `data` 固定であり、各フィールドのデータ型を表す `type` と区別する)。
|
|
30
30
|
- **機械検証正本との依存関係**: YAML の構造・型・正規表現の正本は `docs/specdojo/schemas/v1/bdd.schema.yaml` とする。本書は各キーの用途と業務上の判断を扱い、構文の詳細はスキーマを参照する。
|
|
31
|
-
-
|
|
32
|
-
- **主要な関係者(Role code)と確認観点**:
|
|
33
|
-
- **BA(ビジネスアナリスト / 主作成者)**: 業務上の管理単位・フィールドの業務的意味・状態定義の正確性と完全性を記述する(`vp-ba-requirements-completeness`)。
|
|
34
|
-
- **PO(プロダクトオーナー / 確認者)**: 業務概念のスコープ、エンティティ境界、業務用語の整合性を確認・承認する(`vp-po-purpose-alignment`, `vp-po-decision-readiness`)。
|
|
35
|
-
- **ARC(アーキテクト / 確認者・利用者)**: システム設計・データ構造・正本スキーマ参照(`schema_ref`)との整合性、技術制約を確認する(`vp-arc-technical-constraints`)。
|
|
36
|
-
- **DEV(開発者 / 利用者)**: 実装(モデル・型定義・テーブル設計)の基礎情報として参照し、TypeScript 型参照(`type_ref`)やスキーマとの対応を確認する(`vp-dev-implementation-readiness`)。
|
|
37
|
-
- **QE(品質保証 / 確認者)**: 制約条件、許容値、検証可能性を確認する(`vp-qe-verifiability`)。
|
|
38
|
-
- **用語定義**:
|
|
39
|
-
- **エンティティ(entities)**: 業務上の独立した管理単位・データオブジェクト。
|
|
40
|
-
- **フィールド(fields)**: エンティティを構成する個々のデータ項目。
|
|
41
|
-
- **論理名(`logical_name`)**: 業務利用者が直感的に理解できる日本語名称(単数形)。
|
|
42
|
-
- **物理名(`physical_name`)**: DB 列名やシステム識別子に対応する英語 `lower_snake_case` 名称。
|
|
43
|
-
- **キー項目(`key_fields`)**: エンティティを一意に識別する業務上のキー項目のリスト。
|
|
44
|
-
- **用語集参照キー(`glossary_term_id`)**: 用語集(glossary)に登録された正式な用語 ID(`tm-...`)。
|
|
45
|
-
- **関連用語(`related_terms`)**: 関連する用語集の用語 ID リスト。
|
|
31
|
+
- **隣接仕様との分担**: 用語は用語集、管理単位の関係は CCD、状態遷移・業務ルールはそれぞれの正本を参照する。配置・命名は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従う。
|
|
46
32
|
|
|
47
33
|
## 3. ファイル命名・ID規則
|
|
48
34
|
|
|
@@ -53,17 +39,6 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
53
39
|
- SpecDojo 同梱成果物: `specdojo:bdd-<name>`(例: `specdojo:bdd-sample`)
|
|
54
40
|
- 単体 ID: `bdd-<name>`
|
|
55
41
|
- 成果物メタデータの `type` は `data` 固定とする。
|
|
56
|
-
- **変更管理手順**:
|
|
57
|
-
- 置き換えによる大幅な改訂がある場合は `supersedes` に旧 ID を列挙し、旧 BDD を `status: deprecated` へ移行する(PO 承認)。
|
|
58
|
-
- 用語集(`gl-*.yaml`)や概念クラス図(CCD)が改訂された場合は、保守担当(BA / ARC)が関連する `bdd-*.yaml` の `logical_name`, `glossary_term_id`, `related_terms` を同期更新する。
|
|
59
|
-
- `schema_ref` / `type_ref` の参照元が改訂された場合、ARC / DEV が参照先の移動、フィールドの追加・改名・廃止、キー変更、enum 値の追加・改名・廃止を差分から抽出する。BA / ARC は該当する BDD の参照、`physical_name`、`key_fields`、許容値と業務注釈(論理名・説明・ラベル・用語参照)を照合する。
|
|
60
|
-
- 参照元との対応が未解決の項目は、旧新の対応・影響・確認担当を変更記録に残す。業務注釈の意味を確認し、「成果物の検証手順」を完了するまで更新を受け入れない。値の機械的な置換だけで同期完了としない。
|
|
61
|
-
- **フィールドの非推奨・廃止とアップストリーム削除時の運用パス**:
|
|
62
|
-
- 自発的なフィールドの非推奨・廃止時は、スタンドアロン定義では直接削除せず `description` に非推奨理由および代替フィールドを明記して移行期間を設ける。
|
|
63
|
-
- アップストリーム(正本スキーマまたは TypeScript 型)側ですでにフィールドが削除された場合、アクティブな `fields` に残すと参照元実在項目の手動照合条件と競合する。そのため、ARC / DEV は差分抽出時にアップストリーム削除を検知し、BA とともに次のいずれかの運用パスを実施する:
|
|
64
|
-
1. **レガシーアノテーションの退避**: アクティブな `fields` リストから削除済みフィールドを外し、エンティティの `description` やレガシー注釈ノートへ非推奨理由・代替フィールド・削除時期・旧アノテーションを移動して記録を保持する。
|
|
65
|
-
2. **互換ソースバージョンへの紐付け**: 移行期間中にアクティブなフィールド定義・注釈を維持する必要がある場合は、`schema_ref` / `type_ref` の参照先を最新版から当該フィールド削除前の互換バージョン(Git タグ、特定コミット、または安定版スキーマパス)へ明示的に固定(ピン留め)する。移行期間終了時に最新版へ切り替え、レガシーアノテーションを退避する。
|
|
66
|
-
- これにより、移行期間中の業務情報保持と、手動照合における最新正本との厳格な検証可能性(欠落・余分な注釈の排除)を両立する。変更タスクは PM が PJR 項目として管理する。
|
|
67
42
|
|
|
68
43
|
### 3.2. ファイル命名規約
|
|
69
44
|
|
|
@@ -144,7 +119,7 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
144
119
|
|
|
145
120
|
### 6.1. 記述の基本方針
|
|
146
121
|
|
|
147
|
-
|
|
122
|
+
メタ情報・エンティティ・フィールドは、次の基準で書き分ける。
|
|
148
123
|
|
|
149
124
|
| 対象 | 判断の基準 | 良い例 | 悪い例 |
|
|
150
125
|
| -------------------------- | ------------------------------------------ | -------------------------------------------------------------- | -------------------------------------------------- |
|
|
@@ -190,6 +165,11 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
190
165
|
- **良い例**: `key_fields: [product_code]` が実際の識別項目に対応し、`glossary_term_id: tm-product-code` が対象用語集に存在する。
|
|
191
166
|
- **悪い例**: `key_fields` に論理名を指定する、表示用の導出値を保存キーとして扱う、用語 ID の存在を名前から推測する。
|
|
192
167
|
|
|
168
|
+
参照元の改訂時は、移動・フィールド・キー・enum の差分を抽出し、参照パス、物理名、キー、許容値と業務注釈を照合する。用語集・CCD の変更時は論理名・用語参照を同期する。未解決の対応は論点と影響を残し、「成果物の検証手順」を満たすまで受け入れない。
|
|
169
|
+
|
|
170
|
+
- **スタンドアロンのフィールド廃止**: 直接削除せず、`description` に非推奨理由・代替フィールドを示し、移行期間を設ける。
|
|
171
|
+
- **参照元で削除済みのフィールド**: `fields` から外し、エンティティの `description` または注釈ノートへ非推奨理由・代替・削除時期・旧注釈を退避する。移行中に維持する必要があれば `schema_ref` / `type_ref` を削除前の互換バージョン(タグ・コミット・安定版パス)に固定し、移行終了時に最新版へ切り替えて退避する。
|
|
172
|
+
|
|
193
173
|
### 6.4. enum および業務ステータスの記述方法
|
|
194
174
|
|
|
195
175
|
- enum フィールドや状態遷移を持つ項目では、許容値を必ず明示する。
|
|
@@ -202,30 +182,20 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
202
182
|
|
|
203
183
|
### 6.5. 成果物の検証手順
|
|
204
184
|
|
|
205
|
-
作成・改訂した業務データ辞書 YAML
|
|
185
|
+
作成・改訂した業務データ辞書 YAML は、BDD 構造の機械検証と業務要件の手動照合で判定する。対象ファイル・参照した正本・各検証結果を記録する。
|
|
206
186
|
|
|
207
|
-
#### 6.5.1.
|
|
187
|
+
#### 6.5.1. 個別の構造検証
|
|
208
188
|
|
|
209
189
|
```bash
|
|
210
190
|
npm run validate:schema:file -- --schema docs/specdojo/schemas/v1/bdd.schema.yaml --data <対象YAMLファイルパス>
|
|
211
|
-
node packages/docs-lint/bin/specdojo-docs-lint.js yaml-schema --modeline <対象YAMLファイルパス>
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
- **期待結果**: 両方が対象ファイルを `valid` と表示して終了コード 0 となること。明示的な `--schema` 指定の合格だけでは、先頭コメントの存在や相対パスの正しさを確認したことにならない。
|
|
215
|
-
|
|
216
|
-
#### 6.5.2. 全体検証と整形
|
|
217
|
-
|
|
218
|
-
```bash
|
|
219
|
-
npm run validate:schema
|
|
220
|
-
npx prettier --check <対象YAMLファイルパス>
|
|
221
191
|
```
|
|
222
192
|
|
|
223
|
-
-
|
|
224
|
-
- **検証の限界**: `
|
|
193
|
+
- **合格条件**: 対象ファイルが `valid` と表示され、終了コード 0 となること。
|
|
194
|
+
- **検証の限界**: `bdd.schema.yaml` はスタンドアロンの各フィールドの `type` 必須、列挙方式の排他性、参照元との意味・値・キーの一致、用語参照の解決を保証しない。これらは次の手動照合で判定する。
|
|
225
195
|
|
|
226
|
-
#### 6.5.
|
|
196
|
+
#### 6.5.2. 業務要件と参照整合の手動照合
|
|
227
197
|
|
|
228
|
-
|
|
198
|
+
対象項目を正本の定義位置と対応付け、次の合格条件を一つずつ確認する。該当しない行は対象形態と理由を記録する。
|
|
229
199
|
|
|
230
200
|
| 確認対象 | 合格条件 | 残す証跡 |
|
|
231
201
|
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
@@ -236,33 +206,12 @@ BA / ARC は以下の合格条件を一つずつ確認し、DEV は参照元と
|
|
|
236
206
|
| 参照元の許容値 | 参照元の enum 値と辞書の列挙に不足・余分がなく、業務ラベルが各値の意味に一致する | フィールド・参照元の定義位置・値ごとの対応 |
|
|
237
207
|
| 二重管理の防止 | 参照型の `fields` に `type` / `constraints` を再掲せず、業務上の判断に必要な注釈だけを持つ。状態遷移・承認条件は正本へ参照する | 注釈の選定と重複の有無 |
|
|
238
208
|
|
|
239
|
-
- **良い判定例**:
|
|
209
|
+
- **良い判定例**: 構造検証の成功に加え、用語 ID・キー・enum 値を正本の箇所と対応付けて合格を記録する。
|
|
240
210
|
- **悪い判定例**: `validate:schema` の終了コード 0 だけで、辞書の参照と業務注釈も整合していると判定する。
|
|
241
211
|
|
|
242
|
-
### 6.6. rulebook 改訂候補の enum 網羅確認
|
|
243
|
-
|
|
244
|
-
`npm run validate:schema:rulebook-enums` は `ready` の YAML / JSON rulebook だけを対象とする。`draft` の本書に対しては、コマンド全体の成功を網羅確認の証跡にしない。
|
|
245
|
-
|
|
246
|
-
1. `draft` を維持したまま、`docs/specdojo/schemas/v1/bdd.schema.yaml` 内のすべての文字列 enum を定義位置ごとに抽出する。入れ子の定義も確認し、scaffold 専用のプレースホルダは除く。
|
|
247
|
-
2. 各値が本書の本文に独立した値として明記されているか照合する。Frontmatter と finding コメントは数えない。値の追加・変更時には対応する用途の説明も確認する。
|
|
248
|
-
3. 次の列で対象別の照合記録を残す。全値の対応が埋まり、欠落がゼロであることを確定前の合格条件とする。
|
|
249
|
-
|
|
250
|
-
| 証跡の列 | 記録する内容 |
|
|
251
|
-
| ----------------- | ------------------------------------------------------------------- |
|
|
252
|
-
| 対象と版 | 本 rulebook と BDD 検証スキーマのパス、照合時の版または内容ハッシュ |
|
|
253
|
-
| enum 定義位置・値 | スキーマ内の定義位置と各文字列値 |
|
|
254
|
-
| 本文の記載位置 | その値を記載した見出し名と行、または未記載 |
|
|
255
|
-
| 判定・確認者 | 値ごとの合否、欠落数、確認者 |
|
|
256
|
-
|
|
257
|
-
4. 人間による最終承認にはこの対象別証跡を添える。昇格後は通常コマンドの出力にも本書のパスを含む `enum coverage valid` があることを確認する。
|
|
258
|
-
|
|
259
|
-
- **良い例**: `draft` の改訂候補とスキーマを直接照合し、各値の本文位置と欠落ゼロを記録する。
|
|
260
|
-
- **悪い例**: 対象パスが出力されていない通常コマンドの成功を根拠にする、または確認のために本書を `ready` へ書き換える。
|
|
261
|
-
|
|
262
212
|
## 7. 禁止事項
|
|
263
213
|
|
|
264
214
|
- **技術的属性の無断追加の禁止**: 業務要件として監査証跡や有効期限管理・世代管理が明示的に要求され、プロダクトオーナー(PO)またはアーキテクト(ARC)が認めた場合を除き、技術的属性(`created_at`, `updated_at`, `deleted_at` 等)を含めない。例外として含める場合は、業務上の必要性(法的要件・監査要件等)をフィールドの説明(`description`)に明記する。
|
|
265
215
|
- **スキーマ・実装定義の二重管理・重複記述の禁止**: `schema_ref` や `type_ref` を指定したエンティティにおいて、正本側に既に定義されているデータ型(`type`)や制約条件(`constraints`)を `fields` 内に再掲・重複記述しない。
|
|
266
216
|
- **言語混在・不規則な命名の禁止**: 論理名(`logical_name`)に英数字のみの識別子を記述したり、物理名(`physical_name`)に日本語や `lower_snake_case` 以外の記法(UpperCamelCase、kebab-case、空白混在等)を使用したりしない。
|
|
267
217
|
- **用語集・CCD との不整合の禁止**: 用語集や CCD で定義された用語・ID と異なる名称や略称を使用しない。
|
|
268
|
-
- **曖昧な説明・略語のみの記述の禁止**: 意味が不明瞭な説明や、業務的な文脈を欠いた略語のみの記述をしない。
|
|
@@ -16,28 +16,18 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Business Document Specification (BDS) Authoring Rule
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
業務で使う出力物(報告書、一覧、集計表、ファイル出力など)の利用目的、読み手、出力の時期、表示項目、元にする記録と算出規則を、業務用語で定義する基準を定めます。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
23
23
|
- 1 ファイルは 1 帳票とします。同じ読み手・目的・時期で出力する出力物を 1 帳票にまとめ、読み手や時期が異なれば分けます。
|
|
24
24
|
- 読み手が帳票から下す判断を先に定め、表示項目はその判断に要るものに絞ります。
|
|
25
|
-
-
|
|
25
|
+
- 各表示項目は、元にする記録と算出規則まで追えるようにします。下書きでは出所・確かめ方の未確定を明記できますが、業務の受入確認までに解消します。
|
|
26
26
|
- 出力物自体の本文構成を定める rulebook や、記録・ファイルの schema があれば正本とし、帳票仕様は項目の意味・出所・判断用途を持ちます。
|
|
27
|
-
-
|
|
28
|
-
-
|
|
27
|
+
- 共通事項は上位の索引を正本とし、個別仕様では差分と参照先を示します。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
29
29
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
| 対象者 | 解決する課題 | 確認する内容 |
|
|
33
|
-
| ------------------------------------------- | ---------------------------------------- | -------------------------------------------------------- |
|
|
34
|
-
| 業務分析担当(BA) | 出力物が業務の判断に足りるか分からない | 読み手、利用目的、表示項目、出力の時期が対応している |
|
|
35
|
-
| プロダクトオーナー(PO) | 報告・出力の範囲を承認できない | 対象範囲、対象外、未確定の判断が区別されている |
|
|
36
|
-
| アーキテクト(ARC)・開発者(DEV) | 出力の契機と記録の出所が実装と食い違う | 出力の契機、元にする記録、算出規則と正本の所在 |
|
|
37
|
-
| 品質保証担当(QE) | 出力内容の正しさを判定できない | 各項目を記録から再現する方法、境界条件、例外時の期待結果 |
|
|
38
|
-
| UX / Documentation Designer(UX)・読み手側 | 必要な情報へたどり着けない、用語が揺れる | 項目名と用語、並び順、次に見る文書 |
|
|
39
|
-
|
|
40
|
-
## 2. 位置づけと用語定義
|
|
30
|
+
## 2. 位置づけ
|
|
41
31
|
|
|
42
32
|
帳票仕様は業務仕様の `user-interface-model` に属し、業務プロセスや業務イベントを受けて、出力物の読み手と出力側の境界を定めます。成果物としての位置づけは [[specdojo:deliverables-reference|成果物リファレンス]] を正本とします。
|
|
43
33
|
|
|
@@ -52,20 +42,12 @@ graph TD
|
|
|
52
42
|
BDS -.->|"契機の正本参照"| TRG["出力の契機の仕様<br/>定期実行・手動操作"]
|
|
53
43
|
```
|
|
54
44
|
|
|
55
|
-
| 用語 | この文書での意味 |
|
|
56
|
-
| ------------ | -------------------------------------------------------------------------------------- |
|
|
57
|
-
| 帳票 | 業務で利用する出力物。文書、一覧、集計表、ファイル出力、画面上の出力を含む |
|
|
58
|
-
| 元にする記録 | 帳票の値を得るために読む業務記録。実行記録、状態の変化、前回の帳票などを含む |
|
|
59
|
-
| 対象範囲 | 元にする記録のうち帳票に含める範囲。期間、対象組織・プロジェクト、状態、除外条件で示す |
|
|
60
|
-
| 出力の時期 | 帳票を作る契機と、対象期間の区切り方の組み合わせ |
|
|
61
|
-
| 表示項目 | 帳票に出力される項目。見出し情報、明細、集計値、注記を含む |
|
|
62
|
-
|
|
63
45
|
## 3. ファイル命名・ID規則
|
|
64
46
|
|
|
65
47
|
命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
66
48
|
|
|
67
49
|
- ファイル名は `bds-<帳票名の kebab-case>.md` とします。例: `bds-progress-report.md`。
|
|
68
|
-
- プロダクト文書の ID は `bds-<kebab-case>`、プロジェクト文書は `<project-id>:bds-<kebab-case>`
|
|
50
|
+
- プロダクト文書の ID は `bds-<kebab-case>`、プロジェクト文書は `<project-id>:bds-<kebab-case>` とします。
|
|
69
51
|
- 帳票名は本文先頭の H1 に記述し、「対象 + 観点 + 粒度」で識別できる名前にします。例: 「週次進捗報告」「日次売上サマリ」。
|
|
70
52
|
|
|
71
53
|
## 4. 推奨 Frontmatter 項目
|
|
@@ -73,28 +55,28 @@ graph TD
|
|
|
73
55
|
共通の必須・任意項目と値・型の制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] および `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。BDS 固有の指定は次のとおりです。
|
|
74
56
|
|
|
75
57
|
- `type` は本 rulebook の `deliverable_type` に対応する `ui`、`rulebook` は `specdojo:bds-rulebook` とします。
|
|
76
|
-
- `part_of` は所属する索引、`based_on`
|
|
77
|
-
-
|
|
58
|
+
- `part_of` は所属する索引、`based_on` は根拠とした業務プロセス・業務イベント・設計書を示します。
|
|
59
|
+
- 未作成の索引や接続できない根拠は「メモ / 将来課題」へ記録します。
|
|
78
60
|
|
|
79
61
|
## 5. 本文要件
|
|
80
62
|
|
|
81
|
-
次の順に構成します。
|
|
63
|
+
次の順に構成します。
|
|
82
64
|
|
|
83
65
|
| 章 | 必須・任意 | 目的と内容要件 |
|
|
84
66
|
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------ |
|
|
85
67
|
| 概要 | 必須 | 帳票が何を示し、読み手が何を判断できるかを 1〜3 文で示す |
|
|
86
|
-
| 読み手と利用目的 | 必須 |
|
|
68
|
+
| 読み手と利用目的 | 必須 | 読み手ごとの利用目的と判断、対象外の用途と引き渡し先を示す |
|
|
87
69
|
| 出力の時期と契機 | 必須 | 出力の契機、対象期間の区切り方、取りこぼし・再出力の扱い、時刻の基準を示す |
|
|
88
70
|
| 出力形式と提供方法 | 必須 | 媒体・形式、保存先または配布先、1 回の出力で作る単位、出力物自体の本文構成の正本を示す |
|
|
89
71
|
| 対象範囲と元にする記録 | 必須 | 対象と対象外、元にする記録ごとの用途と正本、記録が欠けるときの扱いを示す |
|
|
90
72
|
| 表示項目 | 必須 | 項目ごとの意味、元にする記録、記録からの確かめ方を表で示す |
|
|
91
73
|
| 集計・算出ルール | 必須 | 期間への割り当て、件数・合計・差分の算出、重複と端数の扱いを示す。算出がない帳票は該当なしと理由を書く |
|
|
92
74
|
| 例外と注意事項 | 必須 | 対象 0 件、記録の欠落、再出力、出力の失敗などで読み手と作成者が取る対応を示す |
|
|
93
|
-
| メモ / 将来課題 | 任意 |
|
|
75
|
+
| メモ / 将来課題 | 任意 | 未作成の参照先、未確認の動作、未決事項の論点と影響・当面の扱いを示す。該当事項があれば省略しない |
|
|
94
76
|
|
|
95
77
|
## 6. 記述ガイド
|
|
96
78
|
|
|
97
|
-
|
|
79
|
+
各章の判断基準と対比例を示します。完成例は frontmatter で宣言した sample を正本とします。
|
|
98
80
|
|
|
99
81
|
### 6.1. 概要
|
|
100
82
|
|
|
@@ -104,7 +86,7 @@ graph TD
|
|
|
104
86
|
|
|
105
87
|
### 6.2. 読み手と利用目的
|
|
106
88
|
|
|
107
|
-
- 判断基準:
|
|
89
|
+
- 判断基準: 読み手ごとに利用目的と判断が対応していること。
|
|
108
90
|
- 対象外の用途(監査、会計、評価など)がある場合は、引き渡し先を示します。
|
|
109
91
|
- 推奨列は「読み手」「利用目的」「帳票から判断すること」です。
|
|
110
92
|
- 良い例: 「PO: 完了と未完了の差から、翌週に優先する成果物を判断する。」
|
|
@@ -121,7 +103,6 @@ graph TD
|
|
|
121
103
|
|
|
122
104
|
- 判断基準: 読み手がどこで何を受け取るか、1 回の出力で何件できるかが分かること。
|
|
123
105
|
- 形式(文書、CSV、印刷、画面など)、保存先または配布先、ファイル単位を示します。CSV など機械可読な形式では、文字コード・見出し行・区切り文字の要否を業務上の前提として示します。
|
|
124
|
-
- 出力物自体の本文構成を定める rulebook があれば正本として参照し、章立てを再掲しません。
|
|
125
106
|
- 良い例: 「Markdown 文書として報告保存先へ 1 期間 1 件で保存する。本文の章立ては進捗報告の rulebook に従う。」
|
|
126
107
|
- 悪い例: 「ファイルで出す。」保存先・単位・構成の正本が分かりません。
|
|
127
108
|
|
|
@@ -135,7 +116,7 @@ graph TD
|
|
|
135
116
|
|
|
136
117
|
### 6.6. 表示項目
|
|
137
118
|
|
|
138
|
-
- 判断基準:
|
|
119
|
+
- 判断基準: 各項目の意味と出所が分かり、記録から値を再現して確かめられること。
|
|
139
120
|
- 推奨列は次のとおりです。区分が不要な帳票では「区分」を省略できます。
|
|
140
121
|
|
|
141
122
|
| 列 | 記述する内容 |
|
|
@@ -154,7 +135,7 @@ graph TD
|
|
|
154
135
|
|
|
155
136
|
- 判断基準: 同じ記録から誰が算出しても同じ値になること。
|
|
156
137
|
- 記録を期間へ割り当てる時刻の基準、集計単位、件数・合計・差分の式、重複の除き方、端数処理を示します。
|
|
157
|
-
-
|
|
138
|
+
- 割合や進捗率を出す場合は分母・分子を定義します。
|
|
158
139
|
- 良い例: 「完了件数 = 期間内に完了へ遷移したタスクの件数。同じタスクが再度完了した場合は 1 件と数える。」
|
|
159
140
|
- 悪い例: 「進捗率を表示する。」分母・分子と判定時点が分かりません。
|
|
160
141
|
|
|
@@ -167,26 +148,24 @@ graph TD
|
|
|
167
148
|
|
|
168
149
|
### 6.9. メモ / 将来課題
|
|
169
150
|
|
|
170
|
-
- 判断基準:
|
|
171
|
-
-
|
|
172
|
-
- 良い例:
|
|
173
|
-
- 悪い例:
|
|
151
|
+
- 判断基準: 確定した仕様と未確定事項を区別でき、影響する項目や境界、当面の扱いが分かること。
|
|
152
|
+
- 推奨列は「項目」「未整備事項と影響」です。
|
|
153
|
+
- 良い例: 「期間の終点が未確定。決まるまでは週末の記録の扱いを受入対象外とする。」
|
|
154
|
+
- 悪い例: 「今後検討する。」論点と影響が分かりません。
|
|
174
155
|
|
|
175
156
|
## 7. 禁止事項
|
|
176
157
|
|
|
177
|
-
| 禁止する記述
|
|
178
|
-
|
|
|
179
|
-
|
|
|
180
|
-
|
|
|
181
|
-
|
|
|
182
|
-
|
|
|
183
|
-
| 根拠のない割合・進捗率、「正しく出る」などの曖昧な表現 | 検証できない |
|
|
184
|
-
| 本文への sample・recipe・template のリンク章や wikilink の設置 | 対応関係は frontmatter で宣言する |
|
|
158
|
+
| 禁止する記述 | 理由 |
|
|
159
|
+
| -------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
160
|
+
| レイアウト・座標・フォントなどの見た目の指定 | 要求の段階で過剰であり、表示項目の判断を妨げる |
|
|
161
|
+
| 元にする記録や確かめ方の未確定を明記せず、表示項目を確定仕様として扱うこと | 値の正しさを判定できないまま受入へ進むため |
|
|
162
|
+
| 出力物の本文構成・記録の構造・契機の設定値の正本の再掲 | 二重管理になり、片方が取り残される |
|
|
163
|
+
| 根拠のない割合・進捗率、「正しく出る」などの曖昧な表現 | 検証できない |
|
|
185
164
|
|
|
186
165
|
## 8. 運用ルール
|
|
187
166
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
167
|
+
業務の受入確認は次の手順で行います。
|
|
168
|
+
|
|
169
|
+
1. 必須章の要件に照らし、読み手の判断に要る項目・出力の時期・提供方法が揃うことを確認します。
|
|
170
|
+
2. 各表示項目を元にする記録と算出規則から再現し、「表示項目」の確かめ方で照合します。すべて一致し、出所・確かめ方に未確定がないことを合格条件とします。
|
|
171
|
+
3. 期間境界、対象 0 件、記録欠落、再出力・失敗のうち該当する場面を照合し、作成可否・表示・対応が「例外と注意事項」と一致することを確認します。未決の境界は「メモ / 将来課題」で受入対象からの除外と影響を明示します。
|
|
@@ -21,66 +21,51 @@ Business Event Specification Index (BES Index) Documentation Rules
|
|
|
21
21
|
- 一つのシステムまたは合意した対象範囲につき、業務イベント一覧の正本を一つにします。範囲は上位の概念データフロー図(全体概要)が定めるプロセス領域とし、一覧の行はその起点イベントから起こします。
|
|
22
22
|
- 網羅は上位のプロセス領域に対して判定します。すべての領域に一つ以上の行が対応し、どの行も一つの領域へたどれる状態を目指します。領域の内部で生じる出来事は、上位文書の起点イベントでない限り一覧に加えません。
|
|
23
23
|
- 一行は一つの業務上の出来事を、発生した事実として過去形で表します。処理手順、画面操作、実装上のメッセージは扱いません。
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
|
|
28
|
-
## 2.
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
| ------------------------------ | ------------------------------------------------------------------------------------------------- |
|
|
32
|
-
| 概念データフロー図(全体概要) | プロセス領域の分割、領域 ID、起点イベントの文言の正本。一覧の網羅を判定する基準になる |
|
|
33
|
-
| 業務イベント一覧(BES Index) | 起点イベントを行として並べ、イベント ID・発生条件・事実データの概要と個別仕様への入口を持つ |
|
|
34
|
-
| 業務イベント仕様(BES) | 一覧の行、または行の一部の成立の仕方について、発生境界を詳細化する個別仕様 |
|
|
35
|
-
| 業務プロセス仕様(BPS) | イベントを受けた後の手順を定める。イベントとプロセスの起動関係は BPS 側で記述する |
|
|
36
|
-
| 業務ルール・状態定義 | 判定の規則と状態の意味・遷移の正本。一覧には発生に必要な条件の要旨だけを置く |
|
|
37
|
-
| 起点イベント | プロセス領域を起動する業務上の出来事。一覧の行の出典 |
|
|
38
|
-
| 事実データ | 出来事の発生時点で観測できる業務上の情報。項目の構造・値・構文はデータモデル・schema を正本とする |
|
|
39
|
-
|
|
40
|
-
- **主要な関係者(Role code)と確認観点**:
|
|
41
|
-
- **BA(主作成者)**: 起点イベントの網羅、行の粒度、事実データの業務上の意味を定義する。
|
|
42
|
-
- **PO(承認者)**: 一覧の範囲と、未決事項を制限事項として受け入れるかを判断する。
|
|
43
|
-
- **ARC(確認者)**: 上位文書・個別 BES・データモデルとの構造整合と、イベント処理設計の入力としての単位を確認する。
|
|
44
|
-
- **QE(確認者)**: 発生条件から発生する場合・しない場合を判定でき、テスト設計で網羅を確かめられるかを確認する。
|
|
45
|
-
- **主な利用者(Role code)**: BA は BPS・BR、UX は UI 仕様、QE はテスト仕様の作成時にイベント ID と発生条件を参照します。ARC・DEV は個別 BES とデータモデルを併せてイベント処理設計へ接続します。
|
|
24
|
+
- 一行で発生境界・時点・起点・発生条件・事実データ・相関のいずれかを判定できない出来事を個別 BES へ詳細化します。個別仕様の書き方は [[specdojo:bes-rulebook|業務イベント仕様 作成ルール]] を正本とします。
|
|
25
|
+
- 上位文書から確認できた内容と、推定・未決の内容を分けます。
|
|
26
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱います。
|
|
27
|
+
|
|
28
|
+
## 2. 位置づけ
|
|
29
|
+
|
|
30
|
+
一覧は、BPS・UI・イベント処理・テスト設計が同じ出来事を参照する入口です。イベントとプロセスの起動関係・処理手順は BPS、判定規則は BR、状態の意味・遷移は状態定義、事実データの構造・値・構文はデータモデル・schema に委ねます。
|
|
46
31
|
|
|
47
32
|
## 3. ファイル命名・ID規則
|
|
48
33
|
|
|
49
34
|
- ファイル名は `bes-index.md`、文書 ID は `bes-index` を基本とし、プロジェクト配下ではそのプロジェクトの authority を付けます。命名・配置の共通規則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正本とします。
|
|
50
35
|
- 一覧のイベント ID は `bes-<event>` とし、`<event>` は出来事を区別できる英小文字・数字・ハイフンのスラッグにします(例: `bes-cash-sale-confirmed`)。`^bes-[a-z0-9][a-z0-9-]*$` に適合し、廃止行を含め一覧の中で一意にします。
|
|
51
36
|
- 個別 BES が行の全体を詳細化する場合は、個別 BES の文書 ID を行のイベント ID と一致させます。行の一部の成立の仕方だけを詳細化する場合は、個別 BES に別の ID を付け、「個別仕様への詳細化」の表で対応を示します。sample の文書 ID はメタ情報標準に従って実物と区別し、イベント ID との対応を詳細化表で示します。
|
|
52
|
-
-
|
|
37
|
+
- 詳細化表から個別 BES へリンクし、個別 BES からも一覧と対応行のイベント ID を識別できるようにします。
|
|
53
38
|
|
|
54
39
|
### 3.1. 追加・変更・廃止の管理
|
|
55
40
|
|
|
56
|
-
-
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
-
|
|
41
|
+
- 追加する行は上位文書の起点イベントと既存行に照合します。列や ID の変更の影響先は、個別 BES・BPS・BR・UI・データモデル・イベント契約・実装・テスト仕様・受入条件です。有効な参照元は後継または代替へ更新します。
|
|
42
|
+
- イベント自体の廃止・置換では行を残し、イベント名に「(廃止)」を付け、発生条件に理由・時期・後継 ID(なければ代替運用)を記載します。廃止行は現行領域の網羅件数に含めず、イベント ID は再利用しません。行の存廃は本書を正とし、BES 作成ルールの行削除の選択肢は本一覧では採りません。
|
|
43
|
+
- 個別 BES だけを廃止しても、出来事が存続するなら一覧の行は有効なまま保持します。詳細化表は後継仕様へ付け替えるか、一覧だけで判定できるなら詳細化の対応を外します。後継がなく詳細化がなお必要なら未決事項に残します。
|
|
44
|
+
- 文書でない行 ID は Frontmatter の `supersedes` に入れず、旧行と新行の対応を本文で示します。
|
|
60
45
|
|
|
61
46
|
## 4. 推奨 Frontmatter 項目
|
|
62
47
|
|
|
63
|
-
項目の構文と許容値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml
|
|
48
|
+
項目の構文と許容値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
64
49
|
|
|
65
|
-
| 項目 | 必須 | 値・記述内容
|
|
66
|
-
| ------------ | -------- |
|
|
67
|
-
| `id` | ○ | `bes-index` 系の ID
|
|
68
|
-
| `type` | ○ | `requirement`
|
|
69
|
-
| `status` | ○ |
|
|
70
|
-
| `rulebook` |
|
|
71
|
-
| `based_on` | 推奨 | 起点イベントの出典とした概念データフロー図(全体概要)の ID
|
|
72
|
-
| `supersedes` | 条件付き | 既存の業務イベント一覧を置き換える場合の旧文書 ID 配列
|
|
50
|
+
| 項目 | 必須 | 値・記述内容 |
|
|
51
|
+
| ------------ | -------- | ----------------------------------------------------------- |
|
|
52
|
+
| `id` | ○ | `bes-index` 系の ID |
|
|
53
|
+
| `type` | ○ | `requirement` |
|
|
54
|
+
| `status` | ○ | 共通の運用に従う |
|
|
55
|
+
| `rulebook` | ○ | `specdojo:bes-index-rulebook` |
|
|
56
|
+
| `based_on` | 推奨 | 起点イベントの出典とした概念データフロー図(全体概要)の ID |
|
|
57
|
+
| `supersedes` | 条件付き | 既存の業務イベント一覧を置き換える場合の旧文書 ID 配列 |
|
|
73
58
|
|
|
74
59
|
## 5. 本文要件
|
|
75
60
|
|
|
76
|
-
template は置かないため、以下を本文構成の基準とします。
|
|
61
|
+
template は置かないため、以下を本文構成の基準とします。
|
|
77
62
|
|
|
78
|
-
| 記述対象 | 必須・任意 | 判定基準
|
|
79
|
-
| ------------------ | ----------------------------------- |
|
|
80
|
-
| 冒頭の概要 | 必須 | 対象範囲、起点イベントの出典、一覧の利用者と委譲先(BES・BPS・BR・状態定義)が分かる
|
|
81
|
-
| 業務イベント一覧 | 必須 | 上位文書のすべての起点イベントが行に対応し、各行が下表の列を満たす
|
|
82
|
-
| 個別仕様への詳細化 | 個別 BES がある、または予定する場合 | 詳細化する行、個別仕様、詳細化する範囲、理由を対応させる
|
|
83
|
-
| 未決事項と承認条件 | 未決・推定の内容がある場合 |
|
|
63
|
+
| 記述対象 | 必須・任意 | 判定基準 |
|
|
64
|
+
| ------------------ | ----------------------------------- | ------------------------------------------------------------------------------------ |
|
|
65
|
+
| 冒頭の概要 | 必須 | 対象範囲、起点イベントの出典、一覧の利用者と委譲先(BES・BPS・BR・状態定義)が分かる |
|
|
66
|
+
| 業務イベント一覧 | 必須 | 上位文書のすべての起点イベントが行に対応し、各行が下表の列を満たす |
|
|
67
|
+
| 個別仕様への詳細化 | 個別 BES がある、または予定する場合 | 詳細化する行、個別仕様、詳細化する範囲、理由を対応させる |
|
|
68
|
+
| 未決事項と承認条件 | 未決・推定の内容がある場合 | 論点、現時点の扱い、利用への影響、確定入力として扱える範囲と条件を示す |
|
|
84
69
|
|
|
85
70
|
「個別仕様への詳細化」「未決事項と承認条件」は該当する内容がなければ省略できます。目的・適用範囲は冒頭の概要にまとめ、独立章の追加は任意とします。処理手順・構文・データ構造の詳細を記す章は不要であり、それぞれの正本を参照します。
|
|
86
71
|
|
|
@@ -99,16 +84,14 @@ template は置かないため、以下を本文構成の基準とします。Ma
|
|
|
99
84
|
| 発生条件 | ○ | 成立に必要な条件の要旨。成立の仕方が複数あれば区別する |
|
|
100
85
|
| 事実データ | ○ | 発生時点で観測できる情報の業務上の概念名 |
|
|
101
86
|
|
|
102
|
-
列の追加・削除・意味の変更時は、ARC が rulebook の本文要件と sample の対応を確認し、BA が一覧・個別 BES・BPS・BR、UX が UI、QE がテスト仕様の利用箇所を照合して、影響する記述を同じ変更の採用時に更新します。契約・schema への影響は DEV と確認し、値・構文・構造をこの一覧へ複製しません。
|
|
103
|
-
|
|
104
87
|
### 5.2. 個別仕様への詳細化の列
|
|
105
88
|
|
|
106
|
-
| 列名 | 必須 | 記述内容
|
|
107
|
-
| -------------- | ---- |
|
|
108
|
-
| イベントID | ○ | 詳細化する一覧の行
|
|
109
|
-
| 個別仕様 | ○ | 個別 BES へのリンク。未作成なら文書 ID を仮置きして明示する
|
|
110
|
-
| 詳細化する範囲 | ○ | 行の全体か、行の一部の成立の仕方か
|
|
111
|
-
| 詳細化の理由 | ○ |
|
|
89
|
+
| 列名 | 必須 | 記述内容 |
|
|
90
|
+
| -------------- | ---- | ------------------------------------------------------------------------------ |
|
|
91
|
+
| イベントID | ○ | 詳細化する一覧の行 |
|
|
92
|
+
| 個別仕様 | ○ | 個別 BES へのリンク。未作成なら文書 ID を仮置きして明示する |
|
|
93
|
+
| 詳細化する範囲 | ○ | 行の全体か、行の一部の成立の仕方か |
|
|
94
|
+
| 詳細化の理由 | ○ | 一行では判定できない発生境界・時点・起点・発生条件・事実データ・相関を特定する |
|
|
112
95
|
|
|
113
96
|
## 6. 記述ガイド
|
|
114
97
|
|
|
@@ -158,22 +141,21 @@ template は置かないため、以下を本文構成の基準とします。Ma
|
|
|
158
141
|
|
|
159
142
|
### 6.8. 個別仕様への詳細化
|
|
160
143
|
|
|
161
|
-
- 判断基準:
|
|
144
|
+
- 判断基準: 詳細化の要否は「全体方針」に従い、判定できない点を理由に書きます。行の一部だけを詳細化する場合は範囲を示し、残りは一覧の定義を適用します。
|
|
162
145
|
- 良い例: 「つけ販売の受付は、上限超過時に受付と承認のどちらで成立するかが割れるため個別仕様へ詳細化する。」
|
|
163
146
|
- 悪い例: 「重要なので個別仕様を作る。」何が一行で判定できないのか分かりません。
|
|
164
147
|
|
|
165
148
|
### 6.9. 未決事項と承認条件
|
|
166
149
|
|
|
167
|
-
- 判断基準:
|
|
168
|
-
- 良い例:
|
|
169
|
-
- 悪い例:
|
|
150
|
+
- 判断基準: 推定で埋めた列、上位文書から判断できない境界、正本との未照合について、論点と利用への影響(当面の扱い、決まったときに直す行)を示します。
|
|
151
|
+
- 良い例: 「事実データは販売記録のデータモデルと未照合。照合までは事実データ列を設計の確定入力にせず、差異があれば該当行を直す。」
|
|
152
|
+
- 悪い例: 「詳細は今後検討する。」未確定の列と利用への影響が分かりません。
|
|
170
153
|
|
|
171
154
|
### 6.10. 検証と引き渡し
|
|
172
155
|
|
|
173
|
-
- 判断基準:
|
|
174
|
-
-
|
|
175
|
-
-
|
|
176
|
-
- 悪い例: 「lint が通ったので網羅・承認済み。」静的検査では業務範囲や承認を判定できません。
|
|
156
|
+
- 判断基準: 上位の全領域・起点イベントと有効行を突き合わせ、出典のない行・欠落・必須列の空欄が 0 件であることを確認します。ID を一覧から抽出し、「ファイル命名・ID規則」の形式違反と廃止行を含む重複が 0 件であること、各行から発生・不成立を判定できること、個別 BES の対応範囲と相互参照が一致することを確かめます。未決の影響範囲を除いて利用できるかを判断し、照合結果を残します。
|
|
157
|
+
- 良い例: 「14 領域に有効な 16 行が対応し、出典なし・欠落・空欄・ID の形式違反・重複は 0 件。全行で発生・不成立を判定でき、詳細化の対応も一致する。事実データ列は未照合のため確定入力にしない。」
|
|
158
|
+
- 悪い例: 「表を埋めたので網羅済み。」出典との対応や発生有無を確かめていません。
|
|
177
159
|
|
|
178
160
|
## 7. 禁止事項
|
|
179
161
|
|
|
@@ -186,6 +168,4 @@ template は置かないため、以下を本文構成の基準とします。Ma
|
|
|
186
168
|
| 発生条件・事実データを「その他」「適宜」「など」で省略し、成立条件や対象項目を特定できなくする | 発生有無と必要な情報の充足を判定できないため |
|
|
187
169
|
| 物理テーブル・カラム、SQL、実装クラス・関数、API、コマンドの構文を記載する | 概念上の出来事と実装契約を混同するため |
|
|
188
170
|
| 発生後にしか分からない結果を事実データにする | 観測時点と事実が矛盾するため |
|
|
189
|
-
| 未作成の個別仕様を存在するようにリンクする | 参照切れと、詳細化済みとの誤認を招くため |
|
|
190
171
|
| 廃止したイベント ID を別の出来事に再利用する | 参照元の BPS・テストが別の出来事を指してしまうため |
|
|
191
|
-
| 推定や未決の内容を確定済みとして表し、範囲の承認前に確定入力とする | 下流が不確かな前提で設計・検証を始めるため |
|