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,310 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:etc-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:etc-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 外部結合テストカタログ 対象別 作成ルール
|
|
12
|
+
|
|
13
|
+
External Integration Test Catalog (ETC) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、外部結合テストカタログ(ETC)の対象別 `etc-<term>` を統一形式で記述するためのルールです。
|
|
16
|
+
`etc-index` を前提に、SSOTの本体として、対象ごとの **外部結合の責務・境界・外部依存/環境、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
個別 ETC(`etc-<term>`)は、外部結合テストにおける SSOT の本体として、対象ごとの結合責務と境界を明確化し、
|
|
21
|
+
観点×条件=ケース(末端表)を最小情報で整理して、テストコード/CI証跡へ確実に接続できる形で記述する。
|
|
22
|
+
|
|
23
|
+
- `etc-<term>` は **対象固有の情報のみ** を記述し、共通ルールは `etc-index` を参照する(重複記述しない)
|
|
24
|
+
- 外部結合テストの目的は「**外部境界を跨いだ結合の振る舞い**を、実運用に近い前提で検証すること」である
|
|
25
|
+
- ケースは「表の1行=1テスト」とし、手順と期待値は **判定可能**な粒度で簡潔に書く
|
|
26
|
+
- 直積(全組合せ)を原則避け、代表→境界→重大例外の順で増やす(必要時は理由・範囲を明記)
|
|
27
|
+
- 外部依存(sandbox/スタブ/モック)・テストデータ・秘密情報の扱いは、再現性と安全性を優先して固定する
|
|
28
|
+
- すべての観点・ケースは、根拠仕様(`based_on` / `トレース`)と、証跡(テストコード/CI/外部リクエストID/ログ相関キー等)に接続されていること
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけ(他ドキュメントとの関係)
|
|
31
|
+
|
|
32
|
+
個別 ETC(`etc-<term>`)と他ドキュメントの関係を示します。
|
|
33
|
+
|
|
34
|
+
```mermaid
|
|
35
|
+
flowchart BT
|
|
36
|
+
TSP["tsp-index<br>テスト戦略・方針"]
|
|
37
|
+
|
|
38
|
+
subgraph TC["テストカタログ"]
|
|
39
|
+
direction RL
|
|
40
|
+
TCIndex["etc-index<br>テスト仕様-全体構成"]
|
|
41
|
+
TCDetail["etc-<term><br>テスト仕様-対象別"]
|
|
42
|
+
TCDetail -->|based_on| TCIndex
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
Code["テストコード 等"]
|
|
46
|
+
|
|
47
|
+
TC -->|based_on| TSP
|
|
48
|
+
Code -->|based_on| TC
|
|
49
|
+
|
|
50
|
+
classDef target stroke-width:4px
|
|
51
|
+
class TCDetail target
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 3. ファイル命名・ID規則
|
|
55
|
+
|
|
56
|
+
- `id` は `etc-<term>`(kebab-case。例: `etc-payment-gateway`)。
|
|
57
|
+
- ファイル名は `etc-010-外部結合テストカタログ-<term>.md` 等(例: `etc-010-外部結合テストカタログ-決済ゲートウェイ.md`)。
|
|
58
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
|
|
59
|
+
|
|
60
|
+
## 4. 推奨 Frontmatter 項目
|
|
61
|
+
|
|
62
|
+
### 4.1. 設定内容
|
|
63
|
+
|
|
64
|
+
Frontmatter は共通スキーマに従います(あわせてドキュメントのメタ情報の記述ルールも参照)。
|
|
65
|
+
|
|
66
|
+
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
67
|
+
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
68
|
+
|
|
69
|
+
| 項目 | 説明 | 必須 |
|
|
70
|
+
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
71
|
+
| id | ETC ID(個別: `etc-<term>`) | ○ |
|
|
72
|
+
| type | `test` 固定 | ○ |
|
|
73
|
+
| title | 外部結合テストカタログ: <対象名> | ○ |
|
|
74
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
75
|
+
| based_on | 根拠仕様(最低限: `tsp-index`, `etc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
76
|
+
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
77
|
+
| supersedes | 置き換え関係 | 任意 |
|
|
78
|
+
|
|
79
|
+
### 4.2. 推奨ルール
|
|
80
|
+
|
|
81
|
+
- `based_on` には **本対象の外部結合テスト観点の根拠となる仕様** を列挙します。
|
|
82
|
+
- `based_on` は原則 `[tsp-index, etc-index]` を最低限とし、対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` 等)は本文「トレース」に集約します。
|
|
83
|
+
- 機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
84
|
+
- 記述内容が多くなる場合は、ドキュメントを分割し、`part_of` で集約ドキュメントに所属させます。
|
|
85
|
+
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
86
|
+
|
|
87
|
+
## 5. 本文構成(標準テンプレ)
|
|
88
|
+
|
|
89
|
+
個別 ETC(`etc-<term>`)は以下の見出し構成を **順序固定** で配置します。
|
|
90
|
+
|
|
91
|
+
| 番号 | 見出し | 必須 |
|
|
92
|
+
| ---- | ---------------------------------- | ---- |
|
|
93
|
+
| 1 | 概要(`<term>`) | ○ |
|
|
94
|
+
| 2 | 責務 | ○ |
|
|
95
|
+
| 3 | 対象外 | ○ |
|
|
96
|
+
| 4 | 境界/依存/環境 | ○ |
|
|
97
|
+
| 5 | トレース | ○ |
|
|
98
|
+
| 6 | テスト観点とケース | ○ |
|
|
99
|
+
| 7 | 実行運用メモ(データ/後始末/制約) | 任意 |
|
|
100
|
+
|
|
101
|
+
注意:次章の記述ガイドのMarkdown見出しはルール文章内の参照用であり、
|
|
102
|
+
生成する `etc-<term>` 本文の見出しは各章で指定された **番号付き** の形式
|
|
103
|
+
(例: `## 6.`, `### 6.1.` / `#### 6.1.1.` / `#### 6.1.2.`)に置き換えてください。
|
|
104
|
+
|
|
105
|
+
## 6. 記述ガイド
|
|
106
|
+
|
|
107
|
+
### 6.1. 概要(`<term>`)
|
|
108
|
+
|
|
109
|
+
生成する `etc-<term>` 本文の見出しは **## 1. 概要(<term>)**
|
|
110
|
+
|
|
111
|
+
本節では、対象(`<term>`)が何であり、どの外部境界を跨ぐ結合を本カタログで扱うかを簡潔に示します。
|
|
112
|
+
|
|
113
|
+
- `<term>` の説明(1〜3行):外部境界・連携対象・主たるユースケースが分かるように書く
|
|
114
|
+
- 期待する利用者:レビューア/実装者/テスト実装者/運用者が前提を把握できる内容にする
|
|
115
|
+
- 対象の粒度:`etc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
116
|
+
- 関連I/F(任意):主要エンドポイント、イベント、キュー、Webhook、SDK関数名などを列挙してよい
|
|
117
|
+
- 長い背景説明は書かない(根拠はトレースで示す)
|
|
118
|
+
|
|
119
|
+
### 6.2. 責務
|
|
120
|
+
|
|
121
|
+
生成する `etc-<term>` 本文の見出しは **## 2. 責務**
|
|
122
|
+
|
|
123
|
+
本節では、「この外部結合が何を保証すべきか(ETで確認する責務)」を列挙します。
|
|
124
|
+
|
|
125
|
+
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる**形で記述する
|
|
126
|
+
- 例:外部I/F契約に従って送受信する/署名を検証する/再送時に冪等性を満たす/失敗時に再試行する/相関IDを出力する
|
|
127
|
+
|
|
128
|
+
- ETの責務は「結合の振る舞い」であり、内部単体のロジック検証はUT/ITへ寄せる(責務≠観点)
|
|
129
|
+
- 重大失敗モード(タイムアウト、レート制限、部分失敗、二重処理など)を含める
|
|
130
|
+
- 可能なら観測可能な成果(外部レスポンス、外部ID、内部状態、イベント、ログ相関)とセットで書く
|
|
131
|
+
- 責務に含まれないものは「対象外」へ移す
|
|
132
|
+
|
|
133
|
+
### 6.3. 対象外
|
|
134
|
+
|
|
135
|
+
生成する `etc-<term>` 本文の見出しは **## 3. 対象外**
|
|
136
|
+
|
|
137
|
+
本節では、「この対象カタログ(`etc-<term>`)ではやらないこと」を明示します。
|
|
138
|
+
`etc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
139
|
+
|
|
140
|
+
- 対象外は「なぜ除外するか(理由)」とセットで書く
|
|
141
|
+
- 可能なら「代替するレベル」(IT/ST/AT/NFR 等)も併記する
|
|
142
|
+
- 対象固有の対象外(例:別の外部I/F、別termの責務)を明確にする
|
|
143
|
+
- 例外としてETで扱う場合は、条件・根拠・安全性・再現方法(sandbox/スタブ等)を明記する
|
|
144
|
+
|
|
145
|
+
推奨フォーマット(簡易):
|
|
146
|
+
|
|
147
|
+
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
148
|
+
|
|
149
|
+
### 6.4. 境界/依存/環境
|
|
150
|
+
|
|
151
|
+
生成する `etc-<term>` 本文の見出しは **## 4. 境界/依存/環境**
|
|
152
|
+
|
|
153
|
+
本節では、外部結合テストにおける「境界(どこまでが対象か)」「依存(外部要因)」「環境前提」を明確にします。
|
|
154
|
+
|
|
155
|
+
- 境界:対象の入口/出口(API、Webhook、Queue、Batch、SDK、外部コール)を明記する
|
|
156
|
+
- 外部依存はカテゴリごとに列挙し、「扱い(sandbox/実/スタブ/モック)」と「観測点」を決める
|
|
157
|
+
- 外部API:sandbox/スタブ(成功/4xx/5xx/タイムアウト/レート制限)
|
|
158
|
+
- 認証:テスト用アカウント、トークン更新/失効の扱い
|
|
159
|
+
- ネットワーク:タイムアウト値、リトライ、DNS/TLS、プロキシ等
|
|
160
|
+
- データ:テストデータのnamespace、クリーンアップ方針(削除/期限/再利用)
|
|
161
|
+
- 時刻:時刻依存のあるI/F(署名期限、リクエスト有効期限)と固定/調整方法
|
|
162
|
+
|
|
163
|
+
- 秘密情報:ログ出力禁止、CI secret管理、マスキング方針を明記する
|
|
164
|
+
- 例外(実疎通が不可/不安定等)がある場合は、理由と影響(再現性・費用・安全性)を明記する
|
|
165
|
+
|
|
166
|
+
### 6.5. トレース
|
|
167
|
+
|
|
168
|
+
生成する `etc-<term>` 本文の見出しは **## 5. トレース**
|
|
169
|
+
|
|
170
|
+
本節では、`etc-<term>` の根拠となる上位成果物との対応関係(トレーサビリティ)を示します。
|
|
171
|
+
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、観点・ケース表では **trace_key(`TR-xx`)参照** に統一します。
|
|
172
|
+
|
|
173
|
+
#### 6.5.1. 記述ルール(trace_key)
|
|
174
|
+
|
|
175
|
+
- 各トレース項目に **trace_key(`TR-xx`)** を付与する(例:`TR-01`…)
|
|
176
|
+
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない(削除しても欠番は詰めない)
|
|
177
|
+
- 観点・ケース表の `トレース` 列には **仕様IDを直書きせず** `TR-xx` を列挙する
|
|
178
|
+
- 新しい根拠が必要になった場合は、**先に本節の表へ追加**し、付与された `trace_key` をケース表で参照する
|
|
179
|
+
|
|
180
|
+
#### 6.5.2. トレース表(標準フォーマット)
|
|
181
|
+
|
|
182
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
183
|
+
| --------- | ------- | ------- | ---- |
|
|
184
|
+
| TR-01 | br-... | (1行) | 任意 |
|
|
185
|
+
| TR-02 | bac-... | (1行) | 任意 |
|
|
186
|
+
|
|
187
|
+
- `要点` は「ケース作成の判断に使ったポイント」を **1行**で書く(冗長な仕様説明はしない)
|
|
188
|
+
|
|
189
|
+
### 6.6. テスト観点とケース
|
|
190
|
+
|
|
191
|
+
生成する `etc-<term>` 本文の見出しは **## 6. テスト観点とケース**
|
|
192
|
+
|
|
193
|
+
本節は `etc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
194
|
+
|
|
195
|
+
#### 6.6.1. 観点:<観点>
|
|
196
|
+
|
|
197
|
+
生成する `etc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
198
|
+
|
|
199
|
+
- 観点は `etc-index` の「観点の立て方(共通)」に従って命名する
|
|
200
|
+
- 観点の粒度は「条件が複数ぶら下がる」程度にまとめる(細かすぎる観点の乱立を避ける)
|
|
201
|
+
- 観点名(見出し)は改善のため変更してよいが、`perspective_key` は原則変更しない
|
|
202
|
+
|
|
203
|
+
##### 6.6.1.1. 意図
|
|
204
|
+
|
|
205
|
+
生成する `etc-<term>` 本文の見出しは **#### 6.1.1. 意図**
|
|
206
|
+
|
|
207
|
+
- 観点ごとに「意図(この観点で保証すること)」を 1〜2 行で書く
|
|
208
|
+
|
|
209
|
+
##### 6.6.1.2. 条件・ケース表
|
|
210
|
+
|
|
211
|
+
生成する `etc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
212
|
+
|
|
213
|
+
- ケース表の 1 行は「1テスト」を表す(条件×期待値が一意)
|
|
214
|
+
- 必須カラムは `etc-index` の定義に従う
|
|
215
|
+
- `case_id` は以下を推奨し、変更しない
|
|
216
|
+
- 形式:`<level>-<term>-<perspective_key>-<nnn>`
|
|
217
|
+
- `level`:`et`
|
|
218
|
+
- `perspective_key`:kebab-case のキー文字列(英小文字+数字+ハイフン)で、原則変更しない
|
|
219
|
+
- `nnn`:3桁、10刻み(010,020,030…)を推奨
|
|
220
|
+
|
|
221
|
+
- 条件は「入力/状態/環境」で表現する(`入力:` `状態:` `環境:` を推奨)
|
|
222
|
+
- 手順は最小化し、クリック列挙を禁止する(API呼び出し/ジョブ起動/Webhook送信等の抽象手順で書く)
|
|
223
|
+
- 期待値は判定可能に書く(外部レスポンス、外部ID、内部状態、イベント、ログ相関など観測点を含める)
|
|
224
|
+
- 証跡はテストコードとCI実行結果へ接続できる形で書く(加えて外部リクエストIDやログ相関キー等を推奨)
|
|
225
|
+
|
|
226
|
+
推奨:観点ごとのケース数は「代表→境界→重大例外」の順で増やし、直積(全組合せ)を原則避ける
|
|
227
|
+
|
|
228
|
+
### 6.7. 実行運用メモ(任意)
|
|
229
|
+
|
|
230
|
+
生成する `etc-<term>` 本文の見出しは **## 7. 実行運用メモ(データ/後始末/制約)**
|
|
231
|
+
|
|
232
|
+
- テストデータの作り方/namespace/削除手順
|
|
233
|
+
- 失敗時のリトライ手順・外部側の後始末(取消、返金、無効化等)
|
|
234
|
+
- 実行制約(並列不可、回数制限、実行時間帯、レート制限)
|
|
235
|
+
- 外部サービスのメンテ時間や制限がある場合の注意
|
|
236
|
+
|
|
237
|
+
## 7. 禁止事項
|
|
238
|
+
|
|
239
|
+
| 禁止事項 | 理由 |
|
|
240
|
+
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
241
|
+
| `etc-index` の共通方針を `etc-<term>` 側で勝手に上書きする(境界/依存/対象外など) | ET全体の一貫性が崩れ、レビュー・保守が困難になるため |
|
|
242
|
+
| 外部疎通を無条件に「実」必須にする(再現性・安全性・費用の判断なし) | CI不安定化・費用増・情報漏洩リスクで運用不能になるため |
|
|
243
|
+
| 秘密情報(token/secret)を本文・証跡・ログに平文で残す | セキュリティ事故につながるため |
|
|
244
|
+
| ケース表にUIクリック手順を大量に列挙する | ETの焦点が外部境界なのにE2E責務と混ざり、保守性が低下するため |
|
|
245
|
+
| 期待値を曖昧に書く(例:「エラーにならないこと」「正常に動くこと」) | 合否判定ができず証跡にならないため |
|
|
246
|
+
| `case_id` を変更する/再利用する | トレース・証跡リンクが破壊され、履歴追跡が不能になるため |
|
|
247
|
+
| 直積(全組合せ)のケースを無条件に作る | ケース爆発で運用不能になるため(必要時は理由・範囲を明記) |
|
|
248
|
+
| トレースや証跡を持たないケースを恒久的に残す | SSOTとして成立しないため(例外は暫定として明記) |
|
|
249
|
+
|
|
250
|
+
## 8. サンプル(最小)
|
|
251
|
+
|
|
252
|
+
注:以下はルール文書内の例示です。生成する `etc-<term>` では `## 1...` から始まります。
|
|
253
|
+
|
|
254
|
+
```yaml
|
|
255
|
+
---
|
|
256
|
+
id: etc-payment-gateway
|
|
257
|
+
type: test
|
|
258
|
+
title: 外部結合テストカタログ: 決済ゲートウェイ(payment-gateway)
|
|
259
|
+
status: draft
|
|
260
|
+
part_of: []
|
|
261
|
+
based_on: [tsp-index, etc-index]
|
|
262
|
+
supersedes: []
|
|
263
|
+
---
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### 8.1. 概要(payment-gateway)
|
|
267
|
+
|
|
268
|
+
決済ゲートウェイとの連携(与信、確定、取消、Webhook受信)を扱う。
|
|
269
|
+
|
|
270
|
+
### 8.2. 責務
|
|
271
|
+
|
|
272
|
+
- 外部I/F契約に従ってリクエストを送信し、レスポンスを解釈する
|
|
273
|
+
- Webhookを検証し、内部状態へ反映する
|
|
274
|
+
- タイムアウト/リトライ時に冪等性を満たす
|
|
275
|
+
- 失敗時に相関IDを含むログ/エラー情報を残す
|
|
276
|
+
|
|
277
|
+
### 8.3. 対象外
|
|
278
|
+
|
|
279
|
+
- 大規模負荷試験(理由:測定条件設計が別物、代替:NFR)
|
|
280
|
+
- 多ブラウザ網羅(理由:目的外、代替:ST/AT)
|
|
281
|
+
|
|
282
|
+
### 8.4. 境界/依存/環境
|
|
283
|
+
|
|
284
|
+
- 境界:`POST /payments/authorize` / `POST /payments/capture` / `POST /payments/cancel` / `POST /webhooks/payment`
|
|
285
|
+
- 外部ゲートウェイ:sandbox(成功/4xx/5xx/timeout/ratelimitを再現)
|
|
286
|
+
- 認証:テスト用APIキー(CI secret管理、ログ出力禁止)
|
|
287
|
+
- データ:`test-run-<runId>-*` プレフィックスで作成、終了時に取消/削除
|
|
288
|
+
- 時刻:署名期限を含むため、許容窓(±N分)を明記
|
|
289
|
+
|
|
290
|
+
### 8.5. トレース
|
|
291
|
+
|
|
292
|
+
| trace_key | 仕様ID | 要点 | 備考 |
|
|
293
|
+
| --------- | ----------- | ------------------- | ---- |
|
|
294
|
+
| TR-01 | spec-pay-01 | 与信→確定の状態遷移 | |
|
|
295
|
+
| TR-02 | nfr-pay-03 | リトライ上限と待機 | |
|
|
296
|
+
|
|
297
|
+
### 8.6. テスト観点とケース
|
|
298
|
+
|
|
299
|
+
#### 8.6.1. 観点:再送と冪等性
|
|
300
|
+
|
|
301
|
+
##### 8.6.1.1. 意図
|
|
302
|
+
|
|
303
|
+
外部の一時失敗やタイムアウト時でも、二重課金を防ぎ最終的に正しい状態へ収束させる。
|
|
304
|
+
|
|
305
|
+
##### 8.6.1.2. 条件・ケース表
|
|
306
|
+
|
|
307
|
+
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 境界/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
308
|
+
| ---------------------------------- | -------------------------------------- | --------------------------------------- | -------------------------- | ----------------------------------- | ---------------- | -------- | ------ | --------- | ------------------------------------------------------- |
|
|
309
|
+
| et-payment-gateway-idempotency-010 | 環境: 外部timeout → 同一冪等キーで再送 | authorize → timeout再現 → 同一keyで再送 | 二重課金なしで最終的に成功 | 外部取引ID一意、内部状態=authorized | sandbox(timeout) | TR-02 | P0 | automated | tests/et/payment/idempotency.test.ts, CI#..., reqId=... |
|
|
310
|
+
| et-payment-gateway-idempotency-020 | 状態: Webhook重複受信 | webhookを同一payloadで2回送信 | 状態が二重更新されない | 更新回数=1、イベント重複なし | sandbox/webhook | TR-01 | P1 | automated | tests/et/payment/webhook.test.ts, CI#..., trace=... |
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:gl-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
recipe: undecided
|
|
8
|
+
sample: specdojo:gl-sample
|
|
9
|
+
template: undecided
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 用語集(Glossary)作成ルール
|
|
13
|
+
|
|
14
|
+
本ドキュメントは、業務分析・要求定義・設計・テストで参照する **用語集(Glossary)を YAML 形式で記述する標準ルール**です。
|
|
15
|
+
用語集は、プロジェクト内で同じ言葉を同じ意味で使うための「辞書」であり、業務データ辞書(BDD)などの `glossaryTermId` が参照する **用語ID(`tm-...`)の正(正式な参照先)**になります。
|
|
16
|
+
|
|
17
|
+
## 1. メタデータ(ファイル単位)
|
|
18
|
+
|
|
19
|
+
用語集 YAML は、以下のメタデータを持つことを推奨します(運用しやすさのため)。
|
|
20
|
+
|
|
21
|
+
| 項目 | 説明 | 必須 |
|
|
22
|
+
| ------ | ---------------------------------- | ---- |
|
|
23
|
+
| id | 用語集ID(`gl-...`) | 推奨 |
|
|
24
|
+
| title | 用語集名(例: 用語集: 在庫・調達) | 推奨 |
|
|
25
|
+
| locale | 言語(例: `ja` / `en`) | 推奨 |
|
|
26
|
+
| status | `draft`/`ready`/`deprecated` | 任意 |
|
|
27
|
+
| terms | 用語の配列 | ○ |
|
|
28
|
+
|
|
29
|
+
### 1.1 ファイル命名(推奨)
|
|
30
|
+
|
|
31
|
+
- ファイル名: `gl-<対象領域>-<locale>.yaml`
|
|
32
|
+
- 例: `gl-sales-ja.yaml`, `gl-inventory-ja.yaml`
|
|
33
|
+
- 多言語化する場合はファイルを分けます(ファイル内で言語を混在させない)。
|
|
34
|
+
|
|
35
|
+
## 2. 記載ルール・命名規則
|
|
36
|
+
|
|
37
|
+
- 形式は YAML とし、**トップレベルに `terms:`(配列)を必ず持つ**ようにします(`id` / `title` / `locale` などのメタデータを併記してよい)。
|
|
38
|
+
- 用語は **業務用語(日本語)**で記述し、UI文言や内部コード名の辞書化は必要最小限にします。
|
|
39
|
+
- 用語の定義は「一文で意味が通り、境界が分かる」ように書きます(同義語の説明にならないように)。
|
|
40
|
+
- BDD や BR、BPS、BAC で参照する用語は、先に用語集に登録して **ID を固定**します。
|
|
41
|
+
|
|
42
|
+
### 2.1 ID 規約
|
|
43
|
+
|
|
44
|
+
- 用語集ID: 正規表現 `^gl-[a-z0-9-]+$`
|
|
45
|
+
- 用語ID: 正規表現 `^tm-[a-z0-9-]+$`
|
|
46
|
+
|
|
47
|
+
推奨:
|
|
48
|
+
|
|
49
|
+
- `tm-` の命名は「名詞」を基本(例: `tm-reorder-point`)。
|
|
50
|
+
- 略語を使う場合は、業務用語集で一般的に通じるものに限定し、必要なら `definition` に補足。
|
|
51
|
+
|
|
52
|
+
## 3. 禁止事項
|
|
53
|
+
|
|
54
|
+
- 用語IDの重複、または ID を意味の違う用語に使い回すこと
|
|
55
|
+
- `definition` が曖昧(例: 「正しく処理される」「いい感じの在庫」など)
|
|
56
|
+
- 用語の説明に実装詳細(物理テーブル名、内部クラス名、SQL 等)を混ぜること
|
|
57
|
+
- 同じ概念を別名で重複登録し、`aliases` で統合しないこと
|
|
58
|
+
- ファイル内で言語を混在させること(多言語はファイル分割)
|
|
59
|
+
|
|
60
|
+
## 4. 用語(terms)の記載項目
|
|
61
|
+
|
|
62
|
+
### 4.1 terms の基本構造
|
|
63
|
+
|
|
64
|
+
| 項目 | 説明 | 必須 |
|
|
65
|
+
| ------------ | --------------------------------------------------------- | ---- |
|
|
66
|
+
| id | 用語ID(`tm-...`) | ○ |
|
|
67
|
+
| term | 用語(正式名称) | ○ |
|
|
68
|
+
| aliases | 別名(配列) | 任意 |
|
|
69
|
+
| definition | 定義(境界が分かる説明) | ○ |
|
|
70
|
+
| notes | 補足・運用メモ(前提、例外、使って良い文脈/ダメな文脈等) | 任意 |
|
|
71
|
+
| category | 分類(推奨: 分類用の用語ID、例: `tm-inventory`) | 任意 |
|
|
72
|
+
| relatedTerms | 関連用語ID(配列) | 任意 |
|
|
73
|
+
| source | 出典/参考(URL等) | 任意 |
|
|
74
|
+
| status | `official` / `deprecated` / `candidate` など | 任意 |
|
|
75
|
+
| example | 用例(短い例文) | 任意 |
|
|
76
|
+
|
|
77
|
+
### 4.2 relatedTerms の運用
|
|
78
|
+
|
|
79
|
+
- `relatedTerms` は **用語ID(`tm-...`)** を列挙します。
|
|
80
|
+
- 関連が強い(同じ業務文脈でセットで出る)ものを中心にし、増やしすぎないことを推奨します。
|
|
81
|
+
|
|
82
|
+
## 5. 禁止事項
|
|
83
|
+
|
|
84
|
+
- 用語定義に実装詳細(クラス名、SQL、内部コード)を記載しない。
|
|
85
|
+
- 用語IDを未採番または重複させない。
|
|
86
|
+
- 曖昧語のみで定義を終えない。
|