specdojo 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +3 -2
- package/CHANGELOG.md +153 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/init.js +5 -1
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +612 -259
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +8 -6
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +9 -4
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/yaml-pages.js +125 -3
- package/dist/exec/agent-config.js +22 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/commands.js +69 -21
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +159 -8
- package/dist/exec/evidence.js +64 -16
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +153 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +48 -25
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +8 -4
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +85 -24
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +109 -0
- package/dist/exec/run/agent-pipeline.js +75 -6
- package/dist/exec/run/agent.js +20 -7
- package/dist/exec/run/in-place.js +69 -32
- package/dist/exec/run/job.js +81 -24
- package/dist/exec/run/lifecycle-commands.js +188 -36
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +6 -10
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +12 -12
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +28 -18
- package/dist/exec/run/register-state.js +10 -7
- package/dist/exec/run/register-worktree.js +60 -30
- package/dist/exec/run/schedule-mode.js +4 -4
- package/dist/exec/run/schedule-prepare.js +201 -59
- package/dist/exec/run/schedule-task.js +129 -25
- package/dist/exec/run/shared.js +4 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/strategy.js +1 -0
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +3 -2
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/worktree-command.js +29 -16
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +19 -2
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-inspect.js +2 -2
- package/dist/grade/command-run.js +2 -0
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +23 -3
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/job.js +31 -17
- package/dist/job/noop.js +104 -0
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +4 -1
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +43 -9
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +4 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +56 -32
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +1 -0
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +2 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git.js +142 -15
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +47 -16
- package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +70 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
- package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +36 -24
- package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
- package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
- package/docs/ja/specdojo/references/command-reference.md +79 -64
- package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +56 -35
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +100 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
- package/docs/ja/specdojo/samples/bes-sample.md +80 -21
- package/docs/ja/specdojo/samples/br-sample.md +68 -14
- package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +132 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
- package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
- package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
- package/docs/ja/specdojo/samples/sf-sample.md +121 -21
- package/docs/ja/specdojo/samples/sld-sample.md +107 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +164 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +53 -3
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/package.json +2 -2
- package/templates/antigravity/orchestrator.md +3 -2
- package/templates/claude/agents/specdojo-orchestrator.md +3 -2
- package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
- package/templates/codex/orchestrator.md +3 -2
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -16,35 +16,36 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Mermaid State Diagram Rulebook for Status Definitions
|
|
18
18
|
|
|
19
|
-
STSD
|
|
19
|
+
STSD の「状態遷移」章の図を Mermaid の `stateDiagram-v2` で一貫して記述するための記法ルールです。状態の意味と成立条件は同じ STSD の「状態一覧」、各遷移の詳細は「状態遷移」の遷移表を正本とします。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
23
23
|
- 一つの図は一つの業務対象の状態遷移だけを扱います。
|
|
24
|
-
-
|
|
25
|
-
-
|
|
24
|
+
- 状態ラベルは「表示名」の定義に従い、STSD の状態一覧にある状態名と値から構成します。
|
|
25
|
+
- 遷移ラベルは遷移 ID・業務イベント・条件を示し、実装フラグ、関数、画面ページを使いません。
|
|
26
26
|
- 図は遷移の全体像を示し、状態の意味や条件の長い説明は図中へ埋め込みません。
|
|
27
27
|
|
|
28
28
|
## 2. 位置づけと用語定義
|
|
29
29
|
|
|
30
|
-
| 用語 | 定義
|
|
31
|
-
| ---------- |
|
|
32
|
-
| 状態 | STSD の状態一覧に定義された業務状態
|
|
33
|
-
| 表示名 |
|
|
34
|
-
| `state_id` | Mermaid コード内で状態を参照する内部 ID
|
|
35
|
-
| 別名 |
|
|
36
|
-
| 初期点 | ライフサイクルの開始を示す `[*]`
|
|
37
|
-
| 終了点 | ライフサイクルの終了を示す `[*]`
|
|
38
|
-
| 遷移 | `遷移元 --> 遷移先 : イベント / 条件` で示す状態変化
|
|
30
|
+
| 用語 | 定義 |
|
|
31
|
+
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| 状態 | STSD の状態一覧に定義された業務状態 |
|
|
33
|
+
| 表示名 | 図上に表示するラベル。値がある場合は `状態名<br>値` の 2 行とし、1 行目は状態一覧の状態名、2 行目は状態一覧の値と完全一致させる。値が `-` の場合は状態名だけを表示する |
|
|
34
|
+
| `state_id` | Mermaid コード内で状態を参照する内部 ID。表示名と分けて使用し、表示する値の代わりにはしない |
|
|
35
|
+
| 別名 | 表示名の状態名部分に使用する、状態一覧の状態名とは異なる名前。本 rulebook では使用しない |
|
|
36
|
+
| 初期点 | ライフサイクルの開始を示す `[*]` |
|
|
37
|
+
| 終了点 | ライフサイクルの終了を示す `[*]` |
|
|
38
|
+
| 遷移 | `遷移元 --> 遷移先 : T-<nn> イベント / 条件` で示す状態変化 |
|
|
39
39
|
|
|
40
40
|
分岐は疑似状態を置かず、同じ遷移元から出る複数の遷移として表します。遷移元と遷移先に使用できるのは、状態一覧にある業務状態と初期点・終了点だけです。
|
|
41
41
|
|
|
42
42
|
## 3. ファイル命名・ID規則
|
|
43
43
|
|
|
44
|
-
- 本 rulebook 単独の成果物は作成せず、`stsd-<term>.md`
|
|
44
|
+
- 本 rulebook 単独の成果物は作成せず、`stsd-<term>.md` の「状態遷移」章の図に適用します。
|
|
45
45
|
- 状態名は日本語の名詞句にし、STSD の状態一覧と同じ表記を使います。
|
|
46
|
+
- 遷移 ID は [[specdojo:stsd-rulebook|ステータス定義作成ルール]] の「状態遷移」に従い、同じ STSD の図直下の遷移表と同じ `T-<nn>` を使用します。
|
|
46
47
|
- イベント名は短い業務用語、条件は業務上判定可能な事実で記述します。
|
|
47
|
-
-
|
|
48
|
+
- 各業務状態は、状態一覧に値がある場合は `state "状態名<br>値" as state_id`、値が `-` の場合は `state "状態名" as state_id` で宣言します。これは別名ではありません。`state_id` は英小文字で始まる英小文字・数字・アンダースコアだけの `[a-z][a-z0-9_]*` とし、一つの Mermaid コードブロック内で一意にします。表示する値には `state_id` ではなく状態一覧の値をそのまま使います。
|
|
48
49
|
- 図を分割して同じ状態を複数図へ再掲する場合は、各図で `state "表示名" as state_id` を宣言し、同じ表示名と同じ `state_id` を維持します。分割図ごとに別名や異なる `state_id` を付けません。
|
|
49
50
|
|
|
50
51
|
## 4. 推奨 Frontmatter 項目
|
|
@@ -53,15 +54,15 @@ STSD の「状態遷移図」を Mermaid の `stateDiagram-v2` で一貫して
|
|
|
53
54
|
|
|
54
55
|
## 5. 本文要件
|
|
55
56
|
|
|
56
|
-
| 要素 | 必須 | 記述
|
|
57
|
-
| ---------- | ---- |
|
|
58
|
-
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする
|
|
59
|
-
| 業務状態 | ○ |
|
|
60
|
-
| 遷移ラベル | ○ |
|
|
61
|
-
| 初期点 | ○ | `[*] --> 初期状態 : イベント / 条件` で示す
|
|
62
|
-
| 終了点 | 任意 |
|
|
57
|
+
| 要素 | 必須 | 記述 |
|
|
58
|
+
| ---------- | ---- | -------------------------------------------------- |
|
|
59
|
+
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする |
|
|
60
|
+
| 業務状態 | ○ | 状態一覧の状態名・値に基づく表示名を使用する |
|
|
61
|
+
| 遷移ラベル | ○ | `T-<nn> イベント / 条件` を記載する |
|
|
62
|
+
| 初期点 | ○ | `[*] --> 初期状態 : T-<nn> イベント / 条件` で示す |
|
|
63
|
+
| 終了点 | 任意 | `終了状態 --> [*] : T-<nn> イベント / 条件` で示す |
|
|
63
64
|
|
|
64
|
-
|
|
65
|
+
初期点は STSD 全体で必須とし、分割時の配置は「図の分割」に従います。終了点の要否、継続状態の扱い、省略時に「適用範囲」へ記載する内容は、[[specdojo:stsd-rulebook|ステータス定義作成ルール]] の「状態遷移」に従います。
|
|
65
66
|
|
|
66
67
|
## 6. 記述ガイド
|
|
67
68
|
|
|
@@ -69,44 +70,55 @@ STSD の「状態遷移図」を Mermaid の `stateDiagram-v2` で一貫して
|
|
|
69
70
|
|
|
70
71
|
```mermaid
|
|
71
72
|
stateDiagram-v2
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
73
|
+
state "入荷済み<br>received" as received
|
|
74
|
+
state "販売可能<br>sellable" as sellable
|
|
75
|
+
state "返品待ち<br>return-pending" as return_pending
|
|
76
|
+
[*] --> received : T-01 入荷受入 / 発注内容と照合済み
|
|
77
|
+
received --> sellable : T-02 検品完了 / 数量・品質が合格
|
|
78
|
+
received --> return_pending : T-03 検品完了 / 数量違いまたは品質不良
|
|
79
|
+
sellable --> [*] : T-04 販売完了 / 顧客へ引渡し済み
|
|
76
80
|
```
|
|
77
81
|
|
|
78
82
|
- 行頭は半角スペース 2 個でそろえます。
|
|
79
|
-
-
|
|
80
|
-
- 条件が常に成立する遷移は
|
|
83
|
+
- コロンの左に遷移元と遷移先、右に遷移 ID・イベント・条件を記載します。
|
|
84
|
+
- 条件が常に成立する遷移は `T-<nn> イベント / イベント発生時` とし、ラベルを省略しません。
|
|
81
85
|
|
|
82
86
|
### 6.2. 分岐と自己遷移
|
|
83
87
|
|
|
84
|
-
-
|
|
85
|
-
- 分岐を表す `<<choice>>`
|
|
88
|
+
- 同じ状態・イベントから分岐する場合は、同じ遷移元から遷移先ごとに矢印を出し、各矢印へ異なる遷移 ID、同じイベント、相互排他的な条件を `T-<nn> イベント / 条件` 形式で記載します。
|
|
89
|
+
- 分岐を表す `<<choice>>` など、状態一覧にない疑似状態は使用しません。分岐判断の根拠は各遷移の条件と「状態遷移」の遷移表に記載します。
|
|
86
90
|
- 自己遷移は業務上の状態を保ったまま記録更新や再確認を行う場合だけ記載します。
|
|
87
91
|
|
|
92
|
+
次の例では、状態一覧の「検品中」の値を `-` とします。
|
|
93
|
+
|
|
88
94
|
```mermaid
|
|
89
95
|
stateDiagram-v2
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
96
|
+
state "検品中" as inspecting
|
|
97
|
+
state "販売可能<br>sellable" as sellable
|
|
98
|
+
state "返品待ち<br>return-pending" as return_pending
|
|
99
|
+
[*] --> inspecting : T-01 検品開始 / 対象商品あり
|
|
100
|
+
inspecting --> sellable : T-02 検品完了 / 数量・品質が合格
|
|
101
|
+
inspecting --> return_pending : T-03 検品完了 / 数量違いまたは品質不良
|
|
93
102
|
```
|
|
94
103
|
|
|
95
104
|
### 6.3. 図の分割
|
|
96
105
|
|
|
97
106
|
- 状態はすべて同じ階層へ置き、親状態と下位状態を持つ複合状態は使用しません。階層化が必要な場合は、状態を持つ対象を分け、対象ごとに別の STSD を作成します。
|
|
98
107
|
- 業務状態が 15 を超える、遷移が 20 を超える、または一つの業務状態に接続する入出力遷移の合計が 6 を超える場合は、同じ STSD 内で図を分割します。
|
|
99
|
-
-
|
|
108
|
+
- 分割単位は業務フェーズまたは通常系・例外系とします。分割した図で共有する状態は、同じ表示名と同じ `state_id` を使用します。
|
|
109
|
+
- 各図のすぐ下にその図の遷移表を置きます。図を読む前に対象経路を識別できるよう、各図が扱う遷移 ID の範囲を図の前へ記載し、直下の遷移表と一致させます。分割理由・共有状態も図の前へ置き、図と遷移表の間に説明文や別の図を挟みません。
|
|
100
110
|
- 規模が閾値以下でも分割できますが、全遷移がいずれか一つの図に過不足なく対応し、図をまたぐ接続状態を明記します。
|
|
111
|
+
- 初期点はライフサイクルの開始遷移を扱う図に置きます。開始遷移は対応する図に一度だけ記載し、共有状態から続きを描く図には初期点を置きません。
|
|
112
|
+
- 到達性と終了状態・継続状態の判定は、共有状態を介して全図をつないで行います。ある図で出力遷移がなくても、他の図に出力遷移がある状態を継続状態とはみなしません。
|
|
101
113
|
|
|
102
114
|
### 6.4. 完成判定
|
|
103
115
|
|
|
104
116
|
- 状態一覧の全状態が少なくとも一つの図に登場しています。
|
|
105
|
-
-
|
|
106
|
-
- 終了状態は終了点 `[*]`
|
|
117
|
+
- 図の業務状態はすべて状態一覧にあり、表示名が「表示名」の定義と一致しています。
|
|
118
|
+
- 終了状態は終了点 `[*]` への出力遷移を持つ状態とします。
|
|
107
119
|
- 初期点が一つ以上あり、各初期点から、正常系・例外系を問わず、すべての終了状態および継続状態まで遷移をたどれます。到達不能な終端は残しません。
|
|
108
120
|
- 状態一覧の各業務状態は、少なくとも一つの初期点から遷移をたどって到達できます。初期点から到達できない中間状態は、既存の終了状態へ接続していても残しません。
|
|
109
|
-
-
|
|
121
|
+
- 全遷移に遷移 ID・イベント・条件があり、「状態遷移」の各図の直下の遷移表と一対一に対応し、遷移元・遷移先も一致しています。
|
|
110
122
|
- 分岐条件が重複せず、どの遷移も業務上判定できます。
|
|
111
123
|
|
|
112
124
|
## 7. 禁止事項
|
|
@@ -114,9 +126,9 @@ stateDiagram-v2
|
|
|
114
126
|
- 画面ページ間の移動を状態遷移として描きません。
|
|
115
127
|
- `if`、`&&`、`null` などの実装条件式を条件ラベルに使いません。
|
|
116
128
|
- enum 値、数値、フラグだけを状態名にしません。
|
|
117
|
-
-
|
|
129
|
+
- 状態一覧にない状態や、「状態遷移」の遷移表にない矢印を追加しません。
|
|
118
130
|
- `<<choice>>`、`<<fork>>`、`<<join>>` など、状態一覧にない疑似状態を使用しません。
|
|
119
131
|
- 親状態と下位状態を持つ `state` ブロックなど、複合状態を使用しません。階層化が必要な対象を一つの STSD に混在させません。
|
|
120
|
-
-
|
|
132
|
+
- STSD 全体から初期点を省略したり、一つのコードブロック内で同じ `state_id` を異なる状態へ割り当てたりしません。
|
|
121
133
|
- 分割図で共有する状態の表示名や `state_id` を図ごとに変更しません。
|
|
122
134
|
- 状態の意味・成立条件を図中の長文ノートへ複製しません。
|
|
@@ -18,15 +18,16 @@ specdojo:
|
|
|
18
18
|
|
|
19
19
|
Status Definition Documentation Rulebook
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
業務上の一つの対象が取り得る状態と、その状態間の遷移を一文書で定義するためのルールです。状態の判定、状態一覧、状態遷移を STSD に集約し、状態の意味とライフサイクルの二重管理を防ぎます。
|
|
22
22
|
|
|
23
23
|
## 1. 全体方針
|
|
24
24
|
|
|
25
25
|
- 一文書は一つの対象(エンティティまたは業務概念)だけを扱います。対象が異なる場合は `stsd-<term>` を分けます。
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
- AS-IS
|
|
26
|
+
- 状態一覧を状態名・意味・成立条件の正本、「状態遷移」の遷移表を遷移元・遷移先・イベント・条件の正本として同じ文書で管理します。状態遷移図は遷移表の全行を俯瞰する投影であり、不一致時は遷移表へ合わせたうえで両者を同じ変更で更新します。
|
|
27
|
+
- 状態一覧の全状態を「状態遷移」の図と表へ対応付け、図だけ、表だけで意味が決まる状態を残しません。
|
|
28
|
+
- スコープは現行を既定とし、通常は明記しません。同じ対象の TO-BE 文書と並ぶ場合だけ AS-IS / TO-BE を明記し、`<term>` にスコープを含めて文書を分けます。両者を同じ図に混在させず、「現行実装(AS-IS)」とは記載しません。
|
|
29
29
|
- 実装上の enum、フラグ、物理テーブル、API、画面操作ではなく、業務で合意する状態とイベントを記述します。
|
|
30
|
+
- 状態値や記録形式に既存の schema・型定義・リファレンスがある場合、その値・構文・構造の詳細は正本を参照します。STSD には状態を識別する値と業務上の判定に必要な意味・条件を残し、正本の全項目や実装手順は再掲しません。
|
|
30
31
|
|
|
31
32
|
## 2. 位置づけと用語定義
|
|
32
33
|
|
|
@@ -43,50 +44,74 @@ Status Definition Documentation Rulebook
|
|
|
43
44
|
## 3. ファイル命名・ID規則
|
|
44
45
|
|
|
45
46
|
- ファイル名は `stsd-<term>.md`、成果物 ID は拡張子を除いた `stsd-<term>` とします。
|
|
46
|
-
- `<term>`
|
|
47
|
-
-
|
|
47
|
+
- `<term>` は対象を表す英小文字・数字・ハイフンのスラッグにし、同じ対象の TO-BE 文書と並ぶ場合だけ AS-IS / TO-BE を識別するスコープを含めます。
|
|
48
|
+
- 一つの対象・スコープに複数の STSD を作らず、例外状態も同じライフサイクルに属する限り同じ文書へ記載します。
|
|
48
49
|
- 状態値を外部参照に使う場合は `lower-kebab-case` とし、状態名は業務で使う日本語の名詞句にします。
|
|
49
50
|
- 外部参照に使う状態値は文書内で一意にし、一つの値を複数の状態へ割り当てません。コードを持たない状態で使う `-` は一意性確認の対象外です。
|
|
50
|
-
- 遷移 ID は文書内で一意な `T-<nn>`
|
|
51
|
+
- 遷移 ID は文書内で一意な `T-<nn>` 形式とし、図のラベル・遷移表・レビュー指摘で同じ ID を使います。
|
|
52
|
+
- STSD 文書の初回の確定前(`status: draft`)は、遷移の追加・削除・並べ替えに合わせて、図と表の順に `T-01` から欠番なく振り直してかまいません。分割時も文書全体で通し番号にし、図のラベル・遷移表・本文中の遷移 ID への参照を同じ変更で更新します。
|
|
53
|
+
- 確定前に振り直した場合は、旧 ID で書いた記録(下書きへのレビュー指摘など)から対応する遷移を追えるよう、振り直したことと旧 ID・新 ID の対応(削除した遷移は削除した旨)を作業の記録へ残します。この対応記録は STSD の本文へ追加しません。
|
|
54
|
+
- 一度確定(`status: ready`)した後は、外部参照を保つため、遷移の追加・削除・並べ替えでも既存 ID を振り直しません。削除した ID は欠番として再利用せず、新規遷移には過去に未使用の ID を割り当てます。
|
|
51
55
|
|
|
52
56
|
## 4. 推奨 Frontmatter 項目
|
|
53
57
|
|
|
54
|
-
|
|
55
|
-
| ------------ | ----------------------------------------------------- | ---- |
|
|
56
|
-
| `id` | プロジェクト修飾なしの `stsd-<term>` | ○ |
|
|
57
|
-
| `type` | `data` | ○ |
|
|
58
|
-
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
59
|
-
| `rulebook` | `specdojo:stsd-rulebook` | ○ |
|
|
60
|
-
| `based_on` | 依存関係上許可された対象定義・業務データ辞書などの ID | 任意 |
|
|
61
|
-
| `supersedes` | 置き換える旧 STSD の ID | 任意 |
|
|
58
|
+
必須項目、値・構文、文書の成熟度と置き換えの扱いは、[[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と同標準が参照する schema に従います。STSD 固有の指定は次のとおりです。
|
|
62
59
|
|
|
63
|
-
- `
|
|
60
|
+
- `id` の文書名部分は「ファイル命名・ID規則」に従います。
|
|
61
|
+
- `type` は `data`、`rulebook` は `specdojo:stsd-rulebook` とします。
|
|
62
|
+
- `based_on` には、作成根拠にした対象定義・業務データ辞書などのうち、成果物カタログの `depends_on` の推移閉包に含まれる先行成果物だけを記載します。
|
|
64
63
|
- 作成途中は `status: draft` とし、`ready` への昇格は定められた人間の承認後に行います。
|
|
65
|
-
- 対象名や文書タイトルの独自メタ項目は追加せず、H1
|
|
64
|
+
- 対象名や文書タイトルの独自メタ項目は追加せず、H1 と「適用範囲」で示します。
|
|
66
65
|
|
|
67
66
|
## 5. 本文要件
|
|
68
67
|
|
|
69
|
-
見出し順、表、記入欄の骨組みは template
|
|
68
|
+
見出し順、表、記入欄の骨組みは template を正本とし、本章では満たすべき内容と必須性を定めます。章ごとの記述判断は「記述ガイド」に従います。関連する recipe / sample / template、併せて適用する rulebook と構造・必須項目・禁止事項に差異がある場合は、本 rulebook を優先します。
|
|
70
69
|
|
|
71
|
-
|
|
|
72
|
-
|
|
|
73
|
-
|
|
|
74
|
-
|
|
|
75
|
-
|
|
|
76
|
-
|
|
|
77
|
-
| 5 | 今後の検討メモ | 条件付き | 未決の例外状態、遷移、用語、責任境界。未決事項がある場合だけ設ける |
|
|
70
|
+
| 内容領域 | 必須 | 判断できること |
|
|
71
|
+
| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
72
|
+
| 主題・目的・境界 | ○ | 一つの対象の何を状態で管理し、誰が何を判断するか。状態変更を起こす業務範囲と対象外、終了または継続管理の到達点 |
|
|
73
|
+
| 現在状態の根拠 | ○ | 状態の正本となる管理場所、現在状態を一意に決める規則、互換の扱い |
|
|
74
|
+
| 状態と遷移の定義 | ○ | 各状態の意味・成立条件・管理場所と、初期・終了または継続状態を含む全遷移。図で経路を俯瞰し、直下の遷移表でイベント・条件・補足を確認できること |
|
|
75
|
+
| 未決事項 | 条件付き | 未決の例外状態・遷移・用語・責任境界と、影響範囲・決定者・決定時期。未決事項がある場合だけ記載する |
|
|
78
76
|
|
|
79
|
-
|
|
77
|
+
状態自体を持たない対象には STSD を作成しません。
|
|
80
78
|
|
|
81
79
|
## 6. 記述ガイド
|
|
82
80
|
|
|
83
|
-
### 6.1.
|
|
81
|
+
### 6.1. 頭書きと目的
|
|
84
82
|
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
83
|
+
- 頭書きは H1 直下に置き、文書が何の状態と遷移を定義するかを 1〜2 行で示します。見出しは設けません。
|
|
84
|
+
- 「目的」には、状態が対象の何を管理し、何のために使われるか(誰がその状態で何を判断するか)を 1〜3 文で示します。文書の読み手や使い方(承認する人、実装・テストへの利用)は書きません。
|
|
85
|
+
- 対象・業務境界・到達点の詳細は「適用範囲」、正本の管理場所や判定の規則は「状態の判定」へ置き、頭書きや目的に再掲しません。
|
|
88
86
|
|
|
89
|
-
|
|
87
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
88
|
+
| -------------------------------- | -------------------------------------------------------------- | ------------------------------------ |
|
|
89
|
+
| 頭書きで主題を識別できる | タスク実行の状態と状態遷移を定義する | 状態について説明する |
|
|
90
|
+
| 目的が利用者の業務判断に結び付く | 実行の進み具合を管理し、担当者が着手・引き継ぎの要否を判断する | 実装担当とテスト担当が読むために作る |
|
|
91
|
+
|
|
92
|
+
### 6.2. 適用範囲
|
|
93
|
+
|
|
94
|
+
- 対象を一つの業務用語で特定します。
|
|
95
|
+
- 状態変更を起こす業務の開始と対象外の境界を示します。
|
|
96
|
+
- 業務上の到達点を示します。終了点を置かない場合は、管理を続ける状態と理由を記載し、出力遷移のない状態を継続状態として特定します。
|
|
97
|
+
|
|
98
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
99
|
+
| ------------------------------ | -------------------------------------------------------------------------- | ------------------------------ |
|
|
100
|
+
| 対象内外の境界を区別できる | 商品受領から販売・返品までを扱い、納品前の発注は対象外とする | 商品に関係する業務全般 |
|
|
101
|
+
| 終了点の要否を業務で説明できる | 完了後も差し戻しを受け付け、中止後も補足記録を更新するため終了点を置かない | 記録を保存するので終了点は不要 |
|
|
102
|
+
|
|
103
|
+
### 6.3. 状態の判定
|
|
104
|
+
|
|
105
|
+
- 現在状態を確認する正本の管理場所を示します。履歴・集約記録を併用する場合は、それぞれが正本か派生物かを区別します。状態ごとの管理場所は「状態一覧」へ記載します。
|
|
106
|
+
- 現在状態を一意に判定する規則を示します。イベントを再生する場合の順序と初期値、導出状態がある場合の導出条件と再判定の契機、複数状態の成立条件を満たす場合の優先関係を該当する範囲で定め、状態固有の成立条件は「状態一覧」を参照します。
|
|
107
|
+
- 旧状態値・旧イベント、未設定・欠損記録の読み取りや移行など、互換の扱いを示します。過去の記録を読む規則と現在発行する遷移を区別し、互換の扱いが不要な場合はその旨を明記します。
|
|
108
|
+
|
|
109
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
110
|
+
| -------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------- |
|
|
111
|
+
| 同じ記録から同じ現在状態に至る | 個票の状態欄を正本とし、一覧はその派生物として再生成する | 個票か一覧の新しそうな方を見る |
|
|
112
|
+
| 過去の読み取りと現在の操作を区別できる | 旧イベントは読み取り時だけ読み替え、新規記録には現行イベントを使う | 古い記録もあるのでどちらの操作も許可する |
|
|
113
|
+
|
|
114
|
+
### 6.4. 状態一覧
|
|
90
115
|
|
|
91
116
|
| 列名 | 記述ルール |
|
|
92
117
|
| -------- | --------------------------------------------------------------------- |
|
|
@@ -99,20 +124,39 @@ Status Definition Documentation Rulebook
|
|
|
99
124
|
|
|
100
125
|
- 状態名は用語集や業務データ辞書の名称と一致させます。
|
|
101
126
|
- `値` は文書内で重複させず、外部参照から対応する状態を一意に特定できるようにします。`-` はコードを持たないことを表し、複数行で使用できます。
|
|
102
|
-
-
|
|
127
|
+
- 終了条件は「状態遷移」の遷移表へ置き、状態一覧の成立条件と同じ説明を重複させません。
|
|
103
128
|
- 同じ状態を管理場所ごとに別名で複製せず、意味または成立条件が異なる場合だけ別状態とします。
|
|
129
|
+
- 状態が一つしかない対象は、状態変化がない根拠を記載し、「状態遷移」の図では初期点からその状態への遷移を示します。
|
|
104
130
|
|
|
105
|
-
|
|
131
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
132
|
+
| -------------------------------------- | -------------------------------------------------------- | ------------------------ |
|
|
133
|
+
| 意味と成立条件から隣接状態と区別できる | 販売可能: 検品合格を記録し、在庫を更新して売場へ配置済み | 販売可能: 販売できる状態 |
|
|
134
|
+
| 現在状態の根拠を確認できる | 管理場所を在庫記録とし、正本の対象行を確認する | 管理場所はシステム |
|
|
106
135
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
-
|
|
136
|
+
### 6.5. 状態遷移
|
|
137
|
+
|
|
138
|
+
- 図と遷移表を同じ「状態遷移」章へ置き、各図のすぐ下にその図の遷移表を置きます。図を分けた場合も、図とその遷移表を一組として繰り返します。
|
|
139
|
+
- 分割理由・遷移 ID の範囲・共有状態は図の前へ置き、図と表の間に説明文や別の図を挟みません。
|
|
140
|
+
- 複数の遷移に共通する条件や補足は、適用する遷移 ID を示して章の冒頭などへ集約し、表から参照します。図表をなぞる説明文は加えません。
|
|
141
|
+
- 図の矢印と表の行は、経路の俯瞰と条件の確認を対応付けるために必要です。分割図の共有状態の宣言も接続に必要なため保持し、冗長さは図表を言い換えた本文や共通条件の再列挙から削ります。
|
|
142
|
+
|
|
143
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
144
|
+
| -------------------------------------- | ------------------------------------------------------------ | -------------------------------------- |
|
|
145
|
+
| 図から直下の表で条件・補足を確認できる | 同じ遷移 ID で図の矢印と表の一行を対応付ける | 図の後に同じ経路を文章でも順に説明する |
|
|
146
|
+
| 分割しても経路を接続できる | 共有状態の表示名と内部 ID をそろえて各図で宣言する | 重複を避けるため後続図の共有状態を削る |
|
|
147
|
+
| 共通条件の適用範囲を判断できる | 対象の遷移 ID を挙げて操作権限を一度定義し、各行から参照する | 操作権限の説明全文を各行へ繰り返す |
|
|
148
|
+
|
|
149
|
+
#### 6.5.1. 図
|
|
150
|
+
|
|
151
|
+
- Mermaid の `stateDiagram-v2` を使用します。状態名と値による表示名、値が `-` の場合の表示、`state_id`、図の分割条件・単位・共有状態の扱いと遷移ラベルの詳細な記法は、[[specdojo:stsd-mermaid-rulebook|STSD の状態遷移図を Mermaid で記述するルール]] に委ねます。
|
|
152
|
+
- 遷移ラベルは遷移表と同じ ID を含む `T-<nn> イベント / 条件` とし、条件がない場合も業務イベントを省略しません。
|
|
110
153
|
- 分岐は同じ遷移元から出る複数の遷移として表し、各矢印へ同じイベントと相互排他的な条件を記載します。`<<choice>>` など、状態一覧にない疑似状態は使用しません。
|
|
111
154
|
- 状態はすべて同じ階層へ置き、親状態と下位状態を持つ複合状態は使用しません。階層化が必要な場合は、状態を持つ対象を分けて別の STSD にします。
|
|
112
|
-
- 初期点は必ず `[*]`
|
|
113
|
-
-
|
|
155
|
+
- 初期点は必ず `[*]` で示します。初期点・終了点を業務上の状態として状態一覧へ追加しません。
|
|
156
|
+
- 終了点は、対象範囲でライフサイクルを閉じる業務イベントと条件が定義されている場合に `[*]` で示します。業務上の完了・中止後も差し戻しや状態の確認・記録更新のために状態管理が続く場合は、終了点を置きません。記録の保存だけでは状態管理の継続とみなさず、終了点のためだけに未定義の業務イベントを追加しません。
|
|
157
|
+
- 終了点の省略理由などは「適用範囲」に記載します。差し戻せる完了には戻りの遷移を示し、以後の状態変更を行わず確認・記録更新を続ける中止は、出力遷移のない継続状態として示します。
|
|
114
158
|
|
|
115
|
-
|
|
159
|
+
#### 6.5.2. 遷移表
|
|
116
160
|
|
|
117
161
|
| 列名 | 記述ルール |
|
|
118
162
|
| -------- | ----------------------------------------------------------------- |
|
|
@@ -123,33 +167,44 @@ Status Definition Documentation Rulebook
|
|
|
123
167
|
| 条件 | 遷移成立を yes / no で判定できる条件。無条件なら `イベント発生時` |
|
|
124
168
|
| 補足 | 判断者、例外時の扱い、記録する証跡など、図だけでは伝わらない事項 |
|
|
125
169
|
|
|
126
|
-
-
|
|
170
|
+
- 直上の図にある全遷移を一行ずつ記載し、表にだけある遷移を残しません。分割時も一つの遷移を複数の図や表へ重複させません。
|
|
127
171
|
- 同じイベントから複数の遷移先へ分岐する場合は、条件を相互排他的かつ判定可能にします。
|
|
128
172
|
- 自己遷移は、状態の意味を変えずに記録更新や再確認を行う業務上の必要がある場合だけ使用します。
|
|
129
173
|
|
|
130
|
-
### 6.
|
|
174
|
+
### 6.6. 今後の検討メモ
|
|
131
175
|
|
|
132
176
|
- 調査で確定できる不足は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: で区別します。
|
|
133
177
|
- 各項目に影響する状態または遷移 ID、決定者、決定時期を記載します。
|
|
134
178
|
- 未決事項がない場合は章を省略し、空欄や「なし」だけの章を残しません。
|
|
135
179
|
|
|
136
|
-
|
|
180
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
181
|
+
| ------------------------------------ | ----------------------------------------------------------- | ------------------ |
|
|
182
|
+
| 未決の影響と解消の担当・時期を追える | _UNDECIDED_: `T-07` の再開承認者を、PO が運用開始前に決める | 再開は今後検討する |
|
|
183
|
+
|
|
184
|
+
### 6.7. 完成判定
|
|
137
185
|
|
|
138
186
|
- 状態一覧の全状態が状態遷移図に登場し、図の業務状態がすべて状態一覧にあります。
|
|
139
187
|
- 外部参照に使う `値` が文書内で一意で、各値から状態を一つに特定できます。
|
|
140
|
-
-
|
|
141
|
-
-
|
|
188
|
+
- 「状態の判定」の正本・判定規則・互換の扱いと「状態一覧」の成立条件から、現在状態を一意に判定できます。
|
|
189
|
+
- 「状態遷移」の各図の全遷移が、その図のすぐ下の遷移表へ一度ずつ対応し、遷移 ID・遷移元・遷移先・イベント・条件が一致しています。分割時も文書全体で遷移の重複や欠落がありません。
|
|
142
190
|
- 初期点からすべての終了状態または継続状態まで到達でき、正常系・例外系の全遷移について終了、正常系への復帰、または人間の判断への引き渡しを説明できます。
|
|
143
191
|
- 状態一覧の各業務状態が少なくとも一つの初期点から到達でき、到達不能な中間状態が残っていません。
|
|
144
192
|
- 状態名、通称、イベント名が用語集・業務データ辞書・関連 CDFD と矛盾していません。
|
|
145
193
|
|
|
194
|
+
### 6.8. 改訂時の影響確認
|
|
195
|
+
|
|
196
|
+
- 改訂・廃止の共通手順は、[[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従います。
|
|
197
|
+
- BA は状態値・状態名・遷移 ID の変更から、参照する業務データ辞書・CDFD・業務ルールの判断への影響を確認します。ARC・DEV は型・schema・イベント処理、QE は状態遷移テスト・受入条件の追従対象を確認します。
|
|
198
|
+
- 影響先と担当 Role code、旧 ID の参照の扱い、追従確認の結果は作業の記録へ残し、未完了の追従は PM へ引き継ぎます。
|
|
199
|
+
|
|
146
200
|
## 7. 禁止事項
|
|
147
201
|
|
|
148
202
|
- 同じ対象の状態一覧と状態遷移図を別文書へ分けません。
|
|
149
203
|
- 状態名に `is_active`、`FLAG_01`、数値だけのコードなど、実装上の識別子を使いません。
|
|
150
204
|
- 画面ページ、API 呼び出し、関数実行を業務状態または業務イベントとしてそのまま記載しません。
|
|
151
|
-
-
|
|
152
|
-
-
|
|
205
|
+
- 遷移ラベルから遷移 ID やイベントを省略したり、条件を実装式だけで表したりしません。
|
|
206
|
+
- 状態一覧にない状態を図へ追加したり、直上の図にない遷移を遷移表へ追加したりしません。
|
|
207
|
+
- 「状態遷移」の図と表を別章へ分けたり、分割図の表を一括して後置したりしません。
|
|
153
208
|
- `<<choice>>` など、状態一覧にない疑似状態を分岐のために追加しません。
|
|
154
209
|
- 親状態と下位状態を持つ複合状態を使用しません。階層化が必要な異なる対象を一つの STSD に混在させません。
|
|
155
210
|
- CDFD、業務データ辞書、用語集に同じ状態一覧や遷移表を複製しません。
|