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,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:stsd-mermaid-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: specdojo:stsd-sample
|
|
9
|
+
template: not-needed
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# STSD の状態遷移図を Mermaid で記述するルール
|
|
15
|
+
|
|
16
|
+
Mermaid State Diagram Rulebook for Status Definitions
|
|
17
|
+
|
|
18
|
+
STSD の「状態遷移図」を Mermaid の `stateDiagram-v2` で一貫して記述するための記法ルールです。状態の意味と成立条件は同じ STSD の「状態一覧」、各遷移の詳細は「遷移の説明」を正本とします。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
- 一つの図は一つの業務対象の状態遷移だけを扱います。
|
|
23
|
+
- 状態ラベルは STSD の状態一覧にある状態名と完全一致させます。
|
|
24
|
+
- 遷移ラベルは業務イベントと条件を示し、実装フラグ、関数、画面ページを使いません。
|
|
25
|
+
- 図は遷移の全体像を示し、状態の意味や条件の長い説明は図中へ埋め込みません。
|
|
26
|
+
|
|
27
|
+
## 2. 位置づけと用語定義
|
|
28
|
+
|
|
29
|
+
| 用語 | 定義 |
|
|
30
|
+
| ---------- | --------------------------------------------------------------------------------------------- |
|
|
31
|
+
| 状態 | STSD の状態一覧に定義された業務状態 |
|
|
32
|
+
| 表示名 | 図上に表示する状態名。STSD の状態一覧にある状態名と完全一致させる |
|
|
33
|
+
| `state_id` | Mermaid コード内で状態を参照する内部 ID。表示名に空白や記号がある場合に表示名と分けて使用する |
|
|
34
|
+
| 別名 | 状態一覧の状態名とは異なる表示名。同一状態の表示名変更を指し、本 rulebook では使用しない |
|
|
35
|
+
| 初期点 | ライフサイクルの開始を示す `[*]` |
|
|
36
|
+
| 終了点 | ライフサイクルの終了を示す `[*]` |
|
|
37
|
+
| 遷移 | `遷移元 --> 遷移先 : イベント / 条件` で示す状態変化 |
|
|
38
|
+
|
|
39
|
+
分岐は疑似状態を置かず、同じ遷移元から出る複数の遷移として表します。遷移元と遷移先に使用できるのは、状態一覧にある業務状態と初期点・終了点だけです。
|
|
40
|
+
|
|
41
|
+
## 3. ファイル命名・ID規則
|
|
42
|
+
|
|
43
|
+
- 本 rulebook 単独の成果物は作成せず、`stsd-<term>.md` の「状態遷移図」に適用します。
|
|
44
|
+
- 状態名は日本語の名詞句にし、STSD の状態一覧と同じ表記を使います。
|
|
45
|
+
- イベント名は短い業務用語、条件は業務上判定可能な事実で記述します。
|
|
46
|
+
- 表示名と Mermaid 内部 ID を分ける必要がある場合は `state "表示名" as state_id` を使い、表示名を状態一覧へ一致させます。これは別名ではありません。`state_id` は英小文字で始まる英小文字・数字・アンダースコアだけの `[a-z][a-z0-9_]*` とし、一つの Mermaid コードブロック内で一意にします。
|
|
47
|
+
- 図を分割して同じ状態を複数図へ再掲する場合は、各図で `state "表示名" as state_id` を宣言し、同じ表示名と同じ `state_id` を維持します。分割図ごとに別名や異なる `state_id` を付けません。
|
|
48
|
+
|
|
49
|
+
## 4. 推奨 Frontmatter 項目
|
|
50
|
+
|
|
51
|
+
この記法ルールは STSD の一章へ包含されるため、独自の Frontmatter 項目を追加しません。STSD の `rulebook`、`status`、`based_on` などをそのまま使用します。
|
|
52
|
+
|
|
53
|
+
## 5. 本文要件
|
|
54
|
+
|
|
55
|
+
| 要素 | 必須 | 記述 |
|
|
56
|
+
| ---------- | ---- | -------------------------------------------------------------------- |
|
|
57
|
+
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする |
|
|
58
|
+
| 業務状態 | ○ | 状態一覧にある状態名だけを使用する |
|
|
59
|
+
| 遷移ラベル | ○ | `イベント / 条件` を記載する |
|
|
60
|
+
| 初期点 | ○ | `[*] --> 初期状態 : イベント / 条件` で示す |
|
|
61
|
+
| 終了点 | 任意 | 業務上の終了がある場合に `終了状態 --> [*] : イベント / 条件` で示す |
|
|
62
|
+
|
|
63
|
+
初期点は省略しません。終了点を省略する場合は、STSD の「概要」で継続的な状態管理である理由と、対象範囲の終了時にライフサイクルが続く継続状態を特定します。
|
|
64
|
+
|
|
65
|
+
## 6. 記述ガイド
|
|
66
|
+
|
|
67
|
+
### 6.1. 基本構文
|
|
68
|
+
|
|
69
|
+
```mermaid
|
|
70
|
+
stateDiagram-v2
|
|
71
|
+
[*] --> 入荷済み : 入荷受入 / 発注内容と照合済み
|
|
72
|
+
入荷済み --> 販売可能 : 検品完了 / 数量・品質が合格
|
|
73
|
+
入荷済み --> 返品待ち : 検品完了 / 数量違いまたは品質不良
|
|
74
|
+
販売可能 --> [*] : 販売完了 / 顧客へ引渡し済み
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
- 行頭は半角スペース 2 個でそろえます。
|
|
78
|
+
- コロンの左に遷移元と遷移先、右にイベントと条件を記載します。
|
|
79
|
+
- 条件が常に成立する遷移は `イベント / イベント発生時` とし、ラベルを省略しません。
|
|
80
|
+
|
|
81
|
+
### 6.2. 分岐と自己遷移
|
|
82
|
+
|
|
83
|
+
- 同じ状態・イベントから分岐する場合は、同じ遷移元から遷移先ごとに矢印を出し、各矢印へ同じイベントと相互排他的な条件を `イベント / 条件` 形式で記載します。
|
|
84
|
+
- 分岐を表す `<<choice>>` など、状態一覧にない疑似状態は使用しません。分岐判断の根拠は各遷移の条件と「遷移の説明」に記載します。
|
|
85
|
+
- 自己遷移は業務上の状態を保ったまま記録更新や再確認を行う場合だけ記載します。
|
|
86
|
+
|
|
87
|
+
```mermaid
|
|
88
|
+
stateDiagram-v2
|
|
89
|
+
[*] --> 検品中 : 検品開始 / 対象商品あり
|
|
90
|
+
検品中 --> 販売可能 : 検品完了 / 数量・品質が合格
|
|
91
|
+
検品中 --> 返品待ち : 検品完了 / 数量違いまたは品質不良
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 6.3. 図の分割
|
|
95
|
+
|
|
96
|
+
- 状態はすべて同じ階層へ置き、親状態と下位状態を持つ複合状態は使用しません。階層化が必要な場合は、状態を持つ対象を分け、対象ごとに別の STSD を作成します。
|
|
97
|
+
- 業務状態が 15 を超える、遷移が 20 を超える、または一つの業務状態に接続する入出力遷移の合計が 6 を超える場合は、同じ STSD 内で図を分割します。
|
|
98
|
+
- 分割単位は業務フェーズまたは通常系・例外系とし、各図が扱う遷移 ID の範囲を図直前に記載します。分割した図で共有する状態は、同じ表示名と同じ `state_id` を使用します。
|
|
99
|
+
- 規模が閾値以下でも分割できますが、全遷移がいずれか一つの図に過不足なく対応し、図をまたぐ接続状態を明記します。
|
|
100
|
+
|
|
101
|
+
### 6.4. 完成判定
|
|
102
|
+
|
|
103
|
+
- 状態一覧の全状態が少なくとも一つの図に登場しています。
|
|
104
|
+
- 図の業務状態はすべて状態一覧にあります。
|
|
105
|
+
- 終了状態は終了点 `[*]` への出力遷移を持つ状態、継続状態は対象範囲の終了時にもライフサイクルが続くため出力遷移を持たない状態とします。継続状態を置く場合は STSD の「概要」に対象範囲を終える理由を記載します。
|
|
106
|
+
- 初期点が一つ以上あり、各初期点から、正常系・例外系を問わず、すべての終了状態および継続状態まで遷移をたどれます。到達不能な終端は残しません。
|
|
107
|
+
- 状態一覧の各業務状態は、少なくとも一つの初期点から遷移をたどって到達できます。初期点から到達できない中間状態は、既存の終了状態へ接続していても残しません。
|
|
108
|
+
- 全遷移にイベントと条件があり、「遷移の説明」と一致しています。
|
|
109
|
+
- 分岐条件が重複せず、どの遷移も業務上判定できます。
|
|
110
|
+
|
|
111
|
+
## 7. 禁止事項
|
|
112
|
+
|
|
113
|
+
- 画面ページ間の移動を状態遷移として描きません。
|
|
114
|
+
- `if`、`&&`、`null` などの実装条件式を条件ラベルに使いません。
|
|
115
|
+
- enum 値、数値、フラグだけを状態名にしません。
|
|
116
|
+
- 状態一覧にない状態や、遷移の説明にない矢印を追加しません。
|
|
117
|
+
- `<<choice>>`、`<<fork>>`、`<<join>>` など、状態一覧にない疑似状態を使用しません。
|
|
118
|
+
- 親状態と下位状態を持つ `state` ブロックなど、複合状態を使用しません。階層化が必要な対象を一つの STSD に混在させません。
|
|
119
|
+
- 初期点を省略したり、一つのコードブロック内で同じ `state_id` を異なる状態へ割り当てたりしません。
|
|
120
|
+
- 分割図で共有する状態の表示名や `state_id` を図ごとに変更しません。
|
|
121
|
+
- 状態の意味・成立条件を図中の長文ノートへ複製しません。
|
|
122
|
+
|
|
123
|
+
## 8. サンプル
|
|
124
|
+
|
|
125
|
+
```mermaid
|
|
126
|
+
stateDiagram-v2
|
|
127
|
+
[*] --> 記録済み : つけ登録 / 顧客と金額を確認済み
|
|
128
|
+
記録済み --> 清算済み : 代金受領 / 残高がゼロ
|
|
129
|
+
記録済み --> 取消済み : 記録取消 / 店主代表が承認
|
|
130
|
+
清算済み --> [*] : 清算記録確定 / 支払記録と一致
|
|
131
|
+
取消済み --> [*] : 取消記録確定 / 取消理由を記録済み
|
|
132
|
+
```
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:stsd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:stsd-recipe
|
|
8
|
+
sample: specdojo:stsd-sample
|
|
9
|
+
template: specdojo:stsd-template
|
|
10
|
+
includes:
|
|
11
|
+
- specdojo:stsd-mermaid-rulebook
|
|
12
|
+
based_on:
|
|
13
|
+
- specdojo:rulebook-authoring-standard
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# ステータス定義(Status Definition: STSD)作成ルール
|
|
17
|
+
|
|
18
|
+
Status Definition Documentation Rulebook
|
|
19
|
+
|
|
20
|
+
業務上の一つの対象が取り得る状態と、その状態間の遷移を一文書で定義するためのルールです。状態一覧、状態遷移図、遷移の説明を STSD に集約し、状態の意味とライフサイクルの二重管理を防ぎます。
|
|
21
|
+
|
|
22
|
+
## 1. 全体方針
|
|
23
|
+
|
|
24
|
+
- 一文書は一つの対象(エンティティまたは業務概念)だけを扱います。対象が異なる場合は `stsd-<term>` を分けます。
|
|
25
|
+
- 状態一覧を状態名・意味・成立条件の正本、「遷移の説明」を遷移元・遷移先・イベント・条件の正本として同じ文書で管理します。状態遷移図は「遷移の説明」の全行を俯瞰する投影であり、不一致時は遷移の説明へ合わせたうえで両者を同じ変更で更新します。
|
|
26
|
+
- 状態一覧の全状態を状態遷移図と遷移の説明へ対応付け、図だけ、表だけで意味が決まる状態を残しません。
|
|
27
|
+
- AS-IS と TO-BE を同じ図に混在させません。両方が必要な場合は `<term>` にスコープを含めて文書を分けます。
|
|
28
|
+
- 実装上の enum、フラグ、物理テーブル、API、画面操作ではなく、業務で合意する状態とイベントを記述します。
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけと用語定義
|
|
31
|
+
|
|
32
|
+
| 用語 | 定義 |
|
|
33
|
+
| ---------- | ----------------------------------------------------------------------------------- |
|
|
34
|
+
| 対象 | 状態を持つ一つの業務上のエンティティまたは概念 |
|
|
35
|
+
| 状態 | 対象について、意味と成立条件を業務上判定できる時点の区分 |
|
|
36
|
+
| 管理場所 | 現在状態を確認する正本の帳簿、台帳、記録、または概念上の保管先 |
|
|
37
|
+
| 遷移 | イベントと条件により、対象が遷移元の状態から遷移先の状態へ変わること |
|
|
38
|
+
| イベント | 遷移の契機となる業務上の出来事または操作 |
|
|
39
|
+
| 遷移条件 | イベント発生時に遷移を成立させる、業務上判定可能な条件 |
|
|
40
|
+
| 初期・終了 | Mermaid の `[*]` で表すライフサイクルの開始点・終了点。業務上の状態一覧には含めない |
|
|
41
|
+
|
|
42
|
+
## 3. ファイル命名・ID規則
|
|
43
|
+
|
|
44
|
+
- ファイル名は `stsd-<term>.md`、成果物 ID は拡張子を除いた `stsd-<term>` とします。
|
|
45
|
+
- `<term>` は対象と、必要に応じて AS-IS / TO-BE などのスコープを表す英小文字・数字・ハイフンのスラッグにします。
|
|
46
|
+
- 一つの対象に複数の STSD を作らず、例外状態も同じライフサイクルに属する限り同じ文書へ記載します。
|
|
47
|
+
- 状態値を外部参照に使う場合は `lower-kebab-case` とし、状態名は業務で使う日本語の名詞句にします。
|
|
48
|
+
- 外部参照に使う状態値は文書内で一意にし、一つの値を複数の状態へ割り当てません。コードを持たない状態で使う `-` は一意性確認の対象外です。
|
|
49
|
+
- 遷移 ID は文書内で一意な `T-<nn>` 形式とし、遷移の説明とレビュー指摘で同じ ID を使います。
|
|
50
|
+
|
|
51
|
+
## 4. 推奨 Frontmatter 項目
|
|
52
|
+
|
|
53
|
+
| 項目 | 説明 | 必須 |
|
|
54
|
+
| ------------ | ----------------------------------------------------- | ---- |
|
|
55
|
+
| `id` | プロジェクト修飾なしの `stsd-<term>` | ○ |
|
|
56
|
+
| `type` | `data` | ○ |
|
|
57
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
58
|
+
| `rulebook` | `specdojo:stsd-rulebook` | ○ |
|
|
59
|
+
| `based_on` | 依存関係上許可された対象定義・業務データ辞書などの ID | 任意 |
|
|
60
|
+
| `supersedes` | 置き換える旧 STSD の ID | 任意 |
|
|
61
|
+
|
|
62
|
+
- `based_on` は成果物カタログの `depends_on` の推移閉包に含まれる先行成果物だけを記載します。
|
|
63
|
+
- 作成途中は `status: draft` とし、`ready` への昇格は定められた人間の承認後に行います。
|
|
64
|
+
- 対象名や文書タイトルの独自メタ項目は追加せず、H1 と「概要」で示します。
|
|
65
|
+
|
|
66
|
+
## 5. 本文要件
|
|
67
|
+
|
|
68
|
+
見出し順、表、記入欄の骨組みは template を正本とし、本章では各章の目的と必須性を定めます。
|
|
69
|
+
|
|
70
|
+
| 番号 | 見出し | 必須 | 内容 |
|
|
71
|
+
| ---- | -------------- | -------- | ---------------------------------------------------------------------------------- |
|
|
72
|
+
| 1 | 概要 | ○ | 対象、スコープ、状態を管理する目的、利用者 |
|
|
73
|
+
| 2 | 状態一覧 | ○ | 値、状態名、通称、意味、成立条件、管理場所 |
|
|
74
|
+
| 3 | 状態遷移図 | ○ | 状態一覧と一致する状態、初期・終了、イベント・条件を示す Mermaid `stateDiagram-v2` |
|
|
75
|
+
| 4 | 遷移の説明 | ○ | 遷移 ID、遷移元、遷移先、イベント、条件、業務上の補足 |
|
|
76
|
+
| 5 | 今後の検討メモ | 条件付き | 未決の例外状態、遷移、用語、責任境界。未決事項がある場合だけ設ける |
|
|
77
|
+
|
|
78
|
+
状態が一つしかない対象も、状態変化がない根拠を「概要」に記載し、状態遷移図では初期点からその状態への遷移を示します。状態自体を持たない対象には STSD を作成しません。
|
|
79
|
+
|
|
80
|
+
## 6. 記述ガイド
|
|
81
|
+
|
|
82
|
+
### 6.1. 概要
|
|
83
|
+
|
|
84
|
+
- 対象を一つの業務用語で特定し、AS-IS / TO-BE などのスコープを明示します。
|
|
85
|
+
- 状態管理によって誰が何を判断するかを 1〜3 文で記述します。
|
|
86
|
+
- 状態の正本となる管理場所と、状態変更を起こす業務範囲を示します。
|
|
87
|
+
|
|
88
|
+
### 6.2. 状態一覧
|
|
89
|
+
|
|
90
|
+
| 列名 | 記述ルール |
|
|
91
|
+
| -------- | --------------------------------------------------------------------- |
|
|
92
|
+
| 値 | 外部参照に使う安定した `lower-kebab-case`。コードを持たない場合は `-` |
|
|
93
|
+
| 状態名 | 対象が置かれた状態を表す、日本語の名詞句 |
|
|
94
|
+
| 通称 | 現場で異なる呼び方を使う場合の呼称。ない場合は `-` |
|
|
95
|
+
| 意味 | その状態に含む範囲と、含まない範囲が分かる説明 |
|
|
96
|
+
| 成立条件 | いつその状態と判定できるかを、確認可能な事実で記述 |
|
|
97
|
+
| 管理場所 | 現在状態を確認する正本の帳簿、台帳、記録、または概念上の保管先 |
|
|
98
|
+
|
|
99
|
+
- 状態名は用語集や業務データ辞書の名称と一致させます。
|
|
100
|
+
- `値` は文書内で重複させず、外部参照から対応する状態を一意に特定できるようにします。`-` はコードを持たないことを表し、複数行で使用できます。
|
|
101
|
+
- 終了条件は遷移の説明へ置き、状態一覧の成立条件と同じ説明を重複させません。
|
|
102
|
+
- 同じ状態を管理場所ごとに別名で複製せず、意味または成立条件が異なる場合だけ別状態とします。
|
|
103
|
+
|
|
104
|
+
### 6.3. 状態遷移図
|
|
105
|
+
|
|
106
|
+
- Mermaid の `stateDiagram-v2` を使用し、Frontmatter の `includes` で指定された記法ルールに従います。
|
|
107
|
+
- 状態一覧の「状態名」を図の状態ラベルにそのまま使用します。
|
|
108
|
+
- 遷移ラベルは `イベント / 条件` とし、条件がない場合も業務イベントを省略しません。
|
|
109
|
+
- 分岐は同じ遷移元から出る複数の遷移として表し、各矢印へ同じイベントと相互排他的な条件を記載します。`<<choice>>` など、状態一覧にない疑似状態は使用しません。
|
|
110
|
+
- 状態はすべて同じ階層へ置き、親状態と下位状態を持つ複合状態は使用しません。階層化が必要な場合は、状態を持つ対象を分けて別の STSD にします。
|
|
111
|
+
- 初期点は必ず `[*]` で示します。終了点は業務上の終了がある場合に `[*]` で示し、初期点・終了点を業務上の状態として状態一覧へ追加しません。終了点を省略する継続的な状態管理では、「概要」に理由と継続状態を記載します。
|
|
112
|
+
- 図の分割条件、分割単位、共有状態の扱いは Frontmatter の `includes` で指定した記法ルールに従います。
|
|
113
|
+
|
|
114
|
+
### 6.4. 遷移の説明
|
|
115
|
+
|
|
116
|
+
| 列名 | 記述ルール |
|
|
117
|
+
| -------- | ----------------------------------------------------------------- |
|
|
118
|
+
| 遷移 ID | 文書内で一意な `T-<nn>` |
|
|
119
|
+
| 遷移元 | 状態一覧の状態名。初期点の場合は `開始` |
|
|
120
|
+
| 遷移先 | 状態一覧の状態名。終了点の場合は `終了` |
|
|
121
|
+
| イベント | 状態変更の契機となる業務上の出来事または操作 |
|
|
122
|
+
| 条件 | 遷移成立を yes / no で判定できる条件。無条件なら `イベント発生時` |
|
|
123
|
+
| 補足 | 判断者、例外時の扱い、記録する証跡など、図だけでは伝わらない事項 |
|
|
124
|
+
|
|
125
|
+
- 図にある全遷移を一行ずつ記載し、表にだけある遷移を残しません。
|
|
126
|
+
- 同じイベントから複数の遷移先へ分岐する場合は、条件を相互排他的かつ判定可能にします。
|
|
127
|
+
- 自己遷移は、状態の意味を変えずに記録更新や再確認を行う業務上の必要がある場合だけ使用します。
|
|
128
|
+
|
|
129
|
+
### 6.5. 今後の検討メモ
|
|
130
|
+
|
|
131
|
+
- 調査で確定できる不足は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: で区別します。
|
|
132
|
+
- 各項目に影響する状態または遷移 ID、決定者、決定時期を記載します。
|
|
133
|
+
- 未決事項がない場合は章を省略し、空欄や「なし」だけの章を残しません。
|
|
134
|
+
|
|
135
|
+
### 6.6. 完成判定
|
|
136
|
+
|
|
137
|
+
- 状態一覧の全状態が状態遷移図に登場し、図の業務状態がすべて状態一覧にあります。
|
|
138
|
+
- 外部参照に使う `値` が文書内で一意で、各値から状態を一つに特定できます。
|
|
139
|
+
- 状態一覧の成立条件だけで現在状態を判定でき、複数状態へ同時に該当する場合の扱いが明示されています。
|
|
140
|
+
- 図の全遷移が遷移の説明へ一度ずつ対応し、遷移元・遷移先・イベント・条件が一致しています。
|
|
141
|
+
- 初期点からすべての終了状態または継続状態まで到達でき、正常系・例外系の全遷移について終了、正常系への復帰、または人間の判断への引き渡しを説明できます。
|
|
142
|
+
- 状態一覧の各業務状態が少なくとも一つの初期点から到達でき、到達不能な中間状態が残っていません。
|
|
143
|
+
- 状態名、通称、イベント名が用語集・業務データ辞書・関連 CDFD と矛盾していません。
|
|
144
|
+
|
|
145
|
+
## 7. 禁止事項
|
|
146
|
+
|
|
147
|
+
- 同じ対象の状態一覧と状態遷移図を別文書へ分けません。
|
|
148
|
+
- 状態名に `is_active`、`FLAG_01`、数値だけのコードなど、実装上の識別子を使いません。
|
|
149
|
+
- 画面ページ、API 呼び出し、関数実行を業務状態または業務イベントとしてそのまま記載しません。
|
|
150
|
+
- 遷移ラベルを空にしたり、条件を実装式だけで表したりしません。
|
|
151
|
+
- 状態一覧にない状態を図へ追加したり、図にない遷移を遷移の説明へ追加したりしません。
|
|
152
|
+
- `<<choice>>` など、状態一覧にない疑似状態を分岐のために追加しません。
|
|
153
|
+
- 親状態と下位状態を持つ複合状態を使用しません。階層化が必要な異なる対象を一つの STSD に混在させません。
|
|
154
|
+
- CDFD、業務データ辞書、用語集に同じ状態一覧や遷移表を複製しません。
|
|
155
|
+
|
|
156
|
+
## 8. サンプル
|
|
157
|
+
|
|
158
|
+
````markdown
|
|
159
|
+
---
|
|
160
|
+
specdojo:
|
|
161
|
+
id: stsd-product
|
|
162
|
+
type: data
|
|
163
|
+
status: draft
|
|
164
|
+
rulebook: specdojo:stsd-rulebook
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
# 商品のステータス定義
|
|
168
|
+
|
|
169
|
+
## 1. 概要
|
|
170
|
+
|
|
171
|
+
店頭商品の現行業務(AS-IS)について、納品受入から販売または返品による終了までの状態と遷移を定義する。店主代表と家族利用者代表は現在状態の判断に、開発担当と同行レビュー担当は状態変更の設計・検証に利用する。
|
|
172
|
+
|
|
173
|
+
- 対象: 店舗が納品を受けた商品
|
|
174
|
+
- 状態の正本: 仕入記録、在庫記録、販売記録
|
|
175
|
+
- 状態変更の業務範囲: 入荷受入、検品、売場補充、販売、返品
|
|
176
|
+
- 一意判定: 正本記録を時系列で照合し、最後に成立した遷移の遷移先を現在状態とする。後続遷移が成立した時点で遷移元の状態は終了する
|
|
177
|
+
|
|
178
|
+
## 2. 状態一覧
|
|
179
|
+
|
|
180
|
+
| 値 | 状態名 | 通称 | 意味 | 成立条件 | 管理場所 |
|
|
181
|
+
| -------------- | -------- | ---------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------- |
|
|
182
|
+
| received | 入荷済み | 入った品 | 店舗が受領し、検品結果が未確定の商品 | 受入日時と数量を仕入記録へ記録し、検品結果をまだ記録していない | 仕入記録 |
|
|
183
|
+
| inspected | 検品済み | 検品した品 | 検品結果を記録し、結果に応じた配置または分離の途中の商品 | 検品結果と理由を仕入記録へ記録し、在庫更新・売場配置または返品保管箱への分離が完了していない | 仕入記録、検品場所 |
|
|
184
|
+
| sellable | 販売可能 | 売れる品 | 検品に合格し、売場で販売できる商品 | 在庫数量を更新して売場棚へ配置し、販売完了をまだ記録していない | 在庫記録、売場棚 |
|
|
185
|
+
| sold | 販売済み | 売れた品 | 会計を終え、顧客への引き渡しを完了した商品 | 販売記録を確定し、在庫を減算して、顧客が商品を受領した | 販売記録 |
|
|
186
|
+
| return-pending | 返品待ち | 返す品 | 検品不合格により仕入先への返品を待つ商品 | 不合格理由を仕入記録へ記録して返品保管箱へ分け、返品日と数量をまだ記録していない | 仕入記録、返品保管箱 |
|
|
187
|
+
| returned | 返品済み | 返した品 | 仕入先へ返却し、店舗の管理対象を外れた商品 | 仕入先が商品を受領し、返品日と数量を仕入記録へ記録した | 仕入記録 |
|
|
188
|
+
|
|
189
|
+
## 3. 状態遷移図
|
|
190
|
+
|
|
191
|
+
```mermaid
|
|
192
|
+
stateDiagram-v2
|
|
193
|
+
[*] --> 入荷済み : 入荷受入 / 商品受領後に受入日時と数量を仕入記録へ記録した
|
|
194
|
+
入荷済み --> 検品済み : 検品結果記録 / 検品結果と理由を仕入記録へ記録した
|
|
195
|
+
検品済み --> 販売可能 : 検品完了 / 結果が合格で在庫を更新し売場へ配置した
|
|
196
|
+
検品済み --> 返品待ち : 検品完了 / 結果が数量違いまたは品質不良で返品保管箱へ分けた
|
|
197
|
+
販売可能 --> 販売済み : 商品引渡し / 会計・在庫減算・顧客受領が完了した
|
|
198
|
+
返品待ち --> 返品済み : 返品処理完了 / 仕入先へ引き渡し返品日と数量を仕入記録へ記録した
|
|
199
|
+
販売済み --> [*] : 販売処理確定 / 販売記録と在庫記録が一致した
|
|
200
|
+
返品済み --> [*] : 返品処理確定 / 返品商品と仕入記録が一致した
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## 4. 遷移の説明
|
|
204
|
+
|
|
205
|
+
| 遷移 ID | 遷移元 | 遷移先 | イベント | 条件 | 補足 |
|
|
206
|
+
| ------- | -------- | -------- | ------------ | ------------------------------------------------ | -------------------------------- |
|
|
207
|
+
| `T-01` | 開始 | 入荷済み | 入荷受入 | 商品受領後に受入日時と数量を仕入記録へ記録した | 検品前の商品を識別する |
|
|
208
|
+
| `T-02` | 入荷済み | 検品済み | 検品結果記録 | 検品結果と理由を仕入記録へ記録した | 後続作業中も現在状態を判定できる |
|
|
209
|
+
| `T-03` | 検品済み | 販売可能 | 検品完了 | 結果が合格で在庫を更新し売場へ配置した | 販売グループへ引き渡せる |
|
|
210
|
+
| `T-04` | 検品済み | 返品待ち | 検品完了 | 結果が数量違いまたは品質不良で返品保管箱へ分けた | 合格条件と相互排他的に判定する |
|
|
211
|
+
| `T-05` | 販売可能 | 販売済み | 商品引渡し | 会計・在庫減算・顧客受領が完了した | 販売記録を正本とする |
|
|
212
|
+
| `T-06` | 返品待ち | 返品済み | 返品処理完了 | 仕入先へ引き渡し返品日と数量を仕入記録へ記録した | 仕入記録へ返品日を残す |
|
|
213
|
+
| `T-07` | 販売済み | 終了 | 販売処理確定 | 販売記録と在庫記録が一致した | 販売経路を終了する |
|
|
214
|
+
| `T-08` | 返品済み | 終了 | 返品処理確定 | 返品商品と仕入記録が一致した | 返品経路を終了する |
|
|
215
|
+
````
|