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,307 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:itc-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:itc-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 内部結合テストカタログ 対象別 作成ルール
|
|
12
|
+
|
|
13
|
+
Internal Integration Test Catalog (ITC) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、内部結合テストカタログ(ITC)の対象別 `itc-<term>` を統一形式で記述するためのルールです。
|
|
16
|
+
`itc-index` を前提に、SSOTの本体として、対象ごとの **内部結合テストの責務・境界・依存、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
個別 ITC(`itc-<term>`)は、内部結合テストにおける SSOT の本体として、対象ごとの責務と結合境界を明確化し、
|
|
21
|
+
観点×条件=ケース(末端表)を最小情報で整理して、テストコード/CI証跡へ確実に接続できる形で記述する。
|
|
22
|
+
|
|
23
|
+
- `itc-<term>` は **対象固有の情報のみ**を記述し、共通ルールは `itc-index` を参照する(重複記述しない)
|
|
24
|
+
- 内部結合テストの目的は「**複数コンポーネントの結合としての振る舞い**を決定的に検証すること」であり、外部要因(外部サービス実疎通/実ユーザUI)は原則排除する(例外は根拠を明記)
|
|
25
|
+
- ITでは、UTでMockしていた境界の一部(例:Repository実装、SQL/制約、トランザクション)を **実装に近い形で検証**する(ただし再現性が崩れる要因は制御する)
|
|
26
|
+
- ケースは「表の1行=1テスト」とし、手順と期待値は **判定可能**な粒度で簡潔に書く
|
|
27
|
+
- 詳細な操作列挙やデータ大量列挙は避け、必要な詳細はテストコード側へ寄せる(証跡で参照可能にする)
|
|
28
|
+
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(テストコード/CI)に接続されていること
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけ(他ドキュメントとの関係)
|
|
31
|
+
|
|
32
|
+
個別 ITC(`itc-<term>`)と他ドキュメントの関係を示します。
|
|
33
|
+
|
|
34
|
+
```mermaid
|
|
35
|
+
flowchart BT
|
|
36
|
+
TSP["tsp-index<br>テスト戦略・方針"]
|
|
37
|
+
|
|
38
|
+
subgraph TC["テストカタログ"]
|
|
39
|
+
direction RL
|
|
40
|
+
TCIndex["itc-index<br>テスト仕様-全体構成"]
|
|
41
|
+
TCDetail["itc-<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
|
+
|
|
55
|
+
## 3. ファイル命名・ID規則
|
|
56
|
+
|
|
57
|
+
- `id` は `itc-<term>`(kebab-case。例: `itc-order`)。
|
|
58
|
+
- ファイル名は `itc-010-内部結合テストカタログ-<term>.md` 等(例: `itc-010-内部結合テストカタログ-受注.md`)。
|
|
59
|
+
- `<term>` は 用語集(GL) の 論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
|
|
60
|
+
|
|
61
|
+
## 4. 推奨 Frontmatter 項目
|
|
62
|
+
|
|
63
|
+
### 4.1. 設定内容
|
|
64
|
+
|
|
65
|
+
Frontmatter は共通スキーマに従います(あわせてドキュメントのメタ情報の記述ルールも参照)。
|
|
66
|
+
|
|
67
|
+
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
68
|
+
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
69
|
+
|
|
70
|
+
| 項目 | 説明 | 必須 |
|
|
71
|
+
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
72
|
+
| id | ITC ID(個別: `itc-<term>`) | ○ |
|
|
73
|
+
| type | `test` 固定 | ○ |
|
|
74
|
+
| title | 内部結合テストカタログ: <対象名> | ○ |
|
|
75
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
76
|
+
| based_on | 根拠仕様(最低限: `tsp-index`, `itc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
77
|
+
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
78
|
+
| supersedes | 置き換え関係 | 任意 |
|
|
79
|
+
|
|
80
|
+
### 4.2. 推奨ルール
|
|
81
|
+
|
|
82
|
+
- `based_on` には **本対象の内部結合テスト観点の根拠となる仕様** を列挙します。
|
|
83
|
+
- `based_on` は原則 `[tsp-index, itc-index]` を最低限とし、
|
|
84
|
+
対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` 等)は本文「トレース」に集約する。
|
|
85
|
+
機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
86
|
+
- 記述内容が多くなる場合は、ドキュメントを分割し、`part_of` で集約ドキュメントに所属させます。
|
|
87
|
+
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
88
|
+
|
|
89
|
+
## 5. 本文構成(標準テンプレ)
|
|
90
|
+
|
|
91
|
+
個別 ITC(`itc-<term>`)は以下の見出し構成を **順序固定** で配置します。
|
|
92
|
+
|
|
93
|
+
| 番号 | 見出し | 必須 |
|
|
94
|
+
| ---- | ---------------------- | ---- |
|
|
95
|
+
| 1 | 概要(`<term>`) | ○ |
|
|
96
|
+
| 2 | 責務(結合として保証) | ○ |
|
|
97
|
+
| 3 | 対象外 | ○ |
|
|
98
|
+
| 4 | 結合境界/依存/環境前提 | ○ |
|
|
99
|
+
| 5 | トレース | ○ |
|
|
100
|
+
| 6 | テスト観点とケース | ○ |
|
|
101
|
+
|
|
102
|
+
注意:次章の記述ガイドのMarkdown見出しはルール文章内の参照用であり、
|
|
103
|
+
生成する `utc-<term>` 本文の見出しは各章で指定された **番号付き** の形式
|
|
104
|
+
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
105
|
+
|
|
106
|
+
## 6. 記述ガイド
|
|
107
|
+
|
|
108
|
+
### 6.1. 概要(`<term>`)
|
|
109
|
+
|
|
110
|
+
生成する `itc-<term>` 本文の見出しは **## 1. 概要(<term>)**
|
|
111
|
+
|
|
112
|
+
本節では、対象(`<term>`)が何であり、どの結合単位を本カタログで扱うかを簡潔に示します。
|
|
113
|
+
|
|
114
|
+
- `<term>` の説明(1〜3行):結合のまとまり(ユースケース×主要I/F、サブシステム境界 等)を人が理解できる形で記述する
|
|
115
|
+
- 期待する利用者:レビューア/実装者/テスト実装者が、対象の前提(構成・依存)を把握できる内容にする
|
|
116
|
+
- 対象の粒度:`itc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
117
|
+
- 結合対象(最低限):結合する主要コンポーネント(例:App層、DB層、Queue、Cache 等)を列挙してよい
|
|
118
|
+
- 詳細な仕様の説明や長い背景は書かない(根拠はトレースで示す)
|
|
119
|
+
|
|
120
|
+
### 6.2. 責務(結合として保証)
|
|
121
|
+
|
|
122
|
+
生成する `itc-<term>` 本文の見出しは **## 2. 責務(結合として保証)**
|
|
123
|
+
|
|
124
|
+
本節では、「この結合対象が何を保証すべきか(内部結合テストで確認する責務)」を列挙します。
|
|
125
|
+
|
|
126
|
+
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる**形で記述する
|
|
127
|
+
- 例:API入力を永続化モデルへ正しく変換する/制約違反時に規定エラーへ変換する/同一要求の冪等性を保証する
|
|
128
|
+
|
|
129
|
+
- 責務は「テスト観点」の上位概念であり、観点は責務を分解した切り口である(責務≠観点)
|
|
130
|
+
- 例外・異常系の責務も含める(制約違反、重複、整合性破壊、部分失敗、競合 等)
|
|
131
|
+
- 可能なら観測可能な成果(DB状態、レスポンス、イベント、ログ、トランザクション結果)とセットで書く
|
|
132
|
+
- 責務に含まれないものは「対象外」へ移す(曖昧さを残さない)
|
|
133
|
+
|
|
134
|
+
### 6.3. 対象外
|
|
135
|
+
|
|
136
|
+
生成する `itc-<term>` 本文の見出しは **## 3. 対象外**
|
|
137
|
+
|
|
138
|
+
本節では、「この対象カタログ(`itc-<term>`)ではやらないこと」を明示します。
|
|
139
|
+
`itc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
140
|
+
|
|
141
|
+
- 対象外は「なぜ除外するか(理由)」と「代替レベル/代替手段」とセットで書く
|
|
142
|
+
- 対象固有の対象外(例:別サブシステムの責務、別termの責務)を明確にする
|
|
143
|
+
- 例外としてITで扱う場合は、条件・根拠・再現性担保(スタブ、固定設定等)を明記する
|
|
144
|
+
|
|
145
|
+
推奨フォーマット(簡易):
|
|
146
|
+
|
|
147
|
+
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
148
|
+
|
|
149
|
+
### 6.4. 結合境界/依存/環境前提
|
|
150
|
+
|
|
151
|
+
生成する `itc-<term>` 本文の見出しは **## 4. 結合境界/依存/環境前提**
|
|
152
|
+
|
|
153
|
+
本節では、内部結合テストにおける「結合境界(どこまでが対象か)」「依存(外部要因)」「環境前提(再現性条件)」を明確にします。
|
|
154
|
+
ITは環境差で揺れやすいため、ここを固定することが重要です。
|
|
155
|
+
|
|
156
|
+
- 結合境界:入口/出口(API、ユースケースI/F、メッセージI/F等)を明記する
|
|
157
|
+
- 結合対象:結合するコンポーネント(例:Service+Repository+DB、Producer+Broker+Consumer 等)を列挙する
|
|
158
|
+
- 依存はカテゴリごとに列挙し、「扱い(実/スタブ/モック/固定化)」を決める
|
|
159
|
+
- DB:原則 実DB相当(コンテナDB等)。スキーマ/制約を観測可能にする
|
|
160
|
+
- 外部API:原則 Stub/Mockサーバ(成功/失敗/タイムアウトを再現)
|
|
161
|
+
- 時刻:固定クロック or 再現可能な基準時刻(TZ含む)
|
|
162
|
+
- 乱数/UUID:固定化(シード/注入)
|
|
163
|
+
- メッセージング:テスト用ブローカ or 同等の決定性構成(同期化/待機条件も明記)
|
|
164
|
+
- ファイル/ストレージ:テスト用領域、Fake、I/F差替(再現性条件を明記)
|
|
165
|
+
|
|
166
|
+
- 環境前提(推奨):DB初期化方法、seed、並列実行の分離(namespace等)、タイムアウト基準、ログ取得方針
|
|
167
|
+
- 「観測点(アサーション)」で何を検証するか(レスポンス/DB状態/イベント/相互作用)もここで整理してよい
|
|
168
|
+
|
|
169
|
+
### 6.5. トレース
|
|
170
|
+
|
|
171
|
+
生成する `itc-<term>` 本文の見出しは **## 5. トレース**
|
|
172
|
+
|
|
173
|
+
本節では、`itc-<term>` の根拠となる上位成果物との対応関係(トレーサビリティ)を示します。
|
|
174
|
+
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、観点・ケース表では **trace_key(`TR-xx`)参照**に統一します。
|
|
175
|
+
|
|
176
|
+
#### 6.5.1. 記述ルール(trace_key)
|
|
177
|
+
|
|
178
|
+
- 各トレース項目に **trace_key(`TR-xx`)** を付与する(2桁、01始まり推奨)
|
|
179
|
+
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
180
|
+
- 観点・ケース表の `トレース` 列には **仕様IDを直書きせず**、`TR-xx` を列挙する
|
|
181
|
+
- 新しい根拠が必要になった場合は、**先に本節の表へ行追加**し、付与された `trace_key` をケース表で参照する
|
|
182
|
+
- 追加順採番。並び替えても trace_key は維持する。また、削除しても欠番は詰めない
|
|
183
|
+
|
|
184
|
+
#### 6.5.2. トレース表(標準フォーマット)
|
|
185
|
+
|
|
186
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
187
|
+
| --------- | ------- | ------- | ---- |
|
|
188
|
+
| TR-01 | br-... | (1行) | 任意 |
|
|
189
|
+
| TR-02 | bac-... | (1行) | 任意 |
|
|
190
|
+
|
|
191
|
+
- `要点` は「ケース作成の判断に使ったポイント」を **1行**で書く(冗長な仕様説明はしない)
|
|
192
|
+
|
|
193
|
+
### 6.6. テスト観点とケース
|
|
194
|
+
|
|
195
|
+
生成する `itc-<term>` 本文の見出しは **## 6. テスト観点とケース**
|
|
196
|
+
|
|
197
|
+
本節は `itc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
198
|
+
|
|
199
|
+
#### 6.6.1. 観点:<観点>
|
|
200
|
+
|
|
201
|
+
生成する `itc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
202
|
+
|
|
203
|
+
- 観点は `itc-index` の「観点の立て方(共通)」に従って命名する
|
|
204
|
+
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(細かすぎる観点の乱立を避ける)
|
|
205
|
+
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない(変更が必要なら `supersedes` 等で追跡する)
|
|
206
|
+
|
|
207
|
+
##### 6.6.1.1. 意図
|
|
208
|
+
|
|
209
|
+
生成する `itc-<term>` 本文の見出しは **#### 6.1.1. 意図**
|
|
210
|
+
|
|
211
|
+
- 観点ごとに「意図(この観点で保証すること)」を 1〜2 行で書く
|
|
212
|
+
|
|
213
|
+
##### 6.6.1.2. 条件・ケース表
|
|
214
|
+
|
|
215
|
+
生成する `itc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
216
|
+
|
|
217
|
+
- ケース表の 1 行は「1テスト」を表す(条件×期待値が一意)
|
|
218
|
+
- 必須カラムは `itc-index` の定義に従う
|
|
219
|
+
- `case_id` は以下を推奨し、変更しない
|
|
220
|
+
- 形式:`<level>-<term>-<perspective_key>-<nnn>`
|
|
221
|
+
- `level`:`it`
|
|
222
|
+
- `perspective_key`:kebab-case のキー文字列(英小文字+数字+ハイフン)で、原則変更しない
|
|
223
|
+
- `nnn`:3桁、10刻み(010,020,030…)を推奨
|
|
224
|
+
|
|
225
|
+
- 条件は「入力/状態/環境」で表現する(`入力:` `状態:` `環境:` を推奨)
|
|
226
|
+
- 手順は最小化し、クリック列挙を禁止する(API呼び出し/ユースケース起動/ジョブ実行等の抽象手順で書く)
|
|
227
|
+
- 期待値は判定可能に書く(レスポンス、DB状態、イベント、ログ、トランザクション結果等の観測点を含める)
|
|
228
|
+
- 証跡はテストコードとCI実行結果へ接続できる形で書く(例:パス、CI run ID 等)
|
|
229
|
+
|
|
230
|
+
推奨:観点ごとのケース数は「代表→境界→重大例外」の順で増やし、直積(全組合せ)を原則避ける
|
|
231
|
+
|
|
232
|
+
## 7. 禁止事項
|
|
233
|
+
|
|
234
|
+
| 禁止事項 | 理由 |
|
|
235
|
+
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
236
|
+
| `itc-index` の共通方針を `itc-<term>` 側で勝手に上書きする(環境前提・依存の扱い・対象外等) | IT全体の一貫性が崩れ、CI不安定・レビュー/保守が困難になるため |
|
|
237
|
+
| ケース表にUIクリック手順を大量に列挙する | ITの責務逸脱になりやすく、意図が読めず変更に弱くなるため |
|
|
238
|
+
| 外部サービス実疎通を必須ケースとして恒久化する | 外部要因で結果が揺れ、再現性が低く、ETへ分離すべき責務のため |
|
|
239
|
+
| 期待値を曖昧に書く(例:「エラーにならないこと」「正常に動くこと」) | 合否判定ができず証跡にならないため |
|
|
240
|
+
| `case_id` を変更する/再利用する | トレース・証跡リンクが破壊され、履歴追跡が不能になるため |
|
|
241
|
+
| `perspective_key` を観点名の修正に合わせて頻繁に変える | ID体系が不安定になり参照が壊れるため |
|
|
242
|
+
| 直積(全組合せ)のケースを無条件に作る | ケース爆発で運用不能になるため(必要時は理由・範囲を明記) |
|
|
243
|
+
| トレースや証跡を持たないケースを恒久的に残す | SSOTとして成立しないため(例外は暫定として明記) |
|
|
244
|
+
|
|
245
|
+
## 8. サンプル(最小)
|
|
246
|
+
|
|
247
|
+
注:以下はルール文書内の例示です。生成する `itc-<term>` では `## 1...` から始まります。
|
|
248
|
+
|
|
249
|
+
```yaml
|
|
250
|
+
---
|
|
251
|
+
id: itc-order
|
|
252
|
+
type: test
|
|
253
|
+
title: 内部結合テストカタログ: 受注(order)
|
|
254
|
+
status: draft
|
|
255
|
+
part_of: []
|
|
256
|
+
based_on: [tsp-index, itc-index]
|
|
257
|
+
supersedes: []
|
|
258
|
+
---
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### 8.1. 概要(order)
|
|
262
|
+
|
|
263
|
+
受注API(入力)から永続化(DB)までの結合、および重複/制約違反/ロールバックを扱う。
|
|
264
|
+
|
|
265
|
+
### 8.2. 責務(結合として保証)
|
|
266
|
+
|
|
267
|
+
- API入力を永続化モデルへ正しく変換し保存する
|
|
268
|
+
- 制約違反時に規定のエラーへ変換し、DB状態を汚さない
|
|
269
|
+
- 部分失敗時にトランザクションをロールバックする
|
|
270
|
+
|
|
271
|
+
### 8.3. 対象外
|
|
272
|
+
|
|
273
|
+
- 外部決済サービス実疎通(理由:外部要因、代替:ET)
|
|
274
|
+
- ブラウザ操作のE2E(理由:責務外、代替:E2E)
|
|
275
|
+
|
|
276
|
+
### 8.4. 結合境界/依存/環境前提
|
|
277
|
+
|
|
278
|
+
- 結合境界:`POST /orders`
|
|
279
|
+
- 結合対象:OrderController → OrderService → OrderRepository → DB
|
|
280
|
+
- DB:PostgreSQL(コンテナ)、マイグレーション適用済み
|
|
281
|
+
- 外部在庫API:Stub(成功/失敗/タイムアウト)
|
|
282
|
+
- 時刻:固定クロック注入
|
|
283
|
+
- 初期化:テストごとにDBクリーン(トランザクション or truncate)
|
|
284
|
+
|
|
285
|
+
### 8.5. トレース
|
|
286
|
+
|
|
287
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
288
|
+
| --------- | ------------- | -------------------- | ---- |
|
|
289
|
+
| TR-01 | bac-order-01 | 受注登録の入力制約 | |
|
|
290
|
+
| TR-02 | spec-order-05 | 重複時のエラーコード | |
|
|
291
|
+
| TR-03 | br-order-02 | トランザクション境界 | |
|
|
292
|
+
|
|
293
|
+
### 8.6. テスト観点とケース
|
|
294
|
+
|
|
295
|
+
#### 8.6.1. 観点:永続化の整合性
|
|
296
|
+
|
|
297
|
+
##### 8.6.1.1. 意図
|
|
298
|
+
|
|
299
|
+
入力→保存→取得で、データが欠損/改変されず、制約と整合性が担保されることを検証する。
|
|
300
|
+
|
|
301
|
+
##### 8.6.1.2. 条件・ケース表
|
|
302
|
+
|
|
303
|
+
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 境界/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
304
|
+
| ---------------------------------- | -------------------------------- | ------------ | ------------------------ | -------------------------- | --------------- | -------- | ------ | --------- | --------------------------------------- |
|
|
305
|
+
| it-order-persistence-integrity-010 | 入力: 正常 / 状態: DB空 | POST /orders | 201 + DBに1件作成 | レスポンス/DB行/主要カラム | DB=実(コンテナ) | TR-01 | P0 | automated | tests/it/orders/create.test.ts, CI#123 |
|
|
306
|
+
| it-order-persistence-integrity-020 | 入力: 制約違反 / 状態: DB空 | POST /orders | 400 + DBに作成されない | レスポンス/DB行0 | DB=実(制約観測) | TR-01 | P0 | automated | tests/it/orders/create.test.ts, CI#124 |
|
|
307
|
+
| it-order-persistence-integrity-030 | 入力: 重複 / 状態: 既存orderあり | POST /orders | 409 + DB状態が変化しない | エラーコード/DB差分なし | DB=実 | TR-02 | P1 | automated | tests/it/orders/duplicate.test.ts, CI#9 |
|
|
@@ -0,0 +1,312 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:mip-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:mip-index-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 移行計画 作成ルール
|
|
12
|
+
|
|
13
|
+
Migration Plan (MIP) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、移行計画ドキュメント(`mip-index`)を統一形式で記述するためのルールです。
|
|
16
|
+
移行全体を「1冊で説明できる状態」にし、関係者の合意と実行の基準点となる内容を定義します。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
`mip-index` は、移行計画の全体像を **運用可能な最小情報** で整理し、合意・実行・判断の基準とする。
|
|
21
|
+
|
|
22
|
+
- 目的は「移行全体を1冊で説明できる状態」にすること
|
|
23
|
+
- 共通方針・前提・スコープ・成功条件を **明確に固定** する
|
|
24
|
+
- 詳細な手順や実作業の粒度は、必要に応じて下位ドキュメントや運用手順へ寄せる
|
|
25
|
+
- 判断に必要な情報(停止許容時間、許容誤差、GO/NO-GO基準)を必ず含める
|
|
26
|
+
- カットオーバーは **概要(骨格)** を必ず含め、分単位の手順は別ドキュメントに分離する
|
|
27
|
+
|
|
28
|
+
運用方針:
|
|
29
|
+
|
|
30
|
+
- `mip` は `mip-index` のみを作成する(`mip-<term>` は作成しない)
|
|
31
|
+
- `mtp-index`/ `cop-index` / `otp-index` を関連ドキュメントとして参照し、詳細は下位ドキュメントへ委譲する
|
|
32
|
+
|
|
33
|
+
## 2. 位置づけ
|
|
34
|
+
|
|
35
|
+
`mip-index` と他ドキュメントの関係を示します。必要に応じて Mermaid による図を使用してよい。
|
|
36
|
+
|
|
37
|
+
- **`mip-index`:移行の合意・判断のSSOT(成功条件・カットオーバー骨格を含む)**
|
|
38
|
+
- `dmd-index` / `dmd-<term>`:データ移行の詳細設計(マッピング/変換/検証)
|
|
39
|
+
- `mtp-index` / `mtp-<term>`:リハーサル計画・検証設計(観点/手順/証跡)
|
|
40
|
+
- `cop-index` / `cop-<term>`:当日実行の詳細手順(Runbook)
|
|
41
|
+
- `otp-index` / `otp-<term>`:運用切替の詳細(監視設定/運用手順/窓口)
|
|
42
|
+
|
|
43
|
+
## 3. ファイル命名・ID規則
|
|
44
|
+
|
|
45
|
+
- `id` は `mip-index` 固定。
|
|
46
|
+
- ファイル名は `mip-010-移行計画-概要.md` 等、プロジェクト内で一意になるように命名する。
|
|
47
|
+
- `id`(参照用の不変キー)とファイル名(可読性/並び順)は独立であり、ファイル名変更は許容する。
|
|
48
|
+
|
|
49
|
+
## 4. 推奨 Frontmatter 項目
|
|
50
|
+
|
|
51
|
+
### 4.1. 設定内容
|
|
52
|
+
|
|
53
|
+
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))。
|
|
54
|
+
|
|
55
|
+
| 項目 | 説明 | 必須 |
|
|
56
|
+
| ---------- | -------------------------------------------- | ---- |
|
|
57
|
+
| id | `mip-index`(固定) | ○ |
|
|
58
|
+
| type | `migration` 固定 | ○ |
|
|
59
|
+
| title | 移行計画: 概要(`<システム名>`) | ○ |
|
|
60
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
61
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
62
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
63
|
+
|
|
64
|
+
### 4.2. 推奨ルール
|
|
65
|
+
|
|
66
|
+
- `based_on` には移行判断に直接利用した成果物(例: `br-*` / `nfr-*` / `issue-*`)のみ列挙する
|
|
67
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
|
|
68
|
+
|
|
69
|
+
## 5. 本文構成(標準テンプレ)
|
|
70
|
+
|
|
71
|
+
`mip-index` は以下の見出し構成を **順序固定** で配置します。
|
|
72
|
+
|
|
73
|
+
| 番号 | 見出し | 必須 |
|
|
74
|
+
| ---- | -------------------------------------------------------------- | ---- |
|
|
75
|
+
| 1 | 移行の背景/目的 | ○ |
|
|
76
|
+
| 2 | 前提・制約 | ○ |
|
|
77
|
+
| 3 | 移行方式と期間(方式/フェーズ/タイムライン) | ○ |
|
|
78
|
+
| 4 | 移行対象一覧(スコープ/非対象) | ○ |
|
|
79
|
+
| 5 | 成功条件・受入基準 | ○ |
|
|
80
|
+
| 6 | 体制・役割(GO判断含む) | ○ |
|
|
81
|
+
| 7 | 移行リスクと対策 | ○ |
|
|
82
|
+
| 8 | カットオーバー概要(当日タイムライン/判定点/ロールバック方針) | ○ |
|
|
83
|
+
| 9 | 移行後ハイパーケア方針 | ○ |
|
|
84
|
+
|
|
85
|
+
## 6. 記述ガイド
|
|
86
|
+
|
|
87
|
+
### 6.1. 移行の背景/目的
|
|
88
|
+
|
|
89
|
+
生成する `mip-index` 本文の見出しは **## 1. 移行の背景/目的**
|
|
90
|
+
|
|
91
|
+
- なぜ移行が必要かを 1〜3 行で明確にする
|
|
92
|
+
- 対象の範囲と期待する成果を簡潔に示す
|
|
93
|
+
|
|
94
|
+
### 6.2. 前提・制約
|
|
95
|
+
|
|
96
|
+
生成する `mip-index` 本文の見出しは **## 2. 前提・制約**
|
|
97
|
+
|
|
98
|
+
- 移行の前提(対象環境、停止可能時間帯、使用可能なリソース)を列挙する
|
|
99
|
+
- 制約(法務/セキュリティ/契約/外部依存)を明記する
|
|
100
|
+
|
|
101
|
+
### 6.3. 移行方式と期間(方式/フェーズ/タイムライン)
|
|
102
|
+
|
|
103
|
+
生成する `mip-index` 本文の見出しは **## 3. 移行方式と期間(方式/フェーズ/タイムライン)**
|
|
104
|
+
|
|
105
|
+
- 移行方式(例: 一斉/並行)を明記する
|
|
106
|
+
- 主要フェーズと期間(準備/移行/検証/切替/撤退)を時系列で示す
|
|
107
|
+
|
|
108
|
+
推奨フォーマット(表):
|
|
109
|
+
|
|
110
|
+
| フェーズ | 期間 | 目的 | 成果物/完了条件 |
|
|
111
|
+
| -------- | ---- | ---- | --------------- |
|
|
112
|
+
|
|
113
|
+
### 6.4. 移行対象一覧(スコープ/非対象)
|
|
114
|
+
|
|
115
|
+
生成する `mip-index` 本文の見出しは **## 4. 移行対象一覧(スコープ/非対象)**
|
|
116
|
+
|
|
117
|
+
- スコープを **一覧表** で示す
|
|
118
|
+
- 以下の観点を含める: 業務/機能/I/F/データ種別/非対象
|
|
119
|
+
- 詳細(テーブル/項目/変換ロジック)は書かず、下位ドキュメントへリンクする
|
|
120
|
+
|
|
121
|
+
推奨フォーマット(表):
|
|
122
|
+
|
|
123
|
+
| 区分 | 対象 | 補足 |
|
|
124
|
+
| ---- | ---- | ---- |
|
|
125
|
+
|
|
126
|
+
### 6.5. 成功条件・受入基準
|
|
127
|
+
|
|
128
|
+
生成する `mip-index` 本文の見出しは **## 5. 成功条件・受入基準**
|
|
129
|
+
|
|
130
|
+
- 停止許容時間、許容誤差、完了定義を明記する
|
|
131
|
+
- 合否判断に使う測定/証跡の種類と所在(例:照合レポート、CIログ、監査ログ等)を示す
|
|
132
|
+
- 測定対象はプロジェクトに合わせて、データ種別(マスタ/トラン)・期間・業務シナリオのうち最低2つ(データ種類+期間、など)は必ず書く
|
|
133
|
+
- GO/NO-GO の最低限の判定条件を箇条書きで明文化する
|
|
134
|
+
|
|
135
|
+
推奨フォーマット(表):
|
|
136
|
+
|
|
137
|
+
| 項目 | 基準 | 測定対象(対象データ/期間/業務) | 測定/証跡 | 判定者 | 失敗時の扱い(ロールバック/延期/代替手順) |
|
|
138
|
+
| ---- | ---- | -------------------------------- | --------- | ------ | ------------------------------------------ |
|
|
139
|
+
|
|
140
|
+
### 6.6. 体制・役割(GO判断含む)
|
|
141
|
+
|
|
142
|
+
生成する `mip-index` 本文の見出しは **## 6. 体制・役割(GO判断含む)**
|
|
143
|
+
|
|
144
|
+
- 体制/責任分担を示す(責任者/実行者/承認者)
|
|
145
|
+
- GO/NO-GO の判断主体と判断基準(参照する成功条件)を明記する
|
|
146
|
+
- 連絡系統(エスカレーション先)を最小限で示す
|
|
147
|
+
|
|
148
|
+
推奨フォーマット(表):
|
|
149
|
+
|
|
150
|
+
| 役割 | 担当 | 責務 | 連絡/判断 |
|
|
151
|
+
| ---- | ---- | ---- | --------- |
|
|
152
|
+
|
|
153
|
+
### 6.7. 移行リスクと対策
|
|
154
|
+
|
|
155
|
+
生成する `mip-index` 本文の見出しは **## 7. 移行リスクと対策**
|
|
156
|
+
|
|
157
|
+
- リスク、影響、対策、検知方法、発動条件(必要に応じて)を整理する
|
|
158
|
+
- 重大リスクは「誰がいつ判断するか」を落とさない
|
|
159
|
+
|
|
160
|
+
推奨フォーマット(表):
|
|
161
|
+
|
|
162
|
+
| リスク | 影響 | 対策 | 検知/判断 |
|
|
163
|
+
| ------ | ---- | ---- | --------- |
|
|
164
|
+
|
|
165
|
+
### 6.8. カットオーバー概要(当日タイムライン/判定点/ロールバック方針)
|
|
166
|
+
|
|
167
|
+
生成する `mip-index` 本文の見出しは **## 8. カットオーバー概要(当日タイムライン/判定点/ロールバック方針)**
|
|
168
|
+
|
|
169
|
+
- 当日の流れを **骨格(マイルストーン)** で示す(分単位の詳細手順は書かない)
|
|
170
|
+
- 判定点(GO1/GO2…)と「失敗時の扱い(ロールバック/延期)」を明記する
|
|
171
|
+
- ロールバックの **発動条件** と **復旧の方針**(旧系復帰/データ無効化等)を明記する
|
|
172
|
+
- 例:判定点で失敗した場合の扱いは ロールバック / 延期(Go-Live中止)/ 代替手順 のいずれかを明記する
|
|
173
|
+
- 詳細Runbook(`cop-*`)がある場合はリンクする
|
|
174
|
+
|
|
175
|
+
推奨フォーマット(表):
|
|
176
|
+
|
|
177
|
+
| 時刻(相対) | イベント | 完了条件 | 判定点 |
|
|
178
|
+
| ------------ | -------- | -------- | ------ |
|
|
179
|
+
|
|
180
|
+
### 6.9. 移行後ハイパーケア方針
|
|
181
|
+
|
|
182
|
+
生成する `mip-index` 本文の見出しは **## 9. 移行後ハイパーケア方針**
|
|
183
|
+
|
|
184
|
+
- 監視期間、体制、対応範囲を明記する
|
|
185
|
+
- 問い合わせ窓口とSLA目安があれば記載する
|
|
186
|
+
- 旧システムの扱い(参照期間/停止/アーカイブ)を方針レベルで書く
|
|
187
|
+
- `dmd-*` / `mtp-index`・`mtp-*` / `cop-index`・`cop-*` / `otp-index`・`otp-*` への導線を示す
|
|
188
|
+
|
|
189
|
+
推奨フォーマット(表):
|
|
190
|
+
|
|
191
|
+
| 項目 | 方針 |
|
|
192
|
+
| ---- | ---- |
|
|
193
|
+
|
|
194
|
+
## 7. 禁止事項
|
|
195
|
+
|
|
196
|
+
| 禁止事項 | 理由 |
|
|
197
|
+
| ----------------------------------------------------------------- | -------------------------------------------------------- |
|
|
198
|
+
| スコープ(対象/非対象)を曖昧に書く | 合意形成と実行判断が不能になるため |
|
|
199
|
+
| 成功条件・受入基準を記載しない | GO判断の基準点がなくなるため |
|
|
200
|
+
| 体制・役割やGO判断主体を未記載にする | 責任が不明確になり判断が遅れるため |
|
|
201
|
+
| リスクと対策を列挙しない | 失敗時の影響が拡大するため |
|
|
202
|
+
| カットオーバー概要(判定点/ロールバック方針)を省略する | 当日判断と失敗時対応が不明確になるため |
|
|
203
|
+
| ハイパーケア方針を省略する | 移行後の不具合対応が不明確になるため |
|
|
204
|
+
| テーブル/項目レベルのマッピングや変換ロジックを本書に詳細記載する | 下位ドキュメントと二重管理になり、更新不整合を起こすため |
|
|
205
|
+
| 分単位の作業チェックリストや手順書を本書に全面記載する | Runbookの責務を侵食し、運用時に参照先が割れるため |
|
|
206
|
+
|
|
207
|
+
## 8. サンプル(最小)
|
|
208
|
+
|
|
209
|
+
注:以下はルール文書内の例示です。生成する `mip-index` では `## 1...` から始まります。
|
|
210
|
+
|
|
211
|
+
```yaml
|
|
212
|
+
---
|
|
213
|
+
id: mip-index
|
|
214
|
+
type: project
|
|
215
|
+
title: 移行計画: 概要(example)
|
|
216
|
+
status: draft
|
|
217
|
+
based_on: []
|
|
218
|
+
supersedes: []
|
|
219
|
+
---
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### 8.1. 移行の背景/目的
|
|
223
|
+
|
|
224
|
+
既存システムの保守限界に伴い、新基盤へ移行するための計画を定義する。
|
|
225
|
+
|
|
226
|
+
### 8.2. 前提・制約
|
|
227
|
+
|
|
228
|
+
- 停止は休日深夜帯のみ(最大 6 時間)
|
|
229
|
+
- 外部決済は sandbox を使用
|
|
230
|
+
|
|
231
|
+
### 8.3. 移行方式と期間(方式/フェーズ/タイムライン)
|
|
232
|
+
|
|
233
|
+
並行移行とし、準備→データ移行→切替→撤退判定の順で実施する。
|
|
234
|
+
|
|
235
|
+
| フェーズ | 期間 | 目的 | 成果物/完了条件 |
|
|
236
|
+
| -------- | ---------- | -------------------- | ------------------ |
|
|
237
|
+
| 準備 | 2026-03 | 手順/環境/権限の準備 | リハーサル実施可能 |
|
|
238
|
+
| 移行 | 2026-04-01 | 本番データ移行 | 移行ログOK |
|
|
239
|
+
| 検証 | 2026-04-01 | 整合性検証 | 照合レポートOK |
|
|
240
|
+
| 切替 | 2026-04-01 | 新系へ切替 | スモークOK |
|
|
241
|
+
| 撤退判定 | 2026-04-15 | 旧系撤退判断 | 承認完了 |
|
|
242
|
+
|
|
243
|
+
### 8.4. 移行対象一覧(スコープ/非対象)
|
|
244
|
+
|
|
245
|
+
| 区分 | 対象 | 補足 |
|
|
246
|
+
| ------ | -------------------- | -------------------- |
|
|
247
|
+
| 業務 | 受注/請求 | 旧基盤から移行 |
|
|
248
|
+
| I/F | 決済連携 | 切替当日に接続先変更 |
|
|
249
|
+
| データ | マスタ/トラン | 詳細は dmd-\* を参照 |
|
|
250
|
+
| 非対象 | 過去アーカイブデータ | 参照のみ |
|
|
251
|
+
|
|
252
|
+
### 8.5. 成功条件・受入基準
|
|
253
|
+
|
|
254
|
+
| 項目 | 基準 | 測定対象(対象データ/期間/業務) | 測定/証跡 | 判定者 |
|
|
255
|
+
| ------------ | --------- | --------------------------------------------- | ---------------------- | ---------- |
|
|
256
|
+
| 停止許容時間 | 6時間以内 | カットオーバー当日(全作業) | カットオーバー作業ログ | 運用責任者 |
|
|
257
|
+
| 件数差異 | 0 | 受注/請求データ(移行対象期間:2024-01-01〜) | 照合レポート | 業務責任者 |
|
|
258
|
+
| 許容誤差 | 0.1%未満 | 売上/売掛集計(移行対象期間:2024-01-01〜) | 集計照合レポート | 業務責任者 |
|
|
259
|
+
|
|
260
|
+
GO/NO-GO(最低条件):
|
|
261
|
+
|
|
262
|
+
- 停止許容時間を満たす
|
|
263
|
+
- 主要データ照合が全て合格
|
|
264
|
+
- 重大障害が未解決でない
|
|
265
|
+
|
|
266
|
+
### 8.6. 体制・役割(GO判断含む)
|
|
267
|
+
|
|
268
|
+
| 役割 | 担当 | 責務 | 連絡/判断 |
|
|
269
|
+
| ------ | ------------------ | ---------------- | ---------------------------- |
|
|
270
|
+
| GO判断 | プロダクトオーナー | GO/NO-GO決定 | 重大障害は即エスカレーション |
|
|
271
|
+
| 実行 | 移行チーム | データ移行・切替 | 作業ログ記録 |
|
|
272
|
+
| 運用 | 運用チーム | 監視/一次対応 | SLAに従う |
|
|
273
|
+
|
|
274
|
+
### 8.7. 移行リスクと対策
|
|
275
|
+
|
|
276
|
+
| リスク | 影響 | 対策 | 検知/判断 |
|
|
277
|
+
| ------------ | -------- | ----------------- | ---------------- |
|
|
278
|
+
| データ不整合 | 受注停止 | 検証ジョブの実行 | 件数差分の検知 |
|
|
279
|
+
| 切替遅延 | 停止延長 | リハーサル/並列化 | タイムライン遅延 |
|
|
280
|
+
|
|
281
|
+
### 8.8. カットオーバー概要(当日タイムライン/判定点/ロールバック方針)
|
|
282
|
+
|
|
283
|
+
| 時刻(相対) | イベント | 完了条件 | 判定点 | 失敗時の扱い(ロールバック/延期/代替手順) |
|
|
284
|
+
| ------------ | ------------ | ------------ | ------ | ----------------------------------------------------------- |
|
|
285
|
+
| T-120m | 旧系受付停止 | 停止確認 | GO1 | 延期(Go-Live中止):旧系で業務継続 |
|
|
286
|
+
| T-90m | 最終差分抽出 | 抽出ログOK | GO2 | 代替手順:抽出条件を切替→再抽出(上限1回)。失敗なら延期 |
|
|
287
|
+
| T-60m | 新DB投入 | 投入ログOK | GO3 | ロールバック:投入データ無効化(run_id単位で隔離)→旧系継続 |
|
|
288
|
+
| T-15m | 接続先切替 | スモークOK | GO4 | ロールバック:接続先を旧系へ戻す→延期判断(必要なら) |
|
|
289
|
+
| T+0 | 利用開始 | 初回業務完了 | GO5 | 代替手順:限定運用(対象業務を絞って開始)。不可なら延期 |
|
|
290
|
+
|
|
291
|
+
ロールバック方針(例):
|
|
292
|
+
|
|
293
|
+
- **延期(Go-Live中止)**:GO1/GO2で失敗 → 当日切替を中止し、旧系で業務継続(再スケジュール)
|
|
294
|
+
- **ロールバック(旧系復帰)**:GO4で失敗 → 接続先を旧系へ戻し、新系投入データは run_id 単位で無効化/隔離
|
|
295
|
+
- **代替手順**:GO2で失敗 → 抽出条件を切替して再抽出(最大1回)し、それでも失敗なら延期
|
|
296
|
+
|
|
297
|
+
### 8.9. 移行後ハイパーケア方針
|
|
298
|
+
|
|
299
|
+
| 項目 | 方針 |
|
|
300
|
+
| ---------- | -------------------------------- |
|
|
301
|
+
| 期間 | 移行後 2 週間 |
|
|
302
|
+
| 体制 | 専用当番(8:00-20:00) |
|
|
303
|
+
| 対応範囲 | 障害一次対応、問い合わせ一次受付 |
|
|
304
|
+
| 窓口/SLA | 30分以内に一次応答(目安) |
|
|
305
|
+
| 旧システム | 3ヶ月参照専用、その後アーカイブ |
|
|
306
|
+
|
|
307
|
+
関連ドキュメント(例):
|
|
308
|
+
|
|
309
|
+
- `dmd-order-data`:データ移行設計(抽出/変換/投入/検証)
|
|
310
|
+
- `mtp-index`:移行リハーサル計画(合否基準/判断プロセス)
|
|
311
|
+
- `cop-index`:カットオーバー計画(当日手順/判定点/ロールバック)
|
|
312
|
+
- `otp-index`:運用切替計画(監視/窓口/ハイパーケア/クローズ条件)
|