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,33 +13,27 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Acceptance Test Catalog (ATC) Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
`atc-index` を前提に、SSOT の本体として、対象ごとの **受入判断に必要な範囲(責務・境界・観点×条件=ケース、トレース、証跡)** を明文化します。
|
|
16
|
+
受入テストカタログの対象別文書 `atc-<term>` を、対象ごとの受入判断の範囲(責務・境界・観点とケース・トレース・証跡)が分かる統一形式で記述するためのルールです。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
20
|
+
- `atc-<term>` は `atc-index` を前提とする受入テストの正本であり、対象固有の情報だけを書く。共通の方針は `atc-index` を参照し、言い直さない。
|
|
21
|
+
- 目的は関係者が受け入れ可否を判断できることであり、内部実装の網羅や詳細な分岐の確認は扱わない(必要なら別のテストレベルへ送る)。
|
|
22
|
+
- ケースは表の 1 行を 1 受入シナリオとし、手順と期待値を合否判定できる粒度で簡潔に書く。クリック列挙や大量データは実施手順書・実施記録へ寄せ、証跡から参照する。
|
|
23
|
+
- すべての観点とケースを、根拠仕様(トレース)と証跡(実施記録・レポート・ログ)へ接続する。
|
|
24
|
+
- 環境・データ・外部依存の前提は合否の再現性に直結するため、対象固有の差分を必ず書く。
|
|
25
|
+
- 共通の運用: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
23
26
|
|
|
24
|
-
|
|
25
|
-
- 受入テストの目的は「関係者が受け入れ可否を判断できること」であり、内部実装の網羅や詳細分岐の確認は目的外(必要なら別レベルへ)
|
|
26
|
-
- ケースは「表の1行=1受入シナリオ」とし、手順と期待値は **合否判定可能** な粒度で簡潔に書く
|
|
27
|
-
- クリック列挙・画面要素の細部・大量データ列挙は避け、必要な詳細は **実施手順書/実施記録** 側へ寄せる(証跡で参照可能にする)
|
|
28
|
-
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(実施記録/レポート/ログ)に接続されていること
|
|
29
|
-
- 環境・データ・外部依存の前提は受入判断の再現性に直結するため、対象ごとの差分は必ず明記する(共通は `atc-index`)
|
|
30
|
-
|
|
31
|
-
## 2. 位置づけ(他ドキュメントとの関係)
|
|
32
|
-
|
|
33
|
-
個別 ATC(`atc-<term>`)と他ドキュメントの関係を示します。
|
|
27
|
+
## 2. 位置づけ
|
|
34
28
|
|
|
35
29
|
```mermaid
|
|
36
30
|
flowchart BT
|
|
37
31
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
38
32
|
|
|
39
|
-
subgraph TC["
|
|
33
|
+
subgraph TC["受入テストカタログ"]
|
|
40
34
|
direction RL
|
|
41
|
-
TCIndex["atc-index<br
|
|
42
|
-
TCDetail["atc-<term><br
|
|
35
|
+
TCIndex["atc-index<br>受入テストカタログ(全体構成)"]
|
|
36
|
+
TCDetail["atc-<term><br>受入テストカタログ(対象別)"]
|
|
43
37
|
TCDetail -->|based_on| TCIndex
|
|
44
38
|
end
|
|
45
39
|
|
|
@@ -50,254 +44,134 @@ flowchart BT
|
|
|
50
44
|
|
|
51
45
|
classDef target stroke-width:4px
|
|
52
46
|
class TCDetail target
|
|
53
|
-
|
|
54
47
|
```
|
|
55
48
|
|
|
56
49
|
## 3. ファイル命名・ID規則
|
|
57
50
|
|
|
58
|
-
- `id` は `atc-<term>`(kebab-case。例: `atc-checkout
|
|
59
|
-
- ファイル名は `atc
|
|
60
|
-
- `<term>`
|
|
51
|
+
- `id` は `atc-<term>`(kebab-case。例: `atc-checkout`)とする。
|
|
52
|
+
- ファイル名は `atc-<term>.md` 等とし、成果物カタログの宣言と一致させる。
|
|
53
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字 kebab-case)を用いる。日本語の表示名は H1 に書く(例: `# 受入テストカタログ: 会計確定`)。
|
|
61
54
|
|
|
62
55
|
## 4. 推奨 Frontmatter 項目
|
|
63
56
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
Frontmatter は共通スキーマに従います(あわせてドキュメントのメタ情報の記述ルールも参照)。
|
|
67
|
-
|
|
68
|
-
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
69
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
70
|
-
|
|
71
|
-
| 項目 | 説明 | 必須 |
|
|
72
|
-
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
73
|
-
| id | ATC ID(個別: `atc-<term>`) | ○ |
|
|
74
|
-
| type | `test` 固定 | ○ |
|
|
75
|
-
| title | 受入テストカタログ: <対象名> | ○ |
|
|
76
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
77
|
-
| based_on | 根拠仕様(最低限: `tsp-index`, `atc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
78
|
-
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
79
|
-
| supersedes | 置き換え関係 | 任意 |
|
|
80
|
-
|
|
81
|
-
### 4.2. 推奨ルール
|
|
82
|
-
|
|
83
|
-
- `based_on` は原則 `[tsp-index, atc-index]` を最低限とする。
|
|
84
|
-
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `ac-*` / `nfr-*` 等)は本文「トレース」に集約する。
|
|
85
|
-
機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
86
|
-
- 記述内容が多くなる場合はドキュメントを分割し、`part_of` で集約ドキュメントに所属させる。
|
|
87
|
-
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
88
|
-
|
|
89
|
-
## 5. 本文構成(標準テンプレ)
|
|
90
|
-
|
|
91
|
-
個別 ATC(`atc-<term>`)は以下の見出し構成を **順序固定** で配置します。
|
|
92
|
-
|
|
93
|
-
| 番号 | 見出し | 必須 |
|
|
94
|
-
| ---- | --------------------------- | ---- |
|
|
95
|
-
| 1 | 概要(`<term>`) | ○ |
|
|
96
|
-
| 2 | 受入の責務(成果/完了条件) | ○ |
|
|
97
|
-
| 3 | 対象外 | ○ |
|
|
98
|
-
| 4 | 環境/データ/外部依存 | ○ |
|
|
99
|
-
| 5 | トレース | ○ |
|
|
100
|
-
| 6 | 受入観点とケース | ○ |
|
|
101
|
-
|
|
102
|
-
注意:次章の記述ガイドのMarkdown見出しはルール文章内の参照用であり、
|
|
103
|
-
生成する `atc-<term>` 本文の見出しは各章で指定された **番号付き** の形式に置き換えてください。
|
|
104
|
-
|
|
105
|
-
## 6. 記述ガイド
|
|
106
|
-
|
|
107
|
-
### 6.1. 概要(`<term>`)
|
|
108
|
-
|
|
109
|
-
生成する `atc-<term>` 本文の見出しは **## 1. 概要(<term>)**
|
|
110
|
-
|
|
111
|
-
本節では、対象(`<term>`)が何であり、どの受入判断単位を本カタログで扱うかを簡潔に示します。
|
|
112
|
-
|
|
113
|
-
- `<term>` の説明(1〜3行):業務成果(ユーザ価値)として説明する
|
|
114
|
-
- 期待する利用者:PO/利用部門/QA/運用が、前提を把握できる内容にする
|
|
115
|
-
- 対象の粒度:`atc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
116
|
-
- 関連する業務フロー名・主要画面/主要I/F(任意):入口を示すために列挙してよい
|
|
117
|
-
- 詳細な仕様説明や背景は書かない(根拠はトレースで示す)
|
|
118
|
-
|
|
119
|
-
### 6.2. 受入の責務(成果/完了条件)
|
|
120
|
-
|
|
121
|
-
生成する `atc-<term>` 本文の見出しは **## 2. 受入の責務(成果/完了条件)**
|
|
122
|
-
|
|
123
|
-
本節では、「この対象が受入で何を保証すべきか(受入判断の責務)」を列挙します。
|
|
124
|
-
|
|
125
|
-
- 箇条書きで 3〜7 個程度を目安に、**成果が分かる動詞**で記述する
|
|
126
|
-
- 例:注文が確定できる/取消できる/通知が届く/監査証跡が残る/権限で拒否される
|
|
127
|
-
|
|
128
|
-
- 責務は「観点」の上位概念(責務≠観点)。観点は責務を分解した切り口
|
|
129
|
-
- 正常系だけでなく、受入判断に必要な重要分岐(代表失敗/復帰/やり直し等)も含める
|
|
130
|
-
- 可能なら「観測できる成果(画面、帳票、通知、ログ相関ID等)」とセットで書く
|
|
131
|
-
- 責務に含まれないものは「対象外」へ移す
|
|
132
|
-
|
|
133
|
-
### 6.3. 対象外
|
|
134
|
-
|
|
135
|
-
生成する `atc-<term>` 本文の見出しは **## 3. 対象外**
|
|
136
|
-
|
|
137
|
-
本節では、「この対象カタログ(`atc-<term>`)ではやらないこと」を明示します。
|
|
138
|
-
`atc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
139
|
-
|
|
140
|
-
- 対象外は「なぜ除外するか(理由)」とセットで書く
|
|
141
|
-
- 可能なら「代替するレベル/手段」(ST/NFR/互換試験/運用検証 等)も併記する
|
|
142
|
-
- 対象固有の対象外(例:別業務成果、別termの責務)を明確にする
|
|
143
|
-
- 例外としてATで扱う場合は、条件・根拠・前提(環境/データ)を明記する
|
|
144
|
-
|
|
145
|
-
推奨フォーマット(簡易):
|
|
146
|
-
|
|
147
|
-
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
148
|
-
|
|
149
|
-
### 6.4. 環境/データ/外部依存
|
|
57
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
150
58
|
|
|
151
|
-
|
|
59
|
+
- `specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:atc-rulebook` とする。
|
|
60
|
+
- `specdojo.based_on` は原則 `tsp-index` と `atc-index` とし、実際に読んで直接の根拠とした作成済み文書だけを加える。
|
|
61
|
+
- 検証する上流の受入条件(`bac-*`・`ac-*` 等)は `specdojo.relations.verifies` に宣言する。本文「トレース」の `TR-xx` は項目単位の対応で、`relations.verifies` の ID を含むこと。上流の受入条件が変わったときは、`relations.verifies` から影響する ATC を特定し、該当する `TR-xx` を参照するケースを見直す。
|
|
62
|
+
- 分割した場合は `part_of` で集約文書に所属させ、置き換える場合は `supersedes` を用いる。
|
|
152
63
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
- sandbox/疑似の接続先、確認手段(管理画面、受信箱、ダッシュボード、ログ)を明記
|
|
166
|
-
- 外部依存が不安定な場合の扱い(再試行可否、判定保留条件など)が必要なら明記
|
|
167
|
-
|
|
168
|
-
- 観測点(アサーション):
|
|
169
|
-
- 画面・帳票・通知・ログ相関IDなど「誰が見ても判定できる」観測点を整理してよい
|
|
170
|
-
|
|
171
|
-
### 6.5. トレース
|
|
172
|
-
|
|
173
|
-
生成する `atc-<term>` 本文の見出しは **## 5. トレース**
|
|
174
|
-
|
|
175
|
-
本節では、`atc-<term>` の根拠となる上位成果物との対応関係(トレーサビリティ)を示します。
|
|
176
|
-
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、観点・ケース表では **trace_key(`TR-xx`)参照** に統一します。
|
|
177
|
-
|
|
178
|
-
#### 6.5.1. 記述ルール(trace_key)
|
|
179
|
-
|
|
180
|
-
- 各トレース項目に **trace_key(`TR-xx`)** を付与する(例:`TR-01`, `TR-02` …、01始まり推奨)
|
|
181
|
-
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
182
|
-
- 観点・ケース表の `トレース` 列には **仕様IDを直書きせず**、`TR-xx` を列挙する
|
|
183
|
-
- ケース表に新しい根拠が必要になった場合は、**先に本節の表へ行追加**し、付与された `TR-xx` をケース表で参照する
|
|
184
|
-
- 採番は追加順。並び替えても trace_key は維持する。削除しても欠番は詰めない
|
|
64
|
+
```yaml
|
|
65
|
+
---
|
|
66
|
+
specdojo:
|
|
67
|
+
id: atc-checkout
|
|
68
|
+
type: test
|
|
69
|
+
status: draft
|
|
70
|
+
rulebook: specdojo:atc-rulebook
|
|
71
|
+
based_on: [tsp-index, atc-index]
|
|
72
|
+
relations:
|
|
73
|
+
verifies: [bac-checkout]
|
|
74
|
+
---
|
|
75
|
+
```
|
|
185
76
|
|
|
186
|
-
|
|
77
|
+
## 5. 本文要件
|
|
187
78
|
|
|
188
|
-
|
|
189
|
-
| --------- | ------ | ------- | ---- |
|
|
190
|
-
| TR-01 | ac-... | (1行) | 任意 |
|
|
191
|
-
| TR-02 | br-... | (1行) | 任意 |
|
|
79
|
+
本文は次の章を順序固定で置く。すべて必須とする。
|
|
192
80
|
|
|
193
|
-
|
|
81
|
+
| 章 | 内容・受入条件 |
|
|
82
|
+
| --------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
83
|
+
| 概要(`<term>`) | 対象が何で、誰がどの受入判断に使うか、`atc-index` の分割基準に沿った対象の粒度が分かる |
|
|
84
|
+
| 受入の責務(成果/完了条件) | 受入で保証する成果を 3〜7 個程度、観測できる成果とともに示す。正常系に加え代表的な失敗・復帰・やり直しを含める |
|
|
85
|
+
| 対象外 | 除外する事項を理由と代替手段(ST・NFR・運用検証等)とともに示し、`atc-index` の共通の対象外と矛盾しない |
|
|
86
|
+
| 環境/データ/外部依存 | 対象固有の環境・データセット・初期化・外部依存の確認手段と、外部依存が不安定なときの判定保留条件を示す |
|
|
87
|
+
| トレース | 根拠仕様を `trace_key`(`TR-xx`)付きの表で示す。トレースの正本はこの章とする |
|
|
88
|
+
| 受入観点とケース | 観点ごとに `### 6.n. 観点:<観点名>`、その下に `#### 6.n.1. 意図` と `#### 6.n.2. 条件・ケース表` を置く |
|
|
194
89
|
|
|
195
|
-
###
|
|
90
|
+
### 5.1. トレース表の列
|
|
196
91
|
|
|
197
|
-
|
|
92
|
+
| 列 | 必須 | 内容 |
|
|
93
|
+
| ----------- | ---- | -------------------------------------------------------------- |
|
|
94
|
+
| `trace_key` | ○ | `TR-01` からの追加順の連番。並べ替え・削除しても番号を変えない |
|
|
95
|
+
| 仕様ID | ○ | 根拠とする受入条件・業務ルール・仕様の ID |
|
|
96
|
+
| 要点 | ○ | 受入判断に使ったポイントを 1 行で書く |
|
|
97
|
+
| 備考 | 任意 | 補足 |
|
|
198
98
|
|
|
199
|
-
|
|
99
|
+
### 5.2. 条件・ケース表の列
|
|
200
100
|
|
|
201
|
-
|
|
101
|
+
次の列をこの順序で置く。
|
|
202
102
|
|
|
203
|
-
|
|
103
|
+
| 列 | 必須 | 内容 |
|
|
104
|
+
| ---------------------- | ---- | ------------------------------------------------------------------------------ |
|
|
105
|
+
| `case_id` | ○ | `at-<term>-<perspective_key>-<nnn>`。`nnn` は 3 桁 10 刻み。変更・再利用しない |
|
|
106
|
+
| 条件 | ○ | 入力・状態・環境・経路のうち必要な要素 |
|
|
107
|
+
| 手順(最小) | ○ | 操作の意図が分かる高位の手順 |
|
|
108
|
+
| 期待値 | ○ | 観測点で合否を判定できる結果 |
|
|
109
|
+
| 観測点(アサーション) | ○ | 画面・帳票・通知・ログ相関 ID など誰が見ても判定できる確認先 |
|
|
110
|
+
| 環境/依存 | 任意 | 「環境/データ/外部依存」の章と異なる前提があるときだけ書く |
|
|
111
|
+
| トレース | ○ | 「トレース」の章の `TR-xx`。仕様 ID を直書きしない |
|
|
112
|
+
| 優先度 | ○ | `P0`: 不合格なら受入不可。`P1`: 重要な分岐で、不合格時は条件付き受入を判断する |
|
|
113
|
+
| 実施形態 | ○ | `manual`(人が実施して記録)または `automated`(自動テストの結果を証跡にする) |
|
|
114
|
+
| 証跡 | ○ | 実施記録 ID・保存先・ログ相関 ID など実施記録とレポートへ辿れる参照 |
|
|
204
115
|
|
|
205
|
-
|
|
206
|
-
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(細かすぎる観点の乱立を避ける)
|
|
207
|
-
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない(変更が必要なら `supersedes` 等で追跡する)
|
|
116
|
+
`perspective_key` は kebab-case とし、観点名を直しても変えない。
|
|
208
117
|
|
|
209
|
-
|
|
118
|
+
## 6. 記述ガイド
|
|
210
119
|
|
|
211
|
-
|
|
120
|
+
完成例は Frontmatter の `sample` で宣言された sample を参照する。各章は次の判断基準と例に従う。
|
|
212
121
|
|
|
213
|
-
|
|
122
|
+
### 6.1. 概要と受入の責務
|
|
214
123
|
|
|
215
|
-
|
|
124
|
+
- 判断基準: 責務は観点の上位概念で、成果が分かる動詞で書かれ、責務に含まれないものは「対象外」にあること。
|
|
125
|
+
- 良い例: 「確定後にレシートと取引 ID が参照できる」。
|
|
126
|
+
- 悪い例: 「会計処理が正しく動く」(観測できる成果がない)。
|
|
216
127
|
|
|
217
|
-
|
|
128
|
+
### 6.2. 対象外と環境/データ/外部依存
|
|
218
129
|
|
|
219
|
-
-
|
|
220
|
-
-
|
|
221
|
-
|
|
222
|
-
- `level`:`at`
|
|
223
|
-
- `perspective_key`:kebab-case(英小文字+数字+ハイフン)。原則変更しない
|
|
224
|
-
- `nnn`:3桁、10刻み(010,020,030…)推奨
|
|
130
|
+
- 判断基準: 対象外に理由と代替があり、前提データがデータセット ID 等で参照でき、外部依存の確認手段と判定保留条件が分かること。
|
|
131
|
+
- 良い例: 「対象外: 決済ゲートウェイの内部ロジック(理由: 外部責務、代替: 提供者の仕様・監査)」「外部依存: 決済は sandbox。応答がない場合は判定保留とし再実施する」。
|
|
132
|
+
- 悪い例: 「外部連携は適宜確認する」(確認手段も保留条件もない)。
|
|
225
133
|
|
|
226
|
-
|
|
227
|
-
- 手順は高位の最小手順で書く(クリック列挙は禁止。操作の意図がわかる粒度)
|
|
228
|
-
- 期待値は判定可能に書く(画面・帳票・通知・ログ相関ID等の観測点を含める)
|
|
229
|
-
- 証跡は実施記録とレポートへ接続できる形で書く(例:実施記録ID、保存先、ログ相関ID)
|
|
134
|
+
### 6.3. 受入観点とケース
|
|
230
135
|
|
|
231
|
-
|
|
136
|
+
- 判断基準: 観点は `atc-index` の観点の立て方に従い、条件が複数ぶら下がる粒度にまとめ、意図を 1〜2 行で書くこと。ケースは代表(`P0`)、重要な分岐(`P0`・`P1`)、重大なリスク(`P0`)の順に増やし、直積を避けること。
|
|
137
|
+
- 良い例: 「期待値: 会計が確定し、取引 ID・帳票・通知が確認できる」(行の全体は「サンプル(最小)」を参照)。
|
|
138
|
+
- 悪い例: 「期待値: 問題がないこと」(合否判定できず証跡にならない)。
|
|
232
139
|
|
|
233
140
|
## 7. 禁止事項
|
|
234
141
|
|
|
235
|
-
| 禁止事項
|
|
236
|
-
|
|
|
237
|
-
| `atc-index` の共通方針を `atc-<term>`
|
|
238
|
-
| ケース表にUI
|
|
239
|
-
|
|
|
240
|
-
| `case_id`
|
|
241
|
-
|
|
|
242
|
-
|
|
|
243
|
-
|
|
|
244
|
-
|
|
|
142
|
+
| 禁止事項 | 理由 |
|
|
143
|
+
| ------------------------------------------------------------------------ | -------------------------------------------------------- |
|
|
144
|
+
| `atc-index` の共通方針を `atc-<term>` 側で上書きする | 受入判断の一貫性が崩れ、合意と追跡が困難になるため |
|
|
145
|
+
| ケース表に UI のクリック手順や画面要素の細部を列挙する | 変更に弱く、受入の意図が読めなくなるため |
|
|
146
|
+
| 期待値を曖昧に書く(例: 「問題がないこと」「使えること」) | 合否判定できず証跡にならないため |
|
|
147
|
+
| `case_id` を変更・再利用する、`perspective_key` を観点名に合わせて変える | トレースと証跡の参照が壊れるため |
|
|
148
|
+
| 理由・範囲を書かずに直積のケースを作る | ケースが爆発して運用できなくなるため |
|
|
149
|
+
| トレースや証跡のないケースを期限・条件なしで残す | 受入の根拠として成立しないため |
|
|
150
|
+
| 判定保留条件を定めずに不安定な外部依存のまま合否を判定する | 受入判断が揺れて合意が崩れるため |
|
|
151
|
+
| ケース表の `トレース` 列に仕様 ID を直書きする | トレースの正本が二重になり、上流の変更に追従できないため |
|
|
245
152
|
|
|
246
153
|
## 8. サンプル(最小)
|
|
247
154
|
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
```yaml
|
|
251
|
-
---
|
|
252
|
-
id: atc-checkout
|
|
253
|
-
type: test
|
|
254
|
-
title: 受入テストカタログ: 会計確定(checkout)
|
|
255
|
-
status: draft
|
|
256
|
-
part_of: []
|
|
257
|
-
based_on: [tsp-index, atc-index]
|
|
258
|
-
supersedes: []
|
|
259
|
-
---
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
### 8.1. 概要(checkout)
|
|
263
|
-
|
|
264
|
-
店頭販売における会計確定(支払い→確定→レシート/通知→在庫/売上反映)を受入判断単位として扱う。
|
|
155
|
+
完成例を sample へ外出しするまでの経過措置として、本文の輪郭だけを示す。
|
|
265
156
|
|
|
266
|
-
|
|
157
|
+
```markdown
|
|
158
|
+
## 5. トレース
|
|
267
159
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
-
|
|
160
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
161
|
+
| --------- | ------------- | ------------------------ | ---- |
|
|
162
|
+
| TR-01 | ac-checkout-1 | 支払い成功時に確定できる | |
|
|
271
163
|
|
|
272
|
-
|
|
164
|
+
## 6. 受入観点とケース
|
|
273
165
|
|
|
274
|
-
|
|
275
|
-
- 性能の厳密測定(理由:受入の枠外、代替:NFR)
|
|
166
|
+
### 6.1. 観点:会計確定の成立
|
|
276
167
|
|
|
277
|
-
|
|
168
|
+
#### 6.1.1. 意図
|
|
278
169
|
|
|
279
|
-
|
|
280
|
-
- データ:受入データセット `DS-CHK-01`(商品/顧客/権限ロール)
|
|
281
|
-
- 外部依存:決済は sandbox、通知は検証用受信箱で確認
|
|
282
|
-
- 観測点:取引ID、帳票PDF、通知メール件名、ログ相関ID
|
|
170
|
+
代表シナリオで、支払いから会計確定までが成立することを保証する。
|
|
283
171
|
|
|
284
|
-
|
|
172
|
+
#### 6.1.2. 条件・ケース表
|
|
285
173
|
|
|
286
|
-
|
|
|
287
|
-
| --------- |
|
|
288
|
-
| TR-01 |
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
### 8.6. 受入観点とケース
|
|
292
|
-
|
|
293
|
-
#### 8.6.1. 観点:会計確定の成立
|
|
294
|
-
|
|
295
|
-
##### 8.6.1.1. 意図
|
|
296
|
-
|
|
297
|
-
代表シナリオで、支払い完了から会計確定までが成立し、必要な成果物が確認できることを保証する。
|
|
298
|
-
|
|
299
|
-
##### 8.6.1.2. 条件・ケース表
|
|
300
|
-
|
|
301
|
-
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 環境/依存 | トレース | 優先度 | 実施形態 | 証跡 |
|
|
302
|
-
| -------------------------------- | -------------------------------------------- | ------------------------------- | ------------------------------------------ | --------------------------------- | ------------ | -------- | ------ | -------- | -------------------------------- |
|
|
303
|
-
| at-checkout-checkout-success-010 | 状態: 正常顧客 / 入力: 正常商品 / 経路: 成功 | 商品を選択し支払い→確定まで実施 | 会計が確定し取引ID・帳票・通知が確認できる | 取引ID、帳票PDF、通知件名、相関ID | 決済=sandbox | TR-01 | P0 | manual | 実施記録#A-1001 / ログ相関ID=... |
|
|
174
|
+
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 環境/依存 | トレース | 優先度 | 実施形態 | 証跡 |
|
|
175
|
+
| -------------------------------- | -------------------------- | --------------------- | ------------------------------------------ | ------------------------- | --------- | -------- | ------ | -------- | --------------- |
|
|
176
|
+
| at-checkout-checkout-success-010 | 状態: 正常顧客、経路: 成功 | 商品を選び支払い→確定 | 会計が確定し取引ID・帳票・通知が確認できる | 取引ID、帳票PDF、通知件名 | | TR-01 | P0 | manual | 実施記録#A-1001 |
|
|
177
|
+
```
|