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,24 +13,18 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Unit Test Catalog (UTC) Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
`utc-index` を前提に、SSOTの本体として、対象ごとの **単体テストの責務・境界・依存、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
16
|
+
単体テストカタログ(UTC)の対象別 `utc-<term>` に記載する責務・境界・依存、観点×条件=ケース、トレース、証跡の基準を定めます。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
- ケースは「表の1行=1テスト」とし、手順と期待値は **判定可能**な粒度で簡潔に書く
|
|
27
|
-
- 詳細な操作列挙やデータ大量列挙は避け、必要な詳細はテストコード側へ寄せる(証跡で参照可能にする)
|
|
28
|
-
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(テストコード/CI)に接続されていること
|
|
20
|
+
- **正本と責務境界**: 対象固有の情報を `utc-<term>` に集約し、共通方針は `utc-index` を参照する。
|
|
21
|
+
- **決定性**: 対象の責務を決定的に検証するため、実DB/実通信/実UIを原則排除する。例外は条件と根拠を示す。
|
|
22
|
+
- **記載レベル**: ケースは表の1行=1テストとし、判定可能な手順・期待値を書く。大量のデータや詳細な操作はテストコードへ寄せる。
|
|
23
|
+
- **追跡性**: すべての観点・ケースを根拠仕様とテストコード/CI証跡へ接続する。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
29
25
|
|
|
30
26
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
31
27
|
|
|
32
|
-
個別 UTC(`utc-<term>`)と他ドキュメントの関係を示します。
|
|
33
|
-
|
|
34
28
|
```mermaid
|
|
35
29
|
flowchart BT
|
|
36
30
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -55,35 +49,19 @@ flowchart BT
|
|
|
55
49
|
|
|
56
50
|
- `id` は `utc-<term>`(kebab-case。例: `utc-inventory`)。
|
|
57
51
|
- ファイル名は `utc-010-単体テストカタログ-<term>.md` 等(例: `utc-010-単体テストカタログ-在庫.md`)。
|
|
58
|
-
- `<term>`
|
|
52
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる。表示名は H1 / ファイル名で日本語を使用してよい。
|
|
59
53
|
|
|
60
54
|
## 4. 推奨 Frontmatter 項目
|
|
61
55
|
|
|
62
56
|
### 4.1. 設定内容
|
|
63
57
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
67
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
68
|
-
|
|
69
|
-
| 項目 | 説明 | 必須 |
|
|
70
|
-
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
71
|
-
| id | UTC ID(個別: `utc-<term>`) | ○ |
|
|
72
|
-
| type | `test` 固定 | ○ |
|
|
73
|
-
| title | 単体テストカタログ: <対象名> | ○ |
|
|
74
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
75
|
-
| based_on | 根拠仕様(最低限: `tsp-index`, `utc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
76
|
-
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
77
|
-
| supersedes | 置き換え関係 | 任意 |
|
|
58
|
+
許可キー・必須項目・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。`specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:utc-rulebook` とする。タイトルは H1 に「単体テストカタログ: <対象名>」と記載する。
|
|
78
59
|
|
|
79
60
|
### 4.2. 推奨ルール
|
|
80
61
|
|
|
81
|
-
- `based_on`
|
|
82
|
-
- `
|
|
83
|
-
|
|
84
|
-
機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
85
|
-
- 記述内容が多くなる場合は、ドキュメントを分割し、`part_of` で集約ドキュメントに所属させます。
|
|
86
|
-
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
62
|
+
- `based_on` は観点の根拠仕様を列挙し、原則 `[tsp-index, utc-index]` を最低限とする。
|
|
63
|
+
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` 等)は本文「トレース」に集約する。機械処理のため `based_on` にも列挙する場合は本文と整合させる。
|
|
64
|
+
- 内容が多く分割する場合は、`part_of` で集約ドキュメントに所属させる。
|
|
87
65
|
|
|
88
66
|
## 5. 本文構成(標準テンプレ)
|
|
89
67
|
|
|
@@ -98,126 +76,81 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
98
76
|
| 5 | トレース | ○ |
|
|
99
77
|
| 6 | テスト観点とケース | ○ |
|
|
100
78
|
|
|
101
|
-
|
|
102
|
-
生成する `utc-<term>` 本文の見出しは各章で指定された **番号付き** の形式
|
|
103
|
-
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
79
|
+
成果物は上表の番号・名称を `##` 見出しにする。「記述ガイド」の節番号は転記しない。「テスト観点とケース」の配下は `### 6.n. 観点:<観点>`、`#### 6.n.1. 意図`、`#### 6.n.2. 条件・ケース表` の順とする。
|
|
104
80
|
|
|
105
81
|
## 6. 記述ガイド
|
|
106
82
|
|
|
107
|
-
|
|
83
|
+
受入確認では次を順に照合する。
|
|
108
84
|
|
|
109
|
-
|
|
85
|
+
1. `utc-index` と責務・対象外・依存の扱いを照合し、例外に条件と根拠があることを確かめる。
|
|
86
|
+
2. 各責務に対応する観点・代表条件・境界条件・重大例外と、トレース先の仕様が一致することを確かめる。
|
|
87
|
+
3. ケースの条件・手順・期待値・観測点をテストコードと照合し、依存を制御して同じ合否を再現でき、CI証跡へ辿れることを確かめる。
|
|
110
88
|
|
|
111
|
-
|
|
89
|
+
### 6.1. 概要(`<term>`)
|
|
112
90
|
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
-
|
|
116
|
-
- 関連コンポーネントや主要API(任意):対象の入口(関数名、クラス名、モジュール名等)を列挙してよい
|
|
117
|
-
- 詳細な仕様の説明や長い背景は書かない(根拠はトレースで示す)
|
|
91
|
+
- 対象を責務のまとまりとして1〜3行で説明し、レビューア・実装者・テスト実装者が前提を把握できるようにする。
|
|
92
|
+
- 粒度は `utc-index` の分割基準に従い、過分割/肥大化を避ける。
|
|
93
|
+
- 主要APIや関連コンポーネントは任意。詳細な仕様や背景はトレース先に置く。
|
|
118
94
|
|
|
119
95
|
### 6.2. 責務
|
|
120
96
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる**形で記述する
|
|
126
|
-
- 例:入力を検証する/業務ルールを適用する/状態遷移を行う/エラーコードを返す
|
|
127
|
-
- 責務は「テスト観点」の上位概念であり、観点は責務を分解した切り口である(責務≠観点)
|
|
128
|
-
- 例外・異常系の責務も含める(不正入力時の振る舞い、権限、期限切れ、競合 等)
|
|
129
|
-
- 可能なら観測可能な成果(戻り値、例外、状態更新、依存呼び出し)とセットで書く
|
|
130
|
-
- 責務に含まれないものは「対象外」へ移す(曖昧さを残さない)
|
|
97
|
+
- 保証すべき責務を3〜7個程度、動詞で始まる箇条書きにする(例:入力を検証する/業務ルールを適用する/状態遷移を行う/エラーコードを返す)。
|
|
98
|
+
- 観点は責務を分解した切り口とし、不正入力・権限・期限切れ・競合などの例外も含める。
|
|
99
|
+
- 戻り値・例外・状態更新・依存呼び出しなど観測可能な成果を可能なら併記する。責務に含めないものは「対象外」へ移す。
|
|
131
100
|
|
|
132
101
|
### 6.3. 対象外
|
|
133
102
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
`utc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
138
|
-
|
|
139
|
-
- 対象外は「なぜ除外するか(理由)」とセットで書く
|
|
140
|
-
- 可能なら「代替するレベル」(IT/ET/E2E/NFR 等)も併記する
|
|
141
|
-
- 対象固有の対象外(例:別モジュールの責務、別termの責務)を明確にする
|
|
142
|
-
- 例外としてUTで扱う場合は、条件・根拠・依存の制御方法(Mock等)を明記する
|
|
143
|
-
|
|
144
|
-
推奨フォーマット(簡易):
|
|
145
|
-
|
|
146
|
-
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
103
|
+
- `utc-index` の「対象外・除外理由(共通)」と整合させ、別モジュール・別termの責務など対象固有の除外を示す。
|
|
104
|
+
- 形式は「対象外:xxx(理由:yyy、代替:zzz)」を推奨し、可能なら代替レベル(IT/ET/E2E/NFR等)も併記する。
|
|
105
|
+
- UTで扱う例外には条件・根拠・依存の制御方法(Mock等)を書く。
|
|
147
106
|
|
|
148
107
|
### 6.4. 境界/依存
|
|
149
108
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
- 境界:対象の入口/出口(公開API、関数、クラス、モジュール)を明記する
|
|
156
|
-
- 依存はカテゴリごとに列挙し、「扱い(Mock/Stub/Fake/固定化)」を決める
|
|
157
|
-
- DB:Fake/Repository mock 等
|
|
158
|
-
- 外部API:Mock/Stub(成功/失敗/タイムアウトを再現)
|
|
159
|
-
- 時刻:固定クロック(注入)
|
|
109
|
+
- 境界は対象の入口/出口(公開API、関数、クラス、モジュール)を示す。
|
|
110
|
+
- 依存は `utc-index` の方針に従い、カテゴリごとに扱いを決める。
|
|
111
|
+
- DB:Fake/Repository mock
|
|
112
|
+
- 外部API:Mock/Stub(成功・失敗・タイムアウトを再現)
|
|
113
|
+
- 時刻:固定クロック注入
|
|
160
114
|
- 乱数/UUID:固定シード/生成器注入
|
|
161
115
|
- ファイル/ストレージ:Fake(テンポラリ/メモリ)/I/F差替
|
|
162
116
|
- 非同期:同期化/制御可能なスケジューラ
|
|
163
|
-
-
|
|
164
|
-
- 「観測点(アサーション)」で何を検証するか(戻り値/例外/状態/相互作用)もここで整理してよい
|
|
117
|
+
- 例外には理由と再現性・速度・保守性への影響を書く。観測点(戻り値/例外/状態/相互作用)も整理してよい。
|
|
165
118
|
|
|
166
119
|
### 6.5. トレース
|
|
167
120
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
本節では、`utc-<term>` の根拠となる上位成果物との対応関係(トレーサビリティ)を示します。
|
|
171
|
-
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、観点・ケース表では **trace_key(`TR-xx`)参照**に統一します。
|
|
172
|
-
|
|
173
|
-
#### 6.5.1. 記述ルール(trace_key)
|
|
174
|
-
|
|
175
|
-
- 各トレース項目に **trace_key(`TR-xx`)** を付与する
|
|
176
|
-
- 例:`TR-01`, `TR-02` …(2桁、01始まり推奨)
|
|
177
|
-
|
|
178
|
-
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
179
|
-
- 仕様IDの改名・統合・分割が起きた場合でも、可能な限り `trace_key` は維持し、対応先(仕様ID)を更新する
|
|
121
|
+
根拠となる上位仕様との対応は「トレース」の表を正本とし、観点・ケース表は `trace_key`(`TR-xx`)で参照する。
|
|
180
122
|
|
|
181
|
-
|
|
182
|
-
- 例:`TR-02` / `TR-01,TR-03`
|
|
123
|
+
#### 6.5.1. 記述ルール(`trace_key`)
|
|
183
124
|
|
|
184
|
-
-
|
|
185
|
-
|
|
186
|
-
- `TR-
|
|
125
|
+
- `trace_key` は文書内で一意とし、追加順に採番する(`TR-01` 始まりの2桁を推奨)。並べ替えや削除で振り直さず、欠番を詰めない。
|
|
126
|
+
- 仕様IDの改名・統合・分割でもキーを可能な限り維持し、対応先を更新する。
|
|
127
|
+
- 観点・ケース表の `トレース` 列は仕様IDを直書きせず `TR-02` / `TR-01,TR-03` のように記載する。根拠の追加時は先にトレース表へ行を追加する。
|
|
187
128
|
|
|
188
129
|
#### 6.5.2. トレース表(標準フォーマット)
|
|
189
130
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
|
194
|
-
|
|
195
|
-
|
|
131
|
+
| 列名 | 内容・判断条件 |
|
|
132
|
+
| ----------- | ------------------------------------------- |
|
|
133
|
+
| `trace_key` | 観点・ケースから参照する一意なキー |
|
|
134
|
+
| 仕様ID | 根拠仕様の文書ID |
|
|
135
|
+
| 要点 | ケース作成の判断に使ったポイントを1行で示す |
|
|
136
|
+
| 備考 | 補足がある場合に記載する |
|
|
196
137
|
|
|
197
138
|
### 6.6. テスト観点とケース
|
|
198
139
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
本節は `utc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
140
|
+
観点ごとに意図とケース表を記述する。
|
|
202
141
|
|
|
203
142
|
#### 6.6.1. 観点:<観点>
|
|
204
143
|
|
|
205
|
-
生成する `utc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
206
|
-
|
|
207
144
|
- 観点は `utc-index` の「観点の立て方(共通)」に従って命名する
|
|
208
145
|
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(細かすぎる観点の乱立を避ける)
|
|
209
146
|
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない(変更が必要なら `supersedes` 等で追跡する)。
|
|
210
147
|
|
|
211
148
|
##### 6.6.1.1. 意図
|
|
212
149
|
|
|
213
|
-
生成する `utc-<term>` 本文の見出しは **#### 6.1.1. 意図**
|
|
214
|
-
|
|
215
150
|
- 観点ごとに「意図(この観点で保証すること)」を 1〜2 行で書く
|
|
216
151
|
|
|
217
152
|
##### 6.6.1.2. 条件・ケース表
|
|
218
153
|
|
|
219
|
-
生成する `utc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
220
|
-
|
|
221
154
|
- ケース表の 1 行は「1テスト」を表す(条件×期待値が一意)
|
|
222
155
|
- 必須カラムは `utc-index` の定義に従う
|
|
223
156
|
- `case_id` は以下を推奨し、変更しない
|
|
@@ -245,60 +178,39 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
245
178
|
|
|
246
179
|
## 8. サンプル(最小)
|
|
247
180
|
|
|
248
|
-
|
|
181
|
+
トレースとケースの接続を示す抜粋。全章構成は「本文構成(標準テンプレ)」に従う。
|
|
249
182
|
|
|
250
|
-
```
|
|
183
|
+
```markdown
|
|
251
184
|
---
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
status: draft
|
|
256
|
-
|
|
257
|
-
based_on: [tsp-index, utc-index]
|
|
258
|
-
supersedes: []
|
|
185
|
+
specdojo:
|
|
186
|
+
id: utc-auth
|
|
187
|
+
type: test
|
|
188
|
+
status: draft
|
|
189
|
+
rulebook: specdojo:utc-rulebook
|
|
190
|
+
based_on: [tsp-index, utc-index]
|
|
259
191
|
---
|
|
260
|
-
```
|
|
261
192
|
|
|
262
|
-
|
|
193
|
+
# 単体テストカタログ: 認証(auth)
|
|
263
194
|
|
|
264
|
-
|
|
195
|
+
## 5. トレース
|
|
265
196
|
|
|
266
|
-
|
|
197
|
+
| `trace_key` | 仕様ID | 要点 | 備考 |
|
|
198
|
+
| ----------- | ----------- | ------------------------ | ---- |
|
|
199
|
+
| TR-01 | br-auth-01 | トークン検証ルール | |
|
|
200
|
+
| TR-02 | bac-auth-02 | 期限切れ時のエラーコード | |
|
|
267
201
|
|
|
268
|
-
|
|
269
|
-
- 権限に応じて許可/拒否を判定する
|
|
270
|
-
- 失敗時に規定のエラーコードを返す
|
|
202
|
+
## 6. テスト観点とケース
|
|
271
203
|
|
|
272
|
-
###
|
|
204
|
+
### 6.1. 観点:入力検証
|
|
273
205
|
|
|
274
|
-
|
|
275
|
-
- 実DB接続による検証(理由:環境依存、代替:IT)
|
|
276
|
-
|
|
277
|
-
### 8.4. 境界/依存
|
|
278
|
-
|
|
279
|
-
- 境界:`verifyToken(token)` / `authorize(user, action)`
|
|
280
|
-
- DB:Fake(インメモリ)
|
|
281
|
-
- 外部IdP:Stub(成功/失敗/タイムアウト)
|
|
282
|
-
- 時刻:固定クロック注入
|
|
283
|
-
|
|
284
|
-
### 8.5. トレース
|
|
285
|
-
|
|
286
|
-
| trace_key | 仕様ID | 要点 | 備考 |
|
|
287
|
-
| --------- | ----------- | ------------------------ | ---- |
|
|
288
|
-
| TR-01 | br-auth-01 | トークン検証ルール | |
|
|
289
|
-
| TR-02 | bac-auth-02 | 期限切れ時のエラーコード | |
|
|
290
|
-
|
|
291
|
-
### 8.6. テスト観点とケース
|
|
292
|
-
|
|
293
|
-
#### 8.6.1. 観点:入力検証
|
|
294
|
-
|
|
295
|
-
##### 8.6.1.1. 意図
|
|
206
|
+
#### 6.1.1. 意図
|
|
296
207
|
|
|
297
208
|
形式不正や期限切れを確実に検出し、規定のエラーコードを返す。
|
|
298
209
|
|
|
299
|
-
|
|
210
|
+
#### 6.1.2. 条件・ケース表
|
|
300
211
|
|
|
301
|
-
| case_id
|
|
302
|
-
| ---------------------------- | ------------------- | ------------------ | -------------- | ---------------------- | --------- |
|
|
303
|
-
| ut-auth-input-validation-010 | 入力: 期限切れtoken | verifyToken(token) | AUTH-001で失敗 | 例外型+code | 時刻=固定 | TR-02
|
|
304
|
-
| ut-auth-input-validation-020 | 入力: 形式不正token | verifyToken(token) | AUTH-002で失敗 | 例外型+code |
|
|
212
|
+
| `case_id` | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 境界/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
213
|
+
| ---------------------------- | ------------------- | ------------------ | -------------- | ---------------------- | --------- | -------- | ------ | --------- | -------------------------------------- |
|
|
214
|
+
| ut-auth-input-validation-010 | 入力: 期限切れtoken | verifyToken(token) | AUTH-001で失敗 | 例外型+code | 時刻=固定 | TR-02 | P0 | automated | tests/auth/verifyToken.test.ts, CI#123 |
|
|
215
|
+
| ut-auth-input-validation-020 | 入力: 形式不正token | verifyToken(token) | AUTH-002で失敗 | 例外型+code | 時刻=固定 | TR-01 | P1 | automated | tests/auth/verifyToken.test.ts, CI#124 |
|
|
216
|
+
```
|
|
@@ -2,37 +2,122 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bac-sample
|
|
4
4
|
type: requirement
|
|
5
|
-
status:
|
|
5
|
+
status: ready
|
|
6
6
|
rulebook: specdojo:bac-rulebook
|
|
7
|
+
based_on: []
|
|
7
8
|
---
|
|
8
9
|
|
|
9
|
-
#
|
|
10
|
+
# 駄菓子屋きぬや 現金販売の業務受入条件
|
|
10
11
|
|
|
11
|
-
## 1.
|
|
12
|
+
## 1. 概要
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
BAC を初めて作成する BA と、承認・設計・受入テストへ引き継ぐ担当者に向けた完成例である。構成と品質判定・検査・確定条件は [[specdojo:bac-rulebook|業務受入条件 作成ルール]] の「本文要件」、rulebook・共通文脈の変更時の追従は [[specdojo:sample-authoring-standard|Sample 記述標準]] の「運用ルール」に従う。
|
|
14
15
|
|
|
15
|
-
|
|
16
|
+
店主代表または家族利用者代表が、現金販売を確定し、販売記録と在庫の変化を照合して店番を引き継げることを確認する。店主の記憶とノートへの転記に頼る負担を減らし、家族が担当しても同じ販売結果を確認できるようにする。
|
|
16
17
|
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
18
|
+
- 価値との対応: 販売と在庫の記録を照合する価値を BAC-01、販売できない購入を誤って確定せず引き継ぐ価値を BAC-02・BAC-03 で確認する。
|
|
19
|
+
- 利用場面・対象範囲: 単一店舗・端末1台で、購入する商品と数量をそろえ、請求額への合意と現金受領を経て、販売と在庫の記録を確認するまで。
|
|
20
|
+
- 対象外: つけ販売、キャッシュレス決済、返品、確定後の訂正、仕入れ、オフラインでの販売継続。
|
|
21
|
+
- 根拠: [[specdojo:prj-overview-sample|プロジェクト概要]] の「まず記録する」方針と家族による店番の継続を、現金販売に限定して具体化する。本例用の業務仕様 `kinuya-bps-cash-sale` は未同梱の架空参照名であり、以下の仮定を完成例の条件とする。受入条件の直接の根拠となる先行成果物への `based_on` は未接続である。
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
_ASSUMPTION_: 本例では、商品・数量が確定し、在庫が足り、合意した請求額の現金を受領してから販売を確定する。確定時は販売を1件記録し、販売数だけ在庫を減らす。入力不足・在庫不足では確定せず、不足を解消してから同じ購入内容の確認へ戻る。これは学習用の業務仮定であり、実店舗の承認済み仕様ではない。
|
|
22
24
|
|
|
23
|
-
|
|
24
|
-
- 必須観点: 対象、条件、判定基準、責任者
|
|
25
|
+
_ASSUMPTION_: 未確定の購入は、分かっている商品・希望数量、不足情報、次に確認することを引継ぎメモに残す。購入中止が合意された場合は中止を記し、再開対象から外す。販売記録・在庫記録・引継ぎメモは論理的な証跡名であり、保存形式は本例で定めない。
|
|
25
26
|
|
|
26
|
-
|
|
27
|
+
| 役割 | 確認・合意する内容 |
|
|
28
|
+
| ---------------- | -------------------------------------------------------------------------- |
|
|
29
|
+
| 家族利用者代表 | 店主不在でも、販売記録・在庫・未確定の購入内容を照合して引き継げること |
|
|
30
|
+
| 店主代表 | 販売確定の条件、販売を止める条件、停止後の次の行為を業務として承認すること |
|
|
31
|
+
| 同行レビュー担当 | 各シナリオの開始状態と確定後の記録から期待結果を確認できること |
|
|
32
|
+
| 開発担当 | 業務条件を設計と動作確認へ引き継ぎ、入力項目と保存構造の正本を整えること |
|
|
27
33
|
|
|
28
|
-
|
|
29
|
-
| ------------ | ---------------------------------------------------- | ------------------------------------ |
|
|
30
|
-
| ドキュメント | [業務受入条件](../rulebooks/bac-rulebook.md) | 最小サンプル |
|
|
31
|
-
| 目的 | 業務として受け入れ可能であることを示す条件を定義する | specdojo:deliverables-reference 準拠 |
|
|
32
|
-
| 主な内容 | 業務シナリオ、受入条件、前提、操作、期待結果 など | 要点のみ記載 |
|
|
34
|
+
## 2. 受入条件
|
|
33
35
|
|
|
34
|
-
|
|
36
|
+
共通前提として、店番担当は店主代表または家族利用者代表とする。商品Aは販売可能な商品で、単価は最終的な販売価格30円、開始時の在庫は5個とする。各ケースは独立した開始状態で確認し、端末と記録の利用に支障はない。計算方式・税区分・保存構造は本例では定めない。
|
|
35
37
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
38
|
+
### 2.1. BAC-01 現金販売を確定して記録を照合する
|
|
39
|
+
|
|
40
|
+
根拠: 概要に記した販売確定と記録の仮定。
|
|
41
|
+
|
|
42
|
+
#### 2.1.1. 前提
|
|
43
|
+
|
|
44
|
+
- 商品Aと購入数量が確定し、在庫数以内である。
|
|
45
|
+
- 来店客と請求額を合意し、その金額の現金を受領している。
|
|
46
|
+
|
|
47
|
+
#### 2.1.2. 操作
|
|
48
|
+
|
|
49
|
+
- 店番担当が、商品と数量、請求額、受領額を確認して販売を確定する。
|
|
50
|
+
|
|
51
|
+
#### 2.1.3. 期待結果
|
|
52
|
+
|
|
53
|
+
| ケース ID | 条件・入力 | 期待結果(観測点) |
|
|
54
|
+
| --------- | ------------------------------------------------------------------ | -------------------------------------------------------------------- |
|
|
55
|
+
| C-01 | 家族利用者代表が商品Aを2個、請求額60円・受領額60円で販売する | 商品A・数量2・販売額60円の販売記録が1件残り、在庫が5個から3個になる |
|
|
56
|
+
| C-02 | 店主代表が商品Aを在庫と同じ5個、請求額150円・受領額150円で販売する | 商品A・数量5・販売額150円の販売記録が1件残り、在庫が5個から0個になる |
|
|
57
|
+
|
|
58
|
+
- 販売記録と在庫の変化を同じ販売へ対応付けて確認できる。次の店番担当は販売済みと未確定の購入を区別できる。
|
|
59
|
+
|
|
60
|
+
#### 2.1.4. 判定方法
|
|
61
|
+
|
|
62
|
+
- 同行レビュー担当が確定後の販売記録と開始前後の在庫記録を照合し、商品・数量・金額・件数と在庫差分を確認する。家族利用者代表は店番交代時に同じ販売記録と引継ぎメモから、販売済みの内容と未確定の購入を区別して説明する。
|
|
63
|
+
|
|
64
|
+
### 2.2. BAC-02 在庫不足なら販売を確定せず確認へ戻る
|
|
65
|
+
|
|
66
|
+
根拠: 概要に記した在庫不足時の仮定。
|
|
67
|
+
|
|
68
|
+
#### 2.2.1. 前提
|
|
69
|
+
|
|
70
|
+
- 商品Aの購入希望数は6個で、在庫5個を超えている。
|
|
71
|
+
- 販売は未確定で、現金をまだ受領していない。
|
|
72
|
+
|
|
73
|
+
#### 2.2.2. 操作
|
|
74
|
+
|
|
75
|
+
- 店番担当が、希望数量と在庫を照合して販売を進めようとする。
|
|
76
|
+
|
|
77
|
+
#### 2.2.3. 期待結果
|
|
78
|
+
|
|
79
|
+
- 不足1個と対象商品を店番担当が確認でき、販売は確定されない。販売記録は追加されず、在庫は5個のままである。
|
|
80
|
+
- 店番担当は不足を来店客へ説明し、数量変更または購入中止を確認できる。店番交代時には、商品A・希望6個・不足1個・来店客への数量変更または中止の確認待ちを引継ぎメモに残し、未確定の内容として次の担当へ渡せる。
|
|
81
|
+
- 来店客が2個への変更に合意した場合は、請求額と現金受領を確認してから BAC-01 の C-01 に相当する販売へ進む。希望数6個の販売記録は作られない。
|
|
82
|
+
- 購入中止に合意した場合は引継ぎメモを中止へ更新し、販売記録は追加せず在庫5個を維持する。
|
|
83
|
+
|
|
84
|
+
#### 2.2.4. 判定方法
|
|
85
|
+
|
|
86
|
+
- 同行レビュー担当が停止直後の不足の表示・販売記録・在庫記録を希望数と開始前の状態に照合する。家族利用者代表は交代時の引継ぎメモから対象・不足数・次の確認行為を説明する。数量変更と購入中止は独立した開始状態で確認し、合意後に同行レビュー担当が引継ぎメモと販売・在庫記録を照合する。変更時は在庫3個・記録1件、中止時は在庫5個・記録追加なしであることを確認する。
|
|
87
|
+
|
|
88
|
+
### 2.3. BAC-03 必須情報が不足した購入を未確定のまま引き継ぐ
|
|
89
|
+
|
|
90
|
+
根拠: 概要に記した入力不足時の仮定。
|
|
91
|
+
|
|
92
|
+
#### 2.3.1. 前提
|
|
93
|
+
|
|
94
|
+
- 共通前提と異なり、次のケースのいずれかで販売に必要な情報がそろっていない。
|
|
95
|
+
- 販売は未確定で、現金受領前である。各ケースは独立して確認する。
|
|
96
|
+
|
|
97
|
+
#### 2.3.2. 操作
|
|
98
|
+
|
|
99
|
+
- 店番担当が購入内容を確認し、不足があれば来店客または次の店番担当へ確認事項を伝える。
|
|
100
|
+
|
|
101
|
+
#### 2.3.3. 期待結果
|
|
102
|
+
|
|
103
|
+
| ケース ID | 条件・入力 | 期待結果(観測点) |
|
|
104
|
+
| --------- | --------------------------------------- | ---------------------------------------------------------------- |
|
|
105
|
+
| C-03 | 数量2は分かるが、対象商品が特定できない | 対象商品の確認が必要と分かり、別の商品を推測して販売を確定しない |
|
|
106
|
+
| C-04 | 商品Aは分かるが、数量が不明である | 数量の確認が必要と分かり、仮の数量で販売を確定しない |
|
|
107
|
+
|
|
108
|
+
- 両ケースで販売記録は追加されず、在庫は5個のままである。引継ぎメモに判明済みの情報と商品または数量の確認待ちを記し、確定済みの販売と区別して次の担当へ引き継げる。
|
|
109
|
+
- 不足が解消し商品A・数量2となった場合は、請求額と現金受領を確認してから BAC-01 の C-01 に相当する販売へ進める。不足中の内容を別の販売として残さない。
|
|
110
|
+
|
|
111
|
+
#### 2.3.4. 判定方法
|
|
112
|
+
|
|
113
|
+
- 同行レビュー担当が停止時の販売記録と在庫記録を開始前と照合する。店番交代時に家族利用者代表が引継ぎメモから判明済みの情報、不足情報、次に確認すること、未確定であることを説明する。補完後は同行レビュー担当が確定時の販売記録と在庫記録を C-01 の期待値に照合し、不足中の販売記録がないことを確認する。
|
|
114
|
+
|
|
115
|
+
## 3. メモ / 将来課題
|
|
116
|
+
|
|
117
|
+
| 論点 | 影響するシナリオ・受入への影響 | 担当・判断者 | 判断時点・解消条件 | 追跡先 |
|
|
118
|
+
| --------------------------------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
119
|
+
| _ASSUMPTION_: 学習用の販売条件と数値 | BAC-01〜03 は粒度を示す完成例であり、実店舗の受入実績ではない | BA が仮定を整理し、店主代表(PO)が業務判断、開発担当(DEV)が試行準備 | 実案件適用前に業務仮定を承認済み仕様へ置き換え、対象商品・数量と引継ぎメモを準備する | 下記の仕様接続と併せて実案件の PJR 登録候補とする |
|
|
120
|
+
| _TODO_: 業務仕様と入力・記録の契約 | BAC-01〜03 の直接の根拠 `kinuya-bps-cash-sale` は未同梱。接続するまで実運用の受入を確定できない | BA が業務仕様と `based_on` を接続し、DEV が契約を整備。店主代表(PO)が業務条件を承認し、同行レビュー担当(QE)が照合 | 受入実施前に、各シナリオの根拠と販売・在庫・引継ぎの証跡をたどれ、全期待結果を判定できること | BA が受入保留への影響を PM へ渡す。登録後は実案件の PJR 個票を参照する |
|
|
121
|
+
| _UNDECIDED_: 通信・記録不能時の販売継続 | BAC-01〜03 の正常稼働前提を外れる。当該経路の受入は保留し、現行シナリオの合格で代替しない | BA が影響を整理し、技術メンター(ARC)が回復案を提示、店主代表(PO)が継続可否を判断 | 当該経路を追加する前に未確定取引の照合と再開条件を承認し、QE が停止・再開の期待結果を確認する | PM へのリスク登録候補。実案件の PJR 個票は未同梱 |
|
|
122
|
+
|
|
123
|
+
返品と確定後の訂正は将来の別シナリオで扱う。店主代表が必要性と業務上の扱いを決めてから追加し、現行の販売条件へ混ぜない。
|