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
|
@@ -4,205 +4,135 @@ specdojo:
|
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: ui
|
|
6
6
|
status: draft
|
|
7
|
-
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
8
9
|
sample: specdojo:uis-sample
|
|
9
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
10
13
|
---
|
|
11
14
|
|
|
12
|
-
#
|
|
15
|
+
# 画面仕様(UIS)作成ルール
|
|
13
16
|
|
|
14
|
-
|
|
17
|
+
User Interface Specification (UIS) Authoring Rule
|
|
18
|
+
|
|
19
|
+
業務ユーザーが GUI 画面を介して達成する目的、表示情報、操作、遷移、入力の制約、エラー時の回復を統一形式で記述するためのルールです。
|
|
15
20
|
|
|
16
21
|
## 1. 全体方針
|
|
17
22
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
- 1
|
|
23
|
+
- Web・タブレット・デスクトップ・エディタ拡張の入力欄などの GUI を対象とし、1 ファイルで 1 画面を定義します。付随する確認ダイアログは、その画面の操作・遷移に含めます。CLI は [[specdojo:clis-rulebook|CLI仕様作成ルール]] に従います。
|
|
24
|
+
- 利用者から観察できる条件と結果を記述します。正常系に加え、空の一覧、処理中、入力不備、権限不足、通信失敗など、対象画面で起こる状態を扱います。
|
|
25
|
+
- 表示項目の意味と操作の業務上の効果を定義します。画面をまたぐ色・文字・部品・レイアウトの型・アクセシビリティは [[specdojo:dss-rulebook|デザインシステム(DSS)]] で定め、画面ごとのワイヤーフレームは文書として保守しません。
|
|
26
|
+
- 同じ判断は 1 か所に書きます。入力の条件は「バリデーション」、失敗時の表示と回復は「エラー表示と利用者の次の手」を正とし、ほかの章は章タイトルで参照します。
|
|
27
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。
|
|
22
28
|
|
|
23
|
-
## 2.
|
|
29
|
+
## 2. 位置づけ
|
|
24
30
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
| 画面 | 業務ユーザーが操作する単位。目的・表示項目・操作・遷移を持つ |
|
|
28
|
-
| 表示項目 | 画面に表示する情報(一覧列、詳細項目、集計値、メッセージ等) |
|
|
29
|
-
| 操作 | ユーザーが実行できるアクション(検索、登録、更新、削除、確定等) |
|
|
30
|
-
| 遷移 | 画面間の移動。条件・遷移先・引き渡し(識別子など)を含む |
|
|
31
|
-
| バリデーション | 入力値の妥当性判定(必須、形式、範囲、相関等) |
|
|
32
|
-
| エラー表示 | 入力不備・権限不足・対象なし等をユーザーに伝える表示 |
|
|
31
|
+
- 業務仕様の `user-interface-model` に属し、業務プロセス仕様(`bps`)やシステム化機能(`sf`)を利用者との対話へ具体化します。共通の業務規則・用語は上位仕様を正本として参照します。
|
|
32
|
+
- 内部 API、保存方式、UI 部品の設計は後続のシステム設計で扱います。画面仕様には、利用者が確認できる保存の成否や再試行の条件までを記述します。
|
|
33
33
|
|
|
34
34
|
## 3. ファイル命名・ID規則
|
|
35
35
|
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
|
|
39
|
-
- `title`: 「商品一覧」などの画面名
|
|
36
|
+
- ファイル名は `uis-<term>.md` とし、`<term>` は画面を表す英小文字の kebab-case とします(例: `uis-sales-register.md`)。
|
|
37
|
+
- 文書 ID はプロダクトの文書で `uis-<term>`、プロジェクトの文書で `<project-id>:uis-<term>` とし、成果物カタログの宣言と一致させます。同梱の完成例は `specdojo:uis-sample` とします。
|
|
38
|
+
- H1 には画面名を書きます。命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
40
39
|
|
|
41
40
|
## 4. 推奨 Frontmatter 項目
|
|
42
41
|
|
|
43
|
-
|
|
44
|
-
| -------- | ------------------------------------------- | ---- |
|
|
45
|
-
| id | 画面ID(小文字ハイフン) | ○ |
|
|
46
|
-
| type | `ui` 固定 | ○ |
|
|
47
|
-
| title | 画面名 | ○ |
|
|
48
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
49
|
-
| based_on | 根拠となる仕様ID(API/ドメイン/他画面など) | 任意 |
|
|
50
|
-
|
|
51
|
-
### NG/OK例(抜粋)
|
|
52
|
-
|
|
53
|
-
- NG例: `id: UI_ProductList`(大文字/アンダースコアNG), `type: data`(`ui`以外NG), `extra: foo`(未定義プロパティNG)
|
|
54
|
-
- OK例: `id: uis-product-list`, `type: ui`, `status: ready`
|
|
55
|
-
|
|
56
|
-
## 5. 本文構成(標準テンプレ)
|
|
57
|
-
|
|
58
|
-
各 UI 仕様ファイルは以下見出しを順番に並べます。
|
|
59
|
-
|
|
60
|
-
1. 概要
|
|
61
|
-
2. 対象ユーザー/利用目的
|
|
62
|
-
3. 表示項目
|
|
63
|
-
4. 操作
|
|
64
|
-
|
|
65
|
-
5. 遷移
|
|
66
|
-
6. バリデーション
|
|
67
|
-
7. エラー表示
|
|
68
|
-
8. メモ / 将来課題
|
|
69
|
-
|
|
70
|
-
## 6. 記述ガイド詳細
|
|
71
|
-
|
|
72
|
-
### 6.1 概要
|
|
73
|
-
|
|
74
|
-
短い一文で「この画面が何をするか」を業務用語で書きます。
|
|
75
|
-
|
|
76
|
-
### 6.2 対象ユーザー/利用目的
|
|
77
|
-
|
|
78
|
-
- 対象ユーザー(例: 店員、店主)
|
|
79
|
-
- 利用目的(例: 商品を検索し、詳細確認や販売登録へ進む)
|
|
80
|
-
|
|
81
|
-
### 6.3 表示項目
|
|
82
|
-
|
|
83
|
-
- 一覧/詳細/集計など、画面で表示する項目を列挙します。
|
|
84
|
-
- レイアウト指定ではなく、**何が表示されるか**を記述します。
|
|
85
|
-
|
|
86
|
-
推奨フォーマット:
|
|
87
|
-
|
|
88
|
-
| 項目名 | 種別 | 表示形式 | 編集可 | 必須 | 備考 |
|
|
89
|
-
| -------- | ---- | -------- | ------ | ---- | --------------------------- |
|
|
90
|
-
| 商品名 | 一覧 | テキスト | - | - | 部分一致検索対象 |
|
|
91
|
-
| 販売価格 | 一覧 | 金額 | - | - | 税込/税別は別途ルールに従う |
|
|
92
|
-
|
|
93
|
-
### 6.4 操作
|
|
94
|
-
|
|
95
|
-
- ユーザーが実行できる操作を列挙し、前提条件と結果(更新/遷移)を明確にします。
|
|
96
|
-
- クリック手順の逐語列挙ではなく、**操作の意味**を書きます。
|
|
97
|
-
- ボタンなどのUI部品は原則として列挙しません(**操作**に包含します)。
|
|
98
|
-
- 例外: 誤解を避ける必要がある場合のみ、備考に**表示ラベル(文言)**を補足してもよい(レイアウト指定はしない)。
|
|
42
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
99
43
|
|
|
100
|
-
|
|
44
|
+
- `specdojo.type` は `ui`、`specdojo.rulebook` は `specdojo:uis-rulebook` とします。
|
|
45
|
+
- `part_of` には所属する画面索引、`based_on` には根拠とした作成済みの業務プロセス・機能の ID を書きます。関係がなければ空配列にし、未作成の文書 ID を書きません。
|
|
101
46
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
| 遷移名 | 遷移先 | 条件 | 引き渡し | 備考 |
|
|
114
|
-
| ------ | ------------------------------ | ------------ | -------- | ---- |
|
|
115
|
-
| 詳細へ | 商品詳細(uis-product-detail) | 一覧行を選択 | 商品ID | - |
|
|
116
|
-
|
|
117
|
-
### 6.6 バリデーション
|
|
118
|
-
|
|
119
|
-
入力欄がある場合、必須/形式/範囲/相関(開始日 ≤ 終了日など)を列挙します。
|
|
120
|
-
|
|
121
|
-
### 6.7 エラー表示
|
|
122
|
-
|
|
123
|
-
代表的な2〜4ケース(入力不備、権限不足、対象なし等)と、ユーザーに見せるメッセージ方針(短く・行動可能)を記述します。
|
|
124
|
-
|
|
125
|
-
## 7. 命名・記述スタイル
|
|
126
|
-
|
|
127
|
-
- 画面名は「名詞+用途」: 例 `商品一覧`, `売上登録`, `在庫照会`
|
|
128
|
-
- 操作名は短く動詞で: 例 `検索`, `登録`, `更新`, `取消`, `確定`
|
|
129
|
-
- 画面/項目/操作は業務用語で統一し、略語は用語集にあるもののみ使用します
|
|
47
|
+
```yaml
|
|
48
|
+
---
|
|
49
|
+
specdojo:
|
|
50
|
+
id: uis-sales-register
|
|
51
|
+
type: ui
|
|
52
|
+
status: draft
|
|
53
|
+
rulebook: specdojo:uis-rulebook
|
|
54
|
+
part_of: []
|
|
55
|
+
based_on: []
|
|
56
|
+
---
|
|
57
|
+
```
|
|
130
58
|
|
|
131
|
-
##
|
|
59
|
+
## 5. 本文要件
|
|
132
60
|
|
|
133
|
-
|
|
134
|
-
| --------------------- | -------------------------------- |
|
|
135
|
-
| 表示項目が多い(>30) | 目的別に分割(一覧/詳細/設定等) |
|
|
136
|
-
| 操作が多い(>10) | サブ画面または別仕様へ分割 |
|
|
137
|
-
| 遷移先が多い(>6) | 目的別に導線を分ける |
|
|
61
|
+
章は次の順で構成します。任意章を省略した場合は番号を詰めます。
|
|
138
62
|
|
|
139
|
-
|
|
63
|
+
| 章 | 必須/任意 | 目的と記述要件 |
|
|
64
|
+
| -------------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
65
|
+
| 概要 | 必須 | 対象業務と画面で達成する結果を 1〜2 文で示す。利用環境や対象範囲を補足できる |
|
|
66
|
+
| 対象ユーザー/利用目的 | 必須 | 操作する業務ロールと、各ロールが達成する業務目的を示す。権限差があれば操作範囲を示す |
|
|
67
|
+
| 表示項目 | 必須 | 項目名、種別、表示内容の意味、編集可否、初期値・未取得時・更新契機などを示す |
|
|
68
|
+
| 操作 | 必須 | 操作名、対象、前提条件、結果を示す。更新の確定時点、処理中や失敗後の再実行条件を含める |
|
|
69
|
+
| 遷移 | 必須 | 契機、遷移元、遷移先、条件、引き渡す情報を示す。戻る・中止時の入力の保持/破棄も示す。画面間移動がなければその旨を記す |
|
|
70
|
+
| バリデーション | 任意。ただし入力がある場合は必須 | 対象、必須性、形式・範囲・相関、判定時点、違反時の扱いを示す |
|
|
71
|
+
| エラー表示と利用者の次の手 | 必須 | 発生条件、表示要点、保持/更新される状態、利用者の回復操作とその結果を示す |
|
|
72
|
+
| メモ / 将来課題 | 任意 | 現在の対象範囲に含めない拡張と、未決事項の論点と影響を示す |
|
|
140
73
|
|
|
141
|
-
|
|
142
|
-
| ------------------------------------- | ---------------------------------- |
|
|
143
|
-
| ワイヤーフレーム/座標/ピクセル指定 | 設計変更に弱く、要求定義段階で過剰 |
|
|
144
|
-
| 物理テーブル名・カラム名・SQL全文 | 概念レベル逸脱 |
|
|
145
|
-
| 実装クラス/関数名・UIコンポーネント名 | 実装依存で変更に弱い |
|
|
146
|
-
| クリック手順の逐語列挙 | 可読性低下・変更に弱い |
|
|
74
|
+
関連する操作・遷移・入力制約・エラーは、同じ名称で対応づけます。既存の要求・業務規則・受入条件は参照し、全文を再掲しません。
|
|
147
75
|
|
|
148
|
-
##
|
|
76
|
+
## 6. 記述ガイド
|
|
149
77
|
|
|
150
|
-
|
|
151
|
-
- クリック手順を長文で列挙 → 操作の前提条件と結果(遷移/更新)に要約
|
|
152
|
-
- 表示項目が列挙だけで目的が不明 → 「対象ユーザー/利用目的」を先に明確化
|
|
78
|
+
表の列は推奨形式であり、本文要件を満たす別形式も使えます。
|
|
153
79
|
|
|
154
|
-
|
|
80
|
+
### 6.1. 概要
|
|
155
81
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
type: ui
|
|
160
|
-
title: 商品一覧
|
|
161
|
-
status: draft
|
|
162
|
-
part_of: []
|
|
163
|
-
based_on: []
|
|
164
|
-
---
|
|
82
|
+
- **判断基準**: どの業務のどの場面で、誰が何を完了する画面かが分かること。表示項目や操作の全件はそれぞれの章へ置く。
|
|
83
|
+
- **良い例**: 「店員が店頭で購入商品と預かり金を登録し、販売を確定して釣銭を確認する画面。」
|
|
84
|
+
- **悪い例**: 「販売を便利にする画面。」(利用者と完了する業務が分からない)
|
|
165
85
|
|
|
166
|
-
|
|
86
|
+
### 6.2. 対象ユーザー/利用目的
|
|
167
87
|
|
|
168
|
-
|
|
88
|
+
- **判断基準**: ロールごとに利用場面と達成する結果が対応し、権限差があれば許可される操作の範囲が分かること。顧客が直接操作するか、店員を介して結果を受け取るかを区別する。
|
|
89
|
+
- **良い例**: 「店員・店主が接客中に購入明細と釣銭を確認する。両ロールに販売登録を許可する。来店客へは担当者が合計額を伝える。」
|
|
90
|
+
- **悪い例**: 「ユーザーがシステムを利用する。」(業務ロールと利用目的が定まらない)
|
|
169
91
|
|
|
170
|
-
|
|
92
|
+
### 6.3. 表示項目
|
|
171
93
|
|
|
172
|
-
-
|
|
173
|
-
-
|
|
94
|
+
- **判断基準**: 表示する業務情報と、空・未取得・処理中を含む値の意味が読み取れること。金額や数量には単位を記す。計算値は算出の意味か上位規則を参照し、入力の許容範囲は「バリデーション」に置く。
|
|
95
|
+
- **良い例**: 「合計請求金額 / 集計 / 明細小計の合計、円単位 / 不可 / 明細なしは 0 円。追加・数量変更・削除の成功時に再計算」
|
|
96
|
+
- **悪い例**: 「合計欄を右下に赤色で表示する。」(値の意味や更新条件が定まらない)
|
|
174
97
|
|
|
175
|
-
|
|
98
|
+
### 6.4. 操作
|
|
176
99
|
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
| 販売価格 | 一覧 | 金額 | - | - | - |
|
|
181
|
-
| 商品ステータス | 一覧 | ラベル | - | - | 販売中/販売停止 |
|
|
100
|
+
- **判断基準**: 操作の実行可否と、成功・中止・失敗後の業務状態を判定できること。保存や確定を伴う操作では、処理中の再操作、結果が不明な場合の確認方法、再試行できる条件を記す。
|
|
101
|
+
- **良い例**: 「会計確定 / 明細があり、入力制約を満たす登録中の取引 / 処理中は再操作を無効化。成功時に販売・在庫を確定して完了画面へ移る。結果不明時は「エラー表示と利用者の次の手」に従う」
|
|
102
|
+
- **悪い例**: 「確定ボタンを押すと保存する。」(保存の条件や二重操作時の扱いが不明)
|
|
182
103
|
|
|
183
|
-
|
|
104
|
+
### 6.5. 遷移
|
|
184
105
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
| 詳細表示 | 一覧行 | 対象が存在する | 商品詳細へ遷移 |
|
|
106
|
+
- **判断基準**: 流入・流出・戻りを、契機と業務上の条件から辿れること。ダイアログを介する場合は確定と取り消しの両方を示し、渡す情報がなければ「なし」と記す。未作成の遷移先は画面名・ID をバッククォートで記す。
|
|
107
|
+
- **良い例**: 「商品選択から復帰 / 「選択」 / `商品検索画面` / `販売登録画面` / 商品を選択済み / 商品コード。既存明細を保持」
|
|
108
|
+
- **悪い例**: 「選択すると次画面へ進む。」(行き先と受け渡し情報が定まらない)
|
|
189
109
|
|
|
190
|
-
|
|
110
|
+
### 6.6. バリデーション
|
|
191
111
|
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
112
|
+
- **判断基準**: 同じ入力に同じ可否を判断でき、境界値で検証できること。入力時と確定時で条件が異なれば区別し、失敗時に前の有効値を保持するか、修正用に入力値を残すかを記す。
|
|
113
|
+
- **良い例**: 「数量 / 必須 / 1〜999 の整数かつ現在庫数以下 / 数量変更時と会計確定時 / 明細・合計は直前の有効値を保持」
|
|
114
|
+
- **悪い例**: 「数量が適切であること。」(許容範囲も確認時点も判定できない)
|
|
195
115
|
|
|
196
|
-
|
|
116
|
+
### 6.7. エラー表示と利用者の次の手
|
|
197
117
|
|
|
198
|
-
-
|
|
118
|
+
- **判断基準**: 利用者が現在の状態、確定の有無、次に実行できる操作を判断できること。内部例外名を表示要点の代わりにしない。回復に別画面や運用担当者が要る場合は、行き先と渡す情報を示す。
|
|
119
|
+
- **良い例**: 「会計結果不明 / 確定要求後に応答を受信できない / 「会計結果を確認してください」と取引番号 / 明細と預かり金を保持し、編集・会計確定を無効化 / 「結果確認」で同じ取引を照会する」
|
|
120
|
+
- **悪い例**: 「通信エラー。もう一度確定する。」(確定済みの取引を再登録するおそれがある)
|
|
199
121
|
|
|
200
|
-
|
|
122
|
+
### 6.8. メモ / 将来課題
|
|
201
123
|
|
|
202
|
-
-
|
|
203
|
-
-
|
|
124
|
+
- **判断基準**: 現在の動作と将来の拡張を区別できること。未決事項は `_UNDECIDED_` などを付けて論点と影響を書き、管理台帳の区分・担当・判断時期の列は設けない(追跡は登録簿で行う)。現行動作に要る判断はこの章だけに置かない。
|
|
125
|
+
- **良い例**: 「電子決済は将来の拡張とし、導入時に決済方法と取消手順を決める。」
|
|
126
|
+
- **悪い例**: 「エラー時の扱いは後で検討する。」(現行画面を実装・検証する条件が欠ける)
|
|
204
127
|
|
|
205
|
-
##
|
|
128
|
+
## 7. 禁止事項
|
|
206
129
|
|
|
207
|
-
|
|
208
|
-
|
|
130
|
+
| 禁止する記述 | 理由 |
|
|
131
|
+
| ------------------------------------------------------------------------- | ------------------------------------------------ |
|
|
132
|
+
| CLI コマンド群を画面・画面遷移として定義する | CLI 固有の要件は clis が担うため |
|
|
133
|
+
| ワイヤーフレーム、配置図、ピクセル座標、CSS、色・フォント・部品配置の指定 | 業務仕様の判断範囲を越えるため |
|
|
134
|
+
| 物理テーブル・物理カラム・SQL・実装クラスや関数・UI ライブラリの指定 | 後続設計の選択に結合するため |
|
|
135
|
+
| クリックやキー入力の逐語列挙だけで操作を説明する | 操作の前提条件と業務上の効果を判断できないため |
|
|
136
|
+
| 回復操作を伴わないエラー一覧、結果不明の更新を無条件に再実行させる指示 | 利用者が業務を安全に再開できる条件が欠けるため |
|
|
137
|
+
| 入力の条件や回復の手順を、正とする章以外で言い直す | 同じ判断が複数か所に書かれ、改訂時に食い違うため |
|
|
138
|
+
| 共通の業務規則や上位仕様の全文再掲 | 正本との不整合や更新漏れを招くため |
|
|
@@ -13,26 +13,17 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Unit Test Catalog (UTC) Index Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
TSPに基づき、単体テストに共通するルールや方針を定義します。
|
|
18
|
-
|
|
19
|
-
個別単体テストカタログ(`utc-<term>`)の記述ルールは [utc-rulebook.md](utc-rulebook.md) を参照してください。
|
|
16
|
+
単体テストカタログの全体概要 `utc-index` に記載する共通方針・判断基準を定めます。対象別カタログ `utc-<term>` は [[specdojo:utc-rulebook|単体テストカタログ 対象別 作成ルール]] に従います。
|
|
20
17
|
|
|
21
18
|
## 1. 全体方針
|
|
22
19
|
|
|
23
|
-
`
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
-
|
|
27
|
-
- 個別の観点・条件・ケースは **`utc-<term>` に集約**し、詳細は **テストコード/CI証跡** に寄せる
|
|
28
|
-
- 記述は **レビュー可能**であることを優先し、長文化を避ける(方針は箇条書き中心)
|
|
29
|
-
- 「例外」や「対象外」を明示し、単体テストの責任境界(何をやらないか)を固定する
|
|
30
|
-
- `tsp-index` の方針を根拠として、単体テストに共通する **分割基準・観点/条件の立て方・依存境界・合格基準・証跡** を定義する
|
|
20
|
+
- **目的と根拠**: `tsp-index` に基づき、対象別カタログの分割基準・観点/条件・依存境界・合格基準・証跡方針を揃える。
|
|
21
|
+
- **責務境界**: `utc-index` は共通方針の正本とし、個別の観点・条件・ケースは `utc-<term>`、実装と実行結果の証跡はテストコード/CIに置く。対象外と例外条件を明示する。
|
|
22
|
+
- **記載レベル**: 判断基準をレビューできる粒度で記述し、個別ケースは列挙しない。
|
|
23
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
31
24
|
|
|
32
25
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
33
26
|
|
|
34
|
-
`utc-index` と他ドキュメントの関係を示します。
|
|
35
|
-
|
|
36
27
|
```mermaid
|
|
37
28
|
flowchart BT
|
|
38
29
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -55,30 +46,21 @@ flowchart BT
|
|
|
55
46
|
|
|
56
47
|
## 3. ファイル命名・ID規則
|
|
57
48
|
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
- `<term>`
|
|
49
|
+
- 対象ドキュメントの `id` は `utc-index`、対象別は `utc-<term>` とする。
|
|
50
|
+
- ファイル名は成果物カタログの宣言に合わせる(例: `utc-index.md`、`utc-010-単体テストカタログ-概要.md`)。
|
|
51
|
+
- `<term>` は用語集の論理名キー(英小文字の kebab-case)を用い、表示名は H1 に日本語で記載してよい。
|
|
61
52
|
|
|
62
53
|
## 4. 推奨 Frontmatter 項目
|
|
63
54
|
|
|
64
55
|
### 4.1. 設定内容
|
|
65
56
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
| 項目 | 説明 | 必須 |
|
|
69
|
-
| ---------- | -------------------------------------------------- | ---- |
|
|
70
|
-
| id | `utc-index`(固定) | ○ |
|
|
71
|
-
| type | `test` 固定 | ○ |
|
|
72
|
-
| title | 単体テストカタログ: 概要(`<システム名>`) | ○ |
|
|
73
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
74
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
75
|
-
| supersedes | 置き換え関係(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
57
|
+
許可キー・必須項目・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。`specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:utc-index-rulebook` とする。タイトルは H1 に「単体テストカタログ: 概要(対象システム名)」と記載する。
|
|
76
58
|
|
|
77
59
|
### 4.2. 推奨ルール
|
|
78
60
|
|
|
79
|
-
- `based_on`
|
|
80
|
-
- BAC/NFR/BR
|
|
81
|
-
-
|
|
61
|
+
- `based_on` には直接の根拠とした `tsp-index` を含める。
|
|
62
|
+
- BAC/NFR/BR 等は、境界・分配・共通合格基準の判断に直接利用した文書だけを列挙する。
|
|
63
|
+
- 成果物カタログに `depends_on` がある場合、参照はその推移閉包内の作成済み文書に限定する。
|
|
82
64
|
|
|
83
65
|
## 5. 本文構成(標準テンプレ)
|
|
84
66
|
|
|
@@ -96,34 +78,24 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
96
78
|
| 8 | ケース表の共通カラム | ○ |
|
|
97
79
|
| 9 | メモ / 将来課題 | 任意 |
|
|
98
80
|
|
|
99
|
-
|
|
100
|
-
生成する `utc-index` 本文の見出しは各章で指定された **番号付き** の形式
|
|
101
|
-
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
81
|
+
本文の見出しは上表の番号と名称を用いる。「記述ガイド」の節番号は rulebook 内の参照用であり、成果物へ転記しない。
|
|
102
82
|
|
|
103
83
|
## 6. 記述ガイド
|
|
104
84
|
|
|
105
|
-
|
|
85
|
+
受入確認では代表的な対象を選び、次を順に照合する。
|
|
106
86
|
|
|
107
|
-
|
|
87
|
+
1. `tsp-index` と対象範囲・除外理由・代替レベルを照合し、責務境界に矛盾がないこと。
|
|
88
|
+
2. 観点/条件を採用基準に当てはめ、主担当の `utc-<term>` を一つ定められ、例外には根拠があること。
|
|
89
|
+
3. 代表ケースを共通カラムで表現し、依存を制御して期待値を判定でき、テストコード/CI証跡へ接続できること。
|
|
108
90
|
|
|
109
|
-
|
|
91
|
+
### 6.1. 本ドキュメントの目的と適用対象
|
|
110
92
|
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
- 成果物の位置づけ:
|
|
115
|
-
- `utc-index`:共通方針(SSOT)
|
|
116
|
-
- `utc-<term>`:対象別の観点・条件・ケース表(SSOT)
|
|
117
|
-
- テストコード/CI:実装と実行証跡(SSOT)
|
|
118
|
-
- SSOTの一次情報は `utc-index` / `utc-<term>` とし、テストコード/CIは **実装と実行結果の証跡(Evidence)** として扱う。
|
|
119
|
-
- 本書が扱う粒度:**判断基準・共通ルールまで**(個別ケースの列挙は禁止)
|
|
93
|
+
- 誰がどのテスト作成・レビューの判断に使うかと、対象システム・領域を示す。
|
|
94
|
+
- `utc-<term>` の品質・粒度・責任範囲を揃える目的と、単体テスト(UT)の適用範囲を示す。
|
|
95
|
+
- 内部結合以降(IT/ET/ST/AT)のルールは、それぞれの `*c-index` で扱う。
|
|
120
96
|
|
|
121
97
|
### 6.2. テスト対象の括り方と分割基準
|
|
122
98
|
|
|
123
|
-
生成する `utc-index` 本文の見出しは **## 2. テスト対象の括り方と分割基準**
|
|
124
|
-
|
|
125
|
-
本節では、`utc-<term>` の `<term>` をどう切るか(対象単位の設計)を定義します。
|
|
126
|
-
|
|
127
99
|
- `<term>` は「責務のまとまり」(例:ドメインサービス/ユースケース/主要関数群)とする
|
|
128
100
|
- 分割基準(推奨順):
|
|
129
101
|
1. **責務境界**:何をする単位かが説明できる
|
|
@@ -138,11 +110,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
138
110
|
|
|
139
111
|
### 6.3. 対象外・除外理由(共通)
|
|
140
112
|
|
|
141
|
-
生成する `utc-index` 本文の見出しは **## 3. 対象外・除外理由(共通)**
|
|
142
|
-
|
|
143
|
-
本節では、単体テスト(UT)で **やらないこと** と、その **理由**、および **例外条件** を明確にします。
|
|
144
|
-
「UTでやるべきこと」を書くよりも、「UTでやらないこと」を固定する方が、責任境界がぶれにくくなります。
|
|
145
|
-
|
|
146
113
|
#### 6.3.1. 記述ルール
|
|
147
114
|
|
|
148
115
|
- 形式は **「対象外(何をやらないか)」「除外理由(なぜやらないか)」「例外(UTで扱う条件)」** の3点セットを基本とする
|
|
@@ -160,15 +127,17 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
160
127
|
|
|
161
128
|
#### 6.3.3. 典型例(記載候補)
|
|
162
129
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
130
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
131
|
+
| -------------------------------------- | ---------------------- | ------------------- | ----------------------------------------------- |
|
|
132
|
+
| UI操作・画面遷移・DOM操作 | ロジック検証を逸脱する | E2E | DOMに依存しない純関数のUIロジックのみ |
|
|
133
|
+
| 実DB接続・実I/O、スキーマ・SQLの妥当性 | 環境依存を伴う | IT | なし。SQL自体が責務でも実接続の検証は IT に委譲 |
|
|
134
|
+
| 外部サービスとの実通信・実認証 | 外部要因で結果が揺れる | IT/ET | 外部SDKのアダプタ層の純粋な入出力変換のみ |
|
|
135
|
+
| 並行性・性能・負荷・耐久(p95等) | 測定条件が別 | 非機能テスト | なし |
|
|
136
|
+
| ブラウザ互換・端末差分 | 実行環境差の確認が必要 | E2E | なし |
|
|
168
137
|
|
|
169
|
-
|
|
138
|
+
例外を適用する `utc-<term>` には、根拠と依存の制御方法を明記する。
|
|
170
139
|
|
|
171
|
-
|
|
140
|
+
### 6.4. 観点の立て方(共通)
|
|
172
141
|
|
|
173
142
|
観点(Perspective)は「何を保証するか」の切り口であり、対象別カタログの章立て(見出し)として用います。
|
|
174
143
|
|
|
@@ -187,8 +156,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
187
156
|
|
|
188
157
|
### 6.5. 条件の立て方(共通)
|
|
189
158
|
|
|
190
|
-
生成する `utc-index` 本文の見出しは **## 5. 条件の立て方(共通)**
|
|
191
|
-
|
|
192
159
|
条件(Condition)は、観点を確認するための前提状態・入力状態・環境条件のバリエーションです。
|
|
193
160
|
条件は「入力」「状態」「環境」に分解して作成します。
|
|
194
161
|
|
|
@@ -205,10 +172,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
205
172
|
|
|
206
173
|
### 6.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
207
174
|
|
|
208
|
-
生成する `utc-index` 本文の見出しは **## 6. 観点/条件の採用基準と対象別への分配方針(共通)**
|
|
209
|
-
|
|
210
|
-
本節では、観点/条件を「採用する判断」と「`utc-<term>` へ割り当てる判断」を共通ルールとして定義します。
|
|
211
|
-
|
|
212
175
|
#### 6.6.1. 採用基準(共通)
|
|
213
176
|
|
|
214
177
|
- 観点は「1観点=1合否命題」で採用する(複数命題の混在を禁止)
|
|
@@ -233,14 +196,11 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
233
196
|
|
|
234
197
|
### 6.7. 単体テスト共通の境界/依存の扱い
|
|
235
198
|
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
単体テストでは、対象の責務を明確にし、依存は原則として制御可能にします。
|
|
239
|
-
依存の扱いは `utc-<term>` 間でぶれないよう、本節で共通方針を定めます。
|
|
199
|
+
依存を制御可能にし、対象別カタログ間で共通方針を揃える。
|
|
240
200
|
|
|
241
201
|
- DB:
|
|
242
202
|
- 原則:実DBに依存しない(In-memory / Fake / Repository mock 等)
|
|
243
|
-
-
|
|
203
|
+
- スキーマ/SQLそのものが責務の場合も、実接続の検証は IT へ寄せる
|
|
244
204
|
- 外部API/外部サービス:
|
|
245
205
|
- 原則:Mock/Stubで制御(成功・失敗・タイムアウトを再現可能に)
|
|
246
206
|
- 時刻:
|
|
@@ -258,8 +218,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
258
218
|
|
|
259
219
|
### 6.8. ケース表の共通カラム
|
|
260
220
|
|
|
261
|
-
生成する `utc-index` 本文の見出しは **## 8. ケース表の共通カラム**
|
|
262
|
-
|
|
263
221
|
`utc-<term>` の末端(条件・ケース表)は、検索性・比較性・自動化移行の容易さを確保するため、
|
|
264
222
|
全termで同一カラム順を採用します。
|
|
265
223
|
|
|
@@ -291,16 +249,12 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
291
249
|
|
|
292
250
|
### 6.9. メモ / 将来課題
|
|
293
251
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
本節は、現時点で決めきれない事項や将来の改善点を記録します。
|
|
297
|
-
ただし、運用ルールとして必須な内容は本節に置かず、本文(1〜8章)へ反映します。
|
|
298
|
-
|
|
252
|
+
- 未決事項がある場合、論点と影響(当面の扱い・決定後に直す方針や列)を記録する。
|
|
253
|
+
- 確定した必須方針は該当する本文の章へ反映する。
|
|
299
254
|
- 将来検討(例):
|
|
300
255
|
- 組合せ削減の方法(ペアワイズ導入)
|
|
301
256
|
- 証跡リンク形式の統一(CI URL、レポート保存場所)
|
|
302
257
|
- 自動化率の目標と移行基準
|
|
303
|
-
- カタログのlint(case_id重複、必須列欠落など)
|
|
304
258
|
|
|
305
259
|
## 7. 禁止事項
|
|
306
260
|
|
|
@@ -315,74 +269,25 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
315
269
|
|
|
316
270
|
## 8. サンプル(最小)
|
|
317
271
|
|
|
318
|
-
|
|
272
|
+
形式の輪郭を示す抜粋。成果物の全章構成は「本文構成(標準テンプレ)」に従う。
|
|
319
273
|
|
|
320
|
-
```
|
|
274
|
+
```markdown
|
|
321
275
|
---
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
status: draft
|
|
326
|
-
|
|
327
|
-
|
|
276
|
+
specdojo:
|
|
277
|
+
id: utc-index
|
|
278
|
+
type: test
|
|
279
|
+
status: draft
|
|
280
|
+
rulebook: specdojo:utc-index-rulebook
|
|
281
|
+
based_on: [tsp-index]
|
|
328
282
|
---
|
|
329
|
-
```
|
|
330
|
-
|
|
331
|
-
### 8.1. 本ドキュメントの目的と適用対象
|
|
332
|
-
|
|
333
|
-
本ドキュメントは、単体テストカタログ(UTC)の全体概要 `utc-index` を統一形式で記述するためのルールである。
|
|
334
|
-
`utc-index` は単体テストに共通する「対象単位の切り方」「観点/条件の立て方」「依存境界」「合格基準」「証跡方針」を定義し、
|
|
335
|
-
対象別カタログ `utc-<term>` の作成と運用の基盤とする。
|
|
336
|
-
|
|
337
|
-
### 8.2. テスト対象の括り方と分割基準
|
|
338
|
-
|
|
339
|
-
`utc-<term>` の `<term>` は責務のまとまり(例:サービス/ユースケース/主要関数群)とする。
|
|
340
|
-
分割は責務境界・変更影響・依存境界・担当境界を基準とし、過分割と肥大化の双方を避ける。
|
|
341
|
-
観点が過剰、または依存境界が混在する場合は分割候補とする。
|
|
342
|
-
|
|
343
|
-
### 8.3. 対象外・除外理由(共通)
|
|
344
|
-
|
|
345
|
-
単体テスト(UT)では、対象の責務を「小さく・決定的に」検証するため、以下は原則として対象外とする。
|
|
346
|
-
|
|
347
|
-
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
348
|
-
| ----------------------------------------------------- | ---------------------------------------------- | ------------------------ | --------------------------------------------------------------- |
|
|
349
|
-
| UIの操作手順や画面遷移の検証(クリック列挙、DOM検証) | UTの責務(ロジック検証)を逸脱し、保守性が低い | E2E(e2eカタログ) | UIロジックが純関数化され、DOMに依存しない場合のみ |
|
|
350
|
-
| 実DB接続・実I/Oによる検証(スキーマ/SQLの正当性) | 環境依存・不安定になりやすい | IT(itcカタログ) | SQLそのものがプロダクト責務で、Fakeでは妥当性が評価できない場合 |
|
|
351
|
-
| 外部サービス疎通(実通信、実認証、ネットワーク障害) | 外部要因で結果が揺れ、再現性が低い | IT/ET(itc/etcカタログ) | 外部SDKのアダプタ層の「入力→出力変換」など純粋な変換責務のみ |
|
|
352
|
-
| 性能・負荷・耐久(p95、スループット、長時間稼働) | UTのスコープ外で測定条件の設計が別物 | NFR(nfrカタログ) | なし |
|
|
353
|
-
| ブラウザ/端末差分(表示崩れ、入力方式差) | 実行環境差が本質でUTでは再現困難 | E2E(e2eカタログ) | なし |
|
|
354
|
-
|
|
355
|
-
例外を適用する場合は、`utc-<term>` 側に「例外の根拠(なぜUTで必要か)」と「依存の制御方法」を明記する。
|
|
356
283
|
|
|
357
|
-
|
|
284
|
+
# 単体テストカタログ: 概要(販売管理)
|
|
358
285
|
|
|
359
|
-
|
|
360
|
-
観点名は「名詞+品質/振る舞い」で統一し、条件を複数持てる程度の粒度にまとめる。
|
|
286
|
+
## 3. 対象外・除外理由(共通)
|
|
361
287
|
|
|
362
|
-
|
|
288
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
289
|
+
| ---------------------- | -------------------------- | ------------------- | ------------------------------------- |
|
|
290
|
+
| UI操作・画面遷移 | UTのロジック検証を逸脱する | E2E | DOMに依存しない純関数のUIロジックのみ |
|
|
363
291
|
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
### 8.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
368
|
-
|
|
369
|
-
観点/条件は、業務影響・境界/例外/状態遷移の重要性・上位仕様根拠を基準に採用する。
|
|
370
|
-
分配は責務境界・依存境界・変更影響を基準に主担当 `utc-<term>` を1つ定め、重複は例外として扱う。
|
|
371
|
-
分配結果は `utc-<term>` のケース表とトレース列で追跡可能にする。
|
|
372
|
-
|
|
373
|
-
### 8.7. 単体テスト共通の境界/依存の扱い
|
|
374
|
-
|
|
375
|
-
単体テストでは依存を制御可能にし、テストの決定性を担保する。
|
|
376
|
-
DBは原則Fake/Mock等で実DB依存を避け、外部APIはMock/Stubで成功・失敗・タイムアウトを再現可能にする。
|
|
377
|
-
時刻・乱数・UUIDは注入または固定化し、直参照を禁止する。
|
|
378
|
-
|
|
379
|
-
### 8.8. ケース表の共通カラム
|
|
380
|
-
|
|
381
|
-
対象別カタログ `utc-<term>` の末端表は、全termで共通のカラム順を採用する。
|
|
382
|
-
必須:case_id / 条件 / 手順(最小) / 期待値
|
|
383
|
-
推奨:観測点(アサーション)/ 境界・依存 / トレース / 優先度 / 自動化 / 証跡
|
|
384
|
-
|
|
385
|
-
### 8.9. メモ / 将来課題
|
|
386
|
-
|
|
387
|
-
将来検討事項(例):組合せ削減の手法(ペアワイズ)、証跡リンク形式の統一、カタログlint(case_id重複検出)等を記録する。
|
|
388
|
-
運用ルールとして必須になった時点で本文へ昇格させる。
|
|
292
|
+
例外を適用する対象別カタログには、根拠と依存の制御方法を示す。
|
|
293
|
+
```
|