specdojo 0.1.0 → 0.2.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/LICENSE +22 -0
- package/README.md +82 -38
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +980 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +45 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +15 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +55 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +120 -24
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,329 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:stc-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:stc-index-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 総合テストカタログ 概要 作成ルール
|
|
12
|
+
|
|
13
|
+
System Test Catalog (STC) Index Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、総合テストカタログ(STC)の全体概要 `stc-index` を統一形式で記述するためのルールです。
|
|
16
|
+
|
|
17
|
+
TSPに基づき、総合テストに共通するルールや方針(対象分割・観点/条件・環境/証跡)を定義します。
|
|
18
|
+
|
|
19
|
+
個別総合テストカタログ(`stc-<term>`)の記述ルールは [stc-rulebook.md](stc-rulebook.md) を参照してください。
|
|
20
|
+
|
|
21
|
+
## 1. 全体方針
|
|
22
|
+
|
|
23
|
+
`stc-index` は、総合テストカタログ(STC)を **運用可能な最小情報** で統一し、
|
|
24
|
+
対象別カタログ(`stc-<term>`)の品質と一貫性を担保するための **共通ルール(SSOT)** とする。
|
|
25
|
+
|
|
26
|
+
- `stc-index` は **「考え方・共通方針・共通定義」** を記述する(個別ケースは持たない)
|
|
27
|
+
- 個別の観点・条件・ケースは **`stc-<term>` に集約**し、詳細は **テストコード/CI/テストレポート等の証跡** に寄せる
|
|
28
|
+
- 記述は **レビュー可能**であることを優先し、長文化を避ける(方針は箇条書き中心)
|
|
29
|
+
- 「例外」や「対象外」を明示し、総合テストの責任境界(何をやらないか)を固定する
|
|
30
|
+
- `tsp-index` の方針を根拠として、総合テストに共通する **分割基準・観点/条件の立て方・環境/外部依存の扱い・合格基準・証跡** を定義する
|
|
31
|
+
|
|
32
|
+
## 2. 位置づけ(他ドキュメントとの関係)
|
|
33
|
+
|
|
34
|
+
`stc-index` と他ドキュメントの関係を示します。
|
|
35
|
+
|
|
36
|
+
```mermaid
|
|
37
|
+
flowchart BT
|
|
38
|
+
TSP["tsp-index<br>テスト戦略・方針"]
|
|
39
|
+
|
|
40
|
+
subgraph TC["テストカタログ"]
|
|
41
|
+
direction RL
|
|
42
|
+
TCIndex["stc-index<br>テスト仕様-全体構成"]
|
|
43
|
+
TCDetail["stc-<term><br>テスト仕様-対象別"]
|
|
44
|
+
TCDetail -->|based_on| TCIndex
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
Code["テストコード 等"]
|
|
48
|
+
|
|
49
|
+
TC -->|based_on| TSP
|
|
50
|
+
Code -->|based_on| TC
|
|
51
|
+
|
|
52
|
+
classDef target stroke-width:4px
|
|
53
|
+
class TCIndex target
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## 3. ファイル命名・ID規則
|
|
57
|
+
|
|
58
|
+
- 本ルールの対象ドキュメントの `id` は `stc-index` 固定。対象別は `stc-<term>`(詳細は [stc-rulebook.md](stc-rulebook.md))。
|
|
59
|
+
- ファイル名は `stc-010-総合テストカタログ-概要.md` 等、プロジェクト内で一意になるように命名します。
|
|
60
|
+
- `<term>` は用語集の論理名キー(英小文字kebab-case)を用いる(表示名は title に日本語で記載してよい)。
|
|
61
|
+
|
|
62
|
+
## 4. 推奨 Frontmatter 項目
|
|
63
|
+
|
|
64
|
+
### 4.1. 設定内容
|
|
65
|
+
|
|
66
|
+
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
67
|
+
|
|
68
|
+
| 項目 | 説明 | 必須 |
|
|
69
|
+
| ---------- | -------------------------------------------------- | ---- |
|
|
70
|
+
| id | `stc-index`(固定) | ○ |
|
|
71
|
+
| type | `test` 固定 | ○ |
|
|
72
|
+
| title | 総合テストカタログ: 概要(`<システム名>`) | ○ |
|
|
73
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
74
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
75
|
+
| supersedes | 置き換え関係(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
76
|
+
|
|
77
|
+
### 4.2. 推奨ルール
|
|
78
|
+
|
|
79
|
+
- `based_on` には最低限 `tsp-index` を含めます。
|
|
80
|
+
- BAC/NFR/BR 等は、`stc-index` の方針判断(対象分割・環境前提・共通合格基準)に **直接利用したものだけ** を `based_on` に列挙します。
|
|
81
|
+
|
|
82
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
83
|
+
|
|
84
|
+
## 5. 本文構成(標準テンプレ)
|
|
85
|
+
|
|
86
|
+
`stc-index` は以下の見出し構成を **順序固定** で配置します。
|
|
87
|
+
|
|
88
|
+
| 番号 | 見出し | 必須 |
|
|
89
|
+
| ---- | ----------------------------------------------- | ---- |
|
|
90
|
+
| 1 | 本ドキュメントの目的と適用対象 | ○ |
|
|
91
|
+
| 2 | テスト対象の括り方と分割基準 | ○ |
|
|
92
|
+
| 3 | 対象外・除外理由(共通) | ○ |
|
|
93
|
+
| 4 | 観点の立て方(共通) | ○ |
|
|
94
|
+
| 5 | 条件の立て方(共通) | ○ |
|
|
95
|
+
| 6 | 観点/条件の採用基準と対象別への分配方針(共通) | ○ |
|
|
96
|
+
|
|
97
|
+
| 7 | 総合テスト共通の境界/環境の扱い | ○ |
|
|
98
|
+
| 8 | ケース表の共通カラム | ○ |
|
|
99
|
+
|
|
100
|
+
| 9 | メモ / 将来課題 | 任意 |
|
|
101
|
+
|
|
102
|
+
注意:次章の記述ガイドのMarkdown見出しはルール文章内の参照用であり、
|
|
103
|
+
生成する `stc-index` 本文の見出しは各章で指定された **番号付き** の形式に置き換えてください。
|
|
104
|
+
|
|
105
|
+
## 6. 記述ガイド
|
|
106
|
+
|
|
107
|
+
### 6.1. 本ドキュメントの目的と適用対象
|
|
108
|
+
|
|
109
|
+
生成する `stc-index` 本文の見出しは **## 1. 本ドキュメントの目的と適用対象**
|
|
110
|
+
|
|
111
|
+
- 目的:`stc-<term>` を同一基準で作成し、品質・粒度・責任範囲を揃える
|
|
112
|
+
- 適用対象:総合テスト(ST)に関するカタログ群(`stc-index` / `stc-<term>`)
|
|
113
|
+
- 非適用:UT/IT/ET/ATの個別ルールはそれぞれの `*c-index` / `*c-<term>` で扱う
|
|
114
|
+
- 成果物の位置づけ:
|
|
115
|
+
- `stc-index`:総合テスト共通方針(SSOT)
|
|
116
|
+
- `stc-<term>`:対象別の観点・条件・ケース表(SSOT)
|
|
117
|
+
- テストコード/CI/レポート:実装と実行証跡(Evidence)
|
|
118
|
+
|
|
119
|
+
- 本書が扱う粒度:**判断基準・共通ルールまで**(個別ケースの大量列挙は禁止)
|
|
120
|
+
|
|
121
|
+
### 6.2. テスト対象の括り方と分割基準
|
|
122
|
+
|
|
123
|
+
生成する `stc-index` 本文の見出しは **## 2. テスト対象の括り方と分割基準**
|
|
124
|
+
|
|
125
|
+
本節では、`stc-<term>` の `<term>` をどう切るか(対象単位の設計)を定義します。
|
|
126
|
+
|
|
127
|
+
- `<term>` は「ユーザ価値/業務シナリオのまとまり」(例:主要業務フロー、代表ユースケース、エンドツーエンド経路)とする
|
|
128
|
+
- 分割基準(推奨順):
|
|
129
|
+
1. **業務/価値境界**:1シナリオとして説明できる(開始条件→完了条件)
|
|
130
|
+
2. **境界横断**:複数コンポーネント/サブシステムを跨ぐ経路が同質
|
|
131
|
+
3. **データ境界**:同じデータライフサイクル(作成→更新→確定等)を扱う
|
|
132
|
+
4. **運用境界**:運用手順・監視観測点・権限が概ね一致する
|
|
133
|
+
|
|
134
|
+
- 過分割の禁止:`stc-<term>` が「1〜2ケースしかない」単位は原則統合する
|
|
135
|
+
- 肥大化の抑制(分割の目安):
|
|
136
|
+
- 観点が過剰(例:15以上)/表の行数が過剰(例:60以上)になったら分割候補
|
|
137
|
+
- 前提データや権限が大きく異なる経路が混在する場合は分割候補
|
|
138
|
+
|
|
139
|
+
### 6.3. 対象外・除外理由(共通)
|
|
140
|
+
|
|
141
|
+
生成する `stc-index` 本文の見出しは **## 3. 対象外・除外理由(共通)**
|
|
142
|
+
|
|
143
|
+
総合テストで **やらないこと** と、その **理由**、および **例外条件** を明確にします。
|
|
144
|
+
|
|
145
|
+
#### 6.3.1. 記述ルール
|
|
146
|
+
|
|
147
|
+
- 形式は **「対象外」「除外理由」「代替レベル/代替手段」「例外」** のセットを基本とする
|
|
148
|
+
- 「代替レベル/代替手段」は、UT/IT/ET/AT/NFR 等 **どこで担保するか** を必ず記載する
|
|
149
|
+
- 例外を認める場合は **判断基準**(いつ/どの条件で)を明記する
|
|
150
|
+
|
|
151
|
+
#### 6.3.2. 推奨フォーマット(表)
|
|
152
|
+
|
|
153
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(STで扱う条件) |
|
|
154
|
+
| ---------------------- | -------- | ------------------- | -------------------- |
|
|
155
|
+
|
|
156
|
+
#### 6.3.3. 典型例(記載候補)
|
|
157
|
+
|
|
158
|
+
- 厳密な性能・負荷・耐久(p95、スループット、長時間運転)
|
|
159
|
+
- 侵入テスト/本格的なセキュリティ診断
|
|
160
|
+
- 全ブラウザ/全端末の網羅互換(広範なマトリクス)
|
|
161
|
+
- 外部事業者の全障害パターン網羅(必要ならETに寄せる)
|
|
162
|
+
|
|
163
|
+
### 6.4. 観点の立て方(共通)
|
|
164
|
+
|
|
165
|
+
生成する `stc-index` 本文の見出しは **## 4. 観点の立て方(共通)**
|
|
166
|
+
|
|
167
|
+
総合テストの観点は「ユーザ/業務視点で、システム全体として何を保証するか」の切り口です。
|
|
168
|
+
|
|
169
|
+
- 観点の型(最低限この順で検討):
|
|
170
|
+
- 業務フローの成立(開始条件→完了条件、主要分岐)
|
|
171
|
+
- 例外/リカバリ(入力不正、権限、競合、外部失敗、再実行)
|
|
172
|
+
- データ整合性(複数コンポーネント間の整合、冪等、二重処理防止)
|
|
173
|
+
- 監視/運用観測(ログ相関、監視アラート条件、監査証跡)
|
|
174
|
+
- 代表的な非機能(STで扱う範囲のみ:タイムアウト、回復、限定的な性能目安)
|
|
175
|
+
|
|
176
|
+
- 命名規則:**「名詞+品質/振る舞い」**(例:`業務フロー成立` / `例外時リカバリ` / `データ整合性`)
|
|
177
|
+
- 粒度規則:
|
|
178
|
+
- 観点は「条件が複数ぶら下がる」程度にまとめる
|
|
179
|
+
- 抽象的すぎて条件が作れない観点は再定義する
|
|
180
|
+
|
|
181
|
+
- 重複禁止:同義の観点名を乱立させない(統合・改名)
|
|
182
|
+
|
|
183
|
+
### 6.5. 条件の立て方(共通)
|
|
184
|
+
|
|
185
|
+
生成する `stc-index` 本文の見出しは **## 5. 条件の立て方(共通)**
|
|
186
|
+
|
|
187
|
+
条件は「入力」「状態(データ/権限)」「環境(設定/外部)」「経路(分岐)」に分解して作成します。
|
|
188
|
+
|
|
189
|
+
- 入力(Input):代表値/境界値/異常値
|
|
190
|
+
- 状態(State):事前データ、権限/ロール、ステータス、ライフサイクル段階
|
|
191
|
+
- 環境(Env):設定値、feature flag、外部I/Fのsandbox/スタブ状態、ネットワーク条件
|
|
192
|
+
- 経路(Path):主要分岐(成功/失敗/再試行/取消 等)
|
|
193
|
+
|
|
194
|
+
組合せルール(増やし過ぎ防止):
|
|
195
|
+
|
|
196
|
+
- まず代表シナリオ(正常系)を作る
|
|
197
|
+
- 次に重要分岐(業務的に重要/頻出/損失大)を追加する
|
|
198
|
+
- 最後に重大例外(データ破壊/二重処理/権限逸脱につながるもの)を追加する
|
|
199
|
+
- 原則として全組合せ(直積)は作らない(必要時は理由と管理方法を明記)
|
|
200
|
+
|
|
201
|
+
### 6.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
202
|
+
|
|
203
|
+
生成する `stc-index` 本文の見出しは **## 6. 観点/条件の採用基準と対象別への分配方針(共通)**
|
|
204
|
+
|
|
205
|
+
本節では、観点/条件を「採用する判断」と「`stc-<term>` へ割り当てる判断」を共通ルールとして定義します。
|
|
206
|
+
|
|
207
|
+
#### 6.6.1. 採用基準(共通)
|
|
208
|
+
|
|
209
|
+
- 観点は「1観点=1合否命題」で採用する(複数命題の混在を禁止)
|
|
210
|
+
- 条件は「1条件=1差分(入力/状態/環境/経路)」で採用する
|
|
211
|
+
- 追加時は、次のいずれかに該当する根拠を明示する
|
|
212
|
+
- 失敗時の業務影響が大きい(誤処理/業務停止/監査不備など)
|
|
213
|
+
- 境界/例外/状態遷移の欠落が不具合につながりやすい
|
|
214
|
+
- 上位仕様(BAC/NFR/BR等)に明示的な要求がある
|
|
215
|
+
- 「重要そうだから」など根拠不明の採用はしない
|
|
216
|
+
|
|
217
|
+
#### 6.6.2. 対象別への分配方針(共通)
|
|
218
|
+
|
|
219
|
+
- 観点/条件は、責務を持つ `stc-<term>` に **主担当1つ** を割り当てる(重複割当は例外扱い)
|
|
220
|
+
- 複数 `stc-<term>` に跨る場合は、主担当 + 従担当(参照)で表現し、重複記載を避ける
|
|
221
|
+
- 分配判断は「業務/価値境界」「境界横断」「運用境界」の順で決める
|
|
222
|
+
- 分配結果は `stc-<term>` 側のケース表とトレース列で追跡可能にする
|
|
223
|
+
|
|
224
|
+
推奨フォーマット(例):
|
|
225
|
+
|
|
226
|
+
| 観点/条件 | 採用理由 | 主担当 `stc-<term>` | 従担当(任意) | 備考 |
|
|
227
|
+
| --------- | -------- | ------------------- | -------------- | ---- |
|
|
228
|
+
|
|
229
|
+
### 6.7. 総合テスト共通の境界/環境の扱い
|
|
230
|
+
|
|
231
|
+
生成する `stc-index` 本文の見出しは **## 7. 総合テスト共通の境界/環境の扱い**
|
|
232
|
+
|
|
233
|
+
総合テストでは「実運用に近い経路」を確認しつつ、運用可能性(再現性・安全性・費用)を優先して境界と環境前提を固定します。
|
|
234
|
+
|
|
235
|
+
- 環境:
|
|
236
|
+
- 原則:ST専用の検証環境(staging相当)を想定し、バージョン/設定の固定ルールを明記する
|
|
237
|
+
- テストデータ:namespace・初期化・後始末(削除/期限/再利用)を共通方針として定める
|
|
238
|
+
|
|
239
|
+
- 外部依存:
|
|
240
|
+
- 原則:ETで担保すべき「外部事業者の詳細」はSTで無理に網羅しない
|
|
241
|
+
- STでは、代表的な成功/失敗(例:外部が一時不可)を **sandbox/スタブ/疑似応答** で再現する方針を定める
|
|
242
|
+
|
|
243
|
+
- UI/操作:
|
|
244
|
+
- STではユーザ操作を扱ってよいが、手順は **高位の行動記述** に留め、クリック列挙を避ける(詳細はテストコードへ)
|
|
245
|
+
|
|
246
|
+
- 観測点(Evidence):
|
|
247
|
+
- 期待値は「画面/レスポンス」だけでなく、**DB状態・イベント・ログ相関ID・監査ログ** 等の観測点を含める
|
|
248
|
+
- 証跡の標準:CI run、レポート、スクリーンショット/動画、ログ相関キー、外部リクエストID 等の形式を定める
|
|
249
|
+
|
|
250
|
+
- 合格基準(共通):
|
|
251
|
+
- P0シナリオは必須成功、P1はリリース条件に応じ、P2は計画的消化など、共通の判定基準を明記する
|
|
252
|
+
|
|
253
|
+
### 6.8. ケース表の共通カラム
|
|
254
|
+
|
|
255
|
+
生成する `stc-index` 本文の見出しは **## 8. ケース表の共通カラム**
|
|
256
|
+
|
|
257
|
+
`stc-<term>` の末端(条件・ケース表)は、検索性・比較性・自動化移行の容易さを確保するため、
|
|
258
|
+
全termで同一カラム順を採用します。
|
|
259
|
+
|
|
260
|
+
必須カラム:
|
|
261
|
+
|
|
262
|
+
- `case_id`(ケースID):対象別に一意なIDで変更しない
|
|
263
|
+
- 形式:`<level>-<term>-<perspective_key>-<nnn>`(`level` は `st`)
|
|
264
|
+
- 例:`st-order-place-flow-success-010`
|
|
265
|
+
- `perspective_key` は kebab-case のキー文字列(英小文字+数字+ハイフン)で、原則変更しない
|
|
266
|
+
- `nnn` は 10刻み(010,020,030…)推奨
|
|
267
|
+
|
|
268
|
+
- `条件`:`入力:` `状態:` `環境:` `経路:` の要点(必要なものだけ記載)
|
|
269
|
+
- `手順(最小)`:高位の最小手順(クリック列挙禁止)
|
|
270
|
+
- `期待値`:判定可能な合格条件(観測点を含める)
|
|
271
|
+
|
|
272
|
+
推奨カラム(運用必須):
|
|
273
|
+
|
|
274
|
+
- `観測点(アサーション)`:画面/レスポンス/状態/イベント/ログ相関など
|
|
275
|
+
- `環境/依存`:sandbox/スタブ、設定、データnamespace 等
|
|
276
|
+
- `トレース`:req/spec/ac/issue 等のID
|
|
277
|
+
- `優先度`:P0/P1/P2
|
|
278
|
+
- `自動化`:manual/automated/mixed
|
|
279
|
+
- `証跡`:CI/レポート/スクショ/動画/ログ相関キー 等の参照先
|
|
280
|
+
|
|
281
|
+
注意:
|
|
282
|
+
|
|
283
|
+
- 表の1行=1テスト(条件×期待値が一意)
|
|
284
|
+
- 詳細はテストコードへ寄せ、カタログは「レビュー可能な最小情報」を維持する
|
|
285
|
+
|
|
286
|
+
### 6.9. メモ / 将来課題
|
|
287
|
+
|
|
288
|
+
生成する `stc-index` 本文の見出しは **## 9. メモ / 将来課題**
|
|
289
|
+
|
|
290
|
+
- 将来検討(例):
|
|
291
|
+
- 実行時間短縮(スモーク/回帰の分離)
|
|
292
|
+
- 証跡リンク形式の統一(レポート保存場所、ログ検索クエリ)
|
|
293
|
+
- テストデータ自動生成/後始末の標準化
|
|
294
|
+
- カタログlint(case_id重複、必須列欠落など)
|
|
295
|
+
|
|
296
|
+
## 7. 禁止事項
|
|
297
|
+
|
|
298
|
+
| 項目 | 理由 |
|
|
299
|
+
| -------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
300
|
+
| `stc-index` に個別ケース(条件・手順・期待値)を大量に列挙する | `stc-index` は共通方針のSSOTであり、個別は `stc-<term>` に集約するため |
|
|
301
|
+
| 環境前提(データ/設定/外部依存)を対象ごとに無根拠に変更する | 再現性が崩れ、CI/運用が不安定になるため |
|
|
302
|
+
| 手順にUI操作のクリック列挙を書く | 保守性が低く、変更に弱く、意図が見えなくなるため |
|
|
303
|
+
| 期待値を曖昧に書く(例:「正常に動くこと」) | 判定不能で合否が揺れ、証跡として機能しないため |
|
|
304
|
+
| `case_id` を後から変更する(参照があるのに変更する) | トレース・証跡リンクが壊れ、履歴追跡が不能になるため |
|
|
305
|
+
|
|
306
|
+
## 8. サンプル(最小)
|
|
307
|
+
|
|
308
|
+
注:以下はルール文書内の例示です。生成する `stc-index` では `## 1...` から始まります。
|
|
309
|
+
|
|
310
|
+
```yaml
|
|
311
|
+
---
|
|
312
|
+
id: stc-index
|
|
313
|
+
type: test
|
|
314
|
+
title: 総合テストカタログ: 概要
|
|
315
|
+
status: draft
|
|
316
|
+
based_on: [tsp-index]
|
|
317
|
+
supersedes: []
|
|
318
|
+
---
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
### 8.1. 本ドキュメントの目的と適用対象
|
|
322
|
+
|
|
323
|
+
`stc-index` は、総合テストに共通する「対象単位の切り方」「観点/条件の立て方」「環境/外部依存」「合格基準」「証跡方針」を定義し、
|
|
324
|
+
対象別カタログ `stc-<term>` の作成と運用の基盤とする。
|
|
325
|
+
|
|
326
|
+
### 8.2. テスト対象の括り方と分割基準
|
|
327
|
+
|
|
328
|
+
`stc-<term>` の `<term>` は主要業務フロー/ユーザシナリオのまとまりとし、
|
|
329
|
+
業務境界・境界横断の同質性・データライフサイクル・運用境界を基準に分割する。
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:stc-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:stc-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 総合テストカタログ 対象別 作成ルール
|
|
12
|
+
|
|
13
|
+
System Test Catalog (STC) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、総合テストカタログ(STC)の対象別 `stc-<term>` を統一形式で記述するためのルールです。
|
|
16
|
+
`stc-index` を前提に、SSOTの本体として、対象ごとの **総合テストの目的・責務・境界・環境前提、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
個別 STC(`stc-<term>`)は、総合テストにおける SSOT の本体として、対象ごとの狙いと境界を明確化し、
|
|
21
|
+
観点×条件=ケース(末端表)を最小情報で整理して、テスト実装/CI/テストレポート証跡へ確実に接続できる形で記述する。
|
|
22
|
+
|
|
23
|
+
- `stc-<term>` は **対象固有の情報のみ** を記述し、共通ルールは `stc-index` を参照する(重複記述しない)
|
|
24
|
+
- 総合テストの目的は「**実運用に近い経路で、システム全体として業務が成立すること**」の確認である
|
|
25
|
+
- ケースは「表の1行=1テスト(1シナリオ)」とし、手順と期待値は **判定可能** な粒度で簡潔に書く
|
|
26
|
+
- クリック列挙や画面要素の細部説明は避け、手順は **高位の行動** と **観測点** に寄せる(詳細はテストコードへ)
|
|
27
|
+
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(CI/レポート/ログ相関等)に接続されていること
|
|
28
|
+
- 環境・テストデータ・外部依存(sandbox/スタブ等)は **再現性** を優先し、対象ごとに無根拠に変更しない(例外は根拠を明記)
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけ(他ドキュメントとの関係)
|
|
31
|
+
|
|
32
|
+
個別 STC(`stc-<term>`)と他ドキュメントの関係を示します。
|
|
33
|
+
|
|
34
|
+
```mermaid
|
|
35
|
+
flowchart BT
|
|
36
|
+
TSP["tsp-index<br>テスト戦略・方針"]
|
|
37
|
+
|
|
38
|
+
subgraph TC["テストカタログ"]
|
|
39
|
+
direction RL
|
|
40
|
+
TCIndex["stc-index<br>テスト仕様-全体構成"]
|
|
41
|
+
TCDetail["stc-<term><br>テスト仕様-対象別"]
|
|
42
|
+
TCDetail -->|based_on| TCIndex
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
Code["テストコード 等"]
|
|
46
|
+
|
|
47
|
+
TC -->|based_on| TSP
|
|
48
|
+
Code -->|based_on| TC
|
|
49
|
+
|
|
50
|
+
classDef target stroke-width:4px
|
|
51
|
+
class TCDetail target
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 3. ファイル命名・ID規則
|
|
55
|
+
|
|
56
|
+
- `id` は `stc-<term>`(kebab-case。例: `stc-order-place`)。
|
|
57
|
+
- ファイル名は `stc-010-総合テストカタログ-<term>.md` 等(例: `stc-010-総合テストカタログ-注文確定.md`)。
|
|
58
|
+
- `<term>` は用語集(GL) の論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
|
|
59
|
+
|
|
60
|
+
## 4. 推奨 Frontmatter 項目
|
|
61
|
+
|
|
62
|
+
### 4.1. 設定内容
|
|
63
|
+
|
|
64
|
+
Frontmatter は共通スキーマに従います(あわせてドキュメントのメタ情報の記述ルールも参照)。
|
|
65
|
+
|
|
66
|
+
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
67
|
+
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
68
|
+
|
|
69
|
+
| 項目 | 説明 | 必須 |
|
|
70
|
+
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
71
|
+
| id | STC ID(個別: `stc-<term>`) | ○ |
|
|
72
|
+
| type | `test` 固定 | ○ |
|
|
73
|
+
| title | 総合テストカタログ: <対象名> | ○ |
|
|
74
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
75
|
+
| based_on | 根拠仕様(最低限: `tsp-index`, `stc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
76
|
+
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
77
|
+
| supersedes | 置き換え関係(ID配列) | 任意 |
|
|
78
|
+
|
|
79
|
+
### 4.2. 推奨ルール
|
|
80
|
+
|
|
81
|
+
- `based_on` は原則 `[tsp-index, stc-index]` を最低限とする。
|
|
82
|
+
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` / `ac-*` / `issue-*` 等)は本文「トレース」に集約する。
|
|
83
|
+
機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
84
|
+
- 記述内容が多くなる場合は、対象を分割し、`part_of` で集約ドキュメントに所属させる。
|
|
85
|
+
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
86
|
+
|
|
87
|
+
## 5. 本文構成(標準テンプレ)
|
|
88
|
+
|
|
89
|
+
個別 STC(`stc-<term>`)は以下の見出し構成を **順序固定** で配置します。
|
|
90
|
+
|
|
91
|
+
| 番号 | 見出し | 必須 |
|
|
92
|
+
| ---- | ------------------ | ---- |
|
|
93
|
+
| 1 | 概要(`<term>`) | ○ |
|
|
94
|
+
| 2 | 目的 | ○ |
|
|
95
|
+
| 3 | 対象外 | ○ |
|
|
96
|
+
| 4 | 境界/環境/依存 | ○ |
|
|
97
|
+
| 5 | トレース | ○ |
|
|
98
|
+
| 6 | テスト観点とケース | ○ |
|
|
99
|
+
|
|
100
|
+
注意:次章の記述ガイドのMarkdown見出しはルール文章内の参照用であり、
|
|
101
|
+
生成する `stc-<term>` 本文の見出しは各章で指定された **番号付き** の形式に置き換えてください。
|
|
102
|
+
|
|
103
|
+
## 6. 記述ガイド
|
|
104
|
+
|
|
105
|
+
### 6.1. 概要(`<term>`)
|
|
106
|
+
|
|
107
|
+
生成する `stc-<term>` 本文の見出しは **## 1. 概要(<term>)**
|
|
108
|
+
|
|
109
|
+
本節では、対象(`<term>`)が何であり、どの業務シナリオ/経路を本カタログで扱うかを簡潔に示します。
|
|
110
|
+
|
|
111
|
+
- `<term>` の説明(1〜3行):業務/ユーザ価値のまとまりとして記述する(開始条件→完了条件が想像できる形)
|
|
112
|
+
- 期待する利用者:レビューア/実装者/テスト実装者が前提を把握できる内容にする
|
|
113
|
+
- 対象の粒度:`stc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
114
|
+
- 関連コンポーネントや主要I/F(任意):主要画面、API、バッチ、イベント等を列挙してよい
|
|
115
|
+
- 詳細な仕様説明や長い背景は書かない(根拠はトレースで示す)
|
|
116
|
+
|
|
117
|
+
### 6.2. 目的
|
|
118
|
+
|
|
119
|
+
生成する `stc-<term>` 本文の見出しは **## 2. 目的**
|
|
120
|
+
|
|
121
|
+
本節では、「この総合テスト対象で何を保証したいか」を明確にします(責務というより **狙い**)。
|
|
122
|
+
|
|
123
|
+
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる** 形で記述する
|
|
124
|
+
- 例:主要業務フローが完了できる/主要分岐で破綻しない/再実行で二重処理しない/監査証跡が残る
|
|
125
|
+
|
|
126
|
+
- 目的は観点の上位概念であり、観点は目的を分解した切り口(目的≠観点)
|
|
127
|
+
- 可能なら観測可能な成果(画面表示、API応答、DB状態、イベント、ログ相関ID等)とセットで書く
|
|
128
|
+
- 目的に含まれないものは「対象外」へ移す(曖昧さを残さない)
|
|
129
|
+
|
|
130
|
+
### 6.3. 対象外
|
|
131
|
+
|
|
132
|
+
生成する `stc-<term>` 本文の見出しは **## 3. 対象外**
|
|
133
|
+
|
|
134
|
+
本節では、「この対象カタログ(`stc-<term>`)ではやらないこと」を明示します。
|
|
135
|
+
`stc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
136
|
+
|
|
137
|
+
- 対象外は「なぜ除外するか(理由)」とセットで書く
|
|
138
|
+
- 可能なら「代替するレベル」(UT/IT/ET/AT/NFR 等)も併記する
|
|
139
|
+
- 対象固有の対象外(例:別業務フロー、別サブシステムの責務)を明確にする
|
|
140
|
+
- 例外としてSTで扱う場合は、条件・根拠・環境前提(sandbox/スタブ/データ準備)を明記する
|
|
141
|
+
|
|
142
|
+
推奨フォーマット(簡易):
|
|
143
|
+
|
|
144
|
+
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
145
|
+
|
|
146
|
+
### 6.4. 境界/環境/依存
|
|
147
|
+
|
|
148
|
+
生成する `stc-<term>` 本文の見出しは **## 4. 境界/環境/依存**
|
|
149
|
+
|
|
150
|
+
本節では、総合テストにおける「境界(どこからどこまでが対象か)」と
|
|
151
|
+
「環境前提」「外部依存(sandbox/スタブ/疑似等)」を明確にします。
|
|
152
|
+
|
|
153
|
+
- 境界:開始トリガ/入口(画面/API/バッチ等)と、完了条件/出口(完了状態、発行イベント等)を明記する
|
|
154
|
+
- 環境:ST環境名、主要設定、テストデータの準備・後始末(namespace/初期化/削除)を列挙する
|
|
155
|
+
- 外部依存:依存先ごとに「扱い」を決める
|
|
156
|
+
- 外部サービス:sandbox/スタブ/疑似応答(成功/代表失敗/一時不可など)
|
|
157
|
+
- メール/SMS/Push:ダミー配送・検証用受信箱・ログ確認の方針
|
|
158
|
+
- 決済/配送など:本番課金/実配送は原則しない(例外は条件を明記)
|
|
159
|
+
|
|
160
|
+
- 観測点(Evidence):何を見て合否判定するかを明記する
|
|
161
|
+
- 画面/レスポンス、DB状態、イベント、監査ログ、相関ID、外部リクエストID 等
|
|
162
|
+
|
|
163
|
+
- 例外:環境や依存の扱いを変える場合は、理由と影響(再現性・コスト・安全性)を明記する
|
|
164
|
+
|
|
165
|
+
### 6.5. トレース
|
|
166
|
+
|
|
167
|
+
生成する `stc-<term>` 本文の見出しは **## 5. トレース**
|
|
168
|
+
|
|
169
|
+
本節では、`stc-<term>` の根拠となる上位成果物との対応関係を示します。
|
|
170
|
+
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、
|
|
171
|
+
観点・ケース表では **trace_key(`TR-xx`)参照** に統一します。
|
|
172
|
+
|
|
173
|
+
#### 6.5.1. 記述ルール(trace_key)
|
|
174
|
+
|
|
175
|
+
- 各トレース項目に **trace_key(`TR-xx`)** を付与する(例:`TR-01`, `TR-02` …)
|
|
176
|
+
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
177
|
+
- 観点・ケース表の `トレース` 列には **仕様IDを直書きせず**、`TR-xx` を列挙する
|
|
178
|
+
- ケース表に新しい根拠が必要になった場合は、**先に本節の表へ行追加**し、付与された `trace_key` をケース表で参照する
|
|
179
|
+
- `TR-xx` の採番は追加順。削除しても欠番は詰めない。
|
|
180
|
+
|
|
181
|
+
#### 6.5.2. トレース表(標準フォーマット)
|
|
182
|
+
|
|
183
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
184
|
+
| --------- | ------- | ------- | ---- |
|
|
185
|
+
| TR-01 | br-... | (1行) | 任意 |
|
|
186
|
+
| TR-02 | bac-... | (1行) | 任意 |
|
|
187
|
+
|
|
188
|
+
- `要点` は「ケース作成の判断に使ったポイント」を **1行**で書く(冗長な仕様説明はしない)
|
|
189
|
+
|
|
190
|
+
### 6.6. テスト観点とケース
|
|
191
|
+
|
|
192
|
+
生成する `stc-<term>` 本文の見出しは **## 6. テスト観点とケース**
|
|
193
|
+
|
|
194
|
+
本節は `stc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
195
|
+
|
|
196
|
+
#### 6.6.1. 観点:<観点>
|
|
197
|
+
|
|
198
|
+
生成する `stc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
199
|
+
|
|
200
|
+
- 観点は `stc-index` の「観点の立て方(共通)」に従って命名する
|
|
201
|
+
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(乱立を避ける)
|
|
202
|
+
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない(変更が必要なら `supersedes` 等で追跡する)
|
|
203
|
+
|
|
204
|
+
##### 6.6.1.1. 意図
|
|
205
|
+
|
|
206
|
+
生成する `stc-<term>` 本文の見出しは **#### 6.1.1. 意図**
|
|
207
|
+
|
|
208
|
+
- 観点ごとに「意図(この観点で保証すること)」を 1〜2 行で書く
|
|
209
|
+
|
|
210
|
+
##### 6.6.1.2. 条件・ケース表
|
|
211
|
+
|
|
212
|
+
生成する `stc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
213
|
+
|
|
214
|
+
- ケース表の 1 行は「1テスト(1シナリオ)」を表す(条件×期待値が一意)
|
|
215
|
+
- 必須カラムは `stc-index` の定義に従う
|
|
216
|
+
- `case_id` は以下を推奨し、変更しない
|
|
217
|
+
- 形式:`<level>-<term>-<perspective_key>-<nnn>`(`level` は `st`)
|
|
218
|
+
- `perspective_key`:kebab-case(英小文字+数字+ハイフン)。原則変更しない
|
|
219
|
+
- `nnn`:3桁、10刻み(010,020,030…)推奨
|
|
220
|
+
|
|
221
|
+
- 条件は `入力:` `状態:` `環境:` `経路:` の要点で表現する(必要な要素のみ記載)
|
|
222
|
+
- 手順は **高位の最小手順** に留め、クリック列挙は禁止(詳細はテストコードへ)
|
|
223
|
+
- 期待値は判定可能に書く(画面/レスポンスに加え、DB状態、イベント、監査ログ、相関IDなどの観測点を含める)
|
|
224
|
+
- 証跡は CI/レポート/ログ相関/スクショ等へ接続できる形で書く(例:パス、CI run ID、レポートURLキー等)
|
|
225
|
+
|
|
226
|
+
推奨:観点ごとのケース数は「代表→重要分岐→重大例外」の順で増やし、直積(全組合せ)を原則避ける
|
|
227
|
+
|
|
228
|
+
## 7. 禁止事項
|
|
229
|
+
|
|
230
|
+
| 禁止事項 | 理由 |
|
|
231
|
+
| ------------------------------------------------------------------------------ | ---------------------------------------------------------- |
|
|
232
|
+
| `stc-index` の共通方針を `stc-<term>` 側で勝手に上書きする(環境/依存/対象外) | 再現性が崩れ、レビュー・運用が困難になるため |
|
|
233
|
+
| ケース表にUIクリック手順や画面要素の細部を大量に列挙する | 変更に弱く、意図が読めず、保守不能になるため |
|
|
234
|
+
| 期待値を曖昧に書く(例:「正常に動くこと」「問題がないこと」) | 合否判定ができず証跡にならないため |
|
|
235
|
+
| `case_id` を変更する/再利用する | トレース・証跡リンクが破壊され、履歴追跡が不能になるため |
|
|
236
|
+
| `perspective_key` を観点名の修正に合わせて頻繁に変える | ID体系が不安定になり参照が壊れるため |
|
|
237
|
+
| 直積(全組合せ)のケースを無条件に作る | ケース爆発で運用不能になるため(必要時は理由・範囲を明記) |
|
|
238
|
+
| トレースや証跡を持たないケースを恒久的に残す | SSOTとして成立しないため(暫定は期限/理由を明記) |
|
|
239
|
+
|
|
240
|
+
## 8. サンプル(最小)
|
|
241
|
+
|
|
242
|
+
注:以下はルール文書内の例示です。生成する `stc-<term>` では `## 1...` から始まります。
|
|
243
|
+
|
|
244
|
+
```yaml
|
|
245
|
+
---
|
|
246
|
+
id: stc-order-place
|
|
247
|
+
type: test
|
|
248
|
+
title: 総合テストカタログ: 注文確定(order-place)
|
|
249
|
+
status: draft
|
|
250
|
+
part_of: []
|
|
251
|
+
based_on: [tsp-index, stc-index]
|
|
252
|
+
supersedes: []
|
|
253
|
+
---
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### 8.1. 概要(order-place)
|
|
257
|
+
|
|
258
|
+
ユーザがカートから注文を確定し、決済(sandbox)を経て注文が確定状態になり、監査/通知の証跡が残る経路を扱う。
|
|
259
|
+
|
|
260
|
+
### 8.2. 目的
|
|
261
|
+
|
|
262
|
+
- 注文確定フローが完了条件(注文=確定)まで到達できることを保証する
|
|
263
|
+
- 決済失敗時に注文が不整合にならず、適切にエラーハンドリングされることを保証する
|
|
264
|
+
- 監査ログ/相関IDにより追跡可能であることを保証する
|
|
265
|
+
|
|
266
|
+
### 8.3. 対象外
|
|
267
|
+
|
|
268
|
+
- 本番決済の実課金(理由:安全性、代替:ET/事業者検証)
|
|
269
|
+
- 全ブラウザ網羅の表示互換(理由:範囲過大、代替:別途互換試験)
|
|
270
|
+
|
|
271
|
+
### 8.4. 境界/環境/依存
|
|
272
|
+
|
|
273
|
+
- 境界:開始=カート確定操作、完了=注文が確定状態+通知イベント発行
|
|
274
|
+
- 環境:staging、テストデータnamespace=st-xxx(毎回初期化)
|
|
275
|
+
- 外部決済:sandbox(成功/残高不足の代表失敗のみ)
|
|
276
|
+
- 観測点:画面結果、注文DB状態、イベント、監査ログ(correlation_id)
|
|
277
|
+
|
|
278
|
+
### 8.5. トレース
|
|
279
|
+
|
|
280
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
281
|
+
| --------- | ----------- | ------------------ | ---- |
|
|
282
|
+
| TR-01 | br-order-01 | 注文確定の完了条件 | |
|
|
283
|
+
| TR-02 | bac-pay-02 | 決済失敗時の扱い | |
|
|
284
|
+
|
|
285
|
+
### 8.6. テスト観点とケース
|
|
286
|
+
|
|
287
|
+
#### 8.6.1. 観点:業務フロー成立
|
|
288
|
+
|
|
289
|
+
##### 8.6.1.1. 意図
|
|
290
|
+
|
|
291
|
+
代表条件で注文確定が完了し、状態・監査証跡が揃うことを確認する。
|
|
292
|
+
|
|
293
|
+
##### 8.6.1.2. 条件・ケース表
|
|
294
|
+
|
|
295
|
+
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 環境/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
296
|
+
| ------------------------------- | --------------------------------------- | ------------------ | --------------------------------------- | -------------------------------------- | -------------------- | -------- | ------ | --------- | ---------------------------- |
|
|
297
|
+
| st-order-place-flow-success-010 | 状態: 在庫あり / 環境: 決済=sandbox成功 | 注文確定を実行する | 注文=確定になり通知イベントが発行される | DB状態/イベント/監査ログcorrelation_id | staging, pay=sandbox | TR-01 | P0 | automated | e2e/order/place.spec.ts, CI# |
|