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
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdr-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
6
|
+
status: draft
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: specdojo:cdr-sample
|
|
10
|
+
template: specdojo:cdr-template
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# コーディング規約(agent 向け instructions)作成ルール
|
|
14
|
+
|
|
15
|
+
Coding Rules (Agent Instructions) Documentation Rulebook
|
|
16
|
+
|
|
17
|
+
実装する agent がどの環境でも同じ規約で実装・検証できるよう、言語・枠組みごとの正本と環境別の薄いラッパーの要件を定めます。
|
|
18
|
+
|
|
19
|
+
## 1. 全体方針
|
|
20
|
+
|
|
21
|
+
- 実装の段の型はこの 1 種類とし、選定済みの技術を「どう書くか」「どう検証するか」に絞る。
|
|
22
|
+
- 実装する agent とレビューする人に向け、命令形の規則と実行できる検証コマンドで書く。
|
|
23
|
+
- ラッパーは適用先のメンバー定義・実行設定にある使用環境だけに用意する。
|
|
24
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、規約の受入確認に含めない。
|
|
25
|
+
|
|
26
|
+
## 2. 位置づけと用語定義
|
|
27
|
+
|
|
28
|
+
- 技術選定と実行基盤は `tsd-index`・`tsd-<term>`、モジュール分割・境界・依存方向と横断ルールは `cpd`・`sysd-*` を正本とする。コーディング規約から参照し、実装の設計書を別に置かない。
|
|
29
|
+
- 規則の本文は `.github/instructions/<言語>.instructions.md` を唯一の正本とする。Copilot は `applyTo` に従って直接読み、ほかの環境ではラッパーを使う。
|
|
30
|
+
- 機械で強制する細則は `eslint.config.*`・`tsconfig.json`・`.editorconfig` 等を正本とする。
|
|
31
|
+
|
|
32
|
+
## 3. ファイル命名・ID規則
|
|
33
|
+
|
|
34
|
+
- 正本はリポジトリルートの `.github/instructions/<言語>.instructions.md` に置く。`<言語>` は英小文字・数字・ハイフンの言語名(`typescript`・`csharp`・`python`)または枠組み名(`vitest`・`nextjs`・`unity-csharp`)とする。
|
|
35
|
+
- 1 ファイルは 1 つの適用範囲(`applyTo` の glob)とする。対象ファイルと規則が異なる場合だけ分ける。範囲が重なる場合は狭い方に追加規則だけを書き、広い方と矛盾させない。
|
|
36
|
+
- `id` は `<言語>-instructions` とする(例: `typescript-instructions`)。
|
|
37
|
+
- 成果物カタログでは、グループの `base_path` を `/.github/instructions`、各成果物の `path` を `<言語>.instructions.md`、`rulebook` を `specdojo:cdr-rulebook` とする。ラッパーはカタログへ載せない。
|
|
38
|
+
|
|
39
|
+
## 4. 推奨 Frontmatter 項目
|
|
40
|
+
|
|
41
|
+
共通の必須項目・型・参照形式は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。トップレベルに Copilot の `applyTo`、`specdojo:` 配下に SpecDojo の項目を置く。
|
|
42
|
+
|
|
43
|
+
| 項目 | 必須 | 値・記述内容 |
|
|
44
|
+
| ------------------- | ---- | ------------------------------------------------------------------------------ |
|
|
45
|
+
| `applyTo` | ○ | 適用する glob(例: `"{src,tests}/**/*.ts"`) |
|
|
46
|
+
| `specdojo.id` | ○ | `<言語>-instructions` |
|
|
47
|
+
| `specdojo.type` | ○ | `architecture` |
|
|
48
|
+
| `specdojo.rulebook` | ○ | `specdojo:cdr-rulebook` |
|
|
49
|
+
| `specdojo.based_on` | 推奨 | 前提とする `tsd-index`・`tsd-<term>`・`sysd-cross-cutting-policy` 等の ID 配列 |
|
|
50
|
+
|
|
51
|
+
## 5. 本文要件
|
|
52
|
+
|
|
53
|
+
見出しの順序と記入欄は template を正本とする。各章の目的と必須・任意は次のとおり。
|
|
54
|
+
|
|
55
|
+
| 章 | 必須 | 目的・記述要件 |
|
|
56
|
+
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
57
|
+
| 導入文 | ○ | H1 の直後に、対象の言語・枠組みと適用範囲を 1〜2 文で書く |
|
|
58
|
+
| 基本方針 | ○ | 型検査の厳しさ、既存コードの書き方への追従、変更の最小化など、全規則の前提になる方針を 3〜5 項目で書く |
|
|
59
|
+
| モジュールと import | ○ | モジュール方式、import の書き方、依存の向きの制約と、その制約を検査する仕組み(linter の規則名など)を書く |
|
|
60
|
+
| 型 | 条件付き | 静的型のある言語で必須。型の宣言、不明な外部入力の扱い、型の強制の制限を書く。動的型の言語は型ヒントの方針で代える |
|
|
61
|
+
| エラー処理 | ○ | 例外と戻り値の使い分け、エラーメッセージに含める文脈、握りつぶしの禁止を書く |
|
|
62
|
+
| 命名 | ○ | 識別子の大文字小文字の規則、略語の扱い、真偽値の名前を書く |
|
|
63
|
+
| テストと検証 | ○ | 変更後に実行するコマンドを、対象(型検査・lint・単体テスト・統合テスト)と実行条件ごとに書く |
|
|
64
|
+
| 禁止事項 | ○ | 破ると被害の大きい書き方と理由を表で書く。表に書いた禁止は本文の章で繰り返さない |
|
|
65
|
+
|
|
66
|
+
- `型` を省けるのは、動的型の言語で型ヒントも使わない場合に限る。省く場合は、その理由を導入文か基本方針に 1 行で書く。
|
|
67
|
+
- 枠組み固有の章(例: Unity のライフサイクル、Next.js のサーバーとクライアントの境界)は、上記の必須章の後ろに 1〜2 章まで追加してよい。
|
|
68
|
+
|
|
69
|
+
## 6. 記述ガイド
|
|
70
|
+
|
|
71
|
+
### 6.1. 規則の書き方
|
|
72
|
+
|
|
73
|
+
- 1 項目に 1 規則を書く。良い例は「型が不明な値は `unknown` で受けて検証する」、悪い例は「型をなるべく安全に扱う」(守ったか判定できない)。理由は判断を誤る場合だけ 1 文で添える。
|
|
74
|
+
- コード例は文章だけでは形が伝わらない場合に 10 行程度までとし、業務ロジックや API の詳細を含めない。
|
|
75
|
+
- 機械で強制する規則は、設定ファイル名・規則名と検査コマンドへの参照にまとめる。
|
|
76
|
+
- 1 ファイルは 300 行程度までを目安とし、超える場合は適用範囲の分割を検討する。
|
|
77
|
+
|
|
78
|
+
### 6.2. テストと検証の書き方
|
|
79
|
+
|
|
80
|
+
| 列 | 記述内容 | 例 |
|
|
81
|
+
| -------- | ---------------------------------------------------- | --------------------------------------- |
|
|
82
|
+
| コマンド | リポジトリの `package.json` などに定義済みのコマンド | `npm run typecheck` |
|
|
83
|
+
| 対象 | 何を検査するか | 型検査(`src`・`tests`) |
|
|
84
|
+
| 実行条件 | どの変更のときに実行するか | TypeScript を変更したとき(毎回) |
|
|
85
|
+
| 失敗時 | 失敗したときに agent が取る行動 | 型エラーを直す。`@ts-ignore` で隠さない |
|
|
86
|
+
|
|
87
|
+
- コマンドが未定義なら追加するか、該当する検査が無いと書く。
|
|
88
|
+
- 実 Git・子プロセス・外部サービスを使う重い検査は、sandbox と親 runner・CI の実行分担を書く。
|
|
89
|
+
- 規約の受入確認では、上位設計・設定と本文を照合し、各コマンドを指定環境で実行する。一致し、所定の検査が成功することを合格条件とする。未決の規則や未提供の検査は、論点・適用への影響・当面の扱いを該当箇所に書く。
|
|
90
|
+
|
|
91
|
+
### 6.3. 環境別のラッパーの作り方
|
|
92
|
+
|
|
93
|
+
ラッパーには適用範囲と正本への参照だけを書く。Claude Code の `<言語>` は正本とそろえる。
|
|
94
|
+
|
|
95
|
+
| 環境 | ラッパーの置き場所 | 正本の読み込ませ方 | 適用範囲の宣言 |
|
|
96
|
+
| -------------- | ------------------------------ | ----------------------------------------------------------------------- | ---------------------- |
|
|
97
|
+
| GitHub Copilot | 不要 | 正本を直接読む | 正本の `applyTo` |
|
|
98
|
+
| Claude Code | `.claude/rules/<言語>.md` | 本文に `@../../.github/instructions/<言語>.instructions.md` を 1 行書く | Frontmatter の `paths` |
|
|
99
|
+
| Codex など | リポジトリルートの `AGENTS.md` | 正本のパスと適用範囲を列挙し、該当ファイルの編集前に読むよう指示する | `AGENTS.md` の本文 |
|
|
100
|
+
| Gemini CLI | `GEMINI.md` | `@.github/instructions/<言語>.instructions.md` で読み込む | `GEMINI.md` の本文 |
|
|
101
|
+
|
|
102
|
+
Claude Code のラッパーの例:
|
|
103
|
+
|
|
104
|
+
```markdown
|
|
105
|
+
---
|
|
106
|
+
paths:
|
|
107
|
+
- "{src,tests}/**/*.ts"
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
# TypeScript Rules
|
|
111
|
+
|
|
112
|
+
@../../.github/instructions/typescript.instructions.md
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
`AGENTS.md` の参照節の例:
|
|
116
|
+
|
|
117
|
+
```markdown
|
|
118
|
+
## Coding Rules
|
|
119
|
+
|
|
120
|
+
次のファイルを編集する前に、対応する規約を読んで従う。
|
|
121
|
+
|
|
122
|
+
- `src/**/*.ts`・`tests/**/*.ts`: `.github/instructions/typescript.instructions.md`
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
- `paths` 等の適用範囲は正本の `applyTo` と同じ glob とし、変更時は同期する。使用環境ごとに対象・対象外のファイルで確認し、対象でのみ正本が読み込まれることを合格条件とする。
|
|
126
|
+
- 差し替えの対象は、成果物カタログの ID・パス、旧 instructions の `applyTo`、各環境のラッパーと `AGENTS.md`・`GEMINI.md` 等の参照節とする。旧正本を自動適用の対象外へ退避し、新正本の適用範囲と各参照をそろえて上記の読み込み確認を行う。旧規約が読み込まれず、新規約が指定範囲で有効になることを切替の完了条件とする。
|
|
127
|
+
- 未決事項・読み込み不具合・参照の切替漏れは、影響する環境・ファイル範囲と当面の扱いを記す。
|
|
128
|
+
|
|
129
|
+
### 6.4. ほかの言語・枠組みへの当てはめ
|
|
130
|
+
|
|
131
|
+
- 章立てを保ち、中身を言語の慣習に合わせる。
|
|
132
|
+
- 枠組みの規則(TypeScript に Next.js の規則を足す等)は固有章に置き、適用範囲が異なる場合は「ファイル命名・ID規則」に従って分ける。
|
|
133
|
+
- Unity の C# 等は、エンジンの命名・ライフサイクルを `命名` と固有章で扱う。検証はエディタ不要の検査(`dotnet format` 等)と起動が必要な検査に分ける。
|
|
134
|
+
|
|
135
|
+
## 7. 禁止事項
|
|
136
|
+
|
|
137
|
+
| 禁止事項 | 理由 |
|
|
138
|
+
| ------------------------------------------------ | ------------------------------------------------------------------------------- |
|
|
139
|
+
| 言語・ライブラリの選定理由や版を書く | `tsd` と二重管理になり、選定の変更が規約に取り残されるため |
|
|
140
|
+
| モジュールの分割やコンポーネントの境界を設計する | 設計の段(`cpd`・`sysd-*`)の責務であり、実装の設計書を置かない方針に反するため |
|
|
141
|
+
| ラッパーに規則の本文を書く・正本を複製する | 環境ごとに規則がずれ、agent ごとに異なる実装になるため |
|
|
142
|
+
| ラッパーの適用範囲を正本の `applyTo` と変える | 環境によって規約が当たるファイルが変わるため |
|
|
143
|
+
| 実行できない・定義されていない検証コマンドを書く | agent が検証を失敗させるか、検証を省くため |
|
|
144
|
+
| linter で強制済みの細則を本文に再掲する | 設定の変更に本文が取り残されるため |
|
|
@@ -4,103 +4,116 @@ specdojo:
|
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
6
|
status: draft
|
|
7
|
-
recipe:
|
|
7
|
+
recipe: not-needed
|
|
8
8
|
sample: specdojo:cdsd-sample
|
|
9
|
-
template:
|
|
9
|
+
template: not-needed
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# 概念データストア定義 作成ルール
|
|
13
13
|
|
|
14
14
|
Conceptual Data Stores Definition (CDSD) Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
業務で扱うデータストア(帳簿・台帳・記録など)を一覧で定義します。各データストアの役割・粒度・用途・更新タイミングなどを明確に記載し、データの流れや管理単位を俯瞰できるようにします。
|
|
16
|
+
業務で継続的に保持・参照する情報の集合について、管理単位・用途・更新責務を定義する基準を定めます。
|
|
18
17
|
|
|
19
|
-
##
|
|
18
|
+
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
- **適用範囲**: 業務分析・要求定義から設計への引き渡しで利用する `cdsd-*.md` を対象とします。帳簿・台帳に加え、定義、実行記録、派生ビュー、人が確定する報告記録も業務上の管理対象なら含めます。
|
|
21
|
+
- **入力**: 成果物カタログの対象範囲・依存・受入条件、上位の目的、関連する BDD・プロセス仕様を確認します。主要な管理単位の採否と用途を、それらの根拠に対応付けます。
|
|
22
|
+
- **記載レベル**: 一覧の各行は独立した管理単位とします。ファイルが複数あることだけで分割せず、正本区分、粒度、更新責務が異なる場合は区別します。
|
|
23
|
+
- **対象外**: 全項目の型・許容値、保存形式、コマンド構文、状態遷移、復旧操作の詳細は、それぞれの schema・型定義・リファレンス・状態定義・運用手順を参照します。概念上の管理境界を判断するための説明だけを残します。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
22
25
|
|
|
23
|
-
##
|
|
26
|
+
## 2. 位置づけと用語定義
|
|
24
27
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
| id | 概念データストア一覧ID (cdsl-xxx-xxxx) | ○ |
|
|
28
|
-
| type | `data` 固定 | ○ |
|
|
28
|
+
- **概念データストア**: 業務上ひとまとまりとして保持・参照する情報です。物理的な保管場所や DB テーブルと一対一とは限りません。
|
|
29
|
+
- **隣接仕様との分担**: BDD は項目の業務的意味、CCD は概念間の関連、プロセス仕様・CDFD は情報の生成・利用の流れ、保管場所一覧は物理的・論理的な場所を扱います。CDSD はこれらを管理単位と更新責務でつなぎます。
|
|
29
30
|
|
|
30
|
-
|
|
31
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
32
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
31
|
+
## 3. ファイル命名・ID規則
|
|
33
32
|
|
|
34
|
-
|
|
33
|
+
- ファイル名は `cdsd-<term>.md` とし、`<term>` は対象業務領域を表す kebab-case とします。プロセス群など、読者が管理境界を合意できる単位でまとめます。
|
|
34
|
+
- プロジェクト成果物の文書 ID は `<project-id>:cdsd-<term>` とします。例は `prj-0001:cdsd-execution` です。文書内のデータストアは名称で一意に対応付け、同名で異なる管理単位を混在させません。
|
|
35
|
+
- 配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従い、カタログの `base_path` と成果物の `path` から解決します。業務仕様のデータモデル配下を基本とし、既存カタログのパスを推測で変更しません。
|
|
35
36
|
|
|
36
|
-
|
|
37
|
-
- `type: data` は業務ドメイン仕様であることを示す。画面やAPI仕様(`ui`/`api`)とは別ドキュメントで管理する。
|
|
37
|
+
## 4. 推奨 Frontmatter 項目
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
許可キー・必須項目・型はドキュメントメタ情報標準と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とし、メタ情報は `specdojo:` 配下に置きます。
|
|
40
40
|
|
|
41
|
-
-
|
|
41
|
+
- `type` は `data`、`rulebook` は `specdojo:cdsd-rulebook` とします。表示名は対象領域が分かる H1 に置き、`title` を併記する場合は H1 と意味を一致させます。
|
|
42
|
+
- `based_on` には実際に読んで直接の根拠とした作成済み文書を記録します。カタログがある場合は `depends_on` の推移閉包内に限定します。単なる関連先や未作成文書を追加しません。
|
|
42
43
|
|
|
43
|
-
|
|
44
|
+
## 5. 本文要件
|
|
44
45
|
|
|
45
|
-
|
|
46
|
-
- 略語のみや実装名(SalesTbl など)は禁止
|
|
46
|
+
本文は次の5章構成を標準とします。
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
| 章 | 必須 | 内容・受入条件 |
|
|
49
|
+
| -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
50
|
+
| 概要 | 必須 | 対象者、利用場面、業務課題と放置時の影響、期待する判断結果、対象・対象外とその根拠を示す。上位文書で説明済みの内容は参照する |
|
|
51
|
+
| 概念データストア一覧 | 必須 | 対象の全管理単位を標準6列で定義し、カタログの対象範囲と照合できること |
|
|
52
|
+
| 正本区分と更新責務 | 必須 | 一覧の全行について、正本か派生・参照情報か、生成元、更新契機、利用制約、担当 Role code を識別できること |
|
|
53
|
+
| 関連仕様と検証 | 必須 | 各管理単位から、根拠となる辞書・プロセス・制約の正本、検証対象と確認手順を辿れること |
|
|
54
|
+
| 確認事項と変更影響 | 条件付き | 未決・欠落・矛盾、または改訂・廃止がある場合に、論点と影響(当面の扱い)を示す。なければ「なし」または省略とする |
|
|
49
55
|
|
|
50
|
-
###
|
|
56
|
+
### 5.1. 一覧の標準列
|
|
51
57
|
|
|
52
|
-
|
|
53
|
-
| ------------------ | ------------------------------------------------------ |
|
|
54
|
-
| **データストア名** | 業務での名称。日本語単数形。慣用的名称はそのまま使用可 |
|
|
58
|
+
列順は次の順に固定します。関連仕様への参照や補足は別表・本文に置けますが、データストア名で対応付けます。
|
|
55
59
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
|
|
|
60
|
+
| 列名 | 内容・判断条件 |
|
|
61
|
+
| -------------- | --------------------------------------------------------------------------------------------- |
|
|
62
|
+
| データストア名 | BDD・用語集と対応する業務名称。日本語の単数形を基本とし、慣用名・正式名称は定義先を示して使う |
|
|
63
|
+
| 対応プロセス | 生成・更新・利用する業務プロセス。複数なら「、」で区切る |
|
|
64
|
+
| 主な内容 | 管理対象が分かる代表情報を名詞句で示す。全フィールドを列挙しない |
|
|
65
|
+
| 更新タイミング | 発生イベントまたは周期と、その適用条件を示す |
|
|
66
|
+
| 粒度 | 最小記録単位と識別の文脈。履歴と集計など複数の単位を混同しない |
|
|
67
|
+
| 主な用途 | 誰のどの業務判断・確認に使うかを示す。概要の目的に対応すること |
|
|
61
68
|
|
|
62
|
-
|
|
69
|
+
更新タイミングは「イベント(会計確定時)」「日次(閉店時)」「月次(締め)」「年次(決算)」「随時(定義変更時)」のように契機を具体化します。複数契機は併記でき、業種固有のイベントをこの例に限定しません。
|
|
63
70
|
|
|
64
|
-
### 2.
|
|
71
|
+
### 5.2. 正本区分と更新責務
|
|
65
72
|
|
|
66
|
-
|
|
73
|
+
- 正本は何を確定する情報かを示します。派生・参照情報は生成元の文書 ID または管理単位、再生成の契機と基準時点を示します。人が確定する報告記録は、その判断の範囲を明示します。
|
|
74
|
+
- 更新担当と確認担当を Role code で示し、参照だけのプロセスと更新するプロセスを区別します。直接編集・再生成・追記などの業務上の制約は、その理由または正本への参照を添えます。
|
|
75
|
+
- 保存・引き渡し単位が境界判断に必要なら、対象ファイル群や運用手順への参照を付けます。詳細なパス規則や実装内部構造は転記しません。更新失敗・不整合時の問い合わせ先と訂正・復旧手順の参照も対応付けます。
|
|
67
76
|
|
|
68
|
-
|
|
69
|
-
- 必要に応じて **「イベントA・イベントB時」形式で複数指定可**
|
|
77
|
+
### 5.3. 関連仕様への追跡
|
|
70
78
|
|
|
71
|
-
-
|
|
72
|
-
-
|
|
73
|
-
-
|
|
74
|
-
- 随時:随時、変更時、追加時
|
|
79
|
+
- 関連 BDD・CCD・用語集・プロセス仕様・CDFD、該当する保管場所一覧(SLL)を文書 ID で特定します。名称・内容・粒度・入出力・管理場所のうち何を照合するかを対応付けます。関連文書がない種別を形式的に作成する必要はありません。
|
|
80
|
+
- schema・型・実装・リファレンスが正本の場合は、BDD 等の参照先を辿れるようにし、外部システムを含む入力元・出力先と更新制約を確認します。構造の詳細を CDSD 独自の定義として複製しません。
|
|
81
|
+
- 関連文書が未整備の場合は、欠ける根拠と現時点で判断できる範囲を「確認事項と変更影響」に残します。依存未整備を対象行の黙示的な除外理由にしません。
|
|
75
82
|
|
|
76
|
-
###
|
|
83
|
+
### 5.4. 検証と受入条件
|
|
77
84
|
|
|
78
|
-
|
|
79
|
-
- 記載する場合は列名を **`physicalName`** とし、**lowerCamelCase** を用いる
|
|
85
|
+
対象範囲と一覧を手動照合し、正本区分・生成元と依存を確認した後、管理単位ごとのデータ検証を行います。
|
|
80
86
|
|
|
81
|
-
|
|
87
|
+
| 確認 | 合格条件・証跡 |
|
|
88
|
+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
89
|
+
| 業務範囲と用途 | カタログの対象と一覧の対応に欠落・重複がなく、標準6列が埋まり、用途が概要の課題・期待価値へつながる |
|
|
90
|
+
| 境界と依存 | 一覧と更新責務の対象集合が一致し、正本・生成元・担当・制約と、参照する BDD 等の定義が矛盾しない |
|
|
91
|
+
| データと運用 | 管理単位ごとに検証対象、適用 schema または手動確認基準、確認コマンド・手順、期待結果、失敗時の対応を参照でき、実行・照合結果が期待結果と一致する |
|
|
82
92
|
|
|
83
|
-
|
|
93
|
+
参照先データの schema 検証はその正本で定める手順を用い、手動照合とともに実行記録へ対象と結果を残します。失敗時は担当へ差し戻して修正・再確認し、未解決を合格として扱いません。
|
|
84
94
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
95
|
+
### 5.5. 未決事項・変更・公開判断
|
|
96
|
+
|
|
97
|
+
- 管理境界・粒度・更新責務の未決、根拠の欠落・矛盾は「確認事項と変更影響」に論点と業務影響、当面の扱いを示します。
|
|
98
|
+
- 名称・用途・粒度の変更では、BDD・CCD・用語集・プロセス仕様・SLL、schema・型・生成処理・コマンド、参照元の受入条件と既存記録への影響を特定します。
|
|
99
|
+
|
|
100
|
+
## 6. 記述ガイド
|
|
101
|
+
|
|
102
|
+
章ごとの判断は次の基準で行います。共通事項は上位文書を正本とし、良い例の短文は判断点だけを示すものです。
|
|
103
|
+
|
|
104
|
+
| 対象章 | 判断の基準 | 良い例 | 悪い例 |
|
|
105
|
+
| -------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
|
106
|
+
| 概要 | 対象者・放置時の影響・期待する判断と、境界の理由が分かる | 「担当交代時の更新漏れを防ぐため、BA が販売記録の更新責務を確認する。在庫は別領域の定義を参照する」 | 「データを一覧にする」のみ、または対象を根拠なく省く |
|
|
107
|
+
| 概念データストア一覧 | 代表情報・更新契機・最小単位・用途を区別できる | 「売上台帳/販売、会計/販売日・金額/イベント(会計確定時)/販売取引毎/店主の売上確認」 | 「SalesTbl/販売/全項目/随時/データ毎/管理」 |
|
|
108
|
+
| 正本区分と更新責務 | 更新元と参照先、担当と許可される扱いが分かる | 「売上集計は売上台帳から日次再生成。OPS が生成し、BA が元帳との一致を確認。集計の直接訂正はしない」 | 「システムが適切に更新する」 |
|
|
109
|
+
| 関連仕様と検証 | 参照先・比較内容・合否を辿れる | 「売上台帳に対応する BDD の文書 ID と検証手順を示し、取引粒度の一致と検証エラー0件を確認する」 | 「BDD 等と整合すること」のみ |
|
|
110
|
+
| 確認事項と変更影響 | 未決の論点と当面の扱い、決まったときに直す管理単位が分かる | 「販売記録の粒度変更は未決。現行粒度を維持し、決定後に日次集計の生成元と既存記録の照合基準を見直す」 | 「詳細は後日」、未決の粒度で集計を確定する |
|
|
111
|
+
|
|
112
|
+
業務名称と正式な識別子の対応が必要なら、名称の初出で短く補足するか正本を参照します。物理名を独立して示す必要がある場合だけ任意の `physicalName` 列を標準6列の後ろに追加し、既存の正本の表記を使います。CDSD のために綴りや命名規則を変換しません。
|
|
113
|
+
|
|
114
|
+
## 7. 禁止事項
|
|
115
|
+
|
|
116
|
+
- 略語・物理名だけで管理対象を表し、業務上の意味や定義先を示さないこと。
|
|
117
|
+
- カタログの対象を未記載のまま除外したり、未決の粒度・更新責務を確定済みとして扱ったりすること。
|
|
118
|
+
- 全項目・型・許容値・状態遷移・コマンド構文・詳細パスを正本から複製し、二重管理すること。
|
|
119
|
+
- 派生・参照情報を正本と混同し、生成元や更新担当の不明なまま後続設計へ渡すこと。
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdt-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
6
|
+
status: ready
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: specdojo:cdt-sample
|
|
9
|
+
template: not-needed
|
|
10
|
+
supersedes:
|
|
11
|
+
- specdojo:cld-rulebook
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# 分類一覧 作成ルール
|
|
15
|
+
|
|
16
|
+
Code Table (CDT) Documentation Rules
|
|
17
|
+
|
|
18
|
+
分類一覧(CDT)は、スキーマ・実装・リファレンスを正本とし、そこから読み取れない値の選定条件と判断境界を補います。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
- **目的と適用範囲**: BDD の属性、画面選択肢、集計軸に使う分類を Markdown で記述し、対象と利用者の判断を明らかにする。
|
|
23
|
+
- **正本参照**: 許容値の正本の選び方は「分類定義」、定義方式ごとの内容は「値の業務的意味と使い分けの要件」に従う。
|
|
24
|
+
- **完成条件**: 「本文要件」を満たし、「成果物の検証」で正本との対応、判断境界、利用先との整合を確認できること。
|
|
25
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱う。
|
|
26
|
+
|
|
27
|
+
## 2. 位置づけと用語定義
|
|
28
|
+
|
|
29
|
+
- **成果物の責務**: CDT は分類の選び方を担う。属性は BDD、語義は用語集、表示・操作は画面仕様、詳細な業務規則・状態遷移・承認は対応仕様へ委ねる。
|
|
30
|
+
- **分類種別**: 業務分類は業務判断の区分、コード表はシステム・外部連携の識別体系、動的分類は利用者が運用中に値を増減する区分。件数だけで種別・管理方式を決めない。
|
|
31
|
+
- **スタンドアロン定義**: 実装に値の定義がない業務区分を CDT 自体で定義する方式。既存の正本を読めない場合の代替にはしない。
|
|
32
|
+
|
|
33
|
+
## 3. ファイル命名・ID規則
|
|
34
|
+
|
|
35
|
+
- **ID**: `<project-id>:cdt-<term>`(例: `prj-0001:cdt-register-type`)。`<term>` は分類の主題を表す英小文字の kebab-case とする。
|
|
36
|
+
- **ファイル名と配置**: `cdt-<term>.md`。成果物カタログの `base_path`・`path` と [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従う。
|
|
37
|
+
- **文書名(H1)**: 分類の主題を示す(例: `# 分類一覧(登録項目の種別)`)。
|
|
38
|
+
|
|
39
|
+
## 4. 推奨 Frontmatter 項目
|
|
40
|
+
|
|
41
|
+
- 共通項目は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]]、許可項目・型制約は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。
|
|
42
|
+
- `specdojo.type` は `data`、`specdojo.rulebook` は `specdojo:cdt-rulebook` とし、CDT 固有項目は追加しない。
|
|
43
|
+
- `schema_ref`・`type_ref` は本文の正本参照欄の表記であり、Frontmatter 項目ではない。
|
|
44
|
+
|
|
45
|
+
## 5. 本文要件
|
|
46
|
+
|
|
47
|
+
本文は次の章を基本とする。
|
|
48
|
+
|
|
49
|
+
| 章タイトル | 必須 | 目的・内容要件 |
|
|
50
|
+
| ------------------------ | ---- | --------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| 概要 | ○ | 業務目的、対象エンティティ、適用範囲、誰がどの判断に使うかを示す |
|
|
52
|
+
| 分類定義 | ○ | 対象エンティティ、分類定義名、種別、正本参照、説明を表形式で特定する |
|
|
53
|
+
| 値の業務的意味と使い分け | ○ | 正本参照あり・スタンドアロン・動的分類の方式に応じて、選定条件と境界または管理規約を示す |
|
|
54
|
+
| 関連仕様との関係 | 任意 | BDD・画面・業務ルール・状態定義などへの参照と、分類の利用先・変更影響を示す。概要等で明確なら省略可 |
|
|
55
|
+
|
|
56
|
+
### 5.1. 分類定義の要件
|
|
57
|
+
|
|
58
|
+
「定義項目」「内容」の 2 列に次の項目を置く。複数の分類軸は軸ごとに定義と説明を対応付ける。
|
|
59
|
+
|
|
60
|
+
| 定義項目 | 内容 |
|
|
61
|
+
| ---------------- | -------------------------------------------------------------------------------------------------- |
|
|
62
|
+
| 対象エンティティ | 分類される業務上の対象。BDD にある場合は論理名・物理名を合わせる |
|
|
63
|
+
| 分類定義名 | 分類軸を表す論理名と属性名。エンティティ名だけで代用しない |
|
|
64
|
+
| 種別 | 業務分類・コード表・動的分類のいずれか |
|
|
65
|
+
| 正本参照(SSOT) | スキーマのパスと定義位置、型のパスと識別子、動的分類の管理元、または「なし(スタンドアロン定義)」 |
|
|
66
|
+
| 説明 | その区分で分ける業務上の判断と目的 |
|
|
67
|
+
|
|
68
|
+
### 5.2. 値の業務的意味と使い分けの要件
|
|
69
|
+
|
|
70
|
+
| 定義方式 | 必須内容 |
|
|
71
|
+
| -------------- | ----------------------------------------------------------------------------------------------- |
|
|
72
|
+
| 正本参照あり | 正本の識別子をキーに各値の意味・選定条件・境界を記す。許容値は再定義しない |
|
|
73
|
+
| スタンドアロン | 値・分類名・表示名・説明と成立条件を定義する。表示名が分類名と同じならその旨を示す |
|
|
74
|
+
| 動的分類 | 管理元、作成・変更権限、命名規約、削除・アーカイブ時の扱いを示す。属性・参照構造は BDD に委ねる |
|
|
75
|
+
|
|
76
|
+
## 6. 記述ガイド
|
|
77
|
+
|
|
78
|
+
共通事項はメタ情報標準・文書構成ガイド、語義は用語集を正本とする。以下は判断基準を示す部分例である。
|
|
79
|
+
|
|
80
|
+
### 6.1. 概要
|
|
81
|
+
|
|
82
|
+
- **判断基準**: 誰がどの場面で何を選ぶかを示し、対象外の判断は対応仕様へ委ねる。
|
|
83
|
+
- **良い例**: 「起票者が、すでに起きた問題と未発生の懸念を分けて追跡するための分類を定義する。状態遷移は状態定義を参照する。」
|
|
84
|
+
- **悪い例**: 「登録項目の分類を適切に管理する。」目的・利用者・判断の境界が分からない。
|
|
85
|
+
|
|
86
|
+
### 6.2. 分類定義
|
|
87
|
+
|
|
88
|
+
参照先のファイル・定義位置を確認する。スキーマと実装が併存する場合も正本は一つとし、他方は対応確認先とする。
|
|
89
|
+
|
|
90
|
+
| 参照方式 | 選定基準 | 正本参照欄の良い例 |
|
|
91
|
+
| -------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
92
|
+
| スキーマ参照 | 許容値をスキーマで管理している | `schema_ref: docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml#/$defs/ItemType` |
|
|
93
|
+
| 型参照 | スキーマがなく、ソースの型で許容値を管理している | `type_ref: <path>#<TypeName>` の形で実在するパスと型識別子を示す |
|
|
94
|
+
| スタンドアロン | 実装に定義がなく、人が業務判断に使う区分である | `なし(スタンドアロン定義)` とし、その区分を判断する主体を説明する |
|
|
95
|
+
| 動的分類 | 利用者が運用中に分類値を増減する | 管理元となる BDD のエンティティを参照し、値を確定するマスタの所在を示す |
|
|
96
|
+
|
|
97
|
+
- **判断基準**: 分類種別と参照方式は別に判断する。固定分類は正本の有無で方式を選び、動的分類は管理元を参照する。
|
|
98
|
+
- **良い例**: 分類定義名を「分類(`item_type`)」とし、スキーマの `ItemType` を正本、CLI の検証定義を対応確認先として示す。
|
|
99
|
+
- **悪い例**: 「登録項目」「ソースコード参照」だけでは、分類軸や参照先を解決できない。
|
|
100
|
+
|
|
101
|
+
### 6.3. 値の業務的意味と使い分け
|
|
102
|
+
|
|
103
|
+
#### 6.3.1. 正本参照あり
|
|
104
|
+
|
|
105
|
+
- **判断基準**: 各正本値に説明が対応し、混同する値を条件で区別できること。識別子は対応付けに用いる。
|
|
106
|
+
- **推奨表**: `値`(正本の識別子)、`分類名`(BDD・用語集に合わせた業務名)、`業務上の意味と使い分け`(選定条件・隣接値との境界)。
|
|
107
|
+
- **良い例**: 「`issue` はすでに起きている問題。まだ起きていない懸念には `risk` を使う。」
|
|
108
|
+
- **悪い例**: 「`issue` は課題、`risk` はリスク。」名称の言い換えだけでは選定できない。
|
|
109
|
+
|
|
110
|
+
#### 6.3.2. スタンドアロン定義
|
|
111
|
+
|
|
112
|
+
- **判断基準**: CDT が正本を担うため、識別可能な値と条件を揃え、条件が重なる場合は優先順位・例外を示す。
|
|
113
|
+
- **推奨表**: `値`(コード)、`分類名`(正式名称)、`表示名`(利用者向け名称)、`説明・成立条件`(選定条件)。
|
|
114
|
+
- **良い例**: 「`experimental`/試験商品/お試し: 店主が新規取扱を試す区分。入荷後30日間の売れ行きで定番化を判断する。」
|
|
115
|
+
- **悪い例**: 「`experimental`/その他/その他: 適宜使用する。」適用条件と判断主体を特定できない。
|
|
116
|
+
|
|
117
|
+
#### 6.3.3. 動的分類
|
|
118
|
+
|
|
119
|
+
- **判断基準**: 値の追加・変更権限と既存参照の扱いを判断できること。
|
|
120
|
+
- **良い例**: 「店主がタグを追加する。使用済みタグは削除せずアーカイブし、新規付与だけを停止する。」管理元の属性定義は BDD を参照する。
|
|
121
|
+
- **悪い例**: 現在のタグを BDD の enum として列挙する。運用中に追加される値を表現できない。
|
|
122
|
+
|
|
123
|
+
### 6.4. 関連仕様との関係
|
|
124
|
+
|
|
125
|
+
- **判断基準**: 参照文書と分類を使う属性・判断を対にする。税率・状態遷移・承認・構文の詳細は各正本へ委ねる。
|
|
126
|
+
- **良い例**: 「業務データ辞書の `item_type` に対応する。分類別の終端・承認者は状態定義を参照する。」
|
|
127
|
+
- **悪い例**: 関連文書名だけを並べる、または状態遷移表や CLI オプション一覧を転記する。利用関係を示せないか、正本との二重管理になる。
|
|
128
|
+
|
|
129
|
+
### 6.5. 成果物の検証
|
|
130
|
+
|
|
131
|
+
1. **参照と対応**: 正本のファイル・定義位置と説明表を照合する。各許容値に説明が過不足なく対応し、CLI 等の検証値を併記する場合は正本と同じ集合であること。
|
|
132
|
+
2. **業務判断**: 境界事例を当てはめ、隣接値を選び分けられること、スタンドアロン分類に重複・漏れがないこと、動的分類の権限・参照保持を判断できることを確認する。
|
|
133
|
+
3. **変更影響**: BDD・用語・画面・業務ルール・関連実装の利用箇所を辿り、意味・表示に不整合がないことを確認する。未解消の不一致は論点と影響を実行結果に残す。
|
|
134
|
+
|
|
135
|
+
## 7. 禁止事項
|
|
136
|
+
|
|
137
|
+
- **正本の再掲**: 値だけの一覧、enum・union 型、型制約、コマンド構文、状態遷移表を転記しない。
|
|
138
|
+
- **判断できない説明**: 名称の直訳や「適切に選ぶ」だけで条件を済ませない。根拠のない値数の目安を分類種別・管理方式の必須条件にしない。
|
|
139
|
+
- **責務の混同**: 動的分類を固定 enum 化しない。分類の業務判断に寄与しない DDL・SQL・内部関数の詳細を混入しない。
|