specdojo 0.7.0 → 0.9.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 +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- 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 +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- 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/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- 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 +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- 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 +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- 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 +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- 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 +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- 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 +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- 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-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- 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 +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -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 +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- 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 +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- 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 +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- 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/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- 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 +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -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/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -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 +125 -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/dec-sample.md +2 -3
- 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-api-sample.yaml +0 -2
- 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/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -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 +141 -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/job-definition-standard.md +24 -9
- 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/cdr-template.md +58 -0
- 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 +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -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/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -13,25 +13,20 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
System Test Catalog (STC) Documentation Rules
|
|
15
15
|
|
|
16
|
-
本ドキュメントは、総合テストカタログ(STC)の対象別 `stc-<term>` を統一形式で記述するためのルールです。
|
|
17
|
-
`stc-index` を前提に、SSOTの本体として、対象ごとの **総合テストの目的・責務・境界・環境前提、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
18
|
-
|
|
19
16
|
## 1. 全体方針
|
|
20
17
|
|
|
21
|
-
個別 STC(`stc-<term>`)は、総合テストにおける SSOT
|
|
22
|
-
観点×条件=ケース(末端表)を最小情報で整理して、テスト実装/CI/テストレポート証跡へ確実に接続できる形で記述する。
|
|
18
|
+
個別 STC(`stc-<term>`)は、総合テストにおける SSOT の本体として、対象ごとの狙いと境界を明確化し、観点×条件=ケース(末端表)を最小情報で整理して、テスト実装/CI/テストレポート証跡へ接続できる形で記述する。
|
|
23
19
|
|
|
24
20
|
- `stc-<term>` は **対象固有の情報のみ** を記述し、共通ルールは `stc-index` を参照する(重複記述しない)
|
|
25
21
|
- 総合テストの目的は「**実運用に近い経路で、システム全体として業務が成立すること**」の確認である
|
|
26
22
|
- ケースは「表の1行=1テスト(1シナリオ)」とし、手順と期待値は **判定可能** な粒度で簡潔に書く
|
|
27
|
-
-
|
|
28
|
-
-
|
|
23
|
+
- 手順は **高位の行動** と **観測点** に寄せ、クリック列挙や画面要素の細部はテストコードへ寄せる
|
|
24
|
+
- すべての観点・ケースは、根拠仕様(`トレース`)と証跡(CI/レポート/ログ相関等)に接続されていること
|
|
29
25
|
- 環境・テストデータ・外部依存(sandbox/スタブ等)は **再現性** を優先し、対象ごとに無根拠に変更しない(例外は根拠を明記)
|
|
26
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、ケースの期待値や証跡に含めない。
|
|
30
27
|
|
|
31
28
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
32
29
|
|
|
33
|
-
個別 STC(`stc-<term>`)と他ドキュメントの関係を示します。
|
|
34
|
-
|
|
35
30
|
```mermaid
|
|
36
31
|
flowchart BT
|
|
37
32
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -56,34 +51,22 @@ flowchart BT
|
|
|
56
51
|
|
|
57
52
|
- `id` は `stc-<term>`(kebab-case。例: `stc-order-place`)。
|
|
58
53
|
- ファイル名は `stc-010-総合テストカタログ-<term>.md` 等(例: `stc-010-総合テストカタログ-注文確定.md`)。
|
|
59
|
-
- `<term>` は用語集(GL) の論理名キー(英小文字kebab-case)を用いる(表示名は
|
|
54
|
+
- `<term>` は用語集(GL) の論理名キー(英小文字kebab-case)を用いる(表示名は H1 / ファイル名で日本語を使用してよい)。
|
|
55
|
+
- H1 は `# 総合テストカタログ: <対象名>` とする。
|
|
60
56
|
|
|
61
57
|
## 4. 推奨 Frontmatter 項目
|
|
62
58
|
|
|
63
59
|
### 4.1. 設定内容
|
|
64
60
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
68
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
61
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
69
62
|
|
|
70
|
-
|
|
71
|
-
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
72
|
-
| id | STC ID(個別: `stc-<term>`) | ○ |
|
|
73
|
-
| type | `test` 固定 | ○ |
|
|
74
|
-
| title | 総合テストカタログ: <対象名> | ○ |
|
|
75
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
76
|
-
| based_on | 根拠仕様(最低限: `tsp-index`, `stc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
77
|
-
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
78
|
-
| supersedes | 置き換え関係(ID配列) | 任意 |
|
|
63
|
+
- `specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:stc-rulebook` とする。
|
|
79
64
|
|
|
80
65
|
### 4.2. 推奨ルール
|
|
81
66
|
|
|
82
|
-
- `based_on` は原則 `[tsp-index, stc-index]` を最低限とする。
|
|
83
|
-
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` / `ac-*` / `issue-*`
|
|
84
|
-
|
|
85
|
-
- 記述内容が多くなる場合は、対象を分割し、`part_of` で集約ドキュメントに所属させる。
|
|
86
|
-
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
67
|
+
- `specdojo.based_on` は原則 `[tsp-index, stc-index]` を最低限とする。
|
|
68
|
+
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` / `ac-*` / `issue-*` 等)は本文「トレース」に集約する。機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
69
|
+
- 記述内容が多くなる場合は、対象を分割し、`specdojo.part_of` で集約ドキュメントに所属させる。
|
|
87
70
|
|
|
88
71
|
## 5. 本文構成(標準テンプレ)
|
|
89
72
|
|
|
@@ -98,8 +81,7 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
98
81
|
| 5 | トレース | ○ |
|
|
99
82
|
| 6 | テスト観点とケース | ○ |
|
|
100
83
|
|
|
101
|
-
|
|
102
|
-
生成する `stc-<term>` 本文の見出しは各章で指定された **番号付き** の形式に置き換えてください。
|
|
84
|
+
次章の見出しは参照用であり、生成する本文の見出しは各章で指定する番号付きの形式とします。
|
|
103
85
|
|
|
104
86
|
## 6. 記述ガイド
|
|
105
87
|
|
|
@@ -107,10 +89,7 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
107
89
|
|
|
108
90
|
生成する `stc-<term>` 本文の見出しは **## 1. 概要(<term>)**
|
|
109
91
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
- `<term>` の説明(1〜3行):業務/ユーザ価値のまとまりとして記述する(開始条件→完了条件が想像できる形)
|
|
113
|
-
- 期待する利用者:レビューア/実装者/テスト実装者が前提を把握できる内容にする
|
|
92
|
+
- `<term>` の説明(1〜3行):本カタログで扱う業務シナリオ/経路を、開始条件→完了条件が想像できる形で書く
|
|
114
93
|
- 対象の粒度:`stc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
115
94
|
- 関連コンポーネントや主要I/F(任意):主要画面、API、バッチ、イベント等を列挙してよい
|
|
116
95
|
- 詳細な仕様説明や長い背景は書かない(根拠はトレースで示す)
|
|
@@ -119,65 +98,40 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
119
98
|
|
|
120
99
|
生成する `stc-<term>` 本文の見出しは **## 2. 目的**
|
|
121
100
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる** 形で記述する
|
|
101
|
+
- 「この対象で何を保証したいか(狙い)」を、3〜7 個程度、**動詞で始まる** 箇条書きで記述する
|
|
125
102
|
- 例:主要業務フローが完了できる/主要分岐で破綻しない/再実行で二重処理しない/監査証跡が残る
|
|
126
|
-
|
|
127
103
|
- 目的は観点の上位概念であり、観点は目的を分解した切り口(目的≠観点)
|
|
128
104
|
- 可能なら観測可能な成果(画面表示、API応答、DB状態、イベント、ログ相関ID等)とセットで書く
|
|
129
|
-
-
|
|
105
|
+
- 目的に含まれないものは「対象外」へ移す
|
|
130
106
|
|
|
131
107
|
### 6.3. 対象外
|
|
132
108
|
|
|
133
109
|
生成する `stc-<term>` 本文の見出しは **## 3. 対象外**
|
|
134
110
|
|
|
135
|
-
本節では、「この対象カタログ(`stc-<term>`)ではやらないこと」を明示します。
|
|
136
111
|
`stc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
137
112
|
|
|
138
|
-
-
|
|
139
|
-
- 可能なら「代替するレベル」(UT/IT/ET/AT/NFR 等)も併記する
|
|
140
|
-
- 対象固有の対象外(例:別業務フロー、別サブシステムの責務)を明確にする
|
|
113
|
+
- 対象外は「理由」と、可能なら「代替するレベル」(UT/IT/ET/AT/NFR 等)を併記する(形式:`対象外:xxx(理由:yyy、代替:zzz)`)
|
|
141
114
|
- 例外としてSTで扱う場合は、条件・根拠・環境前提(sandbox/スタブ/データ準備)を明記する
|
|
142
115
|
|
|
143
|
-
推奨フォーマット(簡易):
|
|
144
|
-
|
|
145
|
-
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
146
|
-
|
|
147
116
|
### 6.4. 境界/環境/依存
|
|
148
117
|
|
|
149
118
|
生成する `stc-<term>` 本文の見出しは **## 4. 境界/環境/依存**
|
|
150
119
|
|
|
151
|
-
本節では、総合テストにおける「境界(どこからどこまでが対象か)」と
|
|
152
|
-
「環境前提」「外部依存(sandbox/スタブ/疑似等)」を明確にします。
|
|
153
|
-
|
|
154
120
|
- 境界:開始トリガ/入口(画面/API/バッチ等)と、完了条件/出口(完了状態、発行イベント等)を明記する
|
|
155
121
|
- 環境:ST環境名、主要設定、テストデータの準備・後始末(namespace/初期化/削除)を列挙する
|
|
156
|
-
-
|
|
157
|
-
|
|
158
|
-
- メール/SMS/Push:ダミー配送・検証用受信箱・ログ確認の方針
|
|
159
|
-
- 決済/配送など:本番課金/実配送は原則しない(例外は条件を明記)
|
|
160
|
-
|
|
161
|
-
- 観測点(Evidence):何を見て合否判定するかを明記する
|
|
162
|
-
- 画面/レスポンス、DB状態、イベント、監査ログ、相関ID、外部リクエストID 等
|
|
163
|
-
|
|
122
|
+
- 外部依存:依存先ごとに sandbox/スタブ/疑似応答(成功/代表失敗/一時不可など)、ダミー配送などの扱いを決める。本番課金/実配送は原則しない(例外は条件を明記)
|
|
123
|
+
- 観測点(Evidence):何を見て合否判定するか(画面/レスポンス、DB状態、イベント、監査ログ、相関ID 等)を明記する
|
|
164
124
|
- 例外:環境や依存の扱いを変える場合は、理由と影響(再現性・コスト・安全性)を明記する
|
|
165
125
|
|
|
166
126
|
### 6.5. トレース
|
|
167
127
|
|
|
168
128
|
生成する `stc-<term>` 本文の見出しは **## 5. トレース**
|
|
169
129
|
|
|
170
|
-
本節では、`stc-<term>` の根拠となる上位成果物との対応関係を示します。
|
|
171
|
-
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、
|
|
172
|
-
観点・ケース表では **trace_key(`TR-xx`)参照** に統一します。
|
|
173
|
-
|
|
174
130
|
#### 6.5.1. 記述ルール(trace_key)
|
|
175
131
|
|
|
176
|
-
-
|
|
177
|
-
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
132
|
+
- 各トレース項目に、本ドキュメント内で一意の **trace_key(`TR-xx`)** を付与する。採番は追加順で、削除しても欠番は詰めない
|
|
178
133
|
- 観点・ケース表の `トレース` 列には **仕様IDを直書きせず**、`TR-xx` を列挙する
|
|
179
134
|
- ケース表に新しい根拠が必要になった場合は、**先に本節の表へ行追加**し、付与された `trace_key` をケース表で参照する
|
|
180
|
-
- `TR-xx` の採番は追加順。削除しても欠番は詰めない。
|
|
181
135
|
|
|
182
136
|
#### 6.5.2. トレース表(標準フォーマット)
|
|
183
137
|
|
|
@@ -192,8 +146,6 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
192
146
|
|
|
193
147
|
生成する `stc-<term>` 本文の見出しは **## 6. テスト観点とケース**
|
|
194
148
|
|
|
195
|
-
本節は `stc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
196
|
-
|
|
197
149
|
#### 6.6.1. 観点:<観点>
|
|
198
150
|
|
|
199
151
|
生成する `stc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
@@ -212,19 +164,12 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
212
164
|
|
|
213
165
|
生成する `stc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
214
166
|
|
|
215
|
-
- ケース表の 1 行は「1テスト(1シナリオ)」を表す(条件×期待値が一意)
|
|
216
167
|
- 必須カラムは `stc-index` の定義に従う
|
|
217
|
-
- `case_id`
|
|
218
|
-
- 形式:`<level>-<term>-<perspective_key>-<nnn>`(`level` は `st`)
|
|
219
|
-
- `perspective_key`:kebab-case(英小文字+数字+ハイフン)。原則変更しない
|
|
220
|
-
- `nnn`:3桁、10刻み(010,020,030…)推奨
|
|
221
|
-
|
|
168
|
+
- `case_id` の形式は `<level>-<term>-<perspective_key>-<nnn>`(`level` は `st`、`perspective_key` は英小文字+数字+ハイフン、`nnn` は3桁で10刻み推奨)とする
|
|
222
169
|
- 条件は `入力:` `状態:` `環境:` `経路:` の要点で表現する(必要な要素のみ記載)
|
|
223
|
-
-
|
|
224
|
-
- 期待値は判定可能に書く(画面/レスポンスに加え、DB状態、イベント、監査ログ、相関IDなどの観測点を含める)
|
|
170
|
+
- 期待値は判定可能に書き、画面/レスポンスに加え DB状態、イベント、監査ログ、相関IDなどの観測点を含める
|
|
225
171
|
- 証跡は CI/レポート/ログ相関/スクショ等へ接続できる形で書く(例:パス、CI run ID、レポートURLキー等)
|
|
226
|
-
|
|
227
|
-
推奨:観点ごとのケース数は「代表→重要分岐→重大例外」の順で増やし、直積(全組合せ)を原則避ける
|
|
172
|
+
- 観点ごとのケース数は「代表→重要分岐→重大例外」の順で増やす
|
|
228
173
|
|
|
229
174
|
## 7. 禁止事項
|
|
230
175
|
|
|
@@ -240,59 +185,54 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
240
185
|
|
|
241
186
|
## 8. サンプル(最小)
|
|
242
187
|
|
|
243
|
-
|
|
188
|
+
注:以下は形式の輪郭を示す最小例である。生成する `stc-<term>` では `## 1...` から始まる。
|
|
244
189
|
|
|
245
|
-
```
|
|
190
|
+
```markdown
|
|
246
191
|
---
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
status: draft
|
|
251
|
-
|
|
252
|
-
based_on: [tsp-index, stc-index]
|
|
253
|
-
supersedes: []
|
|
192
|
+
specdojo:
|
|
193
|
+
id: stc-order-place
|
|
194
|
+
type: test
|
|
195
|
+
status: draft
|
|
196
|
+
rulebook: specdojo:stc-rulebook
|
|
197
|
+
based_on: [tsp-index, stc-index]
|
|
254
198
|
---
|
|
255
|
-
```
|
|
256
199
|
|
|
257
|
-
|
|
200
|
+
# 総合テストカタログ: 注文確定(order-place)
|
|
258
201
|
|
|
259
|
-
|
|
202
|
+
## 1. 概要(order-place)
|
|
260
203
|
|
|
261
|
-
|
|
204
|
+
カートから注文を確定し、決済(sandbox)を経て注文が確定状態になる経路を扱う。
|
|
205
|
+
|
|
206
|
+
## 2. 目的
|
|
262
207
|
|
|
263
208
|
- 注文確定フローが完了条件(注文=確定)まで到達できることを保証する
|
|
264
|
-
- 決済失敗時に注文が不整合にならず、適切にエラーハンドリングされることを保証する
|
|
265
|
-
- 監査ログ/相関IDにより追跡可能であることを保証する
|
|
266
209
|
|
|
267
|
-
|
|
210
|
+
## 3. 対象外
|
|
268
211
|
|
|
269
212
|
- 本番決済の実課金(理由:安全性、代替:ET/事業者検証)
|
|
270
|
-
- 全ブラウザ網羅の表示互換(理由:範囲過大、代替:別途互換試験)
|
|
271
213
|
|
|
272
|
-
|
|
214
|
+
## 4. 境界/環境/依存
|
|
273
215
|
|
|
274
216
|
- 境界:開始=カート確定操作、完了=注文が確定状態+通知イベント発行
|
|
275
|
-
- 環境:staging
|
|
276
|
-
- 外部決済:sandbox(成功/残高不足の代表失敗のみ)
|
|
277
|
-
- 観測点:画面結果、注文DB状態、イベント、監査ログ(correlation_id)
|
|
217
|
+
- 環境:staging、外部決済=sandbox
|
|
278
218
|
|
|
279
|
-
|
|
219
|
+
## 5. トレース
|
|
280
220
|
|
|
281
221
|
| trace_key | 仕様ID | 要点 | 備考 |
|
|
282
222
|
| --------- | ----------- | ------------------ | ---- |
|
|
283
223
|
| TR-01 | br-order-01 | 注文確定の完了条件 | |
|
|
284
|
-
| TR-02 | bac-pay-02 | 決済失敗時の扱い | |
|
|
285
224
|
|
|
286
|
-
|
|
225
|
+
## 6. テスト観点とケース
|
|
287
226
|
|
|
288
|
-
|
|
227
|
+
### 6.1. 観点:業務フロー成立
|
|
289
228
|
|
|
290
|
-
|
|
229
|
+
#### 6.1.1. 意図
|
|
291
230
|
|
|
292
|
-
|
|
231
|
+
代表条件で注文確定が完了し、監査証跡が揃うことを確認する。
|
|
293
232
|
|
|
294
|
-
|
|
233
|
+
#### 6.1.2. 条件・ケース表
|
|
295
234
|
|
|
296
235
|
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 環境/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
297
236
|
| ------------------------------- | --------------------------------------- | ------------------ | --------------------------------------- | -------------------------------------- | -------------------- | -------- | ------ | --------- | ---------------------------- |
|
|
298
237
|
| st-order-place-flow-success-010 | 状態: 在庫あり / 環境: 決済=sandbox成功 | 注文確定を実行する | 注文=確定になり通知イベントが発行される | DB状態/イベント/監査ログcorrelation_id | staging, pay=sandbox | TR-01 | P0 | automated | e2e/order/place.spec.ts, CI# |
|
|
238
|
+
```
|
|
@@ -16,35 +16,32 @@ 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
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
| 別名 | 状態一覧の状態名とは異なる表示名。同一状態の表示名変更を指し、本 rulebook では使用しない |
|
|
36
|
-
| 初期点 | ライフサイクルの開始を示す `[*]` |
|
|
37
|
-
| 終了点 | ライフサイクルの終了を示す `[*]` |
|
|
38
|
-
| 遷移 | `遷移元 --> 遷移先 : イベント / 条件` で示す状態変化 |
|
|
30
|
+
| 用語 | 定義 |
|
|
31
|
+
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| 表示名 | 図上に表示するラベル。値がある場合は `状態名<br>値` の 2 行とし、1 行目は状態一覧の状態名、2 行目は状態一覧の値と完全一致させる。値が `-` の場合は状態名だけを表示する |
|
|
33
|
+
| `state_id` | Mermaid コード内で状態を参照する内部 ID。表示名と分けて使用し、表示する値の代わりにはしない |
|
|
34
|
+
| 別名 | 表示名の状態名部分に使用する、状態一覧の状態名とは異なる名前。本 rulebook では使用しない |
|
|
39
35
|
|
|
40
|
-
|
|
36
|
+
同じイベントによる分岐は疑似状態を置かず、同じ遷移元から出る複数の遷移として表します。遷移元と遷移先に使用できるのは、状態一覧にある業務状態と初期点・終了点だけです。
|
|
41
37
|
|
|
42
38
|
## 3. ファイル命名・ID規則
|
|
43
39
|
|
|
44
|
-
- 本 rulebook 単独の成果物は作成せず、`stsd-<term>.md`
|
|
40
|
+
- 本 rulebook 単独の成果物は作成せず、`stsd-<term>.md` の「状態遷移」章の図に適用します。
|
|
45
41
|
- 状態名は日本語の名詞句にし、STSD の状態一覧と同じ表記を使います。
|
|
42
|
+
- 遷移 ID は [[specdojo:stsd-rulebook|ステータス定義作成ルール]] の「状態遷移」に従い、同じ STSD の図直下の遷移表と同じ `T-<nn>` を使用します。
|
|
46
43
|
- イベント名は短い業務用語、条件は業務上判定可能な事実で記述します。
|
|
47
|
-
-
|
|
44
|
+
- 各業務状態は、状態一覧に値がある場合は `state "状態名<br>値" as state_id`、値が `-` の場合は `state "状態名" as state_id` で宣言します。これは別名ではありません。`state_id` は英小文字で始まる英小文字・数字・アンダースコアだけの `[a-z][a-z0-9_]*` とし、一つの Mermaid コードブロック内で一意にします。表示する値には `state_id` ではなく状態一覧の値をそのまま使います。
|
|
48
45
|
- 図を分割して同じ状態を複数図へ再掲する場合は、各図で `state "表示名" as state_id` を宣言し、同じ表示名と同じ `state_id` を維持します。分割図ごとに別名や異なる `state_id` を付けません。
|
|
49
46
|
|
|
50
47
|
## 4. 推奨 Frontmatter 項目
|
|
@@ -53,15 +50,13 @@ STSD の「状態遷移図」を Mermaid の `stateDiagram-v2` で一貫して
|
|
|
53
50
|
|
|
54
51
|
## 5. 本文要件
|
|
55
52
|
|
|
56
|
-
| 要素 | 必須 | 記述
|
|
57
|
-
| ---------- | ---- |
|
|
58
|
-
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする
|
|
59
|
-
| 業務状態 | ○ |
|
|
60
|
-
| 遷移ラベル | ○ |
|
|
61
|
-
| 初期点 | ○ | `[*] --> 初期状態 : イベント / 条件` で示す |
|
|
62
|
-
| 終了点 | 任意 | 業務上の終了がある場合に `終了状態 --> [*] : イベント / 条件` で示す |
|
|
53
|
+
| 要素 | 必須 | 記述 |
|
|
54
|
+
| ---------- | ---- | ----------------------------------------------- |
|
|
55
|
+
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする |
|
|
56
|
+
| 業務状態 | ○ | 状態一覧の状態名・値に基づく表示名を使用する |
|
|
57
|
+
| 遷移ラベル | ○ | `T-<nn> イベント / 条件` を記載する |
|
|
63
58
|
|
|
64
|
-
|
|
59
|
+
初期点は STSD 全体で必須とし、分割時の配置は「図の分割」に従います。終了点の要否、継続状態の扱い、省略時に「適用範囲」へ記載する内容は、[[specdojo:stsd-rulebook|ステータス定義作成ルール]] の「状態遷移」に従います。
|
|
65
60
|
|
|
66
61
|
## 6. 記述ガイド
|
|
67
62
|
|
|
@@ -69,44 +64,55 @@ STSD の「状態遷移図」を Mermaid の `stateDiagram-v2` で一貫して
|
|
|
69
64
|
|
|
70
65
|
```mermaid
|
|
71
66
|
stateDiagram-v2
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
67
|
+
state "入荷済み<br>received" as received
|
|
68
|
+
state "販売可能<br>sellable" as sellable
|
|
69
|
+
state "返品待ち<br>return-pending" as return_pending
|
|
70
|
+
[*] --> received : T-01 入荷受入 / 発注内容と照合済み
|
|
71
|
+
received --> sellable : T-02 検品完了 / 数量・品質が合格
|
|
72
|
+
received --> return_pending : T-03 検品完了 / 数量違いまたは品質不良
|
|
73
|
+
sellable --> [*] : T-04 販売完了 / 顧客へ引渡し済み
|
|
76
74
|
```
|
|
77
75
|
|
|
78
76
|
- 行頭は半角スペース 2 個でそろえます。
|
|
79
|
-
-
|
|
80
|
-
- 条件が常に成立する遷移は
|
|
77
|
+
- コロンの左に遷移元と遷移先、右に遷移 ID・イベント・条件を記載します。
|
|
78
|
+
- 条件が常に成立する遷移は `T-<nn> イベント / イベント発生時` とし、ラベルを省略しません。
|
|
81
79
|
|
|
82
80
|
### 6.2. 分岐と自己遷移
|
|
83
81
|
|
|
84
|
-
-
|
|
85
|
-
- 分岐を表す `<<choice>>`
|
|
82
|
+
- 同じ状態・イベントから分岐する場合は、同じ遷移元から遷移先ごとに矢印を出し、各矢印へ異なる遷移 ID、同じイベント、相互排他的な条件を `T-<nn> イベント / 条件` 形式で記載します。
|
|
83
|
+
- 分岐を表す `<<choice>>` など、状態一覧にない疑似状態は使用しません。分岐判断の根拠は各遷移の条件と「状態遷移」の遷移表に記載します。
|
|
86
84
|
- 自己遷移は業務上の状態を保ったまま記録更新や再確認を行う場合だけ記載します。
|
|
87
85
|
|
|
86
|
+
次の例では、状態一覧の「検品中」の値を `-` とします。
|
|
87
|
+
|
|
88
88
|
```mermaid
|
|
89
89
|
stateDiagram-v2
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
90
|
+
state "検品中" as inspecting
|
|
91
|
+
state "販売可能<br>sellable" as sellable
|
|
92
|
+
state "返品待ち<br>return-pending" as return_pending
|
|
93
|
+
[*] --> inspecting : T-01 検品開始 / 対象商品あり
|
|
94
|
+
inspecting --> sellable : T-02 検品完了 / 数量・品質が合格
|
|
95
|
+
inspecting --> return_pending : T-03 検品完了 / 数量違いまたは品質不良
|
|
93
96
|
```
|
|
94
97
|
|
|
95
98
|
### 6.3. 図の分割
|
|
96
99
|
|
|
97
100
|
- 状態はすべて同じ階層へ置き、親状態と下位状態を持つ複合状態は使用しません。階層化が必要な場合は、状態を持つ対象を分け、対象ごとに別の STSD を作成します。
|
|
98
101
|
- 業務状態が 15 を超える、遷移が 20 を超える、または一つの業務状態に接続する入出力遷移の合計が 6 を超える場合は、同じ STSD 内で図を分割します。
|
|
99
|
-
-
|
|
102
|
+
- 分割単位は業務フェーズまたは通常系・例外系とします。分割した図で共有する状態は、同じ表示名と同じ `state_id` を使用します。
|
|
103
|
+
- 各図のすぐ下にその図の遷移表を置きます。図を読む前に対象経路を識別できるよう、各図が扱う遷移 ID の範囲を図の前へ記載し、直下の遷移表と一致させます。分割理由・共有状態も図の前へ置き、図と遷移表の間に説明文や別の図を挟みません。
|
|
100
104
|
- 規模が閾値以下でも分割できますが、全遷移がいずれか一つの図に過不足なく対応し、図をまたぐ接続状態を明記します。
|
|
105
|
+
- 初期点はライフサイクルの開始遷移を扱う図に置きます。開始遷移は対応する図に一度だけ記載し、共有状態から続きを描く図には初期点を置きません。
|
|
106
|
+
- 到達性と終了状態・継続状態の判定は、共有状態を介して全図をつないで行います。ある図で出力遷移がなくても、他の図に出力遷移がある状態を継続状態とはみなしません。
|
|
101
107
|
|
|
102
108
|
### 6.4. 完成判定
|
|
103
109
|
|
|
104
110
|
- 状態一覧の全状態が少なくとも一つの図に登場しています。
|
|
105
|
-
-
|
|
106
|
-
- 終了状態は終了点 `[*]`
|
|
111
|
+
- 図の業務状態はすべて状態一覧にあり、表示名が「表示名」の定義と一致しています。
|
|
112
|
+
- 終了状態は終了点 `[*]` への出力遷移を持つ状態とします。
|
|
107
113
|
- 初期点が一つ以上あり、各初期点から、正常系・例外系を問わず、すべての終了状態および継続状態まで遷移をたどれます。到達不能な終端は残しません。
|
|
108
114
|
- 状態一覧の各業務状態は、少なくとも一つの初期点から遷移をたどって到達できます。初期点から到達できない中間状態は、既存の終了状態へ接続していても残しません。
|
|
109
|
-
-
|
|
115
|
+
- 全遷移に遷移 ID・イベント・条件があり、「状態遷移」の各図の直下の遷移表と一対一に対応し、遷移元・遷移先も一致しています。
|
|
110
116
|
- 分岐条件が重複せず、どの遷移も業務上判定できます。
|
|
111
117
|
|
|
112
118
|
## 7. 禁止事項
|
|
@@ -114,9 +120,9 @@ stateDiagram-v2
|
|
|
114
120
|
- 画面ページ間の移動を状態遷移として描きません。
|
|
115
121
|
- `if`、`&&`、`null` などの実装条件式を条件ラベルに使いません。
|
|
116
122
|
- enum 値、数値、フラグだけを状態名にしません。
|
|
117
|
-
-
|
|
123
|
+
- 状態一覧にない状態や、「状態遷移」の遷移表にない矢印を追加しません。
|
|
118
124
|
- `<<choice>>`、`<<fork>>`、`<<join>>` など、状態一覧にない疑似状態を使用しません。
|
|
119
125
|
- 親状態と下位状態を持つ `state` ブロックなど、複合状態を使用しません。階層化が必要な対象を一つの STSD に混在させません。
|
|
120
|
-
-
|
|
126
|
+
- STSD 全体から初期点を省略したり、一つのコードブロック内で同じ `state_id` を異なる状態へ割り当てたりしません。
|
|
121
127
|
- 分割図で共有する状態の表示名や `state_id` を図ごとに変更しません。
|
|
122
128
|
- 状態の意味・成立条件を図中の長文ノートへ複製しません。
|