specdojo 0.1.0 → 0.2.1
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 +142 -35
- 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 +990 -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 +54 -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 +33 -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 +56 -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 +472 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +163 -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 +121 -24
- package/templates/antigravity/README.md +35 -0
- package/templates/antigravity/exec-defaults-snippet.yaml +38 -0
- package/templates/antigravity/orchestrator.md +146 -0
- package/templates/antigravity/pm-members-snippet.yaml +55 -0
- 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/agents/specdojo-orchestrator.md +153 -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/codex/agents/specdojo-orchestrator.toml +154 -0
- package/templates/codex/orchestrator.md +146 -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/templates/opencode/agents/specdojo-orchestrator.md +193 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:bdd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: specdojo:bdd-sample
|
|
9
|
+
template: not-needed
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 業務データ辞書 作成ルール
|
|
13
|
+
|
|
14
|
+
Business Data Dictionary (BDD) Documentation Rules
|
|
15
|
+
|
|
16
|
+
本ドキュメントは、業務分析・要求定義・システム設計のために **業務データ辞書を記述する標準ルール**です。
|
|
17
|
+
業務上の管理単位(エンティティ)とその属性(項目)の論理名・物理名・説明・制約などを定義します。
|
|
18
|
+
データの意味や構造に関する共通理解を関係者間で図り、システム設計や実装の基礎情報として活用します。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
- 業務分析・要求定義・設計で共通利用する業務データ辞書を、YAMLで統一的に定義する。
|
|
23
|
+
- 業務上の管理単位(エンティティ)と属性(フィールド)の意味・制約・例値を、判断可能な粒度で記述する。
|
|
24
|
+
- 実装詳細の仕様書ではなく、業務概念とデータ定義の共通理解を形成するための基準文書として扱う。
|
|
25
|
+
|
|
26
|
+
## 2. 位置づけと用語定義
|
|
27
|
+
|
|
28
|
+
- 本ルールは `type: data` の成果物に適用する。
|
|
29
|
+
- `logical_name` は業務利用者が理解できる論理名、`physical_name` はDB列互換の物理名を指す。
|
|
30
|
+
- `glossary_term_id` は用語集との参照キー、`related_terms` は関連用語への補助参照を指す。
|
|
31
|
+
|
|
32
|
+
## 3. ファイル命名・ID規則
|
|
33
|
+
|
|
34
|
+
### 3.1. ID規約
|
|
35
|
+
|
|
36
|
+
- `id` は正規表現 `^bdd-[a-z0-9-]+$` に合致する一意IDを用いる。
|
|
37
|
+
- `type` は `domain` 固定とする。
|
|
38
|
+
- 置き換えがある場合は `supersedes` に旧IDを列挙する。
|
|
39
|
+
|
|
40
|
+
### 3.2. ファイル命名規約
|
|
41
|
+
|
|
42
|
+
- ファイルは YAML 形式(`.yaml`)で管理する。
|
|
43
|
+
|
|
44
|
+
- ファイル名は、idと同じ名称 `bdd-<term>.yaml` を推奨。日本語の場合は、`業務データ辞書-<用語>.yaml` のように、一貫性を持たせて命名する。
|
|
45
|
+
|
|
46
|
+
## 4. 推奨 Frontmatter 項目
|
|
47
|
+
|
|
48
|
+
Frontmatter と同等の以下の項目をYAMLドキュメントの先頭に必ず定義してください。
|
|
49
|
+
|
|
50
|
+
| 項目 | 説明 | 必須 |
|
|
51
|
+
| ---------- | ---------------------------------------- | ---- |
|
|
52
|
+
| id | データ辞書ID(`bdd-...`) | ○ |
|
|
53
|
+
| type | `domain` 固定 | ○ |
|
|
54
|
+
| title | ドキュメント名。表示ページの見出しになる | ○ |
|
|
55
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
56
|
+
| rulebook | `specdojo:bdd-rulebook` 固定 | ○ |
|
|
57
|
+
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
58
|
+
|
|
59
|
+
## 5. 本文構成(標準テンプレ)
|
|
60
|
+
|
|
61
|
+
| キー | 説明 | 必須 |
|
|
62
|
+
| ---- | ---- | ---- |
|
|
63
|
+
|
|
64
|
+
| entities | 業務データエンティティの一覧 | ○ |
|
|
65
|
+
|
|
66
|
+
### 5.1. entities の標準構成
|
|
67
|
+
|
|
68
|
+
| サブ項目 | 説明 | 必須 |
|
|
69
|
+
| ------------- | ---------------------------------- | ---- |
|
|
70
|
+
| logical_name | 業務上の論理名(日本語単数形) | ○ |
|
|
71
|
+
| physical_name | DB互換の物理名(lower_snake_case) | ○ |
|
|
72
|
+
|
|
73
|
+
| description | 業務データの説明 | 任意 |
|
|
74
|
+
|
|
75
|
+
| glossary_term_id | 用語集の用語ID | 任意 |
|
|
76
|
+
| related_terms | 関連用語IDリスト | 任意 |
|
|
77
|
+
| key_fields | キー項目(`physical_name` のリスト) | ○ |
|
|
78
|
+
|
|
79
|
+
| fields | 業務データフィールドの一覧 | ○ |
|
|
80
|
+
|
|
81
|
+
### 5.2. fields の標準構成
|
|
82
|
+
|
|
83
|
+
| サブ項目 | 説明 | 必須 |
|
|
84
|
+
| ------------- | ---------------------------------- | ---- |
|
|
85
|
+
| logical_name | 業務上の論理名(日本語単数形) | ○ |
|
|
86
|
+
| physical_name | DB互換の物理名(lower_snake_case) | ○ |
|
|
87
|
+
|
|
88
|
+
| glossary_term_id | 用語集の用語ID | 任意 |
|
|
89
|
+
| type | データ型(integer / string / boolean / date / datetime / enum / money) | ○ |
|
|
90
|
+
| description | フィールドの説明 | 任意 |
|
|
91
|
+
| unit | 単位(該当時) | 任意 |
|
|
92
|
+
| constraints | フィールドの制約条件 | 任意 |
|
|
93
|
+
| example | フィールドの例値 | 任意 |
|
|
94
|
+
|
|
95
|
+
### 5.3. constraints の標準構成
|
|
96
|
+
|
|
97
|
+
| サブ項目 | 説明 | 必須 |
|
|
98
|
+
| -------- | -------------------------------- | ---- |
|
|
99
|
+
| required | 必須入力かどうか(true / false) | 任意 |
|
|
100
|
+
| unique | 一意性制約(true / false) | 任意 |
|
|
101
|
+
| min | 最小値 | 任意 |
|
|
102
|
+
| max | 最大値 | 任意 |
|
|
103
|
+
| pattern | 正規表現パターン | 任意 |
|
|
104
|
+
|
|
105
|
+
## 6. 記述ガイド
|
|
106
|
+
|
|
107
|
+
### 6.1. 記述の基本方針
|
|
108
|
+
|
|
109
|
+
- 業務視点の論理名・説明を重視し、実装要素は必要最小限に留める。
|
|
110
|
+
- データ項目の意味・制約・例値・関連情報を簡潔かつ明確に記述する。
|
|
111
|
+
- エンティティ・項目の論理名と説明は、概念クラス図(CCD)と用語集(glossary)に整合させる。
|
|
112
|
+
|
|
113
|
+
### 6.2. 命名と参照の指針
|
|
114
|
+
|
|
115
|
+
- 論理名は日本語単数形で記載する。
|
|
116
|
+
- 物理名(`physical_name`)は entity / field とも lower_snake_case を用いる(例: `product_code`, `credit_balance`, `payment_status`)。
|
|
117
|
+
- アプリケーション(TypeScript等)で利用する場合は、`physical_name` を lowerCamelCase に変換して扱う。
|
|
118
|
+
- `key_fields` は `physical_name` を参照する。
|
|
119
|
+
- `glossary_term_id` は用語集で定義されたIDと一致させる。
|
|
120
|
+
|
|
121
|
+
### 6.3. enum の記述方法
|
|
122
|
+
|
|
123
|
+
- `type: enum` のフィールドは許容値を必ず明示する。
|
|
124
|
+
- 記述方式は次のいずれかを採用する。
|
|
125
|
+
- 簡易列挙: `allowed_values: [PENDING, PAID, CANCELED]`
|
|
126
|
+
- 詳細列挙: `allowed_values_detailed:` に `value` と `label` を持つ配列を記述する。
|
|
127
|
+
|
|
128
|
+
## 7. 禁止事項
|
|
129
|
+
|
|
130
|
+
- 技術的属性(`created_at`, `updated_at`, `deleted_at` など)を原則含めない。
|
|
131
|
+
- 実装都合のカラムや API 用の構造体をそのまま記載しない。
|
|
132
|
+
- 用語集や CCD と不整合な用語・IDを使わない。
|
|
133
|
+
- 物理名と論理名で英語・日本語を無秩序に混在させない。
|
|
134
|
+
- 意味が曖昧な説明や略語のみの記載をしない。
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:bds-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:bds-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 帳票仕様 作成ルール
|
|
12
|
+
|
|
13
|
+
Business Document Specification (BDS) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、業務分析・要求定義のために **帳票仕様を統一形式で記述する標準ルール**です。
|
|
16
|
+
|
|
17
|
+
帳票仕様は、業務ユーザーが利用する「出力物」(印刷物/PDF/CSV/Excel等)の内容を、**業務用語でレビュー可能な形**で定義します。
|
|
18
|
+
|
|
19
|
+
## 1. 全体方針
|
|
20
|
+
|
|
21
|
+
- 帳票は **業務ユーザー視点**で、目的・出力タイミング・表示項目・集計/算出を明確にします。
|
|
22
|
+
- 実装詳細(例: 物理テーブル名・物理カラム名・SQL全文、実装クラス/関数名、テンプレートエンジンやライブラリ名)は記載しません。
|
|
23
|
+
- 1ファイル = 1帳票。
|
|
24
|
+
|
|
25
|
+
## 2. 用語定義
|
|
26
|
+
|
|
27
|
+
| 用語 | 定義 |
|
|
28
|
+
| --------- | -------------------------------------------------------------------- |
|
|
29
|
+
| 帳票 | 業務で利用する出力物(印刷物/PDF/CSV/Excel/画面出力等) |
|
|
30
|
+
| 表示項目 | 帳票に出力される項目(ヘッダ、明細、フッタ、集計値、注記等) |
|
|
31
|
+
| 抽出条件 | 対象データの範囲を決める条件(期間、店舗、状態、担当者等) |
|
|
32
|
+
| 集計/算出 | 帳票内で計算・集計される値(合計、平均、税、差額、件数、グループ化) |
|
|
33
|
+
| 出力形式 | PDF/CSV/Excel/印刷/画面など、提供するファイル/媒体と形式 |
|
|
34
|
+
| 配布/配信 | ダウンロード、メール送付、印刷、外部システム連携などの提供方法 |
|
|
35
|
+
|
|
36
|
+
## 3. ファイル命名・ID規則
|
|
37
|
+
|
|
38
|
+
- ファイル名: `bds-<番号>-<短い日本語名>.md`(例: `bds-0010-日次売上サマリ.md`)
|
|
39
|
+
- Frontmatter:
|
|
40
|
+
- `id`: `bds-daily-sales-summary` のように小文字ハイフン形式
|
|
41
|
+
- `title`: 「日次売上サマリ」などの帳票名
|
|
42
|
+
|
|
43
|
+
## 4. 推奨 Frontmatter 項目
|
|
44
|
+
|
|
45
|
+
Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` の制約に従います。
|
|
46
|
+
|
|
47
|
+
| 項目 | 説明 | 必須 |
|
|
48
|
+
| ---- | ------------------- | ---- |
|
|
49
|
+
| id | 帳票ID(`bds-...`) | ○ |
|
|
50
|
+
|
|
51
|
+
| type | `domain` 固定 | ○ |
|
|
52
|
+
| title | 帳票名 | ○ |
|
|
53
|
+
|
|
54
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
55
|
+
| based_on | 根拠となる仕様ID(BPS/UIS/BR/BES 等) | 任意 |
|
|
56
|
+
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
57
|
+
|
|
58
|
+
### 4.1 ID規約
|
|
59
|
+
|
|
60
|
+
- BDS の `id` は正規表現 `^bds-[a-z0-9-]+$` に合致する一意IDを使用します。
|
|
61
|
+
- `type: data` は業務ドメイン仕様(業務側の合意対象)であることを示します。
|
|
62
|
+
|
|
63
|
+
## 5. 本文構成(標準テンプレ)
|
|
64
|
+
|
|
65
|
+
各 BDS ファイルは以下見出しを順番に並べます。
|
|
66
|
+
|
|
67
|
+
1. 概要
|
|
68
|
+
2. 利用者/利用目的
|
|
69
|
+
3. 出力タイミング/トリガー
|
|
70
|
+
4. 出力形式/配布・配信
|
|
71
|
+
5. 抽出条件/対象範囲
|
|
72
|
+
6. 表示項目
|
|
73
|
+
7. 集計/算出ルール
|
|
74
|
+
8. 例外/注意事項
|
|
75
|
+
9. メモ / 将来課題
|
|
76
|
+
|
|
77
|
+
## 6. 記述ガイド詳細
|
|
78
|
+
|
|
79
|
+
### 6.1 概要
|
|
80
|
+
|
|
81
|
+
1〜3文で「この帳票が何を示すか」を業務用語で記述します。
|
|
82
|
+
|
|
83
|
+
### 6.2 利用者/利用目的
|
|
84
|
+
|
|
85
|
+
- 利用者(例: 店主、経理担当、バイヤー)
|
|
86
|
+
- 利用目的(例: 日次の売上状況を把握し、翌日の発注判断に使う)
|
|
87
|
+
|
|
88
|
+
### 6.3 出力タイミング/トリガー
|
|
89
|
+
|
|
90
|
+
- 出力の契機(例: 日次締め、会計確定、手動出力、バッチ)
|
|
91
|
+
- 対象期間の基準(営業日、締め日時、会計確定日時など)
|
|
92
|
+
|
|
93
|
+
### 6.4 出力形式/配布・配信
|
|
94
|
+
|
|
95
|
+
- 出力形式(PDF/CSV/Excel/印刷/画面)を明示します。
|
|
96
|
+
- 配布・配信(ダウンロード、メール送付、印刷、外部連携)を明示します。
|
|
97
|
+
- CSV 等のエクスポートがある場合は、- 文字コード(例: UTF-8)- ヘッダ行の有無 - 区切り文字(例: カンマ)
|
|
98
|
+
を記載します(ただし実装ライブラリ名等は不要)。
|
|
99
|
+
|
|
100
|
+
### 6.5 抽出条件/対象範囲
|
|
101
|
+
|
|
102
|
+
- 対象となるデータの範囲(期間、店舗、担当者、ステータス等)を列挙します。
|
|
103
|
+
- 除外条件(取消は除外、締め済みのみ対象 等)があれば明記します。
|
|
104
|
+
|
|
105
|
+
### 6.6 表示項目
|
|
106
|
+
|
|
107
|
+
表示項目は表(Markdown table)で列挙します。レイアウト指定はせず、**何が出力されるか**を記述します。
|
|
108
|
+
|
|
109
|
+
推奨フォーマット:
|
|
110
|
+
|
|
111
|
+
| No | 区分 | 項目名 | 意味/定義 | 型・書式 | 出力例 | 備考 |
|
|
112
|
+
| --- | ------ | ------ | ---------- | -------- | ---------- | ---- |
|
|
113
|
+
| 1 | ヘッダ | 出力日 | 帳票生成日 | date | 2025-12-20 | - |
|
|
114
|
+
|
|
115
|
+
補足:
|
|
116
|
+
|
|
117
|
+
- 「区分」は必要に応じて `ヘッダ/明細/フッタ` 等を使い分けます(不要なら省略してもよい)。
|
|
118
|
+
- 項目の意味が用語集にある場合は、備考に `tm-...` を併記して整合性を保ちます。
|
|
119
|
+
|
|
120
|
+
### 6.7 集計/算出ルール
|
|
121
|
+
|
|
122
|
+
- 集計単位(店舗別、商品別、日別など)とグルーピング条件を明確にします。
|
|
123
|
+
- 算出式は、業務上の意味が分かる形で記述します(例: 「売上合計 = 数量 × 単価 の合計」)。
|
|
124
|
+
- 端数処理、税の扱い、丸め(四捨五入/切り捨て/切り上げ)は明記します。
|
|
125
|
+
|
|
126
|
+
### 6.8 例外/注意事項
|
|
127
|
+
|
|
128
|
+
代表的な 2〜6 個の注意点(0件、権限不足、締め前/締め後の違い、欠損データ等)を列挙します。
|
|
129
|
+
|
|
130
|
+
## 7. 命名・記述スタイル
|
|
131
|
+
|
|
132
|
+
- 帳票名は「対象 + 観点 + 粒度」: 例 `日次売上サマリ`, `商品別粗利一覧`, `発注候補リスト`
|
|
133
|
+
- 記述は「業務用語」を優先し、略語は用語集にあるもののみ使用します。
|
|
134
|
+
|
|
135
|
+
## 8. 禁止事項
|
|
136
|
+
|
|
137
|
+
| 項目 | 理由 |
|
|
138
|
+
| ------------------------------------- | ---------------------------------- |
|
|
139
|
+
| 物理テーブル名・物理カラム名・SQL全文 | 概念レベル逸脱(DB設計に記述) |
|
|
140
|
+
| 実装クラス/関数名、ライブラリ名 | 実装依存で変更に弱い |
|
|
141
|
+
| レイアウト/座標/ピクセル指定 | 要求定義段階で過剰、変更に弱い |
|
|
142
|
+
| クリック手順の逐語列挙 | UI変更に弱い(必要なら UI 仕様へ) |
|
|
143
|
+
| 「正しく出る」等の曖昧表現 | 検証不能 |
|
|
144
|
+
|
|
145
|
+
## 9. よくある誤りと対策
|
|
146
|
+
|
|
147
|
+
- 「どのDBから取るか」を書いてしまう → 「どの業務データを出力するか」に置き換える。
|
|
148
|
+
- 表示項目が列挙だけで目的が不明 → 「利用者/利用目的」を先に明確化する。
|
|
149
|
+
- 集計が曖昧(合計/税/端数) → 集計単位・端数処理・税の扱いを明記する。
|
|
150
|
+
|
|
151
|
+
## 10. サンプル(簡易)
|
|
152
|
+
|
|
153
|
+
```markdown
|
|
154
|
+
---
|
|
155
|
+
id: bds-daily-sales-summary
|
|
156
|
+
type: data
|
|
157
|
+
title: 日次売上サマリ
|
|
158
|
+
status: draft
|
|
159
|
+
part_of: []
|
|
160
|
+
based_on: [bps-closing-daily, uis-closing, bes-sale-checkout]
|
|
161
|
+
supersedes: []
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## 概要
|
|
165
|
+
|
|
166
|
+
営業日ごとの売上合計と内訳を確認するための帳票。
|
|
167
|
+
|
|
168
|
+
## 利用者/利用目的
|
|
169
|
+
|
|
170
|
+
- 利用者: 店主、経理担当
|
|
171
|
+
- 利用目的: 日次の売上状況を把握し、締め処理の確認に使う
|
|
172
|
+
|
|
173
|
+
## 出力タイミング/トリガー
|
|
174
|
+
|
|
175
|
+
- 日次締め処理の完了後に出力できる
|
|
176
|
+
- 手動出力(必要に応じて再出力可)
|
|
177
|
+
|
|
178
|
+
## 出力形式/配布・配信
|
|
179
|
+
|
|
180
|
+
- 画面表示とPDFダウンロード
|
|
181
|
+
|
|
182
|
+
## 抽出条件/対象範囲
|
|
183
|
+
|
|
184
|
+
- 対象期間: 指定した営業日(1日)
|
|
185
|
+
- 対象店舗: ログインユーザーの所属店舗
|
|
186
|
+
|
|
187
|
+
## 表示項目
|
|
188
|
+
|
|
189
|
+
| No | 区分 | 項目名 | 意味/定義 | 型・書式 | 出力例 | 備考 |
|
|
190
|
+
| --- | ------ | -------- | ---------------------- | ---------------- | ---------- | ------------------- |
|
|
191
|
+
| 1 | ヘッダ | 営業日 | 集計対象の営業日 | date(YYYY-MM-DD) | 2025-12-19 | - |
|
|
192
|
+
| 2 | 明細 | 売上合計 | 当日の売上合計 | integer(円) | 12345 | 税抜/税込は別ルール |
|
|
193
|
+
| 3 | 明細 | 取引件数 | 会計確定した取引の件数 | integer | 42 | - |
|
|
194
|
+
|
|
195
|
+
## 集計/算出ルール
|
|
196
|
+
|
|
197
|
+
- 売上合計: 会計確定した取引の合計
|
|
198
|
+
- 端数処理: 税計算の端数は切り捨て(br-tax-rounding に従う)
|
|
199
|
+
|
|
200
|
+
## 例外/注意事項
|
|
201
|
+
|
|
202
|
+
- 取引が0件の場合でも帳票は出力できる(売上合計=0、取引件数=0)
|
|
203
|
+
|
|
204
|
+
## メモ / 将来課題
|
|
205
|
+
|
|
206
|
+
- 将来: 商品カテゴリ別の内訳を追加検討
|
|
207
|
+
```
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:bes-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: undecided
|
|
8
|
+
sample: specdojo:bes-index-sample
|
|
9
|
+
template: undecided
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 業務イベント仕様 全体構成 作成ルール
|
|
13
|
+
|
|
14
|
+
Business Event Specification Index (BES Index) Documentation Rules
|
|
15
|
+
|
|
16
|
+
業務で発生する主要イベント(販売、仕入、在庫調整など)を一覧化し、後続の BPS・BR・UI・テスト仕様と追跡可能につなぐための作成ルールを定義する。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- 業務イベントは「業務的に意味のある出来事」の一覧として整理し、実装設計ではなく概念レベルで記述する。
|
|
21
|
+
- 一覧は後工程(BPS / BR / UI / テスト)の参照元として扱い、イベントIDの一意性と可読性を優先する。
|
|
22
|
+
- 複雑なイベントは個別 BES へ分離し、一覧から相対リンクで辿れる構成を維持する。
|
|
23
|
+
|
|
24
|
+
## 2. 位置づけと用語定義
|
|
25
|
+
|
|
26
|
+
- 本ルールの対象は「業務イベント / 業務イベント仕様 全体構成(`bes-index`)」である。
|
|
27
|
+
- **イベントID** は一覧表の各行を一意に識別するIDで、`bes-<領域>-<短い英字>` を推奨する。
|
|
28
|
+
- **事実データ** はイベント発生時点で観測できる情報(ペイロード)の概念項目を指す。
|
|
29
|
+
|
|
30
|
+
## 3. ファイル命名・ID規則
|
|
31
|
+
|
|
32
|
+
### 3.1. ID規約
|
|
33
|
+
|
|
34
|
+
- 一覧ドキュメント自体の `id` は `bes-index` を推奨する。
|
|
35
|
+
- 一覧表のイベントIDは `^bes-[a-z0-9][a-z0-9-]*$` に合致する一意IDを用いる。
|
|
36
|
+
- 個別 BES ドキュメントを作成する場合、イベントIDとファイル名を対応させる(例: `bes-sale-checkout` ↔ `bes-sale-checkout.md`)。
|
|
37
|
+
|
|
38
|
+
### 3.2. ファイル命名規約
|
|
39
|
+
|
|
40
|
+
- 対象ドキュメントのファイル名は `bes-index.md` を推奨する。
|
|
41
|
+
- 個別イベント仕様のファイル名は `bes-<term>.md` を推奨する。
|
|
42
|
+
- 相対リンクで一覧から個別仕様へ遷移できる命名・配置を維持する。
|
|
43
|
+
|
|
44
|
+
## 4. 推奨 Frontmatter 項目
|
|
45
|
+
|
|
46
|
+
| 項目 | 説明 | 必須 |
|
|
47
|
+
| ------------ | ---------------------------------- | ---- |
|
|
48
|
+
| `id` | ドキュメントID(例: `bes-index`) | ○ |
|
|
49
|
+
| `type` | `project` を推奨(メタ仕様に従う) | ○ |
|
|
50
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
51
|
+
| `rulebook` | `specdojo:bes-index-rulebook` | 任意 |
|
|
52
|
+
| `supersedes` | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
53
|
+
|
|
54
|
+
## 5. 本文構成(標準テンプレ)
|
|
55
|
+
|
|
56
|
+
| 章 | 内容 | 必須 |
|
|
57
|
+
| --- | ---------------------- | ---- |
|
|
58
|
+
| 1 | 業務イベント一覧(表) | ○ |
|
|
59
|
+
|
|
60
|
+
### 5.1. 業務イベント一覧の標準列
|
|
61
|
+
|
|
62
|
+
| 列名 | 説明 | 必須 |
|
|
63
|
+
| ------------ | ------------------------------------- | ---- |
|
|
64
|
+
| イベントID | 一意識別子(例: `bes-sale-checkout`) | ○ |
|
|
65
|
+
| イベント名 | 業務ユーザーが理解可能な日本語名 | ○ |
|
|
66
|
+
| 何が起きたか | 業務的出来事を一文で記述 | ○ |
|
|
67
|
+
| いつ | 発生タイミング・周期 | ○ |
|
|
68
|
+
| 誰が/何が | 人・システム・外部の起点 | ○ |
|
|
69
|
+
| 発生条件 | 観測条件・成立条件 | ○ |
|
|
70
|
+
| 事実データ | 観測可能情報(概念レベル) | ○ |
|
|
71
|
+
|
|
72
|
+
### 5.2. 列順ルール
|
|
73
|
+
|
|
74
|
+
- 列順は次を固定する。
|
|
75
|
+
- イベントID → イベント名 → 何が起きたか → いつ → 誰が/何が → 発生条件 → 事実データ
|
|
76
|
+
|
|
77
|
+
## 6. 記述ガイド
|
|
78
|
+
|
|
79
|
+
### 6.1. 一覧記述の基本
|
|
80
|
+
|
|
81
|
+
- 一覧は表形式で記載する。
|
|
82
|
+
- 「何が起きたか」「いつ」「誰が/何が」「発生条件」は1セル1文の短文を基本とする。
|
|
83
|
+
- 事実データは実装カラム名ではなく業務概念名で列挙する。
|
|
84
|
+
|
|
85
|
+
### 6.2. リンクと責務分離
|
|
86
|
+
|
|
87
|
+
- 個別 BES を作成する場合、一覧のイベントIDを相対リンクとして記載する。
|
|
88
|
+
- イベントと業務プロセスは独立に管理し、起動関係は BPS 側で記述する。
|
|
89
|
+
- 用語は BPS / BR / UI / 用語集と整合する語彙を用いる。
|
|
90
|
+
|
|
91
|
+
### 6.3. ID・命名運用
|
|
92
|
+
|
|
93
|
+
- イベントIDは再利用せず、廃止時は置き換え関係を明示する。
|
|
94
|
+
- 略語は業務用語集で一般的に通用するもののみ使用する。
|
|
95
|
+
- 意味が推測しづらい内部コードはID・イベント名に使わない。
|
|
96
|
+
|
|
97
|
+
## 7. 禁止事項
|
|
98
|
+
|
|
99
|
+
- 物理テーブル名・物理カラム名・SQL全文を記載しない。
|
|
100
|
+
- 実装クラス名・関数名・API実装詳細を記載しない。
|
|
101
|
+
- UI操作手順(クリック列挙など)を一覧に混在させない。
|
|
102
|
+
- 曖昧語(その他、適宜など)を多用しない。
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:bes-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:bes-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 業務イベント仕様 作成ルール
|
|
12
|
+
|
|
13
|
+
Business Event Specification (BES) Documentation Rules
|
|
14
|
+
|
|
15
|
+
BES は、BEL(業務イベント一覧)の各イベントについて、**重要/複雑なものだけ** を詳細化するための仕様です。
|
|
16
|
+
|
|
17
|
+
## 1. 位置づけ
|
|
18
|
+
|
|
19
|
+
- BEL: イベントを網羅する一覧(表)
|
|
20
|
+
- BES: イベント1件の記述を **責務の範囲で** 最小限に明確化(何が起きたか/いつ/誰が・何が/発生条件/事実データ)
|
|
21
|
+
- BPS: イベントを契機に動く業務プロセスの手順(詳細手順ガイドは BPS 側に寄せる)
|
|
22
|
+
- BR: 判断/計算ロジック(BES には直書きせず、必要なら `implements` で参照)
|
|
23
|
+
|
|
24
|
+
## 2. いつ BES を作るか
|
|
25
|
+
|
|
26
|
+
次のいずれかに当てはまる場合に作成します。
|
|
27
|
+
|
|
28
|
+
前提:
|
|
29
|
+
|
|
30
|
+
- BES の本文は「何が起きたか / いつ / 誰が/何が / 発生条件 / 事実データ」の **事実(観測)** に限定します。
|
|
31
|
+
- それでも、BEL の 1 行だけでは **解釈が割れやすい**(= 後工程が迷う)場合があり、そのとき BES を作成します。
|
|
32
|
+
|
|
33
|
+
判断基準(BEL 1 行では足りないサイン):
|
|
34
|
+
|
|
35
|
+
- **何が起きたか** の解釈が割れる(例: 「確定」「受付」「取消」「訂正」「差戻し」など、事実の境界が曖昧)
|
|
36
|
+
- **いつ** の基準が割れる(例: 入力時/承認時/締め処理時/外部応答時 のどれを指すかが曖昧)
|
|
37
|
+
- **誰が/何が** が混在して割れる(例: 人の操作/システム自動/外部起点が混ざり、起点が一意にならない)
|
|
38
|
+
- **発生条件** が複数パターンで揉める(例: 部分返品、分割納品、在庫差異の許容、締め済みへの訂正など)
|
|
39
|
+
- **事実データ** の範囲が合意できない(例: ID体系、金額内訳、訂正元ID、理由の必須性、個人情報の含有可否など)
|
|
40
|
+
|
|
41
|
+
目安:
|
|
42
|
+
|
|
43
|
+
- 重要な「確定」を伴う出来事(売上確定/在庫確定/会計確定など)は、上記の曖昧さが起きやすいため BES 化を優先検討します。
|
|
44
|
+
|
|
45
|
+
### 2.1 BEL からのリンク
|
|
46
|
+
|
|
47
|
+
個別 BES を作成したら、対応する BEL の一覧表で **イベントIDをBESファイルへのリンク** に更新します。
|
|
48
|
+
|
|
49
|
+
- 例(例示はコード表記): `[bes-sale-checkout](./bes-sale-checkout.md)`
|
|
50
|
+
|
|
51
|
+
## 3. メタデータ(Frontmatter)
|
|
52
|
+
|
|
53
|
+
Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` の制約に従います。
|
|
54
|
+
|
|
55
|
+
| 項目 | 説明 | 必須 |
|
|
56
|
+
| ---- | --------------------------------- | ---- |
|
|
57
|
+
| id | BES ID(例: `bes-sale-checkout`) | ○ |
|
|
58
|
+
|
|
59
|
+
| type | `domain` 固定 | ○ |
|
|
60
|
+
| title | 業務イベント名(例: 業務イベント: 会計確定(販売)) | ○ |
|
|
61
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
62
|
+
| based_on | 根拠となる仕様ID(BEL/UIS/BPS 等) | 任意 |
|
|
63
|
+
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
64
|
+
|
|
65
|
+
### 3.1 ID規約
|
|
66
|
+
|
|
67
|
+
- BES ID は `bes-...` の形式を推奨します(例: `bes-sale-checkout`)。
|
|
68
|
+
- `type: data` は業務ドメイン仕様であることを示します。
|
|
69
|
+
|
|
70
|
+
## 4. 本文テンプレ(最小)
|
|
71
|
+
|
|
72
|
+
BES の責務は次に **限定** し、各項目を見出しとしてこの順序で記述します。
|
|
73
|
+
|
|
74
|
+
1. 何が起きたか
|
|
75
|
+
2. いつ
|
|
76
|
+
3. 誰が/何が
|
|
77
|
+
4. 発生条件
|
|
78
|
+
5. 事実データ
|
|
79
|
+
|
|
80
|
+
補足:
|
|
81
|
+
|
|
82
|
+
- 結果(出力/状態変化/通知)や例外、購読先、詳細手順は BES の責務外です。必要なら BPS(業務プロセス仕様)側で扱います。
|
|
83
|
+
- イベントとプロセスは独立に保ち、起動関係は BPS(業務プロセス仕様)側で記載します。
|
|
84
|
+
|
|
85
|
+
## 5. 禁止事項
|
|
86
|
+
|
|
87
|
+
| 項目 | 理由 |
|
|
88
|
+
| ------------------------------------------ | ---------------------- |
|
|
89
|
+
| 物理テーブル名・物理カラム名・SQL全文 | 概念レベル逸脱 |
|
|
90
|
+
| 実装クラス/関数名・APIの実装詳細 | 実装依存で変更に弱い |
|
|
91
|
+
| UIコンポーネント名、クリック手順の逐語列挙 | UI変更に弱い |
|
|
92
|
+
| BRのロジックを本文に重複記載 | 変更時に不整合が起きる |
|
|
93
|
+
|
|
94
|
+
## 6. サンプル(最小)
|
|
95
|
+
|
|
96
|
+
```markdown
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
id: bes-sale-checkout
|
|
100
|
+
type: data
|
|
101
|
+
title: 業務イベント: 会計確定(販売)
|
|
102
|
+
status: draft
|
|
103
|
+
part_of: []
|
|
104
|
+
based_on:
|
|
105
|
+
- bel-sale
|
|
106
|
+
- uis-sale
|
|
107
|
+
supersedes: []
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 1. 何が起きたか
|
|
111
|
+
|
|
112
|
+
- 販売の会計が確定した。
|
|
113
|
+
|
|
114
|
+
## 2. いつ
|
|
115
|
+
|
|
116
|
+
- 会計確定操作の実行時。
|
|
117
|
+
|
|
118
|
+
## 3. 誰が/何が
|
|
119
|
+
|
|
120
|
+
- 店員(人)。
|
|
121
|
+
|
|
122
|
+
## 4. 発生条件
|
|
123
|
+
|
|
124
|
+
- 対象の取引が確定可能な状態である。
|
|
125
|
+
|
|
126
|
+
## 5. 事実データ
|
|
127
|
+
|
|
128
|
+
- 取引ID
|
|
129
|
+
- 明細(商品、数量、単価 等)
|
|
130
|
+
- 支払情報(支払方法、受領金額 等)
|
|
131
|
+
```
|