specdojo 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +125 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +141 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -13,62 +13,50 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Technology Stack Detail Definition (TSD) Documentation Rules
|
|
15
15
|
|
|
16
|
-
`tsd-<term>.md`
|
|
16
|
+
`tsd-<term>.md` は、採用した技術や実行基盤の構成・設定・利用手順を定義する。構築・接続・日常利用を行う人と確認者が、対象環境で構成を再現し、採用設定と正常性を照合するために使う。
|
|
17
17
|
|
|
18
18
|
## 1. 全体方針
|
|
19
19
|
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
- 秘密値は記載せず、取得・保存・参照の方法を記載する。公開可能な接続方式、ポート、汎用ホスト名と、個人・組織固有の機密情報を区別する。
|
|
20
|
+
- 一冊は技術領域・接続関係・一連の利用場面を単位とし、目的を共有する複数技術を含めてよい。
|
|
21
|
+
- 採用値・推奨値・任意の選択肢・未決事項を区別し、根拠のない製品名・版・容量・並列数を補わない。
|
|
22
|
+
- 初期構築・接続設定・日常利用は必要に応じて分冊し、各設定の正本を一つにする。
|
|
23
|
+
- 再現に必要な設定・コマンド・補助スクリプトを記載する。アプリケーション内部設計・詳細 API 仕様・SQL 全文は対象外とする。
|
|
24
|
+
- **共通の運用**: 作成・維持・確認の役割は適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の動作確認に含めない。
|
|
26
25
|
|
|
27
26
|
## 2. 位置づけ
|
|
28
27
|
|
|
29
|
-
| 文書・情報 |
|
|
30
|
-
| -------------------- |
|
|
31
|
-
| `tsd-index` |
|
|
32
|
-
| `tsd-<term>` |
|
|
33
|
-
| 接続設定の分冊 |
|
|
34
|
-
| 日常利用の分冊 |
|
|
35
|
-
| 上位設計・非機能要件 |
|
|
36
|
-
| 運用設計・運用手順 |
|
|
28
|
+
| 文書・情報 | TSD との分担 |
|
|
29
|
+
| -------------------- | ----------------------------------------------------------- |
|
|
30
|
+
| `tsd-index` | 採用技術・区分・担当責務の一覧から詳細へ導く |
|
|
31
|
+
| `tsd-<term>` | 対象領域の構成・採用設定・再現手順の正本 |
|
|
32
|
+
| 接続設定の分冊 | 基盤導入を前提とするクライアント設定 |
|
|
33
|
+
| 日常利用の分冊 | 初期構築後の接続・再接続・起動・停止 |
|
|
34
|
+
| 上位設計・非機能要件 | 責務分界・品質要求・採用判断の根拠 |
|
|
35
|
+
| 運用設計・運用手順 | 体制・SLO・障害対応・バックアップ方針。技術固有の操作は TSD |
|
|
37
36
|
|
|
38
|
-
|
|
39
|
-
- ホスト、コンテナ、接続元端末などで役割が異なる場合は、構成図または対応表で境界を示す。
|
|
40
|
-
- 共通設定や技術一覧を転載せず、正本への参照でつなぐ。参照だけでは実行順が分からない場合は、前提の完了条件を併記する。
|
|
37
|
+
分冊では前提文書と完了条件、本書で定義する差分を示し、共通設定や技術一覧は参照する。
|
|
41
38
|
|
|
42
39
|
## 3. ファイル命名・ID規則
|
|
43
40
|
|
|
44
|
-
- ファイル名は `tsd-<term>.md`
|
|
45
|
-
- 接続設定は `tsd-<technology>-<client>.md`、日常利用は `tsd-<environment>-usage.md`
|
|
46
|
-
- `id` はファイル名の stem
|
|
47
|
-
- 配置先は `tsd-index.md` と同じ技術基盤の文書群とする。プロジェクトのディレクトリ構成を優先する。
|
|
41
|
+
- ファイル名は `tsd-<term>.md` とし、`<term>` は対象技術・基盤・接続関係を表す英小文字・数字・ハイフンとする。
|
|
42
|
+
- 接続設定は `tsd-<technology>-<client>.md`、日常利用は `tsd-<environment>-usage.md` のように用途を区別してよい。
|
|
43
|
+
- `id` はファイル名の stem に対応させ、配置はプロジェクトの構成に従って `tsd-index.md` と同じ文書群に置く。
|
|
48
44
|
|
|
49
45
|
## 4. 推奨 Frontmatter 項目
|
|
50
46
|
|
|
51
|
-
|
|
47
|
+
共通項目・型・必須性は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。
|
|
52
48
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
| `type` | ○ | `architecture` |
|
|
57
|
-
| `status` | ○ | `draft` / `ready` / `deprecated` |
|
|
58
|
-
| `rulebook` | 推奨 | `specdojo:tsd-rulebook` |
|
|
59
|
-
| `part_of` | 推奨 | 所属する `tsd-index` などの ID 配列 |
|
|
60
|
-
| `based_on` | 条件付き | 構成や設定の直接の根拠となる上位設計、基盤定義などの ID 配列 |
|
|
61
|
-
| `supersedes` | 条件付き | 既存の構成定義を置き換える場合の旧文書 ID 配列 |
|
|
62
|
-
|
|
63
|
-
接続設定や利用手順を分冊する場合は、前提となる技術基盤の文書を `based_on` に示す。参考として読んだだけの文書を、採用判断の根拠として列挙しない。
|
|
49
|
+
- `type` は `architecture`、`rulebook` は `specdojo:tsd-rulebook` とする。
|
|
50
|
+
- `part_of` には所属する `tsd-index` などの ID 配列を推奨する。
|
|
51
|
+
- `based_on` は構成・設定の直接の根拠となる上位設計や基盤定義がある場合に示す。接続設定・利用手順の分冊では前提の基盤文書を含める。
|
|
64
52
|
|
|
65
53
|
## 5. 本文要件
|
|
66
54
|
|
|
67
|
-
|
|
55
|
+
以下は内容要件であり、章の統合・分割・順序変更を認める。別冊へ委ねる条件付きの内容は、正本と前提の完了条件を示す。
|
|
68
56
|
|
|
69
57
|
| 内容 | 必須 | 目的・記述要件 |
|
|
70
58
|
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------- |
|
|
71
|
-
| 概要・位置づけ | ○ |
|
|
59
|
+
| 概要・位置づけ | ○ | 誰がどの作業・判断に使うか、目的、対象範囲・対象外、他文書との責務分担を示す |
|
|
72
60
|
| 対象環境・前提条件 | ○ | OS、実行環境、必要な権限、導入済みの依存、必要な資源を示す。特別な前提がない項目はその旨を書く |
|
|
73
61
|
| 全体構成・接続経路 | 条件付き | 複数のホスト、プロセス、クライアントを使う場合、配置、役割、通信方向、公開範囲を示す |
|
|
74
62
|
| 採用技術・設定 | ○ | 用途、採用する版・モデル・設定値、適用範囲、理由、制約を対応させる |
|
|
@@ -80,17 +68,15 @@ Technology Stack Detail Definition (TSD) Documentation Rules
|
|
|
80
68
|
| 更新・復旧・撤去 | 条件付き | 既存環境を変更する場合、切り戻し、旧方式との共存可否、設定・データの保持や削除の範囲を示す |
|
|
81
69
|
| 参照情報 | 任意 | 判断や手順の根拠となる公式情報、確認した版や日付、関連文書への導線を示す |
|
|
82
70
|
|
|
83
|
-
|
|
84
|
-
- 版や環境で手順が変わる場合は、適用条件を分ける。任意の設定を全利用者の必須条件として書かない。
|
|
85
|
-
- 手順を省略して別文書へ導く場合も、本書の開始条件と完了を判断する確認方法は残す。
|
|
71
|
+
冒頭に初期構築・接続設定・日常利用の対象と開始条件を示し、手順を別冊へ委ねても完了の確認方法は残す。版・環境別の条件と任意設定を分け、未決事項は論点と影響(当面の扱い)を記す。
|
|
86
72
|
|
|
87
73
|
## 6. 記述ガイド
|
|
88
74
|
|
|
89
75
|
### 6.1. 対象環境と責務分界
|
|
90
76
|
|
|
91
|
-
-
|
|
92
|
-
-
|
|
93
|
-
- OS
|
|
77
|
+
- 接続元端末・ホスト・コンテナを構成図か対応表で区別し、呼び名を各操作の実行場所と統一する。
|
|
78
|
+
- 導入先・設定保存先・作業ディレクトリ・実行ユーザーを特定する。
|
|
79
|
+
- OS・ハードウェア・資源・並列数の制約を採用理由に結び付け、検証済み構成と一般的な推奨を分ける。
|
|
94
80
|
|
|
95
81
|
### 6.2. 採用設定の表
|
|
96
82
|
|
|
@@ -103,14 +89,14 @@ Technology Stack Detail Definition (TSD) Documentation Rules
|
|
|
103
89
|
| 理由・制約 | 採用根拠、互換性、資源上の制約 |
|
|
104
90
|
| 反映・確認方法 | 再起動の要否、有効値の確認方法 |
|
|
105
91
|
|
|
106
|
-
|
|
92
|
+
設定ファイルと環境変数の優先順位・反映先、GUI 設定の画面項目名・保存先・反映条件を示す。
|
|
107
93
|
|
|
108
94
|
### 6.3. 導入・変更手順
|
|
109
95
|
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
96
|
+
- 順序付き手順と言語識別子付きコードブロックに、シェル・実行場所・事前条件を示す。
|
|
97
|
+
- 追加・部分変更・全体置換を区別し、既存の provider や利用者設定との統合方法を書く。
|
|
98
|
+
- 導入・起動・再起動・停止を分け、権限変更やデータ削除の影響・事前確認を添える。
|
|
99
|
+
- 移行では旧方式の停止・競合回避・切り戻しを示し、撤去では設定・認証状態・データの保持と削除を分ける。
|
|
114
100
|
|
|
115
101
|
### 6.4. 動作確認と切り分け
|
|
116
102
|
|
|
@@ -121,31 +107,28 @@ Technology Stack Detail Definition (TSD) Documentation Rules
|
|
|
121
107
|
| 期待結果 | 出力項目、状態、応答内容などの判定条件 |
|
|
122
108
|
| 失敗時の確認先 | 前提の依存、保存先、ログ、次の切り分け手順 |
|
|
123
109
|
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
-
|
|
110
|
+
- 対象に応じ、起動・疎通・認証・モデルや provider の識別子・最終利用を段階的に確認する。
|
|
111
|
+
- 期待結果は表示の丸写しを避け、版や環境に応じた合否判定項目を示す。
|
|
112
|
+
- 確認環境・未確認条件・残る確認方法を示し、未実施を成功と扱わない。
|
|
127
113
|
|
|
128
114
|
### 6.5. 継続利用と状態の保存
|
|
129
115
|
|
|
130
|
-
-
|
|
131
|
-
-
|
|
132
|
-
-
|
|
116
|
+
- 再接続・処理再開・プロセス再起動と、自動復旧の範囲を区別する。
|
|
117
|
+
- 再起動・再構築で保持・喪失する設定・認証状態・データ・セッションを示す。
|
|
118
|
+
- 資源制約・長時間実行では、監視項目・正常範囲・処理を減らす条件を示す。
|
|
133
119
|
|
|
134
120
|
### 6.6. 接続情報と秘密情報
|
|
135
121
|
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
-
-
|
|
122
|
+
- 接続方式・公開可能なポート・汎用ホスト名・API 基点は再現に必要なら記載する。
|
|
123
|
+
- 固有のホスト名・アカウント・URL は公開可否を判断し、機密ならプレースホルダーにする。
|
|
124
|
+
- 認証情報は実値に代えて取得・保存・参照方法を示し、設定例・出力例でも同じ扱いとする。
|
|
139
125
|
|
|
140
126
|
## 7. 禁止事項
|
|
141
127
|
|
|
142
|
-
| 禁止事項
|
|
143
|
-
|
|
|
144
|
-
|
|
|
145
|
-
|
|
|
146
|
-
|
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
| 技術一覧や他の TSD の設定を複数箇所で正本として管理する | 更新時に構成が食い違うため |
|
|
150
|
-
| 無関係な技術領域や独立した利用目的を一つの文書に詰め込む | 適用範囲と保守単位が分からなくなるため |
|
|
151
|
-
| 停止、削除、再構築を、状態やデータへの影響を示さず指示する | 復旧や継続利用に必要な状態を失うため |
|
|
128
|
+
| 禁止事項 | 理由 |
|
|
129
|
+
| -------------------------------------------------------------- | -------------------------------------- |
|
|
130
|
+
| 実行場所や適用条件が異なる手順を区別せず並べる | 誤った環境や権限で設定を変更するため |
|
|
131
|
+
| 未確認の構成や未採択の設定を、動作確認済み・採用済みとして書く | 実行と判断の前提を誤らせるため |
|
|
132
|
+
| 技術一覧や他の TSD の設定を複数箇所で正本として管理する | 更新時に構成が食い違うため |
|
|
133
|
+
| 無関係な技術領域や独立した利用目的を一つの文書に詰め込む | 適用範囲と保守単位が分からなくなるため |
|
|
134
|
+
| 停止、削除、再構築を、状態やデータへの影響を示さず指示する | 復旧や継続利用に必要な状態を失うため |
|
|
@@ -13,37 +13,21 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Test Strategy and Policy (TSP) Index Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
TSP は「全体として、どのようにテストで品質を担保するか」を明文化し、テスト設計・実施・受入判断の認識ズレを防ぎます。
|
|
18
|
-
|
|
19
|
-
TSP は「個別のテストケース集」ではありません。
|
|
20
|
-
各テストレベル(単体/内部結合/外部結合/総合/受入など)の **目的・範囲・体制**、および **フェーズ間の入口/出口条件(品質ゲート)** を合意することが主目的です。
|
|
16
|
+
テスト設計者・実施者・受入判断者が、各テストレベルの目的・範囲・体制と入口/出口条件(品質ゲート)を合意するための記述基準を定めます。
|
|
21
17
|
|
|
22
18
|
## 1. 全体方針
|
|
23
19
|
|
|
24
|
-
- TSP は **プロジェクト/システムのテストの全体像**(考え方)を定義します。
|
|
25
|
-
- 例: 「ドメインロジックは単体〜結合まで自動化し、UI は主要シナリオのみ E2E を行う」
|
|
26
20
|
- テスト戦略は全体の考え方・分配、テスト方針は各レベル・領域での具体的な判断基準を指します。
|
|
27
|
-
- TSP
|
|
28
|
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
- スコープ(対象/対象外)
|
|
33
|
-
- 品質ゲート(入口/出口条件)
|
|
34
|
-
- エビデンス(何をもって合否判断するか)
|
|
35
|
-
を明確に書きます。
|
|
36
|
-
- クリック手順の逐語列挙は避け、**業務行為/入力/期待結果**として要約します。
|
|
37
|
-
- 実装詳細(例: 物理テーブル名、SQL全文、実装クラス/関数名、特定ライブラリの設定値)は記載しません。
|
|
38
|
-
- TSP は原則 **`tsp-index` 1本** に統一します。分割ルールは [セクション 3](#3-ファイル命名id規則) 参照。
|
|
39
|
-
- 観点/条件の詳細は、`*c-index`(共通ルール)と `*c-<term>`(対象別)で管理します。
|
|
21
|
+
- TSP は BAC/SAC 等を根拠に、テスト全体の方針・品質ゲート・観点/条件設計の共通原則を定義します。責務の境界は [[specdojo:test-document-scope-standard|テストドキュメントスコープ定義標準]] に従います。
|
|
22
|
+
- レベル共通の採用基準・分配方針は `*c-index`、対象別の観点→ケース化と証跡リンクは `*c-<term>`、具体値・網羅展開・実行結果はテストコード/CI成果物を正とします。
|
|
23
|
+
- 原則 `tsp-index` 1本とし、分割時は「ファイル命名・ID規則」に従います。
|
|
24
|
+
- 共通の記述原則・禁止事項は [[specdojo:rulebook-authoring-standard|Rulebook 記述標準]] に従います。
|
|
25
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の検証に含めません。
|
|
40
26
|
|
|
41
27
|
## 2. 位置づけと用語定義
|
|
42
28
|
|
|
43
29
|
### 2.1. 位置づけ(他ドキュメントとの関係)
|
|
44
30
|
|
|
45
|
-
TSP と下位ドキュメント(テストカタログ、テストコード/CI成果物)の関係を示します。
|
|
46
|
-
|
|
47
31
|
```mermaid
|
|
48
32
|
flowchart BT
|
|
49
33
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -69,21 +53,16 @@ flowchart BT
|
|
|
69
53
|
|
|
70
54
|
### 2.2. 用語定義
|
|
71
55
|
|
|
72
|
-
| 用語 | 定義
|
|
73
|
-
| ---------------------- |
|
|
74
|
-
|
|
|
75
|
-
|
|
|
76
|
-
|
|
|
77
|
-
|
|
|
78
|
-
| 回帰(リグレッション) | 変更により既存機能が壊れていないことを確認する試験 |
|
|
79
|
-
| 重大度 | 不具合の影響度(業務影響/停止有無/回避可否など) |
|
|
80
|
-
| スタブ | テスト対象外の依存を置き換え、決め打ちの応答を返すことでテスト対象を動かすための代替実装 |
|
|
81
|
-
| モック | スタブの一種で、依存がどのように呼び出されたか(回数・引数・順序など)を検証できる代替実装 |
|
|
82
|
-
| スモーク | システムの基本的な動作確認を目的とした簡易試験 |
|
|
56
|
+
| 用語 | 定義 |
|
|
57
|
+
| ---------------------- | -------------------------------------------------- |
|
|
58
|
+
| 回帰(リグレッション) | 変更後も既存機能が成立することを確認する試験 |
|
|
59
|
+
| スタブ | 対象外の依存を置き換え、決めた応答を返す代替実装 |
|
|
60
|
+
| モック | 依存の呼び出し回数・引数・順序を検証できる代替実装 |
|
|
61
|
+
| スモーク | 基本動作の成立を確認する簡易試験 |
|
|
83
62
|
|
|
84
63
|
## 3. ファイル命名・ID規則
|
|
85
64
|
|
|
86
|
-
ID 命名ルールは [id-and-file-naming-standard
|
|
65
|
+
ID 命名ルールは [[specdojo:id-and-file-naming-standard|ドキュメントIDおよびファイル命名標準]] に従います。
|
|
87
66
|
|
|
88
67
|
- `id`: 小文字ハイフン形式で `tsp-<term>` の構造とします。
|
|
89
68
|
- **デフォルト: `tsp-index`** (全体方針の入口・概説)
|
|
@@ -97,21 +76,13 @@ ID 命名ルールは [id-and-file-naming-standard.md](../standards/id-and-file-
|
|
|
97
76
|
|
|
98
77
|
### 4.1. 設定内容
|
|
99
78
|
|
|
100
|
-
|
|
79
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
101
80
|
|
|
102
|
-
|
|
103
|
-
| ---------- | -------------------------------------------------- | ---- |
|
|
104
|
-
| id | TSP ID(`tsp-...`) | ○ |
|
|
105
|
-
| type | `test` 固定 | ○ |
|
|
106
|
-
| title | 方針名(例: テスト戦略・方針: 全体) | ○ |
|
|
107
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
108
|
-
| part_of | 集約ドキュメントへの所属(例: `tsp-index`) | 任意 |
|
|
109
|
-
| based_on | 参照する仕様ID(BAC/NFR/SAC/DEC/TSL/UIS/EAPIS 等) | 任意 |
|
|
110
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
81
|
+
- メタ情報は `specdojo:` 配下に置き、`type: test`、`rulebook: specdojo:tsp-index-rulebook` を指定します。
|
|
111
82
|
|
|
112
83
|
### 4.2. 推奨ルール
|
|
113
84
|
|
|
114
|
-
- `part_of`:
|
|
85
|
+
- `part_of`: 分割した個別方針から集約ドキュメント `tsp-index` を指定します。
|
|
115
86
|
- `based_on`: 方針の根拠となる主要仕様(BAC/NFR/SAC/DECなど)を列挙し、スコープを明確にする。
|
|
116
87
|
|
|
117
88
|
## 5. 本文構成(標準テンプレ)
|
|
@@ -121,7 +92,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
121
92
|
1. 概要
|
|
122
93
|
2. テストレベル一覧(目的/範囲/体制)と観点/条件設計の共通原則
|
|
123
94
|
3. スコープ(対象/対象外)
|
|
124
|
-
|
|
125
95
|
4. テスト環境・テストデータ(スタブ/モック方針を含む)
|
|
126
96
|
5. 入口/出口条件(品質ゲート)
|
|
127
97
|
6. 自動化・回帰方針(任意だが推奨)
|
|
@@ -142,58 +112,44 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
142
112
|
|
|
143
113
|
#### 6.2.1. 最小(必須)
|
|
144
114
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
| 列 | 目的 |
|
|
148
|
-
| ------------ | ---------------------------------------------- |
|
|
149
|
-
| テストレベル | 単体/結合/システム/受け入れ等 |
|
|
150
|
-
| 目的 | そのレベルで何を保証したいか |
|
|
151
|
-
| 範囲 | 対象(例: モジュール/画面/API/バッチ/外部I/F) |
|
|
152
|
-
|
|
153
|
-
| 実施体制・備考 | 実施主体、ツール、自動化方針、除外など |
|
|
115
|
+
最小構成(必須)の列は次の4列です。
|
|
154
116
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
117
|
+
| 列 | 目的 |
|
|
118
|
+
| -------------- | ---------------------------------------------- |
|
|
119
|
+
| テストレベル | 単体/結合/システム/受け入れ等 |
|
|
120
|
+
| 目的 | そのレベルで何を保証したいか |
|
|
121
|
+
| 範囲 | 対象(例: モジュール/画面/API/バッチ/外部I/F) |
|
|
122
|
+
| 実施体制・備考 | テストの実施主体、ツール、自動化方針、除外など |
|
|
159
123
|
|
|
160
124
|
#### 6.2.2. 推奨(責任分界を明確化)
|
|
161
125
|
|
|
162
|
-
|
|
126
|
+
各レベルの責任分界は一覧表で明文化します。「目的」「範囲」「実施体制・備考」に収まらない場合は、次の推奨列を追加します。
|
|
163
127
|
|
|
164
|
-
| 列 | 目的
|
|
165
|
-
| -------------------------- |
|
|
166
|
-
| 保証すること(合格の意味) |
|
|
167
|
-
| やらないこと(非目的) |
|
|
128
|
+
| 列 | 目的 |
|
|
129
|
+
| -------------------------- | -------------------------- |
|
|
130
|
+
| 保証すること(合格の意味) | 合格によって保証できること |
|
|
131
|
+
| やらないこと(非目的) | 他レベルへ委ねること |
|
|
168
132
|
|
|
169
133
|
例(外部I/Fの責任分界):
|
|
170
134
|
|
|
171
|
-
| テストレベル | 保証すること(合格の意味)
|
|
172
|
-
| -------------- |
|
|
173
|
-
| 単体テスト | I/F
|
|
174
|
-
| 外部結合テスト |
|
|
175
|
-
| 総合/受入 | BAC/SAC
|
|
135
|
+
| テストレベル | 保証すること(合格の意味) | やらないこと(非目的) | 前提(下位で保証済み) |
|
|
136
|
+
| -------------- | --------------------------------------------------------- | -------------------------------------------------------------------- | ----------------------------------- |
|
|
137
|
+
| 単体テスト | I/Fデータの生成・変換・検証が仕様どおり | 実ネットワークの導通、相手側の状態差分による挙動 | ドメイン/計算/検証の網羅 |
|
|
138
|
+
| 外部結合テスト | 認証・要求/応答形式とタイムアウト等の代表エラー対処が成立 | 相手側の内部整合・SLA・全機能の保証。一貫テストは導通/スモークに限定 | 内部結合で主要フローが成立 |
|
|
139
|
+
| 総合/受入 | BAC/SACの主要シナリオと合意範囲の外部I/Fを含むE2Eが成立 | 相手側の障害・性能・データ品質の全面保証 | 外部結合でI/F契約と代表エラーが成立 |
|
|
176
140
|
|
|
177
141
|
#### 6.2.3. 観点/条件設計の共通原則(必須)
|
|
178
142
|
|
|
179
|
-
|
|
143
|
+
観点/条件は、次の原則で定義します。
|
|
180
144
|
|
|
181
145
|
| 項目 | ルール | 最低限の記述要素 |
|
|
182
146
|
| -------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
183
147
|
| 定義粒度 | 1観点は「1つの合否命題」で定義する(1行に複数命題を混在させない)。1条件は「状態/入力の差分を表す1単位」とする。 | 観点名、条件名、期待結果を 1:1:1 で対応づける |
|
|
184
148
|
| 分類 | 観点/条件は最低限「正常・境界・例外・状態(遷移)」で分類する。非機能や運用起因が重要な場合は追加分類を定義する。 | 分類名、採用理由、どのレベルで担保するか |
|
|
185
|
-
| 判定軸 | 判定は「期待結果」「観測点」「合格条件」の3
|
|
186
|
-
|
|
187
|
-
補足:
|
|
188
|
-
|
|
189
|
-
- レベル共通の採用基準・分配方針は `*c-index` に記載する。
|
|
190
|
-
- 対象別の観点→ケース化と証跡リンクは `*c-<term>` に記載する。
|
|
191
|
-
- 具体値・網羅展開・実行結果はテストコード/CI成果物を正とする。
|
|
149
|
+
| 判定軸 | 判定は「期待結果」「観測点」「合格条件」の3点で定義する。 | 期待結果(何が起きるか)、観測点(どこで確認するか)、合格条件(Pass/Fail基準) |
|
|
192
150
|
|
|
193
151
|
### 6.3. スコープ(対象/対象外)
|
|
194
152
|
|
|
195
|
-
TSP は必ず「どこまでがテスト対象か」を定義します。
|
|
196
|
-
|
|
197
153
|
- 対象(含む)
|
|
198
154
|
- 対象外(除外)
|
|
199
155
|
- 除外の理由(任意)
|
|
@@ -205,9 +161,6 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
|
|
|
205
161
|
|
|
206
162
|
### 6.4. テスト環境・テストデータ
|
|
207
163
|
|
|
208
|
-
環境やデータの前提が曖昧だと、試験結果が比較できません。
|
|
209
|
-
次を“方針”として定義します。
|
|
210
|
-
|
|
211
164
|
- 環境区分(例: 開発/内部結合/外部結合/総合/受入)と用途
|
|
212
165
|
- データ方針(匿名化、代表データ量、マスタの扱い)
|
|
213
166
|
- 外部I/Fの扱い(実接続/スタブ/モック、切り替え方針)
|
|
@@ -234,35 +187,23 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
|
|
|
234
187
|
|
|
235
188
|
### 6.5. 入口/出口条件(品質ゲート)
|
|
236
189
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
推奨の書き方(表):
|
|
190
|
+
各レベルの開始前提・完了条件・判定根拠を次の列で定義します。
|
|
240
191
|
|
|
241
|
-
| フェーズ/テストレベル | 入口条件(開始条件) | 出口条件(完了条件)
|
|
242
|
-
| --------------------- | -------------------- |
|
|
243
|
-
|
|
|
244
|
-
| 内部結合テスト | … | … | … |
|
|
245
|
-
| 外部結合テスト | … | … | … |
|
|
246
|
-
| 総合テスト | … | … | … |
|
|
247
|
-
| 受け入れテスト | … | … | … |
|
|
248
|
-
|
|
249
|
-
記述のコツ:
|
|
192
|
+
| フェーズ/テストレベル | 入口条件(開始条件) | 出口条件(完了条件) | エビデンス(根拠) |
|
|
193
|
+
| --------------------- | -------------------- | ---------------------- | ------------------------ |
|
|
194
|
+
| 採用する各レベル | 前提・準備完了条件 | 合格基準・残課題の扱い | レポート・ログ・判定記録 |
|
|
250
195
|
|
|
251
196
|
- 出口条件には「未解決不具合の扱い(重大度別の許容)」を含めます。
|
|
252
197
|
- 非機能の出口条件は、可能なら NFR/SAC と接続します(例: 「全 NFR を満たす」)。
|
|
253
198
|
|
|
254
199
|
### 6.6. 自動化・回帰方針(任意)
|
|
255
200
|
|
|
256
|
-
自動化は “やる/やらない” ではなく、**どこを自動化し、どこを手動で補うか** を決めます。
|
|
257
|
-
|
|
258
201
|
- 自動化の優先領域(例: ドメインロジック、計算、バリデーション、回帰)
|
|
259
202
|
- 手動で行う領域(例: UX の探索、端末差異、教育/運用リハーサル)
|
|
260
203
|
- 回帰の基本方針(例: 変更影響のある領域は自動回帰を必須)
|
|
261
204
|
|
|
262
205
|
### 6.7. 不具合管理方針(任意)
|
|
263
206
|
|
|
264
|
-
不具合管理は、テスト成果の解釈ブレを防ぐために記載してよいです。
|
|
265
|
-
|
|
266
207
|
- 重大度(例: Blocker/Critical/Major/Minor)と判断観点(業務影響/回避可否)
|
|
267
208
|
- 収束基準(出口条件との関係)
|
|
268
209
|
- 既知不具合の扱い(残課題/例外承認/ロールバック条件)
|
|
@@ -277,27 +218,25 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
|
|
|
277
218
|
|
|
278
219
|
- 未確定の前提(例: ピーク時の定義、想定データ量、外部依存の SLA)
|
|
279
220
|
- 将来追加したい試験(例: DR 訓練、長期運用での監査手順、非機能の拡充)
|
|
221
|
+
- 未決の論点がスコープ・環境・品質ゲートのどこに影響し、決定までどう扱うかを記載します。
|
|
280
222
|
|
|
281
223
|
### 6.10. よくある誤りと対策
|
|
282
224
|
|
|
283
|
-
| 誤り | 対策
|
|
284
|
-
| ---------------------------- |
|
|
285
|
-
| テストレベルの役割分担が曖昧 | 「目的/範囲/体制」を表で固定する
|
|
286
|
-
| スコープが書かれていない |
|
|
287
|
-
| 入口/出口条件がない | 品質ゲート(開始/完了条件)を表で定義する
|
|
288
|
-
| 自動化の範囲が不明 | 自動化領域と手動領域を分けて記述する
|
|
289
|
-
| 不具合が残ったまま“完了”扱い | 重大度別許容と例外承認ルールを出口条件に含める
|
|
225
|
+
| 誤り | 対策 |
|
|
226
|
+
| ---------------------------- | ----------------------------------------------- |
|
|
227
|
+
| テストレベルの役割分担が曖昧 | 「目的/範囲/体制」を表で固定する |
|
|
228
|
+
| スコープが書かれていない | 「スコープ(対象/対象外)」を参照して不足を補う |
|
|
229
|
+
| 入口/出口条件がない | 品質ゲート(開始/完了条件)を表で定義する |
|
|
230
|
+
| 自動化の範囲が不明 | 自動化領域と手動領域を分けて記述する |
|
|
231
|
+
| 不具合が残ったまま“完了”扱い | 重大度別許容と例外承認ルールを出口条件に含める |
|
|
290
232
|
|
|
291
233
|
## 7. 禁止事項
|
|
292
234
|
|
|
293
|
-
| 項目
|
|
294
|
-
|
|
|
295
|
-
|
|
|
296
|
-
|
|
|
297
|
-
|
|
|
298
|
-
| 個別テストケースの大量列挙 | 下位成果物(`<level>s-<term>`、テストコード、CI成果物)に委譲すべき |
|
|
299
|
-
| 「十分」「適切」「問題ない」等の曖昧表現 | 合否判定不能 |
|
|
300
|
-
| 前提なしの数値(条件が不明) | 合意不能、再現不能 |
|
|
235
|
+
| 項目 | 理由 |
|
|
236
|
+
| ---------------------------- | -------------------------------------------------------------------------- |
|
|
237
|
+
| クリック/画面遷移の逐語列挙 | 業務行為・入力・期待結果として要約し、方針の判断を読み取れるようにするため |
|
|
238
|
+
| 個別テストケースの大量列挙 | `*c-<term>`、テストコード、CI成果物の責務であるため |
|
|
239
|
+
| 前提なしの数値(条件が不明) | 合意不能、再現不能 |
|
|
301
240
|
|
|
302
241
|
## 8. サンプル(最小)
|
|
303
242
|
|
|
@@ -305,26 +244,17 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
|
|
|
305
244
|
|
|
306
245
|
```yaml
|
|
307
246
|
---
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
status: draft
|
|
312
|
-
|
|
313
|
-
based_on:
|
|
314
|
-
- bac-sale-checkout
|
|
315
|
-
- bac-inventory-replenishment
|
|
316
|
-
- nfr-performance
|
|
317
|
-
- nfr-security
|
|
318
|
-
- sac-performance
|
|
319
|
-
- sac-disaster-recovery
|
|
320
|
-
supersedes: []
|
|
247
|
+
specdojo:
|
|
248
|
+
id: tsp-index
|
|
249
|
+
type: test
|
|
250
|
+
status: draft
|
|
251
|
+
rulebook: specdojo:tsp-index-rulebook
|
|
321
252
|
---
|
|
322
253
|
```
|
|
323
254
|
|
|
324
255
|
### 8.2. 概要
|
|
325
256
|
|
|
326
|
-
|
|
327
|
-
担保方法は、単体→内部結合→外部結合→総合→受入の順に確認し、入口/出口条件(品質ゲート)とエビデンス(BAC/SAC含む)で合否を判定する。
|
|
257
|
+
駄菓子屋販売管理システムを単体→内部結合→外部結合→総合→受入の順に確認し、品質ゲートと BAC/SAC に対応する証跡で合否を判定する。対象範囲は「スコープ(対象/対象外)」に示す。
|
|
328
258
|
|
|
329
259
|
### 8.3. テストレベル一覧
|
|
330
260
|
|
|
@@ -336,15 +266,13 @@ supersedes: []
|
|
|
336
266
|
| 総合テスト | E2E成立の確認 | 販売→在庫→発注→入荷→棚卸→レポート | テスト担当・業務担当。代表データ量で実運用相当を確認 |
|
|
337
267
|
| 受け入れテスト | BAC/SACで合否判定 | 受入シナリオ(BAC/SAC準拠) | 業務担当。承認をもって完了 |
|
|
338
268
|
|
|
339
|
-
補足: 結合テストは「社内境界(内部)」と「外部境界(外部)」で分け、切り分け容易性を上げる。
|
|
340
|
-
|
|
341
269
|
#### 8.3.1. 観点/条件設計の共通原則(例)
|
|
342
270
|
|
|
343
|
-
| 項目 | ルール(例)
|
|
344
|
-
| -------- |
|
|
345
|
-
| 定義粒度 | 1
|
|
346
|
-
| 分類 |
|
|
347
|
-
| 判定軸 |
|
|
271
|
+
| 項目 | ルール(例) |
|
|
272
|
+
| -------- | ------------------------------------------------------------------------------------------------- |
|
|
273
|
+
| 定義粒度 | 決済要求の妥当性を1観点とし、必須項目の欠落を1条件、検証エラー応答を期待結果とする |
|
|
274
|
+
| 分類 | 正常・境界・例外・状態(遷移)を採用。決済タイムアウトは例外に分類し外部結合で担保する |
|
|
275
|
+
| 判定軸 | タイムアウト後の再送で二重決済が発生しないことを、決済履歴の取引ID別件数が1件であることで判定する |
|
|
348
276
|
|
|
349
277
|
### 8.4. スコープ(対象/対象外)
|
|
350
278
|
|
|
@@ -386,10 +314,7 @@ supersedes: []
|
|
|
386
314
|
|
|
387
315
|
### 8.8. 成果物(エビデンス)の最小セット(例)
|
|
388
316
|
|
|
389
|
-
|
|
390
|
-
- 総合テスト結果(主要シナリオの結果)
|
|
391
|
-
- NFR/SACに対応する試験レポート(性能/可用性/セキュリティの合否)
|
|
392
|
-
- 受入判定記録(承認、残課題の扱い)
|
|
317
|
+
「入口/出口条件(例)」のエビデンス列を最小セットとする。受入判定記録には承認と残課題の扱いを含める。
|
|
393
318
|
|
|
394
319
|
### 8.9. メモ / 将来課題
|
|
395
320
|
|