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,269 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:bps-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:bps-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 業務プロセス仕様書 作成ルール
|
|
12
|
+
|
|
13
|
+
Business Process Specification (BPS) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、業務分析・要求定義のために **業務プロセス仕様を統一形式で記述する標準ルール**です。
|
|
16
|
+
業務プロセス仕様は、概念データフローで定義された各プロセスについて、開始条件・手順・入出力・例外処理などを詳細に記述します。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- 対象は「業務上の単位処理(プロセス)」であり、**概念レベルの手順+判断ポイント+入出力**を明確化する。
|
|
21
|
+
- システムへの実装(例:物理テーブル名、SQL、UI操作、実装クラス/関数名)については記載しない(詳細は「9. 禁止事項」参照)。
|
|
22
|
+
- 1ファイル = 1 プロセスとし、複雑な場合は子業務プロセスへ分解する。
|
|
23
|
+
|
|
24
|
+
## 2. 用語定義
|
|
25
|
+
|
|
26
|
+
| 用語 | 定義 |
|
|
27
|
+
| ------------ | ----------------------------------------------------------------------------------------------------------------- |
|
|
28
|
+
| 業務プロセス | 業務イベントまたは条件を契機に起動し、明確な成果物/状態変化を生む処理単位 |
|
|
29
|
+
| トリガー | プロセスを開始させるイベント |
|
|
30
|
+
| 前提条件 | プロセス開始前に成立しているべき条件 |
|
|
31
|
+
| 入力 | プロセスが参照/取得するデータ(概念レベル)。業務データ辞書の論理名で参照、idを付与する場合は用語集の用語idで参照 |
|
|
32
|
+
| 処理 | 手順/判断の論理的なステップ。順序と分岐を含む |
|
|
33
|
+
| 出力 | プロセスが生成/更新/通知するデータ・イベント・状態変化 |
|
|
34
|
+
| 例外 | 異常/例外パス(入力不備・判定失敗・外部連携失敗等) |
|
|
35
|
+
|
|
36
|
+
## 3. ファイル命名・ID規則
|
|
37
|
+
|
|
38
|
+
- ファイル名: `bps-<番号>-<短い日本語名>.md` (例: `bps-0010-在庫不足検知.md`)
|
|
39
|
+
- Frontmatter:
|
|
40
|
+
- `id`: `bps-low-stock-detection` のように小文字ハイフン形式。
|
|
41
|
+
- `title`: 「在庫不足検知」など。
|
|
42
|
+
- 子業務プロセスへ分割する場合: `bps-low-stock-check`, `bps-low-stock-alert`などのidを付与し、子側で `part_of: [bps-low-stock-detection]` を指定します。
|
|
43
|
+
|
|
44
|
+
## 4. 推奨 Frontmatter 項目
|
|
45
|
+
|
|
46
|
+
| 項目 | 説明 | 必須 |
|
|
47
|
+
| ---------- | ------------------------------------- | ---- |
|
|
48
|
+
| id | プロセスID (bps-xxx-xxxx) | ○ |
|
|
49
|
+
| type | `domain` 固定 | ○ |
|
|
50
|
+
| title | プロセス名 | ○ |
|
|
51
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
52
|
+
| part_of | 親プロセスID(子プロセスの場合) | 任意 |
|
|
53
|
+
| based_on | 根拠となる仕様ID(BES/BEL/BR/UIS 等) | 任意 |
|
|
54
|
+
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
55
|
+
|
|
56
|
+
## 5. 本文構成(標準テンプレ)
|
|
57
|
+
|
|
58
|
+
各 BPS ファイルは以下見出しを順番に並べる。
|
|
59
|
+
|
|
60
|
+
1. 概要
|
|
61
|
+
2. トリガー
|
|
62
|
+
3. 前提条件
|
|
63
|
+
4. 入力
|
|
64
|
+
5. 処理
|
|
65
|
+
6. 出力
|
|
66
|
+
7. 例外 / 異常系
|
|
67
|
+
8. メモ / 将来課題
|
|
68
|
+
|
|
69
|
+
## 6. 記述ガイド詳細
|
|
70
|
+
|
|
71
|
+
### 6.1 概要
|
|
72
|
+
|
|
73
|
+
短い一文+業務プロセスの5W1Hをビジネス用語で書く。
|
|
74
|
+
|
|
75
|
+
### 6.2 トリガー
|
|
76
|
+
|
|
77
|
+
- 起点となる業務内容と業務イベント ID(bes-xxx-xxx)を列挙。
|
|
78
|
+
- 例: 商品の在庫数が更新された: 在庫数更新イベント(bes-stock-amount-updated)
|
|
79
|
+
- BEV(個別業務イベント仕様)が存在する場合は、イベントの「契約」(発行者/発生源/ペイロード/結果/主な購読先)は BES を参照し、BPS のトリガー/入力では **購読側(このプロセスが受ける)観点**で簡潔に記述します。
|
|
80
|
+
|
|
81
|
+
### 6.3 前提条件
|
|
82
|
+
|
|
83
|
+
- 開始前に真であるべき条件を列挙。例: 「対象商品が販売中状態」「店舗が営業中」等。
|
|
84
|
+
|
|
85
|
+
### 6.4 入力
|
|
86
|
+
|
|
87
|
+
- 業務データ辞書のエンティティ、論理名を列挙し、利用目的を簡潔に付記。
|
|
88
|
+
- 例: エンティティ:在庫、項目:発注点、目的:発注判定基準
|
|
89
|
+
- 必要に応じて用語集の用語ID(tm-xxx-xxx)を併記。
|
|
90
|
+
- 外部システム IF の場合は IF 仕様の ID を引用。
|
|
91
|
+
- イベントの付帯情報(ペイロード)は、BES があれば BES を正とし、BPS にはこのプロセスで参照する範囲を記述します。
|
|
92
|
+
|
|
93
|
+
### 6.5 処理
|
|
94
|
+
|
|
95
|
+
番号付き箇条書きで最小限のステップ。分岐は `if / else` ではなく日本語条件句。
|
|
96
|
+
|
|
97
|
+
例:
|
|
98
|
+
|
|
99
|
+
1. 定番商品以外は除外
|
|
100
|
+
2. 発注数量を計算(発注数量 = 注文毎の発注点 − 現在在庫数)
|
|
101
|
+
3. 発注数量 > 0 の場合、発注候補を生成
|
|
102
|
+
4. bes-order-candidate-generated「発注候補生成」イベントを発火
|
|
103
|
+
|
|
104
|
+
もしくは、複雑処理については、TypeScriptの擬似コードでロジックを示す。具体的には、
|
|
105
|
+
|
|
106
|
+
- 業務イベントを受けるハンドラとして書く
|
|
107
|
+
- 「イベント → 入力読み取り → BR呼び出し → イベント発火」のフローとする
|
|
108
|
+
- 商品を取得する や 発注候補生成イベントを発火する は、インフラ詳細に踏み込まず、概念レベルの名前だけに留める
|
|
109
|
+
|
|
110
|
+
例:
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
// トリガー: bes-stock-amount-updated「在庫数更新」イベント
|
|
114
|
+
type 在庫数更新イベント = {
|
|
115
|
+
商品ID: string;
|
|
116
|
+
新在庫数: number;
|
|
117
|
+
};
|
|
118
|
+
|
|
119
|
+
function 在庫数更新イベントを処理する(イベント: 在庫数更新イベント) {
|
|
120
|
+
const 商品 = 商品を取得する(イベント.商品ID); // 概念レベルでOK
|
|
121
|
+
const 在庫 = 在庫を取得する(イベント.商品ID);
|
|
122
|
+
if (!商品.定番商品フラグ) {
|
|
123
|
+
return; // 定番以外は自動発注対象外
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
// 以下はサンプルでビジネスルールを直書き
|
|
127
|
+
const 発注数量 = 商品.発注点 - 在庫.現在在庫数;
|
|
128
|
+
if (発注数量 > 0) {
|
|
129
|
+
const 発注候補 = {
|
|
130
|
+
商品ID: 商品.商品ID,
|
|
131
|
+
発注数量: 発注数量,
|
|
132
|
+
};
|
|
133
|
+
// 出力: bes-order-candidate-generated「発注候補生成」イベント発火
|
|
134
|
+
発注候補生成イベントを発火する(発注候補);
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### 6.6 出力
|
|
140
|
+
|
|
141
|
+
- 新規生成: レコード/イベント/通知。
|
|
142
|
+
- 更新: どの項目がどう変わるか(増減/ステータス変更)。
|
|
143
|
+
- 削除(あれば)。
|
|
144
|
+
|
|
145
|
+
### 6.7 例外 / 異常系
|
|
146
|
+
|
|
147
|
+
- 外部呼び出し失敗 / 入力欠損 / 矛盾(発注点 < 0)など。
|
|
148
|
+
- 失敗時挙動(再試行回数 / 中断 / 警告ログ / オペレーション通知)を記述。
|
|
149
|
+
|
|
150
|
+
### 6.8 メモ / 将来課題
|
|
151
|
+
|
|
152
|
+
既知の改善余地(閾値動的化、並行処理最適化など)。
|
|
153
|
+
|
|
154
|
+
## 7. 命名・記述スタイル
|
|
155
|
+
|
|
156
|
+
- プロセス名は「名詞+機能動詞」: 例 `在庫不足検知`, `自動発注候補生成`。
|
|
157
|
+
- ステップは簡潔に。禁止: 冗長なスクリーン操作列(「ページを開く→スクロール→クリック」)。
|
|
158
|
+
- 条件文は業務用語ベースで。「在庫数 − 予約数 < 発注点」などは式と意味を併記可。
|
|
159
|
+
- 受動態より能動態(「システムは候補を生成する」)。
|
|
160
|
+
|
|
161
|
+
## 8. 階層分解ガイド
|
|
162
|
+
|
|
163
|
+
| シグナル | 子業務プロセスへ分割検討 |
|
|
164
|
+
| ---------------- | ------------------------ |
|
|
165
|
+
| ステップ数が10超 | 冗長化・可読性低下 |
|
|
166
|
+
| 分岐が3種類以上 | 条件別プロセス分離 |
|
|
167
|
+
| 複数イベント混在 | イベント別に分割 |
|
|
168
|
+
| 出力が多種(>5) | 目的別再編 |
|
|
169
|
+
|
|
170
|
+
親子関係は、子プロセス側で `part_of` を指定します(親プロセス側に子を列挙しない)。
|
|
171
|
+
|
|
172
|
+
## 9. 禁止事項
|
|
173
|
+
|
|
174
|
+
| 項目 | 理由 |
|
|
175
|
+
| ---------------------------- | ------------------------------ |
|
|
176
|
+
| UI操作列の逐語的記述 | 可読性低下・設計変更に弱い |
|
|
177
|
+
| 物理テーブル名・SQL全文 | 概念レベル逸脱(DB設計に記述) |
|
|
178
|
+
| 画面レイアウト詳細 | 画面仕様へ委譲 |
|
|
179
|
+
| 機能要件以外の雑多な会話ログ | メンテ不能 |
|
|
180
|
+
| ビジネスルール重複記述 | 変更時不整合リスク |
|
|
181
|
+
| 未定義略語乱用 | 用語集との整合欠如 |
|
|
182
|
+
|
|
183
|
+
## 10. よくある誤りと対策
|
|
184
|
+
|
|
185
|
+
- 在庫不足判定ロジックをステップ内に長文記載 → BR 化して参照。
|
|
186
|
+
- 画面遷移記述を羅列 → 「トリガー」「出力」に要約。
|
|
187
|
+
- 外部 API エラー未記載 → 例外セクションで HTTP タイムアウト・再試行方針を明示。
|
|
188
|
+
|
|
189
|
+
## 11. サンプル(簡易)
|
|
190
|
+
|
|
191
|
+
````markdown
|
|
192
|
+
---
|
|
193
|
+
id: bps-order-candidate-generation
|
|
194
|
+
type: data
|
|
195
|
+
title: 発注候補生成
|
|
196
|
+
status: draft
|
|
197
|
+
part_of: []
|
|
198
|
+
based_on: [bes-stock-amount-updated]
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## 概要
|
|
202
|
+
|
|
203
|
+
在庫数が発注点を下回ったかどうかを判定し、発注候補を生成する。
|
|
204
|
+
|
|
205
|
+
## トリガー
|
|
206
|
+
|
|
207
|
+
- 商品の在庫数が更新された: 在庫数更新イベント(bes-stock-amount-updated)
|
|
208
|
+
|
|
209
|
+
## 前提条件
|
|
210
|
+
|
|
211
|
+
- 商品が販売可能状態
|
|
212
|
+
- 発注点 > 0
|
|
213
|
+
|
|
214
|
+
## 入力
|
|
215
|
+
|
|
216
|
+
- 更新があった在庫(tm-inventory)
|
|
217
|
+
|
|
218
|
+
## 処理
|
|
219
|
+
|
|
220
|
+
### 処理(ステップ例)
|
|
221
|
+
|
|
222
|
+
1. 定番商品以外は除外
|
|
223
|
+
2. 発注数量を計算(発注数量 = 注文毎の発注点 − 現在在庫数)
|
|
224
|
+
3. 発注数量 > 0 の場合、発注候補を生成
|
|
225
|
+
4. bes-order-candidate-generated「発注候補生成」イベントを発火
|
|
226
|
+
|
|
227
|
+
### 処理(擬似コード例)
|
|
228
|
+
|
|
229
|
+
```ts
|
|
230
|
+
// 例外処理は省略
|
|
231
|
+
// トリガー: bes-stock-amount-updated「在庫数更新」イベント
|
|
232
|
+
type 在庫数更新イベント = {
|
|
233
|
+
商品ID: string;
|
|
234
|
+
新在庫数: number;
|
|
235
|
+
};
|
|
236
|
+
|
|
237
|
+
function 在庫数更新イベントを処理する(イベント: 在庫数更新イベント) {
|
|
238
|
+
const 商品 = 商品を取得する(イベント.商品ID);
|
|
239
|
+
const 在庫 = 在庫を取得する(イベント.商品ID);
|
|
240
|
+
if (!商品.定番商品フラグ) {
|
|
241
|
+
return; // 定番以外は自動発注対象外
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
// 以下はサンプルでビジネスルールを直書き
|
|
245
|
+
const 発注数量 = 商品.発注点 - 在庫.現在在庫数;
|
|
246
|
+
if (発注数量 > 0) {
|
|
247
|
+
const 発注候補 = {
|
|
248
|
+
商品ID: 商品.商品ID,
|
|
249
|
+
発注数量: 発注数量,
|
|
250
|
+
};
|
|
251
|
+
// 出力: bes-order-candidate-generated「発注候補生成」イベント発火
|
|
252
|
+
発注候補生成イベントを発火する(発注候補);
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
## 出力
|
|
258
|
+
|
|
259
|
+
- 発注候補生成イベント発火(bes-order-candidate-generated)
|
|
260
|
+
|
|
261
|
+
## 例外
|
|
262
|
+
|
|
263
|
+
- 発注点未設定: ログ WARN, 商品スキップ
|
|
264
|
+
- 外部API遅延(商品取得失敗: 3回リトライ後失敗記録
|
|
265
|
+
|
|
266
|
+
## メモ
|
|
267
|
+
|
|
268
|
+
将来: 閾値を動的(曜日別)にする拡張検討。
|
|
269
|
+
````
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:br-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:br-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# ビジネスルール 作成ルール
|
|
12
|
+
|
|
13
|
+
Business Rule (BR) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、業務分析・要求定義のために **ビジネスルールを統一形式で記述する標準ルール**です。ビジネスルールは、複数の業務プロセス(BPS)から参照される横断的な判断・条件・計算ロジックを定義します。
|
|
16
|
+
|
|
17
|
+
## 1. 全体方針
|
|
18
|
+
|
|
19
|
+
- 対象は「判断・条件・計算ロジック」であり、**概念レベルの入力条件+判定結果(または出力)** を明確化する。
|
|
20
|
+
- 実装詳細(例: 物理テーブル名、SQL、UI操作、実装クラス/関数名)は記載しない(詳細は「9. 禁止事項」参照)。
|
|
21
|
+
- 1ファイル = 1 ビジネスルール。複雑な場合はサブルールへ分解し、親子関係はサブルール側の `part_of` で表現する。
|
|
22
|
+
|
|
23
|
+
## 2. 用語定義
|
|
24
|
+
|
|
25
|
+
| 用語 | 定義 |
|
|
26
|
+
| -------------- | -------------------------------------------------------------------- |
|
|
27
|
+
| ビジネスルール | 業務上の判断・制約・計算ロジック。複数プロセスで共通に参照される定義 |
|
|
28
|
+
| 入力 | ルールが参照する概念データ・前提条件 |
|
|
29
|
+
| 判定 | 真偽またはカテゴリ分類の結果 |
|
|
30
|
+
| 出力 | 計算値・カテゴリ・フラグなど、ルールの適用結果 |
|
|
31
|
+
| 例外 | 入力不備・矛盾・外部参照失敗など |
|
|
32
|
+
|
|
33
|
+
## 3. ファイル命名・ID規則
|
|
34
|
+
|
|
35
|
+
- ファイル名: `br-<番号>-<短い日本語名>.md` (例: `br-0010-在庫不足判定.md`)
|
|
36
|
+
- Frontmatter:
|
|
37
|
+
- `id`: `br-low-stock-judgment` のように小文字ハイフン形式。
|
|
38
|
+
- `title`: 「在庫不足判定」など。
|
|
39
|
+
- サブルールへ分割する場合: `br-low-stock-threshold`, `br-stock-reservation-deduction` などの id を付与し、サブルール側で `part_of: [br-low-stock-judgment]` を指定。
|
|
40
|
+
|
|
41
|
+
## 4. 推奨 Frontmatter 項目
|
|
42
|
+
|
|
43
|
+
| 項目 | 説明 | 必須 |
|
|
44
|
+
| ---- | ---- | ---- |
|
|
45
|
+
|
|
46
|
+
| id | ルールID (br-xxx-xxxx) | ○ |
|
|
47
|
+
| type | `rule` 固定 | ○ |
|
|
48
|
+
| title | ルール名 | ○ |
|
|
49
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
50
|
+
| part_of | 親ルールID(サブルールの場合) | 任意 |
|
|
51
|
+
| based_on | 根拠となる仕様ID(BPS/UIS/BEL/BES 等) | 任意 |
|
|
52
|
+
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
53
|
+
|
|
54
|
+
### NG/OK例(抜粋)
|
|
55
|
+
|
|
56
|
+
- NG例: `type: api`(列挙外), `id: BR_LowStock`(大文字/アンダースコアNG), `extra: foo`(未定義プロパティNG)
|
|
57
|
+
- OK例: `type: rule`, `id: br-low-stock-judgment`, `status: ready`
|
|
58
|
+
|
|
59
|
+
## 5. 本文構成(標準テンプレ)
|
|
60
|
+
|
|
61
|
+
各 BR ファイルは以下見出しを順番に並べる。
|
|
62
|
+
|
|
63
|
+
1. 概要
|
|
64
|
+
2. 入力
|
|
65
|
+
3. ルール(判定/計算)
|
|
66
|
+
4. 出力
|
|
67
|
+
5. 例外 / 異常系
|
|
68
|
+
6. メモ / 将来課題
|
|
69
|
+
|
|
70
|
+
## 6. 記述ガイド詳細
|
|
71
|
+
|
|
72
|
+
### 6.1 概要
|
|
73
|
+
|
|
74
|
+
短い一文で、何を判断/計算するルールかを業務用語で記述する。
|
|
75
|
+
|
|
76
|
+
### 6.2 入力
|
|
77
|
+
|
|
78
|
+
- 業務データ辞書のエンティティ・論理名を列挙し、利用目的を簡潔に付記。
|
|
79
|
+
- 例: エンティティ:在庫、項目:在庫数・予約数、目的:不足判定の基準
|
|
80
|
+
- 必要に応じて用語集の用語ID(tm-xxx-xxx)や外部 IF 仕様の ID を併記。
|
|
81
|
+
|
|
82
|
+
- 入力は概念レベルで記述する(詳細は「9. 禁止事項」参照)。
|
|
83
|
+
|
|
84
|
+
### 6.3 ルール(判定/計算)
|
|
85
|
+
|
|
86
|
+
- 箇条書きで条件式と意味をセットで記述する。
|
|
87
|
+
- 数式や条件式は業務用語に沿って表現し、必要なら TypeScript 風の擬似コードで補足してもよい。
|
|
88
|
+
|
|
89
|
+
例:
|
|
90
|
+
|
|
91
|
+
1. 不足判定: `在庫数 − 予約数 < 発注点` → 真なら不足
|
|
92
|
+
2. 優先度分類: 定番商品は高優先、季節商品は中優先、その他は低優先
|
|
93
|
+
|
|
94
|
+
擬似コード例:
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
type 商品 = { 商品ID: string; 定番: boolean; 発注点: number };
|
|
98
|
+
type 在庫 = { 商品ID: string; 在庫数: number; 予約数: number };
|
|
99
|
+
|
|
100
|
+
function 在庫不足判定(商品: 商品, 在庫: 在庫): boolean {
|
|
101
|
+
return 在庫.在庫数 - 在庫.予約数 < 商品.発注点;
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### 6.4 出力
|
|
106
|
+
|
|
107
|
+
- 判定結果(真偽/カテゴリ/数値)を列挙。
|
|
108
|
+
- 他プロセスが参照するための概念的な出力定義(例: 「不足フラグ」「優先度ランク」)。
|
|
109
|
+
|
|
110
|
+
### 6.5 例外 / 異常系
|
|
111
|
+
|
|
112
|
+
- 入力欠損・値の矛盾(発注点 < 0 等)・外部参照失敗など。
|
|
113
|
+
- 失敗時挙動(スキップ/再試行/警告ログ/オペ通知)を記述。
|
|
114
|
+
|
|
115
|
+
### 6.6 メモ / 将来課題
|
|
116
|
+
|
|
117
|
+
既知の改善余地(閾値動的化、季節要因考慮など)。
|
|
118
|
+
|
|
119
|
+
## 7. 命名・記述スタイル
|
|
120
|
+
|
|
121
|
+
- ルール名は「名詞+判断/計算」: 例 `在庫不足判定`, `発注優先度算定`。
|
|
122
|
+
- 条件は簡潔に(禁止事項は「9. 禁止事項」参照)。
|
|
123
|
+
- 数式は意味説明と併記し、業務用語で読み下せるようにする。
|
|
124
|
+
|
|
125
|
+
## 8. 階層分解ガイド
|
|
126
|
+
|
|
127
|
+
| シグナル | サブルールへ分割検討 |
|
|
128
|
+
| ---------------------- | -------------------- |
|
|
129
|
+
| 条件が5種以上 | ルール別に分離 |
|
|
130
|
+
| 出力が多種(>3) | 目的別再編 |
|
|
131
|
+
| 複数ドメインに跨る参照 | 参照境界で分割 |
|
|
132
|
+
|
|
133
|
+
親子関係は、サブルール側で `part_of` を指定します(親ルール側に子を列挙しない)。
|
|
134
|
+
|
|
135
|
+
## 9. 禁止事項
|
|
136
|
+
|
|
137
|
+
| 項目 | 理由 |
|
|
138
|
+
| ------------------------ | -------------------- |
|
|
139
|
+
| 物理テーブル名・SQL全文 | 概念レベル逸脱 |
|
|
140
|
+
| 画面操作手順 | 概念レベル逸脱 |
|
|
141
|
+
| 実装クラス・関数名の列挙 | 実装依存・メンテ不能 |
|
|
142
|
+
| ビジネスルール重複記述 | 変更時不整合リスク |
|
|
143
|
+
| 未定義略語乱用 | 用語集との整合欠如 |
|
|
144
|
+
|
|
145
|
+
## 10. よくある誤りと対策
|
|
146
|
+
|
|
147
|
+
- 複雑なロジックを長文で記述 → サブルールへ分割し参照。
|
|
148
|
+
- 物理データ項目を記載 → 概念データ辞書の論理名に置換。
|
|
149
|
+
- BPSの手順を流用 → 本ドキュメントでは判断・計算のみを記述。
|
|
150
|
+
|
|
151
|
+
## 11. サンプル(簡易)
|
|
152
|
+
|
|
153
|
+
```markdown
|
|
154
|
+
---
|
|
155
|
+
id: br-low-stock-judgment
|
|
156
|
+
type: rule
|
|
157
|
+
title: 在庫不足判定
|
|
158
|
+
status: draft
|
|
159
|
+
part_of: []
|
|
160
|
+
based_on: []
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 概要
|
|
164
|
+
|
|
165
|
+
在庫数から予約数を差し引いた有効在庫が発注点を下回るか判定する。
|
|
166
|
+
|
|
167
|
+
## 入力
|
|
168
|
+
|
|
169
|
+
- 在庫(在庫数・予約数)
|
|
170
|
+
- 商品(発注点)
|
|
171
|
+
|
|
172
|
+
## ルール(判定/計算)
|
|
173
|
+
|
|
174
|
+
1. `(在庫数 − 予約数) < 発注点` → 不足
|
|
175
|
+
|
|
176
|
+
## 出力
|
|
177
|
+
|
|
178
|
+
- 不足フラグ(boolean)
|
|
179
|
+
|
|
180
|
+
## 例外
|
|
181
|
+
|
|
182
|
+
- 発注点未設定: ログ WARN, 商品スキップ
|
|
183
|
+
|
|
184
|
+
## メモ
|
|
185
|
+
|
|
186
|
+
将来: 閾値を曜日別に動的化
|
|
187
|
+
```
|