specdojo 0.1.0 → 0.2.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/LICENSE +22 -0
- package/README.md +82 -38
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +980 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +45 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +15 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +55 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +120 -24
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdfd-uc-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:cdfd-uc-recipe
|
|
8
|
+
sample: specdojo:cdfd-uc-sample
|
|
9
|
+
template: specdojo:cdfd-uc-template
|
|
10
|
+
includes:
|
|
11
|
+
- specdojo:cdfd-mermaid-rulebook
|
|
12
|
+
based_on:
|
|
13
|
+
- specdojo:rulebook-authoring-standard
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# 概念データフロー図(ユースケース別)作成ルール
|
|
17
|
+
|
|
18
|
+
Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
19
|
+
|
|
20
|
+
全体概要で選定した一つの横断ユースケースについて、複数のプロセスグループを通る順序、グループ間で引き渡す情報、引き渡し条件、条件不成立時の戻り先を、表と Mermaid 図で合意可能にするためのルールです。グループ内部のプロセスと状態遷移は、それぞれプロセスグループ別 CDFD と STSD を参照します。
|
|
21
|
+
|
|
22
|
+
## 1. 全体方針
|
|
23
|
+
|
|
24
|
+
- 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID とユースケースを詳細化します。単一のプロセスグループに閉じる業務には作成しません。
|
|
25
|
+
- 「プロセス領域」を順序とグループ別責務の正本、「データストア」を引き渡しで使う上位一覧の部分集合、「引き渡し」を情報・条件・戻す条件の正本、図を開始から終了までの横断順序の正本として併用します。
|
|
26
|
+
- 図の一つのプロセスノードは一つのプロセスグループを表します。グループ内部の領域やプロセスを再掲せず、対応する `cdfd-<group>` を参照します。
|
|
27
|
+
- 引き渡し条件は、送り元の成果が受け側の開始に足りることを判定できる形にします。条件を満たさない場合の戻り先、戻す情報、再開条件も定めます。
|
|
28
|
+
- 状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。本書は状態の定義や遷移表を持たず、グループ間の引き渡しだけを扱います。
|
|
29
|
+
- 人間が担う承認や最終判断を省略しません。AI Agent やシステムは支援主体として扱えても、責任分担の正本は対応する方針文書を参照します。
|
|
30
|
+
|
|
31
|
+
## 2. 位置づけと用語定義
|
|
32
|
+
|
|
33
|
+
| 用語 | 定義 |
|
|
34
|
+
| -------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
35
|
+
| 全体概要 | プロセス領域、プロセスグループ、データストア、詳細 CDFD の割り当てを定める `cdfd-overview` |
|
|
36
|
+
| ユースケース別 CDFD | 複数のプロセスグループをまたぐ一つの業務について、グループ間の順序と引き渡し条件だけを定める CDFD |
|
|
37
|
+
| プロセスグループ代表ノード | 横断順序に参加する一つのプロセスグループを表す角丸長方形のノード。グループ内部のプロセスは含めない |
|
|
38
|
+
| 引き渡し | 送り元グループの成果を、判定可能な条件の成立後に受け側グループの入力として渡す責任境界 |
|
|
39
|
+
| 引き渡し条件 | 引き渡す情報の完全性、承認、記録の確定など、受け側グループを開始できることを判定する条件 |
|
|
40
|
+
| 戻す条件 | 引き渡し条件の不成立または受け側で判明した不足により、情報や判断を送り元または先行グループへ返す条件 |
|
|
41
|
+
| 例外時の戻り先 | 条件不成立時に補完・再判断を担い、再開条件を成立させるプロセスグループ |
|
|
42
|
+
| 関連データストア | 引き渡し条件の判定または引き渡す情報の正本として必要な、全体概要と同じ名称・区分を持つデータストア |
|
|
43
|
+
| グループ内部 | `cdfd-<group>` が正本とする、領域、個別プロセス、プロセス入出力、主要例外、データストアの具体的な読み書き |
|
|
44
|
+
|
|
45
|
+
全体概要は横断ユースケースの業務目的、ケース ID、参加グループを選定します。ユースケース別 CDFD はその選定を変えずにグループ間の順序と引き渡しを具体化し、各グループの内部はプロセスグループ別 CDFD へ委ねます。
|
|
46
|
+
|
|
47
|
+
## 3. ファイル命名・ID規則
|
|
48
|
+
|
|
49
|
+
- 対象プロダクトの業務仕様配下にあるデータフローディレクトリへ配置します。
|
|
50
|
+
- ファイル名と成果物 ID は `cdfd-uc-<topic>` とし、ファイル名だけ `.md` を付けます。`<topic>` は全体概要のユースケースを表す英小文字・数字・ハイフンのスラッグです。
|
|
51
|
+
- product 成果物の ID にプロジェクト ID や authority を付けません。例: ファイル名 `cdfd-uc-replenishment.md`、ID `cdfd-uc-replenishment`。
|
|
52
|
+
- ケース ID は全体概要の `C-<nn>` 形式をそのまま引き継ぎ、新しい ID を採番したり別のユースケースの ID を流用したりしません。
|
|
53
|
+
- 引き渡し ID は文書内で一意な `H-<nn>` 形式とし、正常順序に沿って採番します。同じ引き渡しには、引き渡し表、図、例外時の戻り先で同じ ID を使います。
|
|
54
|
+
- プロセスグループ名、領域 ID、データストア名は全体概要と一致させます。プロセスグループ別 CDFD の参照先は `cdfd-<group>` 形式とします。
|
|
55
|
+
|
|
56
|
+
## 4. 推奨 Frontmatter 項目
|
|
57
|
+
|
|
58
|
+
| 項目 | 説明 | 必須 |
|
|
59
|
+
| ---------- | ----------------------------------------------------- | ---- |
|
|
60
|
+
| id | プロジェクト修飾なしの `cdfd-uc-<topic>` | ○ |
|
|
61
|
+
| type | `flow` | ○ |
|
|
62
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
63
|
+
| rulebook | `specdojo:cdfd-uc-rulebook` | ○ |
|
|
64
|
+
| based_on | 全体概要など、依存関係上許可された直接の内容根拠の ID | 任意 |
|
|
65
|
+
| supersedes | 置き換える旧ユースケース別 CDFD の ID | 任意 |
|
|
66
|
+
|
|
67
|
+
- `based_on` に全体概要を記載する場合も product 成果物 ID を使用し、成果物カタログの `depends_on` の推移閉包に含まれる根拠だけを列挙します。
|
|
68
|
+
- ケース ID、ユースケース名、対象者、開始・終了条件は本文で定義し、未定義の Frontmatter 項目を追加しません。
|
|
69
|
+
- 作成途中の `status` は `draft` とし、完成判定と所定の承認を満たした後の昇格は定められた承認者が行います。
|
|
70
|
+
|
|
71
|
+
## 5. 本文要件
|
|
72
|
+
|
|
73
|
+
見出し順・表・記入欄の骨組みは template を正本とします。本章は各章の目的と必須・任意を定めます。
|
|
74
|
+
|
|
75
|
+
| 番号 | 見出し | 必須 | 内容 |
|
|
76
|
+
| ---- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
|
|
77
|
+
| 冒頭 | 導入文 | ○ | ケース ID、ユースケース、横断目的を一文で定義 |
|
|
78
|
+
| 1 | 目的 | ○ | 対象者と、横断順序・責任境界・設計入力の利用場面 |
|
|
79
|
+
| 2 | 適用範囲 | ○ | ケース ID、開始イベント、終了条件、参加グループ、組織・システム境界、対象外、責任分担 |
|
|
80
|
+
| 3 | プロセス領域 | ○ | グループごとの節。説明文、主要入力・主要出力・データストアの箇条書き、横断上の役割の表 |
|
|
81
|
+
| 4 | データストア | ○ | 全体概要と同じ名称・区分を持つ、引き渡す情報または条件判定に使うデータストアの部分集合 |
|
|
82
|
+
| 5 | 概念データフロー | ○ | 開始イベント、グループ代表ノード、引き渡し条件、関連データストア、終了条件だけを示す Mermaid 図と図直後の注記 |
|
|
83
|
+
| 6 | 引き渡し | ○ | 引き渡し ID、送り元、受け側、引き渡す情報、引き渡し条件、戻す条件 |
|
|
84
|
+
| 7 | 例外時の戻り先 | ○ | 対象引き渡し、条件不成立、戻り先グループ、戻す情報、再開条件 |
|
|
85
|
+
| 8 | 未決事項 | 条件付き | 横断境界、引き渡し条件、戻り先、判断者が未確定な論点。未決事項がある場合だけ設ける |
|
|
86
|
+
|
|
87
|
+
「未決事項」を設ける場合は最終章とします。図を分割する場合は「概念データフロー」に `5.1.`、`5.2.` の節を設け、引き渡し ID を接続キーにします。
|
|
88
|
+
|
|
89
|
+
## 6. 記述ガイド
|
|
90
|
+
|
|
91
|
+
### 6.1. 導入文と目的
|
|
92
|
+
|
|
93
|
+
- 導入文は「ケース `C-02` の欠品から補充まで」のように、全体概要のケース ID とユースケース名を明示し、どのグループ間の引き渡しを定めるかを一文で示します。
|
|
94
|
+
- 目的は、誰が横断順序を承認し、誰がグループ間の入出力を設計へ使い、誰が重複・欠落を確認するかを利用結果と結び付けます。
|
|
95
|
+
- 上位の業務目的を長く書き写さず、グループ境界の合意によって防ぐ欠落や手戻りを示します。
|
|
96
|
+
|
|
97
|
+
### 6.2. 適用範囲
|
|
98
|
+
|
|
99
|
+
- 全体概要からケース ID、ユースケース名、横断するプロセスグループを引き継ぎます。グループを追加・削除・改名する必要がある場合は、先に全体概要を変更します。
|
|
100
|
+
- 開始イベントは最初のグループが動き始める出来事、終了条件は最後のグループが受け取った成果を利用可能と判断できる状態として記述します。
|
|
101
|
+
- 対象外には、グループ内部の領域・プロセス・主要例外、補助操作、実装詳細、状態の定義・遷移を明記し、対応する `cdfd-<group>` と STSD へ委ねます。
|
|
102
|
+
- 人間と AI Agent の責任分担は本文で再定義せず、対応する方針文書を参照します。参照先がない場合は、人間が承認と最終判断を担う原則だけを記載します。
|
|
103
|
+
|
|
104
|
+
### 6.3. プロセス領域
|
|
105
|
+
|
|
106
|
+
- 章の冒頭で、ケース ID、参加グループ数、正常系の通過順、全体概要との正本関係を示します。
|
|
107
|
+
- 正常系で通過するプロセスグループごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名(含む領域 ID の範囲)」とします。同じグループが正常系で再登場する場合は別の節とし、その理由を説明します。
|
|
108
|
+
- 各節は、そのグループが前段から何を受け取り次段へ何を渡すかを示す 1〜3 文の説明、`**主要入力**`・`**主要出力**`・`**データストア**` の箇条書き、横断上の役割を示す表の順で構成します。
|
|
109
|
+
- 表は「順序」「プロセスグループ」「含む領域」「横断上の役割」「参照先」の 5 列とし、一節に一行を記載します。グループ名と領域 ID は全体概要から引き継ぎ、参照先は `cdfd-<group>` 形式とします。
|
|
110
|
+
- 内部プロセス、内部例外、担当は書き写しません。未作成の参照先も安定した ID をバッククォートで示し、作成状況は登録簿で追跡します。
|
|
111
|
+
|
|
112
|
+
### 6.4. データストア
|
|
113
|
+
|
|
114
|
+
- 全体概要の「データストア」と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、引き渡す情報または引き渡し条件の判定に使う行だけを掲載します。該当する行がない区分は節ごと省略します。
|
|
115
|
+
- 表の列は「データストア」「関連引き渡し」「横断上の利用」とします。関連引き渡しには `H-<nn>` を記載し、どの情報または条件の正本かを利用内容で説明します。
|
|
116
|
+
- 名称と区分は全体概要から変更しません。新しいデータストアまたは区分変更が必要なら先に全体概要を変更し、本章だけへ追加しません。
|
|
117
|
+
- 各行は概念データフローの同名ノードに対応させます。図に置かないデータストアや、本章に行のないデータストアノードを残しません。
|
|
118
|
+
|
|
119
|
+
### 6.5. 概念データフロー
|
|
120
|
+
|
|
121
|
+
- Mermaid のノード、エッジ、形状、線種は Frontmatter の `includes` で指定した記法ルールに従います。
|
|
122
|
+
- プロセスノードは「プロセス領域」の各表の一行に対応する代表ノードとし、ラベルにグループ名と含む領域 ID を記載します。内部プロセス ID や処理名は描きません。
|
|
123
|
+
- 開始イベント、引き渡し条件、終了条件をイベントノードとして置き、引き渡し ID と情報名をエッジラベルまたはイベントラベルで追跡可能にします。
|
|
124
|
+
- データストアは、引き渡し条件の判定または引き渡す情報の正本として必要なものだけを、全体概要と同じ名称・区分で置きます。個別プロセスの読み書きや項目は描きません。
|
|
125
|
+
- 図直後に、全体概要に「凡例(本プロダクト共通)」がある場合はその参照、ない場合は `specdojo:cdfd-mermaid-rulebook` の既定凡例に従う旨を記載します。併せて、使用した線種、内部プロセスを省略したこと、図に置いたデータストアの選定理由を示します。
|
|
126
|
+
- 一図で順序を追えない場合は連続する引き渡し単位で分割し、前図の終了側と後図の開始側へ同じ引き渡し ID を記載します。
|
|
127
|
+
|
|
128
|
+
### 6.6. 引き渡し
|
|
129
|
+
|
|
130
|
+
- 一行を一つのグループ間引き渡しとし、「引き渡し ID」「送り元グループ」「受け側グループ」「引き渡す情報」「引き渡し条件」「戻す条件」の 6 列を使用します。
|
|
131
|
+
- 引き渡す情報は「補充依頼」「承認済みの評価結果」のような業務上の名詞で記述し、ファイル形式や API 項目へ展開しません。
|
|
132
|
+
- 引き渡し条件は、必要情報、承認、記録確認などの成立を第三者が yes / no で判定できる形にします。「処理が終わった」「問題がない」だけで終わらせません。
|
|
133
|
+
- 戻す条件は、どの不足または不一致で受け側が開始できないかを示します。戻しが発生しない引き渡しは、その根拠を記載し、空欄にしません。
|
|
134
|
+
|
|
135
|
+
### 6.7. 例外時の戻り先
|
|
136
|
+
|
|
137
|
+
- 表は「対象引き渡し」「条件不成立」「戻り先グループ」「戻す情報」「再開条件」の 5 列とし、すべての引き渡し ID を一度以上確認します。
|
|
138
|
+
- 戻り先は補完・再判断の責任を持つ参加グループから選びます。グループ内部のどのプロセスへ戻すかは、対応するプロセスグループ別 CDFD に委ねます。
|
|
139
|
+
- 再開条件は、修正済み情報の再提示、承認の成立、正本の読み返し確認など、同じ引き渡しを再評価できる条件にします。
|
|
140
|
+
- 受け側の内部だけで完結する例外、ログ、再試行は記載しません。横断順序またはグループ間責任が変わるものだけを扱います。
|
|
141
|
+
|
|
142
|
+
### 6.8. 未決事項
|
|
143
|
+
|
|
144
|
+
- 横断境界、引き渡し条件、戻り先、判断者のいずれかが未確定な場合だけ設けます。ない場合は章ごと省略します。
|
|
145
|
+
- 表は「論点」「影響するケース・引き渡し」「決定者」「決定時期」の 4 列とし、本文中の `_UNDECIDED_` と対応させます。
|
|
146
|
+
- 調査で埋める不足は `_TODO_`、意思決定待ちは `_UNDECIDED_`、仮置きする前提は `_ASSUMPTION_` として区別します。
|
|
147
|
+
|
|
148
|
+
### 6.9. 完成判定
|
|
149
|
+
|
|
150
|
+
- 全体概要のケース ID、ユースケース名、業務目的、参加グループと矛盾せず、二つ以上のプロセスグループを横断しています。
|
|
151
|
+
- 正常系の全参加グループが「プロセス領域」の節と図へ同じ順序・名称・領域 ID で登場し、各節が説明文、三つの箇条書き、役割表の順で構成されています。
|
|
152
|
+
- 隣接するグループ間に引き渡し ID があり、引き渡す情報、引き渡し条件、戻す条件が空欄なく定義されています。
|
|
153
|
+
- 図の各プロセスノードが一つのプロセスグループを表し、内部領域・内部プロセス・グループ内例外を再掲していません。
|
|
154
|
+
- 関連データストアの名称・区分が全体概要と一致し、引き渡し条件に不要なデータストアや物理項目がありません。
|
|
155
|
+
- 「データストア」は全体概要の部分集合で、各行が引き渡し ID と図の同名ノードに対応しています。
|
|
156
|
+
- 例外時の戻り先から、条件不成立、戻す情報、補完責任、再開条件を説明できます。
|
|
157
|
+
- 状態定義、遷移表、状態遷移図を持たず、必要な STSD と各 `cdfd-<group>` を参照しています。
|
|
158
|
+
- `_TODO_` が残っていません。`_UNDECIDED_` は「未決事項」と対応しています。
|
|
159
|
+
|
|
160
|
+
## 7. 禁止事項
|
|
161
|
+
|
|
162
|
+
- 単一グループに閉じる業務へユースケース別 CDFD を作成したり、全体概要にないケースを先に詳細化したりしません。
|
|
163
|
+
- product 成果物 ID を `<project-id>:cdfd-uc-<topic>` にしたり、`cdfd-<group>` と同じ命名で作成したりしません。
|
|
164
|
+
- ケース ID を採番し直したり、引き渡し ID を図・引き渡し表・例外時の戻り先で不一致にしたりしません。
|
|
165
|
+
- グループ内部の領域、個別プロセス、プロセス入出力、主要例外、操作手順を再掲しません。
|
|
166
|
+
- プロセスグループ別 CDFD と異なる責務をグループ代表ノードへ割り当てたり、全体概要と異なる領域 ID・データストア名・区分を使ったりしません。
|
|
167
|
+
- 状態名・成立条件を定義したり、遷移元・遷移先・遷移条件の表や状態遷移図を複製したりしません。
|
|
168
|
+
- 引き渡し条件や再開条件を「完了した」「適切になった」「問題がなくなった」のような判定不能な表現だけで記述しません。
|
|
169
|
+
- 物理テーブル、カラム、SQL、実装クラス、詳細 API、画面操作を概念フローへ記載しません。
|
|
170
|
+
- 受け側グループ、戻り先グループ、引き渡す情報のいずれかがない矢印や表行を残しません。
|
|
171
|
+
- 作成状況やレビュー状態を成果物本文へ記載せず、登録簿で追跡します。
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdsd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:cdsd-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 概念データストア定義 作成ルール
|
|
12
|
+
|
|
13
|
+
Conceptual Data Stores Definition (CDSD) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、業務分析・要求定義・システム設計のために **概念データストア定義を記述する標準ルール** です。
|
|
16
|
+
業務で扱うデータストア(帳簿・台帳・記録など)を一覧で定義します。各データストアの役割・粒度・用途・更新タイミングなどを明確に記載し、データの流れや管理単位を俯瞰できるようにします。
|
|
17
|
+
|
|
18
|
+
## 0. 概要
|
|
19
|
+
|
|
20
|
+
概念データストアとは、業務上継続的に保持・参照される情報の集合(帳簿・台帳・記録)を表す。DB やファイル形式などの物理構造ではなく、「業務単位としての情報管理のまとまり」を定義する。
|
|
21
|
+
|
|
22
|
+
## 1. メタデータ
|
|
23
|
+
|
|
24
|
+
| 項目 | 説明 | 必須 |
|
|
25
|
+
| ---- | -------------------------------------- | ---- |
|
|
26
|
+
| id | 概念データストア一覧ID (cdsl-xxx-xxxx) | ○ |
|
|
27
|
+
| type | `domain` 固定 | ○ |
|
|
28
|
+
|
|
29
|
+
| title | 概念データストア一覧名 | ○ |
|
|
30
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
31
|
+
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
32
|
+
|
|
33
|
+
### 1.1 ID規約
|
|
34
|
+
|
|
35
|
+
- 概念データストア一覧IDは正規表現 `^cdsl-[a-z0-9-]+$` に合致する一意IDを用いる。
|
|
36
|
+
- `type: data` は業務ドメイン仕様であることを示す。画面やAPI仕様(`screen`/`api`)とは別ドキュメントで管理する。
|
|
37
|
+
|
|
38
|
+
## 2. 記述ルール
|
|
39
|
+
|
|
40
|
+
- 仕様間(BDD/SLL/CCD/用語集)で名称の整合性を保つ。
|
|
41
|
+
|
|
42
|
+
### 2.1 データストア名の命名規則
|
|
43
|
+
|
|
44
|
+
- **日本語の単数形**を基本とする(例:売上台帳、在庫台帳)
|
|
45
|
+
- 略語のみや実装名(SalesTbl など)は禁止
|
|
46
|
+
|
|
47
|
+
- 「〜台帳」「〜帳簿」「〜一覧表」など、業務慣用名称はそのまま使用してよい
|
|
48
|
+
|
|
49
|
+
### 2.2 標準列の定義
|
|
50
|
+
|
|
51
|
+
| 列名 | 説明 |
|
|
52
|
+
| ------------------ | ------------------------------------------------------ |
|
|
53
|
+
| **データストア名** | 業務での名称。日本語単数形。慣用的名称はそのまま使用可 |
|
|
54
|
+
|
|
55
|
+
| **対応プロセス** | 調達/販売/会計など複数可(複数の場合は「、」区切り) |
|
|
56
|
+
| **主な内容** | 記録項目の代表例を名詞句で簡潔に |
|
|
57
|
+
| **更新タイミング** | 発生イベント・日次・月次などの処理基準 |
|
|
58
|
+
| **粒度** | データの最小記録単位(例:仕入取引毎/商品×在庫時点) |
|
|
59
|
+
| **主な用途** | 管理・分析・会計などの目的 |
|
|
60
|
+
|
|
61
|
+
※ 列順は **データストア名 → 対応プロセス → 主な内容 → 更新タイミング → 粒度 → 主な用途** の順に統一する。
|
|
62
|
+
|
|
63
|
+
### 2.3 更新タイミングの標準語彙(改訂)
|
|
64
|
+
|
|
65
|
+
使用可能なカテゴリ:
|
|
66
|
+
|
|
67
|
+
- イベント:発注時、納品時、販売時、支払い時
|
|
68
|
+
- 必要に応じて **「イベントA・イベントB時」形式で複数指定可**
|
|
69
|
+
|
|
70
|
+
- 日次処理:日次(閉店時)
|
|
71
|
+
- 月次処理:月次(締め)
|
|
72
|
+
- 年次処理:年次(決算)
|
|
73
|
+
- 随時:随時、変更時、追加時
|
|
74
|
+
|
|
75
|
+
### 2.4 物理名の扱い(補足追加)
|
|
76
|
+
|
|
77
|
+
- 概念データストアでは物理名は **原則記載しない**
|
|
78
|
+
- 記載する場合は列名を **`physicalName`** とし、**lowerCamelCase** を用いる
|
|
79
|
+
|
|
80
|
+
## 3. サンプル
|
|
81
|
+
|
|
82
|
+
### 3.1 メタデータ(front-matter YAML)
|
|
83
|
+
|
|
84
|
+
```yaml
|
|
85
|
+
---
|
|
86
|
+
id: cdsl-main
|
|
87
|
+
type: data
|
|
88
|
+
title: 概念データストア一覧(main)
|
|
89
|
+
status: draft
|
|
90
|
+
supersedes: []
|
|
91
|
+
---
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 3.2 概念データストア一覧(表)
|
|
95
|
+
|
|
96
|
+
| データストア名 | 対応プロセス | 主な内容 | 更新タイミング | 粒度 | 主な用途 |
|
|
97
|
+
| -------------- | ------------ | ------------------------------------------------------------ | ------------------------------------ | -------------- | -------------------------------------------- |
|
|
98
|
+
| 商品一覧表 | 調達 | 商品名、仕入単価、販売価格、分類(お菓子/玩具など) | 随時(新商品追加・価格変更時) | 商品マスタ単位 | 商品情報の統一、仕入・販売・会計の基礎データ |
|
|
99
|
+
| 仕入台帳 | 調達 | 発注日、仕入先、商品名、数量、仕入単価、合計金額、支払状況 | イベント(発注時・納品時) | 仕入取引毎 | 仕入履歴と支払い管理、原価把握 |
|
|
100
|
+
| 在庫台帳 | 調達、販売 | 商品名、入庫数、出庫数、現在庫数、賞味期限 | イベント(納品時・販売時・補充時) | 商品×在庫時点 | 欠品防止、再発注判断、廃棄ロス管理 |
|
|
101
|
+
| 売上台帳 | 会計 | 日付、販売金額、販売数量、売れ筋商品、販売方法(現金/つけ) | 日次(閉店時) | 日次集計 | 売上把握、販売分析、仕入見直し |
|
|
102
|
+
| つけ帳 | 販売、会計 | お客様名、購入日、商品名・金額、支払期日、支払状況 | イベント(購入時・支払い時) | つけ取引毎 | つけ払い(後払い)の記録と回収管理 |
|
|
103
|
+
| レジ記録 | 販売、会計 | 日付、入金(売上)、出金(仕入・経費)、残高 | 日次(閉店時)/イベント(支払い時) | レジ取引毎 | 現金の入出金管理、レジ締め・差額確認 |
|
|
104
|
+
| 支払管理表 | 会計 | 支払先、支払日、金額、支払方法、ステータス | イベント(請求書受領時・支払い時) | 支払取引毎 | 仕入や経費の支払い状況管理 |
|
|
105
|
+
| 会計帳簿 | 会計 | 日次売上、つけ払い入金、経費、仕入原価、利益計算 | 月次(締め)/年次(決算) | 月次/年次集計 | 会計全体の記録、税務・申告対応用 |
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cld-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:cld-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 分類一覧(Classification List)作成ルール
|
|
12
|
+
|
|
13
|
+
業務上の分類(カテゴリ、種別、区分など)を一覧で整理するための標準ルールです。
|
|
14
|
+
分類は業務目的に応じて **業務分類(固定)/コード表(システム分類)/動的分類(ユーザー定義)** の3種類に分けて管理します。
|
|
15
|
+
|
|
16
|
+
分類は業務データ辞書(BDD)の enum や画面の選択肢、集計軸として重要な役割を持つため、ここでのルールは他仕様(BDD/ステータス/用語集)と一貫させることを目的とします。
|
|
17
|
+
|
|
18
|
+
## 0. 概要
|
|
19
|
+
|
|
20
|
+
分類(Classification)とは、**業務データを意味的にグループ化する構造**である。
|
|
21
|
+
|
|
22
|
+
分類は以下の 3 種類に分類される:
|
|
23
|
+
|
|
24
|
+
### 1. **業務分類(Business Classification)**
|
|
25
|
+
|
|
26
|
+
- 業務ロジックに基づいて固定的に存在する分類
|
|
27
|
+
- 例:商品区分、顧客種別、売上種別
|
|
28
|
+
- 値は少数で変動しないことが多い
|
|
29
|
+
- システム依存性は低い
|
|
30
|
+
|
|
31
|
+
### 2. **コード表(Code List / System Code List)**
|
|
32
|
+
|
|
33
|
+
- システムで使用されるコード値の一覧
|
|
34
|
+
- 都道府県コード、支払方法コード、税種別コードなど
|
|
35
|
+
- 多くの場合 **マスターテーブルとして保持する**
|
|
36
|
+
- BDD の enum と密接に対応
|
|
37
|
+
|
|
38
|
+
### 3. **動的分類(Dynamic Classification)**
|
|
39
|
+
|
|
40
|
+
- ユーザーが自由に作成・編集・削除できる分類
|
|
41
|
+
- タグ、ラベル、フォルダ分類など
|
|
42
|
+
- **BDD の enum にしてはいけない**
|
|
43
|
+
- システムテーブルで管理し、BDD では string または reference とする
|
|
44
|
+
|
|
45
|
+
## 1. メタデータ
|
|
46
|
+
|
|
47
|
+
分類一覧を1つの YAML ドキュメントとして管理する場合、以下のメタデータを用いる。
|
|
48
|
+
|
|
49
|
+
| 項目 | 説明 | 必須 |
|
|
50
|
+
| ---- | ------------------------------ | ---- |
|
|
51
|
+
| id | 分類一覧ID(例:cll-xxx-xxxx) | ○ |
|
|
52
|
+
|
|
53
|
+
| type | `domain` 固定 | ○ |
|
|
54
|
+
| title | 分類一覧名 | ○ |
|
|
55
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
56
|
+
| supersedes | 置き換え関係(旧仕様→新仕様) | 任意 |
|
|
57
|
+
|
|
58
|
+
### 1.1 ID規約
|
|
59
|
+
|
|
60
|
+
- 分類一覧IDは正規表現 **`^cll-[a-z0-9-]+$`** に合致すること
|
|
61
|
+
- `type: data` は画面やAPI仕様と切り離して管理することを示す
|
|
62
|
+
|
|
63
|
+
## 2. 記述ルール(共通)
|
|
64
|
+
|
|
65
|
+
- 日本語の単数形で記載する(例:商品区分、顧客種別)
|
|
66
|
+
- 分類を 分類定義 と 値の説明(値一覧) の二つの表で整理する。
|
|
67
|
+
- 値はシステム上の識別子として lower-kebab-case を使用する。
|
|
68
|
+
- 略語のみの記述や曖昧な説明は避ける。
|
|
69
|
+
- システム内部名称のみにしない
|
|
70
|
+
|
|
71
|
+
### 2.1 分類定義の説明
|
|
72
|
+
|
|
73
|
+
分類定義は、**「定義項目 / 内容」** の 2 列の表で記述します。
|
|
74
|
+
|
|
75
|
+
| 列名 | 説明 |
|
|
76
|
+
| ---------------- | -------------------------------------------------- |
|
|
77
|
+
| 対象エンティティ | 分類が属する業務上の主要対象(例:商品、顧客など) |
|
|
78
|
+
| 分類定義名 | 分類を表す項目(フィールド)名 |
|
|
79
|
+
| 種別 | 「業務分類」「コード表」「動的分類」のいずれか |
|
|
80
|
+
| 説明 | 分類が何を意味するか |
|
|
81
|
+
|
|
82
|
+
### 2.2 値一覧
|
|
83
|
+
|
|
84
|
+
値を持つ分類では、以下の列を基本とする。
|
|
85
|
+
|
|
86
|
+
| 列名 | 説明 |
|
|
87
|
+
| ------ | ------------------------------------------- |
|
|
88
|
+
| 値 | システム上の識別子。`lower-kebab-case` 推奨 |
|
|
89
|
+
| 分類名 | 正式名称。BDD/用語集と整合させる |
|
|
90
|
+
| 表示名 | UI や現場で使用される表示用名称 |
|
|
91
|
+
| 説明 | 値の意味・成立条件など |
|
|
92
|
+
|
|
93
|
+
## 3. 分類の種類別のルール
|
|
94
|
+
|
|
95
|
+
### 3.1 業務分類(Business Classification)
|
|
96
|
+
|
|
97
|
+
#### 特徴
|
|
98
|
+
|
|
99
|
+
- 業務ロジック上必然的に存在する分類
|
|
100
|
+
- 値は少数で固定的
|
|
101
|
+
- システム実装に強く依存しない
|
|
102
|
+
|
|
103
|
+
#### BDD での扱い
|
|
104
|
+
|
|
105
|
+
- 値が少ない場合は BDD の `type: enum` として記載してよい。
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
### 3.2 コード表(System Code List)
|
|
110
|
+
|
|
111
|
+
#### 特徴
|
|
112
|
+
|
|
113
|
+
- システム内で使用される **コード値の一覧**
|
|
114
|
+
- 多くの場合 **マスターテーブルとして管理すべき**
|
|
115
|
+
- 外部連携や識別子として利用される
|
|
116
|
+
|
|
117
|
+
#### マスターテーブル化すべき条件
|
|
118
|
+
|
|
119
|
+
以下のいずれかを満たす:
|
|
120
|
+
|
|
121
|
+
- 値が多い(10以上)
|
|
122
|
+
- 追加・変更・廃止の可能性がある
|
|
123
|
+
- 外部システム連携や帳票に必要
|
|
124
|
+
- 多言語化が必要
|
|
125
|
+
- BDD enum では収まらないメタ情報がある(例:税率、期間)
|
|
126
|
+
|
|
127
|
+
#### BDD enum で良いケース
|
|
128
|
+
|
|
129
|
+
- 値が3〜5個以下
|
|
130
|
+
- 業務ルールで固定されている
|
|
131
|
+
- ラベル変更の可能性が低い
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
### 3.3 動的分類(Dynamic Classification)
|
|
136
|
+
|
|
137
|
+
#### 特徴
|
|
138
|
+
|
|
139
|
+
- ユーザーが自由に追加・編集・削除可能
|
|
140
|
+
- タグ、ラベル、フォルダ分類などに用いられる
|
|
141
|
+
|
|
142
|
+
#### BDD の enum にしてはいけない
|
|
143
|
+
|
|
144
|
+
- 値の増減に対応できず仕様が破綻するため
|
|
145
|
+
|
|
146
|
+
#### BDD での扱い
|
|
147
|
+
|
|
148
|
+
- type: `string` または `reference` とする
|
|
149
|
+
|
|
150
|
+
#### 標準列
|
|
151
|
+
|
|
152
|
+
| 値 | 作成者 | 説明 |
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## 4. BDD との関係(重要)
|
|
157
|
+
|
|
158
|
+
| 分類種類 | BDD の扱い |
|
|
159
|
+
| -------- | ---------------------------- |
|
|
160
|
+
| 業務分類 | enum 可能 |
|
|
161
|
+
| コード表 | enum または マスターテーブル |
|
|
162
|
+
| 動的分類 | enum 禁止、別テーブルで管理 |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 5. サンプル(商品区分)
|
|
167
|
+
|
|
168
|
+
### 5.1 メタデータ
|
|
169
|
+
|
|
170
|
+
```yaml
|
|
171
|
+
---
|
|
172
|
+
id: cll-product-type
|
|
173
|
+
type: data
|
|
174
|
+
title: 商品区分
|
|
175
|
+
status: draft
|
|
176
|
+
supersedes: []
|
|
177
|
+
---
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### 5.2 分類定義
|
|
181
|
+
|
|
182
|
+
| 定義項目 | 内容 |
|
|
183
|
+
| ---------------- | ---------------------- |
|
|
184
|
+
| 対象エンティティ | 商品 |
|
|
185
|
+
| 分類定義名 | 商品区分 |
|
|
186
|
+
| 種別 | 業務分類 |
|
|
187
|
+
| 説明 | 商品の業務上の上位分類 |
|
|
188
|
+
|
|
189
|
+
### 5.3 値一覧
|
|
190
|
+
|
|
191
|
+
| 値 | 分類名 | 表示名 | 説明 |
|
|
192
|
+
| ----- | ------ | -------- | ---------- |
|
|
193
|
+
| snack | お菓子 | おやつ | 食品系商品 |
|
|
194
|
+
| toy | 玩具 | おもちゃ | 玩具類 |
|
|
195
|
+
| drink | 飲料 | ドリンク | 飲み物類 |
|