specdojo 0.1.0 → 0.2.1
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 +142 -35
- 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 +990 -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 +54 -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 +33 -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 +56 -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 +472 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +163 -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 +121 -24
- package/templates/antigravity/README.md +35 -0
- package/templates/antigravity/exec-defaults-snippet.yaml +38 -0
- package/templates/antigravity/orchestrator.md +146 -0
- package/templates/antigravity/pm-members-snippet.yaml +55 -0
- 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/agents/specdojo-orchestrator.md +153 -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/codex/agents/specdojo-orchestrator.toml +154 -0
- package/templates/codex/orchestrator.md +146 -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/templates/opencode/agents/specdojo-orchestrator.md +193 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:uis-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:uis-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 画面仕様(UI) 作成ルール
|
|
12
|
+
|
|
13
|
+
本ドキュメントは、業務分析・要求定義のために **画面仕様(User Interface: UI)を統一形式で記述する標準ルール**です。
|
|
14
|
+
|
|
15
|
+
## 1. 全体方針
|
|
16
|
+
|
|
17
|
+
- 画面仕様は、**業務ユーザー視点**での画面の目的・表示項目・操作・遷移を明確に記述します。
|
|
18
|
+
- 画面の機能に着目し、**画面のレイアウトやワイヤーフレームは含めません**。
|
|
19
|
+
- 実装詳細(例: 物理テーブル名、SQL、実装クラス/関数名、UIコンポーネント名)は記載しません。
|
|
20
|
+
- 1ファイル = 1画面。
|
|
21
|
+
|
|
22
|
+
## 2. 用語定義
|
|
23
|
+
|
|
24
|
+
| 用語 | 定義 |
|
|
25
|
+
| -------------- | ---------------------------------------------------------------- |
|
|
26
|
+
| 画面 | 業務ユーザーが操作する単位。目的・表示項目・操作・遷移を持つ |
|
|
27
|
+
| 表示項目 | 画面に表示する情報(一覧列、詳細項目、集計値、メッセージ等) |
|
|
28
|
+
| 操作 | ユーザーが実行できるアクション(検索、登録、更新、削除、確定等) |
|
|
29
|
+
| 遷移 | 画面間の移動。条件・遷移先・引き渡し(識別子など)を含む |
|
|
30
|
+
| バリデーション | 入力値の妥当性判定(必須、形式、範囲、相関等) |
|
|
31
|
+
| エラー表示 | 入力不備・権限不足・対象なし等をユーザーに伝える表示 |
|
|
32
|
+
|
|
33
|
+
## 3. ファイル命名・ID規則
|
|
34
|
+
|
|
35
|
+
- ファイル名: `uis-<番号>-<短い日本語名>.md`(例: `uis-0010-商品一覧.md`)
|
|
36
|
+
- Frontmatter:
|
|
37
|
+
- `id`: `uis-product-list` のように小文字ハイフン形式
|
|
38
|
+
- `title`: 「商品一覧」などの画面名
|
|
39
|
+
|
|
40
|
+
## 4. 推奨 Frontmatter 項目
|
|
41
|
+
|
|
42
|
+
| 項目 | 説明 | 必須 |
|
|
43
|
+
| -------- | ------------------------------------------- | ---- |
|
|
44
|
+
| id | 画面ID(小文字ハイフン) | ○ |
|
|
45
|
+
| type | `screen` 固定 | ○ |
|
|
46
|
+
| title | 画面名 | ○ |
|
|
47
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
48
|
+
| based_on | 根拠となる仕様ID(API/ドメイン/他画面など) | 任意 |
|
|
49
|
+
|
|
50
|
+
### NG/OK例(抜粋)
|
|
51
|
+
|
|
52
|
+
- NG例: `id: UI_ProductList`(大文字/アンダースコアNG), `type: data`(`screen`以外NG), `extra: foo`(未定義プロパティNG)
|
|
53
|
+
- OK例: `id: uis-product-list`, `type: ui`, `status: ready`
|
|
54
|
+
|
|
55
|
+
## 5. 本文構成(標準テンプレ)
|
|
56
|
+
|
|
57
|
+
各 UI 仕様ファイルは以下見出しを順番に並べます。
|
|
58
|
+
|
|
59
|
+
1. 概要
|
|
60
|
+
2. 対象ユーザー/利用目的
|
|
61
|
+
3. 表示項目
|
|
62
|
+
4. 操作
|
|
63
|
+
|
|
64
|
+
5. 遷移
|
|
65
|
+
6. バリデーション
|
|
66
|
+
7. エラー表示
|
|
67
|
+
8. メモ / 将来課題
|
|
68
|
+
|
|
69
|
+
## 6. 記述ガイド詳細
|
|
70
|
+
|
|
71
|
+
### 6.1 概要
|
|
72
|
+
|
|
73
|
+
短い一文で「この画面が何をするか」を業務用語で書きます。
|
|
74
|
+
|
|
75
|
+
### 6.2 対象ユーザー/利用目的
|
|
76
|
+
|
|
77
|
+
- 対象ユーザー(例: 店員、店主)
|
|
78
|
+
- 利用目的(例: 商品を検索し、詳細確認や販売登録へ進む)
|
|
79
|
+
|
|
80
|
+
### 6.3 表示項目
|
|
81
|
+
|
|
82
|
+
- 一覧/詳細/集計など、画面で表示する項目を列挙します。
|
|
83
|
+
- レイアウト指定ではなく、**何が表示されるか**を記述します。
|
|
84
|
+
|
|
85
|
+
推奨フォーマット:
|
|
86
|
+
|
|
87
|
+
| 項目名 | 種別 | 表示形式 | 編集可 | 必須 | 備考 |
|
|
88
|
+
| -------- | ---- | -------- | ------ | ---- | --------------------------- |
|
|
89
|
+
| 商品名 | 一覧 | テキスト | - | - | 部分一致検索対象 |
|
|
90
|
+
| 販売価格 | 一覧 | 金額 | - | - | 税込/税別は別途ルールに従う |
|
|
91
|
+
|
|
92
|
+
### 6.4 操作
|
|
93
|
+
|
|
94
|
+
- ユーザーが実行できる操作を列挙し、前提条件と結果(更新/遷移)を明確にします。
|
|
95
|
+
- クリック手順の逐語列挙ではなく、**操作の意味**を書きます。
|
|
96
|
+
- ボタンなどのUI部品は原則として列挙しません(**操作**に包含します)。
|
|
97
|
+
- 例外: 誤解を避ける必要がある場合のみ、備考に**表示ラベル(文言)**を補足してもよい(レイアウト指定はしない)。
|
|
98
|
+
|
|
99
|
+
推奨フォーマット:
|
|
100
|
+
|
|
101
|
+
| 操作名 | 対象 | 前提条件 | 結果(更新/遷移) |
|
|
102
|
+
| -------- | -------- | ---------- | ---------------------------- |
|
|
103
|
+
| 検索 | 検索条件 | なし | 条件に合致する商品一覧を表示 |
|
|
104
|
+
| 新規登録 | - | 権限がある | 商品登録画面へ遷移 |
|
|
105
|
+
|
|
106
|
+
### 6.5 遷移
|
|
107
|
+
|
|
108
|
+
遷移元/遷移先/遷移条件/引き渡す識別子(概念レベル)を明確にします。
|
|
109
|
+
|
|
110
|
+
推奨フォーマット:
|
|
111
|
+
|
|
112
|
+
| 遷移名 | 遷移先 | 条件 | 引き渡し | 備考 |
|
|
113
|
+
| ------ | ------------------------------ | ------------ | -------- | ---- |
|
|
114
|
+
| 詳細へ | 商品詳細(uis-product-detail) | 一覧行を選択 | 商品ID | - |
|
|
115
|
+
|
|
116
|
+
### 6.6 バリデーション
|
|
117
|
+
|
|
118
|
+
入力欄がある場合、必須/形式/範囲/相関(開始日 ≤ 終了日など)を列挙します。
|
|
119
|
+
|
|
120
|
+
### 6.7 エラー表示
|
|
121
|
+
|
|
122
|
+
代表的な2〜4ケース(入力不備、権限不足、対象なし等)と、ユーザーに見せるメッセージ方針(短く・行動可能)を記述します。
|
|
123
|
+
|
|
124
|
+
## 7. 命名・記述スタイル
|
|
125
|
+
|
|
126
|
+
- 画面名は「名詞+用途」: 例 `商品一覧`, `売上登録`, `在庫照会`
|
|
127
|
+
- 操作名は短く動詞で: 例 `検索`, `登録`, `更新`, `取消`, `確定`
|
|
128
|
+
- 画面/項目/操作は業務用語で統一し、略語は用語集にあるもののみ使用します
|
|
129
|
+
|
|
130
|
+
## 8. 階層分解ガイド
|
|
131
|
+
|
|
132
|
+
| シグナル | 分割検討 |
|
|
133
|
+
| --------------------- | -------------------------------- |
|
|
134
|
+
| 表示項目が多い(>30) | 目的別に分割(一覧/詳細/設定等) |
|
|
135
|
+
| 操作が多い(>10) | サブ画面または別仕様へ分割 |
|
|
136
|
+
| 遷移先が多い(>6) | 目的別に導線を分ける |
|
|
137
|
+
|
|
138
|
+
## 9. 禁止事項
|
|
139
|
+
|
|
140
|
+
| 項目 | 理由 |
|
|
141
|
+
| ------------------------------------- | ---------------------------------- |
|
|
142
|
+
| ワイヤーフレーム/座標/ピクセル指定 | 設計変更に弱く、要求定義段階で過剰 |
|
|
143
|
+
| 物理テーブル名・カラム名・SQL全文 | 概念レベル逸脱 |
|
|
144
|
+
| 実装クラス/関数名・UIコンポーネント名 | 実装依存で変更に弱い |
|
|
145
|
+
| クリック手順の逐語列挙 | 可読性低下・変更に弱い |
|
|
146
|
+
|
|
147
|
+
## 10. よくある誤りと対策
|
|
148
|
+
|
|
149
|
+
- 「どのDBを参照するか」を書く → 「どの概念データを表示するか」に置換
|
|
150
|
+
- クリック手順を長文で列挙 → 操作の前提条件と結果(遷移/更新)に要約
|
|
151
|
+
- 表示項目が列挙だけで目的が不明 → 「対象ユーザー/利用目的」を先に明確化
|
|
152
|
+
|
|
153
|
+
## 11. サンプル(簡易)
|
|
154
|
+
|
|
155
|
+
```markdown
|
|
156
|
+
---
|
|
157
|
+
id: uis-product-list
|
|
158
|
+
type: ui
|
|
159
|
+
title: 商品一覧
|
|
160
|
+
status: draft
|
|
161
|
+
part_of: []
|
|
162
|
+
based_on: []
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 概要
|
|
166
|
+
|
|
167
|
+
商品を検索し、詳細確認や登録に進むための一覧画面。
|
|
168
|
+
|
|
169
|
+
## 対象ユーザー/利用目的
|
|
170
|
+
|
|
171
|
+
- 対象ユーザー: 店員
|
|
172
|
+
- 利用目的: 商品を検索して販売登録に必要な情報を確認する
|
|
173
|
+
|
|
174
|
+
## 表示項目
|
|
175
|
+
|
|
176
|
+
| 項目名 | 種別 | 表示形式 | 編集可 | 必須 | 備考 |
|
|
177
|
+
| -------------- | ---- | -------- | ------ | ---- | --------------- |
|
|
178
|
+
| 商品名 | 一覧 | テキスト | - | - | - |
|
|
179
|
+
| 販売価格 | 一覧 | 金額 | - | - | - |
|
|
180
|
+
| 商品ステータス | 一覧 | ラベル | - | - | 販売中/販売停止 |
|
|
181
|
+
|
|
182
|
+
## 操作
|
|
183
|
+
|
|
184
|
+
| 操作名 | 対象 | 前提条件 | 結果(更新/遷移) |
|
|
185
|
+
| -------- | -------- | -------------- | ---------------------------- |
|
|
186
|
+
| 検索 | 検索条件 | なし | 条件に合致する商品一覧を表示 |
|
|
187
|
+
| 詳細表示 | 一覧行 | 対象が存在する | 商品詳細へ遷移 |
|
|
188
|
+
|
|
189
|
+
## 遷移
|
|
190
|
+
|
|
191
|
+
| 遷移名 | 遷移先 | 条件 | 引き渡し | 備考 |
|
|
192
|
+
| ------ | ------------------------------ | ------------ | -------- | ---- |
|
|
193
|
+
| 詳細へ | 商品詳細(uis-product-detail) | 一覧行を選択 | 商品ID | - |
|
|
194
|
+
|
|
195
|
+
## バリデーション
|
|
196
|
+
|
|
197
|
+
- 検索条件(商品名): 100文字以内
|
|
198
|
+
|
|
199
|
+
## エラー表示
|
|
200
|
+
|
|
201
|
+
- 検索結果0件: 「該当する商品がありません」
|
|
202
|
+
- 権限不足: 「権限がありません」
|
|
203
|
+
|
|
204
|
+
## メモ / 将来課題
|
|
205
|
+
|
|
206
|
+
将来: タグ検索を追加
|
|
207
|
+
```
|
|
@@ -0,0 +1,387 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:utc-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:utc-index-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 単体テストカタログ概要 作成ルール
|
|
12
|
+
|
|
13
|
+
Unit Test Catalog (UTC) Index Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、単体テストカタログ(UTC)の全体概要 `utc-index` を統一形式で記述するためのルールです。
|
|
16
|
+
TSPに基づき、単体テストに共通するルールや方針を定義します。
|
|
17
|
+
|
|
18
|
+
個別単体テストカタログ(`utc-<term>`)の記述ルールは [utc-rulebook.md](utc-rulebook.md) を参照してください。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
`utc-index` は、単体テストカタログ(UTC)を **運用可能な最小情報**で統一し、
|
|
23
|
+
対象別カタログ(`utc-<term>`)の品質と一貫性を担保するための **共通ルール(SSOT)** とする。
|
|
24
|
+
|
|
25
|
+
- `utc-index` は **「考え方・共通方針・共通定義」** を記述する(個別ケースは持たない)
|
|
26
|
+
- 個別の観点・条件・ケースは **`utc-<term>` に集約**し、詳細は **テストコード/CI証跡** に寄せる
|
|
27
|
+
- 記述は **レビュー可能**であることを優先し、長文化を避ける(方針は箇条書き中心)
|
|
28
|
+
- 「例外」や「対象外」を明示し、単体テストの責任境界(何をやらないか)を固定する
|
|
29
|
+
- `tsp-index` の方針を根拠として、単体テストに共通する **分割基準・観点/条件の立て方・依存境界・合格基準・証跡** を定義する
|
|
30
|
+
|
|
31
|
+
## 2. 位置づけ(他ドキュメントとの関係)
|
|
32
|
+
|
|
33
|
+
`utc-index` と他ドキュメントの関係を示します。
|
|
34
|
+
|
|
35
|
+
```mermaid
|
|
36
|
+
flowchart BT
|
|
37
|
+
TSP["tsp-index<br>テスト戦略・方針"]
|
|
38
|
+
|
|
39
|
+
subgraph TC["テストカタログ"]
|
|
40
|
+
direction RL
|
|
41
|
+
TCIndex["utc-index<br>テスト仕様-全体構成"]
|
|
42
|
+
TCDetail["utc-<term><br>テスト仕様-対象別"]
|
|
43
|
+
TCDetail -->|based_on| TCIndex
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
Code["テストコード<br>JUnit 等"]
|
|
47
|
+
|
|
48
|
+
TC -->|based_on| TSP
|
|
49
|
+
Code -->|based_on| TC
|
|
50
|
+
|
|
51
|
+
classDef target stroke-width:4px
|
|
52
|
+
class TCIndex target
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## 3. ファイル命名・ID規則
|
|
56
|
+
|
|
57
|
+
- 本ルールの対象ドキュメントの`id` は `utc-index` 固定。対象別は `utc-<term>`(詳細は [utc-rulebook.md](utc-rulebook.md))。
|
|
58
|
+
- ファイル名は `utc-010-単体テストカタログ-概要.md` 等、プロジェクト内で一意になるように命名します。
|
|
59
|
+
- `<term>` は用語集の論理名キー(英小文字kebab-case) を用いる(表示名は title に日本語で記載してよい)。
|
|
60
|
+
|
|
61
|
+
## 4. 推奨 Frontmatter 項目
|
|
62
|
+
|
|
63
|
+
### 4.1. 設定内容
|
|
64
|
+
|
|
65
|
+
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))。
|
|
66
|
+
|
|
67
|
+
| 項目 | 説明 | 必須 |
|
|
68
|
+
| ---------- | -------------------------------------------------- | ---- |
|
|
69
|
+
| id | `utc-index`(固定) | ○ |
|
|
70
|
+
| type | `test` 固定 | ○ |
|
|
71
|
+
| title | 単体テストカタログ: 概要(`<システム名>`) | ○ |
|
|
72
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
73
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
74
|
+
| supersedes | 置き換え関係(ID配列。未指定時は `[]` を許容) | 任意 |
|
|
75
|
+
|
|
76
|
+
### 4.2. 推奨ルール
|
|
77
|
+
|
|
78
|
+
- `based_on` には最低限`tsp-index`を含めます。
|
|
79
|
+
- BAC/NFR/BR 等は、`utc-index` の方針判断(境界・分配・共通合格基準)に **直接利用したものだけ**を`based_on`に列挙します。
|
|
80
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
81
|
+
|
|
82
|
+
## 5. 本文構成(標準テンプレ)
|
|
83
|
+
|
|
84
|
+
`utc-index` は以下の見出し構成を **順序固定**で配置します。
|
|
85
|
+
|
|
86
|
+
| 番号 | 見出し | 必須 |
|
|
87
|
+
| ---- | ----------------------------------------------- | ---- |
|
|
88
|
+
| 1 | 本ドキュメントの目的と適用対象 | ○ |
|
|
89
|
+
| 2 | テスト対象の括り方と分割基準 | ○ |
|
|
90
|
+
| 3 | 対象外・除外理由(共通) | ○ |
|
|
91
|
+
| 4 | 観点の立て方(共通) | ○ |
|
|
92
|
+
| 5 | 条件の立て方(共通) | ○ |
|
|
93
|
+
| 6 | 観点/条件の採用基準と対象別への分配方針(共通) | ○ |
|
|
94
|
+
| 7 | 単体テスト共通の境界/依存の扱い | ○ |
|
|
95
|
+
| 8 | ケース表の共通カラム | ○ |
|
|
96
|
+
| 9 | メモ / 将来課題 | 任意 |
|
|
97
|
+
|
|
98
|
+
注意:次章の記述ガイドのMarkdown見出しはルール文章内の参照用であり、
|
|
99
|
+
生成する `utc-index` 本文の見出しは各章で指定された **番号付き** の形式
|
|
100
|
+
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
101
|
+
|
|
102
|
+
## 6. 記述ガイド
|
|
103
|
+
|
|
104
|
+
### 6.1. 本ドキュメントの目的と適用対象
|
|
105
|
+
|
|
106
|
+
生成する `utc-index` 本文の見出しは **## 1. 本ドキュメントの目的と適用対象**
|
|
107
|
+
|
|
108
|
+
本節では、`utc-index` が **何のために存在し、何に適用されるか** を明確にします。
|
|
109
|
+
|
|
110
|
+
- 目的:`utc-<term>` を同一基準で作成し、品質・粒度・責任範囲を揃える
|
|
111
|
+
- 適用対象:単体テスト(UT)に関するカタログ群(`utc-index` / `utc-<term>`)
|
|
112
|
+
- 非適用:内部結合以降(IT/ET/ST/AT)のルールはそれぞれの `*c-index` で扱う
|
|
113
|
+
- 成果物の位置づけ:
|
|
114
|
+
- `utc-index`:共通方針(SSOT)
|
|
115
|
+
- `utc-<term>`:対象別の観点・条件・ケース表(SSOT)
|
|
116
|
+
- テストコード/CI:実装と実行証跡(SSOT)
|
|
117
|
+
- SSOTの一次情報は `utc-index` / `utc-<term>` とし、テストコード/CIは **実装と実行結果の証跡(Evidence)** として扱う。
|
|
118
|
+
- 本書が扱う粒度:**判断基準・共通ルールまで**(個別ケースの列挙は禁止)
|
|
119
|
+
|
|
120
|
+
### 6.2. テスト対象の括り方と分割基準
|
|
121
|
+
|
|
122
|
+
生成する `utc-index` 本文の見出しは **## 2. テスト対象の括り方と分割基準**
|
|
123
|
+
|
|
124
|
+
本節では、`utc-<term>` の `<term>` をどう切るか(対象単位の設計)を定義します。
|
|
125
|
+
|
|
126
|
+
- `<term>` は「責務のまとまり」(例:ドメインサービス/ユースケース/主要関数群)とする
|
|
127
|
+
- 分割基準(推奨順):
|
|
128
|
+
1. **責務境界**:何をする単位かが説明できる
|
|
129
|
+
2. **変更影響**:同時に変更されやすいものが同じ単位に収まる
|
|
130
|
+
3. **依存境界**:外部I/F・DB・時刻などの依存の扱いが同質
|
|
131
|
+
4. **担当境界**:所有者(チーム/モジュール)が概ね一致する
|
|
132
|
+
- 過分割の禁止:`utc-<term>` が「1〜2ケースしかない」単位は原則統合する
|
|
133
|
+
- 肥大化の抑制(分割の目安):
|
|
134
|
+
- 観点が過剰(例:15以上)/表の行数が過剰(例:50以上)になったら分割候補
|
|
135
|
+
- 依存境界が混在(同じterm内で Mock方針が割れる)する場合は分割候補
|
|
136
|
+
- 画面テストの注意:UTの `<term>` は **UI部品よりもロジック中心**で切る(画面はE2E側で扱う)
|
|
137
|
+
|
|
138
|
+
### 6.3. 対象外・除外理由(共通)
|
|
139
|
+
|
|
140
|
+
生成する `utc-index` 本文の見出しは **## 3. 対象外・除外理由(共通)**
|
|
141
|
+
|
|
142
|
+
本節では、単体テスト(UT)で **やらないこと** と、その **理由**、および **例外条件** を明確にします。
|
|
143
|
+
「UTでやるべきこと」を書くよりも、「UTでやらないこと」を固定する方が、責任境界がぶれにくくなります。
|
|
144
|
+
|
|
145
|
+
#### 6.3.1. 記述ルール
|
|
146
|
+
|
|
147
|
+
- 形式は **「対象外(何をやらないか)」「除外理由(なぜやらないか)」「例外(UTで扱う条件)」** の3点セットを基本とする
|
|
148
|
+
- 「対象外」は **テストレベルの責務分界**(UT/IT/E2E)に紐づけて書く
|
|
149
|
+
- 「例外」は乱用しない。例外を認める場合は **判断基準**(いつ/どの条件で)を明記する
|
|
150
|
+
- 個別対象(`utc-<term>`)固有の対象外は、`utc-<term>` 側に書く。本節は **UT共通** に限定する
|
|
151
|
+
|
|
152
|
+
#### 6.3.2. 推奨フォーマット(表)
|
|
153
|
+
|
|
154
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
155
|
+
| ---------------------- | -------- | ------------------- | -------------------- |
|
|
156
|
+
|
|
157
|
+
- 「代替レベル/代替手段」は、IT/E2E/NFRなど **どこで担保するか** を必ず記載する
|
|
158
|
+
- 例外がない場合は `なし` とする
|
|
159
|
+
|
|
160
|
+
#### 6.3.3. 典型例(記載候補)
|
|
161
|
+
|
|
162
|
+
- UI操作のエンドツーエンド検証(画面遷移やDOM操作の再現)
|
|
163
|
+
- 実DBへの接続・実I/O(スキーマやSQLの妥当性そのもの)
|
|
164
|
+
- 外部サービス疎通(ネットワーク・認証を含む実通信)
|
|
165
|
+
- 並行性・性能・負荷(スループット、p95等)
|
|
166
|
+
- ブラウザ互換・端末差分(表示崩れ、入力方式差)
|
|
167
|
+
|
|
168
|
+
### 6.4. 観点の立て方(共通)
|
|
169
|
+
|
|
170
|
+
生成する `utc-index` 本文の見出しは **## 4. 観点の立て方(共通)**
|
|
171
|
+
|
|
172
|
+
観点(Perspective)は「何を保証するか」の切り口であり、対象別カタログの章立て(見出し)として用います。
|
|
173
|
+
|
|
174
|
+
- 観点の型(最低限この順で検討):
|
|
175
|
+
- 機能/業務ルールの正しさ(正常系)
|
|
176
|
+
- 例外/エラー処理(不正入力、権限、存在しない、期限切れ、競合)
|
|
177
|
+
- 状態遷移(前→後:作成→確定→取消 等)
|
|
178
|
+
- 契約/インタフェース(戻り値、例外、エラーコード、イベント発行 等)
|
|
179
|
+
- 非機能(UTで扱う範囲のみ:計算量、入力上限、決定性 など)
|
|
180
|
+
- 命名規則:**「名詞+品質/振る舞い」**(例:`入力検証` / `認可エラー処理` / `状態遷移の整合性`)
|
|
181
|
+
- 粒度規則:
|
|
182
|
+
- 観点は「条件を複数持てる」程度にまとめる(細分化し過ぎない)
|
|
183
|
+
- 観点が抽象的で条件が作れない場合は観点を再定義する
|
|
184
|
+
- 重複禁止:
|
|
185
|
+
- 同一対象内で、同義の観点名を乱立させない(統合・改名する)
|
|
186
|
+
|
|
187
|
+
### 6.5. 条件の立て方(共通)
|
|
188
|
+
|
|
189
|
+
生成する `utc-index` 本文の見出しは **## 5. 条件の立て方(共通)**
|
|
190
|
+
|
|
191
|
+
条件(Condition)は、観点を確認するための前提状態・入力状態・環境条件のバリエーションです。
|
|
192
|
+
条件は「入力」「状態」「環境」に分解して作成します。
|
|
193
|
+
|
|
194
|
+
- 入力(Input):代表値/境界値/異常値(空、最大、形式不正、桁あふれ 等)
|
|
195
|
+
- 状態(State):事前データ、権限、ステータス、ライフサイクル段階(有効/無効、未確定/確定 等)
|
|
196
|
+
- 環境(Env):時刻、タイムゾーン、外部I/F失敗、ネットワーク、設定値(feature flag 等)
|
|
197
|
+
|
|
198
|
+
組合せルール(増やし過ぎ防止):
|
|
199
|
+
|
|
200
|
+
- まず代表ケース(正常系)を作る
|
|
201
|
+
- 次に境界値(上限/下限/空/ゼロなど)を追加する
|
|
202
|
+
- 最後に重大例外(セキュリティ/整合性/データ破壊につながるもの)を追加する
|
|
203
|
+
- 原則として全組合せ(直積)は作らない。必要な場合は理由を明記し、データセット参照等で管理する
|
|
204
|
+
|
|
205
|
+
### 6.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
206
|
+
|
|
207
|
+
生成する `utc-index` 本文の見出しは **## 6. 観点/条件の採用基準と対象別への分配方針(共通)**
|
|
208
|
+
|
|
209
|
+
本節では、観点/条件を「採用する判断」と「`utc-<term>` へ割り当てる判断」を共通ルールとして定義します。
|
|
210
|
+
|
|
211
|
+
#### 6.6.1. 採用基準(共通)
|
|
212
|
+
|
|
213
|
+
- 観点は「1観点=1合否命題」で採用する(複数命題の混在を禁止)
|
|
214
|
+
- 条件は「1条件=1差分(入力/状態/環境)」で採用する
|
|
215
|
+
- 追加時は、次のいずれかに該当する根拠を明示する
|
|
216
|
+
- 失敗時の業務影響が大きい(誤課金/欠品/誤更新など)
|
|
217
|
+
- 境界/例外/状態遷移の欠落が不具合につながりやすい
|
|
218
|
+
- 上位仕様(BAC/NFR/BR等)に明示的な要求がある
|
|
219
|
+
- 「重要そうだから」など根拠不明の採用はしない
|
|
220
|
+
|
|
221
|
+
#### 6.6.2. 対象別への分配方針(共通)
|
|
222
|
+
|
|
223
|
+
- 観点/条件は、責務を持つ `utc-<term>` に **主担当1つ** を割り当てる(重複割当は例外扱い)
|
|
224
|
+
- 複数 `utc-<term>` に跨る場合は、主担当 + 従担当(参照)で表現し、重複記載を避ける
|
|
225
|
+
- 分配判断は「責務境界」「依存境界」「変更影響」の順で決める
|
|
226
|
+
- 分配結果は `utc-<term>` 側のケース表とトレース列で追跡可能にする
|
|
227
|
+
|
|
228
|
+
推奨フォーマット(例):
|
|
229
|
+
|
|
230
|
+
| 観点/条件 | 採用理由 | 主担当 `utc-<term>` | 従担当(任意) | 備考 |
|
|
231
|
+
| --------- | -------- | ------------------- | -------------- | ---- |
|
|
232
|
+
|
|
233
|
+
### 6.7. 単体テスト共通の境界/依存の扱い
|
|
234
|
+
|
|
235
|
+
生成する `utc-index` 本文の見出しは **## 7. 単体テスト共通の境界/依存の扱い**
|
|
236
|
+
|
|
237
|
+
単体テストでは、対象の責務を明確にし、依存は原則として制御可能にします。
|
|
238
|
+
依存の扱いは `utc-<term>` 間でぶれないよう、本節で共通方針を定めます。
|
|
239
|
+
|
|
240
|
+
- DB:
|
|
241
|
+
- 原則:実DBに依存しない(In-memory / Fake / Repository mock 等)
|
|
242
|
+
- 例外:スキーマ/SQLそのものが責務の場合のみ、別レベル(IT)へ寄せる
|
|
243
|
+
- 外部API/外部サービス:
|
|
244
|
+
- 原則:Mock/Stubで制御(成功・失敗・タイムアウトを再現可能に)
|
|
245
|
+
- 時刻:
|
|
246
|
+
- 原則:固定クロック(Clock注入等)。現在時刻直参照は禁止
|
|
247
|
+
- 乱数/UUID:
|
|
248
|
+
- 原則:固定シード、または生成器を注入
|
|
249
|
+
- ファイル/ストレージ:
|
|
250
|
+
- 原則:Fake(テンポラリ/メモリ)またはインタフェース差替
|
|
251
|
+
- 非同期/並行性:
|
|
252
|
+
- 原則:決定性が担保できる形(同期化、制御可能なスケジューラ等)
|
|
253
|
+
- 例外方針(Mock/Stub/Fakeの使い分け):
|
|
254
|
+
- Fake:簡易実装で状態を持つ(インメモリDB等)
|
|
255
|
+
- Stub:戻り値固定で分岐を作る
|
|
256
|
+
- Mock:呼び出し回数・引数など「相互作用」を検証する場合に使用
|
|
257
|
+
|
|
258
|
+
### 6.8. ケース表の共通カラム
|
|
259
|
+
|
|
260
|
+
生成する `utc-index` 本文の見出しは **## 8. ケース表の共通カラム**
|
|
261
|
+
|
|
262
|
+
`utc-<term>` の末端(条件・ケース表)は、検索性・比較性・自動化移行の容易さを確保するため、
|
|
263
|
+
全termで同一カラム順を採用します。
|
|
264
|
+
|
|
265
|
+
必須カラム:
|
|
266
|
+
|
|
267
|
+
- `case_id`(ケースID):対象別に一意なIDで変更しない
|
|
268
|
+
- `case_id` は `<level>-<term>-<perspective_key>-<nnn>`(nnnは3桁推奨)を推奨
|
|
269
|
+
- 例: `ut-auth-input-validation-010`
|
|
270
|
+
- `perspective_key` は kebab-case のキー文字列(英小文字+数字+ハイフン)で、原則変更しない
|
|
271
|
+
- `nnn` を 10刻みで付番(010, 020, 030…)
|
|
272
|
+
|
|
273
|
+
- `条件`:入力/状態/環境の要点(`入力:` `状態:` `環境:` の形を推奨)
|
|
274
|
+
- `手順(最小)`:抽象化した最小手順(クリック列挙禁止)
|
|
275
|
+
- `期待値`:判定可能な合格条件(観測点を含める)
|
|
276
|
+
|
|
277
|
+
推奨カラム(運用必須):
|
|
278
|
+
|
|
279
|
+
- `観測点(アサーション)`:戻り値/例外/状態/呼び出し相互作用など
|
|
280
|
+
- `境界/依存`:Mock/Stub/Fake、固定クロック等
|
|
281
|
+
- `トレース`:req/spec/ac/issue 等のID
|
|
282
|
+
- `優先度`:P0/P1/P2(省力時の判断軸)
|
|
283
|
+
- `自動化`:manual/automated/mixed
|
|
284
|
+
- `証跡`:テストコード/CI/レポート等の参照先
|
|
285
|
+
|
|
286
|
+
注意:
|
|
287
|
+
|
|
288
|
+
- 表の1行=1テスト(条件×期待値が一意)
|
|
289
|
+
- 手順・期待値を冗長に書かず、詳細はテストコードへ寄せる
|
|
290
|
+
|
|
291
|
+
### 6.9. メモ / 将来課題
|
|
292
|
+
|
|
293
|
+
生成する `utc-index` 本文の見出しは **## 9. メモ / 将来課題**
|
|
294
|
+
|
|
295
|
+
本節は、現時点で決めきれない事項や将来の改善点を記録します。
|
|
296
|
+
ただし、運用ルールとして必須な内容は本節に置かず、本文(1〜8章)へ反映します。
|
|
297
|
+
|
|
298
|
+
- 将来検討(例):
|
|
299
|
+
- 組合せ削減の方法(ペアワイズ導入)
|
|
300
|
+
- 証跡リンク形式の統一(CI URL、レポート保存場所)
|
|
301
|
+
- 自動化率の目標と移行基準
|
|
302
|
+
- カタログのlint(case_id重複、必須列欠落など)
|
|
303
|
+
|
|
304
|
+
## 7. 禁止事項
|
|
305
|
+
|
|
306
|
+
| 項目 | 理由 |
|
|
307
|
+
| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
308
|
+
| `utc-index` に個別ケース(条件・手順・期待値)を大量に列挙する | `utc-index` は共通方針のSSOTであり、個別は `utc-<term>` に集約するため |
|
|
309
|
+
| 依存の扱い(Mock/Stub/Fake、時刻等)を対象ごとに無根拠に変更する | UT全体で一貫性が崩れ、テストが不安定・レビュー困難になるため(例外は根拠とともに明記) |
|
|
310
|
+
| 手順にUI操作のクリック列挙を書く(末端表でも過剰な操作手順を書く) | 保守性が低く、変更に弱く、テストの意図が見えなくなるため |
|
|
311
|
+
| 期待値を「エラーにならないこと」など曖昧に書く | 判定不能で合否が揺れ、証跡として機能しないため |
|
|
312
|
+
| `case_id` を後から変更する(参照があるのに変更する) | トレース・証跡リンクが壊れ、履歴追跡が不能になるため |
|
|
313
|
+
| 対象外・除外理由(共通) と矛盾するケースを `utc-<term>` に記載する | 責任境界が崩れるため(例外は根拠と条件を明記) |
|
|
314
|
+
|
|
315
|
+
## 8. サンプル(最小)
|
|
316
|
+
|
|
317
|
+
注:以下はルール文書内の例示です。生成する `utc-index` では `## 1...` から始まります。
|
|
318
|
+
|
|
319
|
+
```yaml
|
|
320
|
+
---
|
|
321
|
+
id: utc-index
|
|
322
|
+
type: test
|
|
323
|
+
title: 単体テストカタログ: 概要
|
|
324
|
+
status: draft
|
|
325
|
+
based_on: [tsp-index]
|
|
326
|
+
supersedes: []
|
|
327
|
+
---
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### 8.1. 本ドキュメントの目的と適用対象
|
|
331
|
+
|
|
332
|
+
本ドキュメントは、単体テストカタログ(UTC)の全体概要 `utc-index` を統一形式で記述するためのルールである。
|
|
333
|
+
`utc-index` は単体テストに共通する「対象単位の切り方」「観点/条件の立て方」「依存境界」「合格基準」「証跡方針」を定義し、
|
|
334
|
+
対象別カタログ `utc-<term>` の作成と運用の基盤とする。
|
|
335
|
+
|
|
336
|
+
### 8.2. テスト対象の括り方と分割基準
|
|
337
|
+
|
|
338
|
+
`utc-<term>` の `<term>` は責務のまとまり(例:サービス/ユースケース/主要関数群)とする。
|
|
339
|
+
分割は責務境界・変更影響・依存境界・担当境界を基準とし、過分割と肥大化の双方を避ける。
|
|
340
|
+
観点が過剰、または依存境界が混在する場合は分割候補とする。
|
|
341
|
+
|
|
342
|
+
### 8.3. 対象外・除外理由(共通)
|
|
343
|
+
|
|
344
|
+
単体テスト(UT)では、対象の責務を「小さく・決定的に」検証するため、以下は原則として対象外とする。
|
|
345
|
+
|
|
346
|
+
| 対象外(やらないこと) | 除外理由 | 代替レベル/代替手段 | 例外(UTで扱う条件) |
|
|
347
|
+
| ----------------------------------------------------- | ---------------------------------------------- | ------------------------ | --------------------------------------------------------------- |
|
|
348
|
+
| UIの操作手順や画面遷移の検証(クリック列挙、DOM検証) | UTの責務(ロジック検証)を逸脱し、保守性が低い | E2E(e2eカタログ) | UIロジックが純関数化され、DOMに依存しない場合のみ |
|
|
349
|
+
| 実DB接続・実I/Oによる検証(スキーマ/SQLの正当性) | 環境依存・不安定になりやすい | IT(itcカタログ) | SQLそのものがプロダクト責務で、Fakeでは妥当性が評価できない場合 |
|
|
350
|
+
| 外部サービス疎通(実通信、実認証、ネットワーク障害) | 外部要因で結果が揺れ、再現性が低い | IT/ET(itc/etcカタログ) | 外部SDKのアダプタ層の「入力→出力変換」など純粋な変換責務のみ |
|
|
351
|
+
| 性能・負荷・耐久(p95、スループット、長時間稼働) | UTのスコープ外で測定条件の設計が別物 | NFR(nfrカタログ) | なし |
|
|
352
|
+
| ブラウザ/端末差分(表示崩れ、入力方式差) | 実行環境差が本質でUTでは再現困難 | E2E(e2eカタログ) | なし |
|
|
353
|
+
|
|
354
|
+
例外を適用する場合は、`utc-<term>` 側に「例外の根拠(なぜUTで必要か)」と「依存の制御方法」を明記する。
|
|
355
|
+
|
|
356
|
+
### 8.4. 観点の立て方(共通)
|
|
357
|
+
|
|
358
|
+
観点は「何を保証するか」の切り口であり、機能の正しさ・例外処理・状態遷移・契約/インタフェースを基軸に立てる。
|
|
359
|
+
観点名は「名詞+品質/振る舞い」で統一し、条件を複数持てる程度の粒度にまとめる。
|
|
360
|
+
|
|
361
|
+
### 8.5. 条件の立て方(共通)
|
|
362
|
+
|
|
363
|
+
条件は入力・状態・環境に分解し、代表→境界→重大例外の順で追加する。
|
|
364
|
+
全組合せ(直積)は原則作らず、必要時のみ理由と管理方法(データセット参照等)を明記する。
|
|
365
|
+
|
|
366
|
+
### 8.6. 観点/条件の採用基準と対象別への分配方針(共通)
|
|
367
|
+
|
|
368
|
+
観点/条件は、業務影響・境界/例外/状態遷移の重要性・上位仕様根拠を基準に採用する。
|
|
369
|
+
分配は責務境界・依存境界・変更影響を基準に主担当 `utc-<term>` を1つ定め、重複は例外として扱う。
|
|
370
|
+
分配結果は `utc-<term>` のケース表とトレース列で追跡可能にする。
|
|
371
|
+
|
|
372
|
+
### 8.7. 単体テスト共通の境界/依存の扱い
|
|
373
|
+
|
|
374
|
+
単体テストでは依存を制御可能にし、テストの決定性を担保する。
|
|
375
|
+
DBは原則Fake/Mock等で実DB依存を避け、外部APIはMock/Stubで成功・失敗・タイムアウトを再現可能にする。
|
|
376
|
+
時刻・乱数・UUIDは注入または固定化し、直参照を禁止する。
|
|
377
|
+
|
|
378
|
+
### 8.8. ケース表の共通カラム
|
|
379
|
+
|
|
380
|
+
対象別カタログ `utc-<term>` の末端表は、全termで共通のカラム順を採用する。
|
|
381
|
+
必須:case_id / 条件 / 手順(最小) / 期待値
|
|
382
|
+
推奨:観測点(アサーション)/ 境界・依存 / トレース / 優先度 / 自動化 / 証跡
|
|
383
|
+
|
|
384
|
+
### 8.9. メモ / 将来課題
|
|
385
|
+
|
|
386
|
+
将来検討事項(例):組合せ削減の手法(ペアワイズ)、証跡リンク形式の統一、カタログlint(case_id重複検出)等を記録する。
|
|
387
|
+
運用ルールとして必須になった時点で本文へ昇格させる。
|