specdojo 0.7.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 +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- 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 +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- 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 +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- 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/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- 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 +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -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 +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- 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 +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- 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 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- 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 +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- 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 +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- 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 +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- 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 +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -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 +171 -0
- 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 +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- 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 +12 -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 +92 -102
- 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 +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- 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 +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- 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 +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- 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 +91 -161
- 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/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +125 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- 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-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +141 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -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/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- 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 +8 -4
|
@@ -3,7 +3,7 @@ specdojo:
|
|
|
3
3
|
id: specdojo:bdd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
|
-
status:
|
|
6
|
+
status: ready
|
|
7
7
|
target_format: yaml
|
|
8
8
|
recipe: not-needed
|
|
9
9
|
sample: specdojo:bdd-sample
|
|
@@ -14,122 +14,204 @@ specdojo:
|
|
|
14
14
|
|
|
15
15
|
Business Data Dictionary (BDD) Documentation Rules
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
業務上の管理単位(エンティティ)とその属性(項目)の論理名・物理名・説明・制約などを定義します。
|
|
19
|
-
データの意味や構造に関する共通理解を関係者間で図り、システム設計や実装の基礎情報として活用します。
|
|
17
|
+
業務データ辞書(BDD)で、業務上の管理単位と項目の意味を記述するための基準を定めます。
|
|
20
18
|
|
|
21
19
|
## 1. 全体方針
|
|
22
20
|
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
21
|
+
- **適用範囲**: 業務分析・要求定義・設計で利用する `bdd-*.yaml` を対象とする。
|
|
22
|
+
- **実装重複の排除**: 実装詳細を再掲するのではなく、schema や実装(TypeScript 型)が存在するエンティティはそれらを正本として参照し、業務データ辞書にはスキーマから読み取れない業務上の意味(項目の業務的定義、enum 値が表す業務状態など)に特化して記述する。
|
|
23
|
+
- **完成条件**: 「本文要件」を満たし、「成果物の検証手順」の機械検証と手動照合をともに完了する。コマンドの成功だけで業務上の正しさを判定しない。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
25
|
+
- **変更時の影響範囲**: BDD の検証スキーマ、成果物カタログ、参照するスキーマ・型定義、用語集、CCD、状態・業務ルールの正本を確認する。正本の変更と業務注釈の整合を別々に確認する。
|
|
26
26
|
|
|
27
|
-
## 2.
|
|
27
|
+
## 2. 位置づけ
|
|
28
28
|
|
|
29
|
-
- 本ルールは `type: data`
|
|
30
|
-
- `
|
|
31
|
-
-
|
|
29
|
+
- **成果物の種別**: 本ルールは `type: data` の成果物に適用する(成果物メタデータとしての `type` は `data` 固定であり、各フィールドのデータ型を表す `type` と区別する)。
|
|
30
|
+
- **機械検証正本との依存関係**: YAML の構造・型・正規表現の正本は `docs/specdojo/schemas/v1/bdd.schema.yaml` とする。本書は各キーの用途と業務上の判断を扱い、構文の詳細はスキーマを参照する。
|
|
31
|
+
- **隣接仕様との分担**: 用語は用語集、管理単位の関係は CCD、状態遷移・業務ルールはそれぞれの正本を参照する。配置・命名は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従う。
|
|
32
32
|
|
|
33
33
|
## 3. ファイル命名・ID規則
|
|
34
34
|
|
|
35
35
|
### 3.1. ID規約
|
|
36
36
|
|
|
37
|
-
- `id`
|
|
38
|
-
-
|
|
39
|
-
-
|
|
37
|
+
- `id` は `bdd.schema.yaml` の制約に合致する一意 ID を用いる。
|
|
38
|
+
- プロジェクト成果物: `<project-id>:bdd-<name>`(例: `prj-0001:bdd-project-config`)
|
|
39
|
+
- SpecDojo 同梱成果物: `specdojo:bdd-<name>`(例: `specdojo:bdd-sample`)
|
|
40
|
+
- 単体 ID: `bdd-<name>`
|
|
41
|
+
- 成果物メタデータの `type` は `data` 固定とする。
|
|
40
42
|
|
|
41
43
|
### 3.2. ファイル命名規約
|
|
42
44
|
|
|
43
|
-
-
|
|
44
|
-
|
|
45
|
-
-
|
|
45
|
+
- **配置ディレクトリ**: プロジェクト内の業務データ辞書は、成果物カタログの `base_path`(通常は `docs/ja/product/010-business-specs/020-data-model/`)直下に配置する。
|
|
46
|
+
- **ファイル形式**: YAML 形式(`.yaml`)で管理する。
|
|
47
|
+
- **ファイル名**: `bdd-<term>.yaml`(英小文字 kebab-case)とする(例: `bdd-project-config.yaml`, `bdd-payment.yaml`)。
|
|
46
48
|
|
|
47
49
|
## 4. 推奨 Frontmatter 項目
|
|
48
50
|
|
|
49
|
-
|
|
51
|
+
独立 YAML のため、メタデータをルートに置き、Markdown 用の `specdojo:` ラッパーや `---` で囲まない。共通の意味はドキュメントメタ情報標準、許可キーと型の詳細は `bdd.schema.yaml` に従う。
|
|
52
|
+
|
|
53
|
+
| 項目 | 説明 | 必須 |
|
|
54
|
+
| ------------ | ---------------------------------------- | ---- |
|
|
55
|
+
| `id` | データ辞書ID(`bdd-...`) | ○ |
|
|
56
|
+
| `type` | 成果物種別(`data` 固定) | ○ |
|
|
57
|
+
| `title` | 対象業務・管理単位が分かる表示名 | ○ |
|
|
58
|
+
| `status` | 状態(`draft` / `ready` / `deprecated`) | ○ |
|
|
59
|
+
| `rulebook` | 準拠ルール(`specdojo:bdd-rulebook`) | ○ |
|
|
60
|
+
| `supersedes` | 置き換え関係(旧IDの配列) | 任意 |
|
|
61
|
+
|
|
62
|
+
## 5. 本文要件
|
|
63
|
+
|
|
64
|
+
- ファイル先頭のコメントとして `# yaml-language-server: $schema=<相対パス>` を必須とする。パスは出力 YAML ファイルのディレクトリを基準に解決し、BDD 検証用の `docs/specdojo/schemas/v1/bdd.schema.yaml` を指すこと。`schema_ref` が指す業務エンティティのスキーマとは用途が異なる。
|
|
65
|
+
- 例えば `docs/ja/product/010-business-specs/020-data-model/bdd-payment.yaml` では、`# yaml-language-server: $schema=../../../../specdojo/schemas/v1/bdd.schema.yaml` とする。別の配置へこの相対パスをそのまま転記しない。
|
|
66
|
+
- ルートの必須キー `entities` に一つ以上のエンティティを置く。エンティティの管理境界と、注釈を付けるフィールドの選定理由が説明から判断できること。
|
|
67
|
+
|
|
68
|
+
### 5.1. entities の構成
|
|
69
|
+
|
|
70
|
+
各エンティティには以下のサブ項目を定義する。
|
|
71
|
+
|
|
72
|
+
| サブ項目 | 説明 | 必須 |
|
|
73
|
+
| ------------------ | ---------------------------------------------------------------------- | -------- |
|
|
74
|
+
| `logical_name` | 業務上の論理名(日本語単数形) | ○ |
|
|
75
|
+
| `physical_name` | DB互換の物理名(`lower_snake_case`) | ○ |
|
|
76
|
+
| `description` | 業務データエンティティの説明・役割 | 任意 |
|
|
77
|
+
| `schema_ref` | 正本スキーマへの参照パス(JSON Schema / YAML Schema 等) | 任意 |
|
|
78
|
+
| `type_ref` | 正本型定義への参照パス(TypeScript 等、例: `src/types/xxx.ts#Type`) | 任意 |
|
|
79
|
+
| `glossary_term_id` | 用語集の用語ID(`tm-...`) | 任意 |
|
|
80
|
+
| `related_terms` | 関連用語IDのリスト | 任意 |
|
|
81
|
+
| `key_fields` | キー項目(`physical_name` のリスト) | ○ |
|
|
82
|
+
| `fields` | 業務データフィールドの一覧(スタンドアロン定義では必須、参照時は任意) | 条件付き |
|
|
83
|
+
|
|
84
|
+
※ `schema_ref` と `type_ref` は同時に指定できない。どちらも指定しない場合(スタンドアロン定義)は `fields` の定義が必須となる。
|
|
85
|
+
|
|
86
|
+
### 5.2. fields の構成
|
|
87
|
+
|
|
88
|
+
各フィールドには以下のサブ項目を定義する。
|
|
89
|
+
|
|
90
|
+
| サブ項目 | 説明 | 必須 |
|
|
91
|
+
| ------------------------- | ------------------------------------------------------------------------------------------------------------- | -------- |
|
|
92
|
+
| `logical_name` | 業務上の論理名(日本語単数形) | ○ |
|
|
93
|
+
| `physical_name` | DB互換の物理名(`lower_snake_case`) | ○ |
|
|
94
|
+
| `glossary_term_id` | 用語集の用語ID(`tm-...`) | 任意 |
|
|
95
|
+
| `type` | データ型(`integer` / `string` / `boolean` / `date` / `datetime` / `enum` / `money`。スタンドアロン時は必須) | 条件付き |
|
|
96
|
+
| `description` | フィールドの業務的説明・役割 | 任意 |
|
|
97
|
+
| `unit` | 単位(該当時、例: 円、個、kg) | 任意 |
|
|
98
|
+
| `constraints` | フィールドの制約条件(スタンドアロン定義時) | 任意 |
|
|
99
|
+
| `example` | フィールドの例値 | 任意 |
|
|
100
|
+
| `allowed_values` | 許容値リスト(簡易列挙。`type: enum` または状態定義時) | 条件付き |
|
|
101
|
+
| `allowed_values_detailed` | 許容値と業務ラベルのリスト(詳細列挙。`type: enum` または状態定義時) | 条件付き |
|
|
102
|
+
|
|
103
|
+
※ `type: enum` を指定する場合、またはスキーマ・型参照エンティティで業務状態の許容値を定義する場合、`allowed_values` または `allowed_values_detailed` のいずれか一方を必須とする。
|
|
104
|
+
※ `schema_ref` または `type_ref` を指定したエンティティでは、`type` や `constraints` は参照先で定義されているため省略し、業務上の意味(`description` や `allowed_values_detailed`)のみを記述する。
|
|
105
|
+
|
|
106
|
+
### 5.3. constraints の構成
|
|
107
|
+
|
|
108
|
+
スタンドアロン定義で制約条件を明記する場合、以下のサブ項目を用いる。
|
|
109
|
+
|
|
110
|
+
| サブ項目 | 説明 | 必須 |
|
|
111
|
+
| ---------- | -------------------------------- | ---- |
|
|
112
|
+
| `required` | 必須入力かどうか(true / false) | 任意 |
|
|
113
|
+
| `unique` | 一意性制約(true / false) | 任意 |
|
|
114
|
+
| `min` | 最小値 | 任意 |
|
|
115
|
+
| `max` | 最大値 | 任意 |
|
|
116
|
+
| `pattern` | 正規表現パターン | 任意 |
|
|
117
|
+
|
|
118
|
+
## 6. 記述ガイド
|
|
50
119
|
|
|
51
|
-
|
|
52
|
-
| ---------- | ---------------------------------------- | ---- |
|
|
53
|
-
| id | データ辞書ID(`bdd-...`) | ○ |
|
|
54
|
-
| type | `data` 固定 | ○ |
|
|
55
|
-
| title | ドキュメント名。表示ページの見出しになる | ○ |
|
|
56
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
57
|
-
| rulebook | `specdojo:bdd-rulebook` 固定 | ○ |
|
|
58
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
120
|
+
### 6.1. 記述の基本方針
|
|
59
121
|
|
|
60
|
-
|
|
122
|
+
メタ情報・エンティティ・フィールドは、次の基準で書き分ける。
|
|
61
123
|
|
|
62
|
-
|
|
|
63
|
-
|
|
|
124
|
+
| 対象 | 判断の基準 | 良い例 | 悪い例 |
|
|
125
|
+
| -------------------------- | ------------------------------------------ | -------------------------------------------------------------- | -------------------------------------------------- |
|
|
126
|
+
| メタ情報 | ID と表示名から対象を識別できる | `bdd-register-entry`、業務データ辞書(登録項目個票) | タイトルが「データ定義」のみで対象が不明 |
|
|
127
|
+
| エンティティの説明 | 管理単位・範囲・他の正本との境界が分かる | 「登録簿で個別に追跡する作業・課題。状態遷移は状態定義を参照」 | 「登録項目の情報」のみ、または状態遷移表を複写 |
|
|
128
|
+
| フィールドの説明 | 業務判断に使う意味と区別すべき概念が分かる | 「文書成熟度。対応の進捗を表す処理状態とは別の判断軸」 | 「状態」や「文字列」のみ |
|
|
129
|
+
| スタンドアロンの単位・制約 | 業務上の根拠を持つ条件だけを定義する | 数量の単位を「個」とし、受注可能数の下限を業務ルールから定める | 根拠のない上限を設定する、参照元の制約を重ねて書く |
|
|
64
130
|
|
|
65
|
-
|
|
131
|
+
### 6.2. スキーマ・実装参照と選定基準
|
|
66
132
|
|
|
67
|
-
|
|
133
|
+
エンティティの定義形態は、対象データの仕様管理状況に応じて次の3通りから選定する。
|
|
68
134
|
|
|
69
|
-
|
|
70
|
-
| ------------- | ---------------------------------- | ---- |
|
|
71
|
-
| logical_name | 業務上の論理名(日本語単数形) | ○ |
|
|
72
|
-
| physical_name | DB互換の物理名(lower_snake_case) | ○ |
|
|
135
|
+
#### 6.2.1. schema があるエンティティ(スキーマ参照: `schema_ref`)
|
|
73
136
|
|
|
74
|
-
|
|
137
|
+
- **選定基準**: 対象エンティティの JSON Schema / YAML Schema / OpenAPI 仕様が既に存在し、物理構造・制約の正本として管理されている場合に選択する。
|
|
138
|
+
- **記述規則**:
|
|
139
|
+
- `schema_ref` に正本スキーマのファイルパス(例: `schemas/payment.schema.yaml`)またはポインタ(例: `schemas/order.schema.yaml#/$defs/Payment`)を明記する。
|
|
140
|
+
- `fields` には、スキーマから読み取れない業務上の意味(項目の業務的定義、enum の値が表す業務上の状態遷移や業務ルール上の分岐など)だけを書く。
|
|
141
|
+
- データ型(`type`)、必須(`required`)、最小/最大(`min` / `max`)、パターン(`pattern`)など、スキーマに定義済みの制約は絶対に繰り返さない。
|
|
142
|
+
- **良い例**: `schema_ref` で支払いの正本を示し、状態項目の注釈で「入金確認が済み、出荷判断に使える状態」と説明する。
|
|
143
|
+
- **悪い例**: 正本に定義済みの `type: string` や `constraints.required: true` を転記し、説明を「文字列」にとどめる。
|
|
75
144
|
|
|
76
|
-
|
|
77
|
-
| related_terms | 関連用語IDリスト | 任意 |
|
|
78
|
-
| key_fields | キー項目(`physical_name` のリスト) | ○ |
|
|
145
|
+
#### 6.2.2. schema のないエンティティの選定基準(スタンドアロン定義 vs TypeScript 型参照)
|
|
79
146
|
|
|
80
|
-
|
|
147
|
+
スキーマが存在しないエンティティは、開発フェーズや正本の所在に応じて次のいずれかを選択する。
|
|
81
148
|
|
|
82
|
-
|
|
149
|
+
| 方式 | 選定基準 | 記述規則 |
|
|
150
|
+
| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
151
|
+
| **スタンドアロン定義** | 実装(コードやDB)が未着手の企画・要求分析初期フェーズ、または特定の実装言語に依存しない純粋なドメイン概念モデルを独立して定義したい場合に選択する | `fields` に `type`、`constraints`、`example` などの物理・論理仕様を直接定義する。 |
|
|
152
|
+
| **TypeScript 型参照(`type_ref`)** | すでに TypeScript で `interface` や `type` が正本として実装・運用されており、JSON Schema がない内部モデルや設定値の業務仕様を整理する場合に選択する | `type_ref` に型定義パス(例: `src/types/xxx.ts#Type`)を明記し、`fields` にはコードから読めない業務的意味のみを記述する。 |
|
|
83
153
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
| logical_name | 業務上の論理名(日本語単数形) | ○ |
|
|
87
|
-
| physical_name | DB互換の物理名(lower_snake_case) | ○ |
|
|
154
|
+
- **良い例**: 実装前の商品数量をスタンドアロンで `type: integer`、`unit: 個` と定義する。型が正本になった内部取引は `type_ref` を示し、業務上の区分だけを注釈する。
|
|
155
|
+
- **悪い例**: 実在する正本を調べずにスタンドアロンで同じ型を定義する、または型のない項目へ推測で `type_ref` を付ける。
|
|
88
156
|
|
|
89
|
-
|
|
90
|
-
| type | データ型(integer / string / boolean / date / datetime / enum / money) | ○ |
|
|
91
|
-
| description | フィールドの説明 | 任意 |
|
|
92
|
-
| unit | 単位(該当時) | 任意 |
|
|
93
|
-
| constraints | フィールドの制約条件 | 任意 |
|
|
94
|
-
| example | フィールドの例値 | 任意 |
|
|
157
|
+
### 6.3. 命名と参照の指針
|
|
95
158
|
|
|
96
|
-
|
|
159
|
+
- 論理名は日本語単数形とする(例: `商品`, `支払い`)。
|
|
160
|
+
- 物理名(`physical_name`)は entity / field とも `lower_snake_case` を用いる(例: `product_code`, `credit_balance`, `payment_status`)。
|
|
161
|
+
- 参照先の lowerCamelCase 名と対応させる場合は相互変換を確認する。参照先の定義がネストされている場合は、対象位置をポインタまたは説明で特定し、同名の別項目と区別する。
|
|
162
|
+
- `key_fields` は `physical_name` を指定する。
|
|
163
|
+
- `glossary_term_id` は用語集で定義された ID(`tm-...`)と厳密に一致させる。
|
|
164
|
+
- `schema_ref` / `type_ref` はリポジトリルートから辿れるパスと対象定義を示す。キー一覧は参照先で確認し、`fields` は業務注釈が必要な項目に絞ってよい。
|
|
165
|
+
- **良い例**: `key_fields: [product_code]` が実際の識別項目に対応し、`glossary_term_id: tm-product-code` が対象用語集に存在する。
|
|
166
|
+
- **悪い例**: `key_fields` に論理名を指定する、表示用の導出値を保存キーとして扱う、用語 ID の存在を名前から推測する。
|
|
97
167
|
|
|
98
|
-
|
|
99
|
-
| -------- | -------------------------------- | ---- |
|
|
100
|
-
| required | 必須入力かどうか(true / false) | 任意 |
|
|
101
|
-
| unique | 一意性制約(true / false) | 任意 |
|
|
102
|
-
| min | 最小値 | 任意 |
|
|
103
|
-
| max | 最大値 | 任意 |
|
|
104
|
-
| pattern | 正規表現パターン | 任意 |
|
|
168
|
+
参照元の改訂時は、移動・フィールド・キー・enum の差分を抽出し、参照パス、物理名、キー、許容値と業務注釈を照合する。用語集・CCD の変更時は論理名・用語参照を同期する。未解決の対応は論点と影響を残し、「成果物の検証手順」を満たすまで受け入れない。
|
|
105
169
|
|
|
106
|
-
|
|
170
|
+
- **スタンドアロンのフィールド廃止**: 直接削除せず、`description` に非推奨理由・代替フィールドを示し、移行期間を設ける。
|
|
171
|
+
- **参照元で削除済みのフィールド**: `fields` から外し、エンティティの `description` または注釈ノートへ非推奨理由・代替・削除時期・旧注釈を退避する。移行中に維持する必要があれば `schema_ref` / `type_ref` を削除前の互換バージョン(タグ・コミット・安定版パス)に固定し、移行終了時に最新版へ切り替えて退避する。
|
|
107
172
|
|
|
108
|
-
### 6.
|
|
173
|
+
### 6.4. enum および業務ステータスの記述方法
|
|
174
|
+
|
|
175
|
+
- enum フィールドや状態遷移を持つ項目では、許容値を必ず明示する。
|
|
176
|
+
- 記述方式は用途に応じて選択する:
|
|
177
|
+
- **簡易列挙(`allowed_values`)**: 値の名称自体で意味が自明な場合(例: `allowed_values: [PENDING, PAID, CANCELED]`)。
|
|
178
|
+
- **詳細列挙(`allowed_values_detailed`)**: 各値が表す業務上の状態や画面表示名を明示する場合(`value` と `label` を指定)。スキーマ参照エンティティで状態の業務的意味を定義する際は、原則として詳細列挙を用いる。
|
|
179
|
+
- **判断基準**: 値の詳細な構文や遷移条件は正本へ譲り、辞書では値と業務上の意味の対応を確認できる粒度にする。参照元の enum 値と過不足なく対応させ、ラベルだけを値として置き換えない。
|
|
180
|
+
- **良い例**: `value: PAID` に `label: 入金確認済み` を対応させる。状態遷移や承認条件は、その正本を説明から参照する。
|
|
181
|
+
- **悪い例**: 同じフィールドに `allowed_values` と `allowed_values_detailed` を併記する、参照元にない値を追加する、状態遷移の仕様を辞書へ複写する。
|
|
182
|
+
|
|
183
|
+
### 6.5. 成果物の検証手順
|
|
184
|
+
|
|
185
|
+
作成・改訂した業務データ辞書 YAML は、BDD 構造の機械検証と業務要件の手動照合で判定する。対象ファイル・参照した正本・各検証結果を記録する。
|
|
186
|
+
|
|
187
|
+
#### 6.5.1. 個別の構造検証
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
npm run validate:schema:file -- --schema docs/specdojo/schemas/v1/bdd.schema.yaml --data <対象YAMLファイルパス>
|
|
191
|
+
```
|
|
109
192
|
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
- エンティティ・項目の論理名と説明は、概念クラス図(CCD)と用語集(glossary)に整合させる。
|
|
193
|
+
- **合格条件**: 対象ファイルが `valid` と表示され、終了コード 0 となること。
|
|
194
|
+
- **検証の限界**: `bdd.schema.yaml` はスタンドアロンの各フィールドの `type` 必須、列挙方式の排他性、参照元との意味・値・キーの一致、用語参照の解決を保証しない。これらは次の手動照合で判定する。
|
|
113
195
|
|
|
114
|
-
|
|
196
|
+
#### 6.5.2. 業務要件と参照整合の手動照合
|
|
115
197
|
|
|
116
|
-
|
|
117
|
-
- 物理名(`physical_name`)は entity / field とも lower_snake_case を用いる(例: `product_code`, `credit_balance`, `payment_status`)。
|
|
118
|
-
- アプリケーション(TypeScript等)で利用する場合は、`physical_name` を lowerCamelCase に変換して扱う。
|
|
119
|
-
- `key_fields` は `physical_name` を参照する。
|
|
120
|
-
- `glossary_term_id` は用語集で定義されたIDと一致させる。
|
|
198
|
+
対象項目を正本の定義位置と対応付け、次の合格条件を一つずつ確認する。該当しない行は対象形態と理由を記録する。
|
|
121
199
|
|
|
122
|
-
|
|
200
|
+
| 確認対象 | 合格条件 | 残す証跡 |
|
|
201
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
202
|
+
| スタンドアロン定義 | 全フィールドに `type` があり、単位・制約・例値が業務上の意味と矛盾しない | エンティティ・フィールドと確認結果 |
|
|
203
|
+
| enum・業務状態 | 対象項目に空でない列挙を一方式だけ持つ。詳細列挙では `value` が重複せず、各ラベルで業務上の意味を識別できる | フィールド・方式・値と意味の確認結果 |
|
|
204
|
+
| 用語集・CCD | エンティティとフィールドの全 `glossary_term_id`、全 `related_terms` が対象用語集の用語 ID に存在し、論理名・意味が用語集と CCD に整合する | 対象用語集・CCD の ID と照合箇所。該当文書がない場合は理由 |
|
|
205
|
+
| フィールドとキー | スタンドアロンでは `key_fields` の全要素が `fields` に存在する。参照型では参照先のファイルと対象定義が存在し、注釈する全フィールドとキーが正本の実在項目に対応する(アップストリーム削除済みのフィールドは、レガシーアノテーション退避または互換バージョンへの固定が行われていること)。いずれも単独・複合キーとしての識別意味が一致する | 対象定義・キーとフィールドの対応、および退避・バージョン固定の証跡 |
|
|
206
|
+
| 参照元の許容値 | 参照元の enum 値と辞書の列挙に不足・余分がなく、業務ラベルが各値の意味に一致する | フィールド・参照元の定義位置・値ごとの対応 |
|
|
207
|
+
| 二重管理の防止 | 参照型の `fields` に `type` / `constraints` を再掲せず、業務上の判断に必要な注釈だけを持つ。状態遷移・承認条件は正本へ参照する | 注釈の選定と重複の有無 |
|
|
123
208
|
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
- 簡易列挙: `allowed_values: [PENDING, PAID, CANCELED]`
|
|
127
|
-
- 詳細列挙: `allowed_values_detailed:` に `value` と `label` を持つ配列を記述する。
|
|
209
|
+
- **良い判定例**: 構造検証の成功に加え、用語 ID・キー・enum 値を正本の箇所と対応付けて合格を記録する。
|
|
210
|
+
- **悪い判定例**: `validate:schema` の終了コード 0 だけで、辞書の参照と業務注釈も整合していると判定する。
|
|
128
211
|
|
|
129
212
|
## 7. 禁止事項
|
|
130
213
|
|
|
131
|
-
-
|
|
132
|
-
-
|
|
133
|
-
-
|
|
134
|
-
-
|
|
135
|
-
- 意味が曖昧な説明や略語のみの記載をしない。
|
|
214
|
+
- **技術的属性の無断追加の禁止**: 業務要件として監査証跡や有効期限管理・世代管理が明示的に要求され、プロダクトオーナー(PO)またはアーキテクト(ARC)が認めた場合を除き、技術的属性(`created_at`, `updated_at`, `deleted_at` 等)を含めない。例外として含める場合は、業務上の必要性(法的要件・監査要件等)をフィールドの説明(`description`)に明記する。
|
|
215
|
+
- **スキーマ・実装定義の二重管理・重複記述の禁止**: `schema_ref` や `type_ref` を指定したエンティティにおいて、正本側に既に定義されているデータ型(`type`)や制約条件(`constraints`)を `fields` 内に再掲・重複記述しない。
|
|
216
|
+
- **言語混在・不規則な命名の禁止**: 論理名(`logical_name`)に英数字のみの識別子を記述したり、物理名(`physical_name`)に日本語や `lower_snake_case` 以外の記法(UpperCamelCase、kebab-case、空白混在等)を使用したりしない。
|
|
217
|
+
- **用語集・CCD との不整合の禁止**: 用語集や CCD で定義された用語・ID と異なる名称や略称を使用しない。
|