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
|
@@ -11,105 +11,103 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Requirements Traceability (Requirements to Specs) Rulebook
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
仕様成果物の型付き ID 参照から要求と仕様の対応を派生ビューとして示し、要求漏れ・仕様漏れを見つける形式を定めます。
|
|
15
15
|
|
|
16
16
|
## 1. 全体方針
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
- 1 行は 1
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
- 本ビューは必要なプロジェクトで生成する任意の管理ビューとし、独立した成果物ドメインやトラックを持たない。
|
|
18
|
+
- **対象**: 要求と仕様の対応の可視化を扱い、要求・仕様の本文は扱いません。
|
|
19
|
+
- **正本と派生**: 対応の正本は仕様成果物の `relations.satisfies` とし、本ビューは派生ビューとして生成します。「目的と適用範囲」と「トレース対象の前提」は生成の条件として書き、「トレースマトリクス」「充足状況サマリ」「ギャップと対応方針」は生成元から導出します。
|
|
20
|
+
- **記載レベル**: 1 行は 1 つの要求 ID とその対応仕様 ID 群とします。
|
|
21
|
+
- **任意の管理ビュー**: 必要なプロジェクトだけが生成し、独自のドメインやトラックを持ちません。
|
|
22
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
24
23
|
|
|
25
|
-
## 2.
|
|
24
|
+
## 2. 位置づけ
|
|
26
25
|
|
|
27
|
-
|
|
28
|
-
| ---------- | --------------------------------------------------------------- |
|
|
29
|
-
| 要求ID | 要求を一意に識別する ID(例: `req-` 系) |
|
|
30
|
-
| 対応仕様ID | 要求を実現する仕様を一意に識別する ID(例: `bac-` / `bes-` 系) |
|
|
31
|
-
|
|
32
|
-
| 充足状況 | 要求に対する仕様整備の達成状態(未着手 / 一部充足 / 充足) |
|
|
33
|
-
| ギャップ | 要求と仕様の間に残る不足・不整合・未確定事項 |
|
|
26
|
+
本ビューは、要求(業務の受入基準 `bac-*` など)と、それを充足する仕様(システム化機能 `sf-*`、業務仕様 `bes-*` など)の作成後に生成し、仕様のレビュー時と要求・仕様の変更時に再生成します。要求→テストの対応は [[specdojo:trc-requirements-to-tests-rulebook|トレーサビリティ(要求→テスト)作成ルール]] が扱います。
|
|
34
27
|
|
|
35
28
|
## 3. ファイル命名・ID規則
|
|
36
29
|
|
|
37
|
-
-
|
|
38
|
-
|
|
39
|
-
- 推奨ファイル名は `trc-requirements-to-specs.md` とする。
|
|
40
|
-
- 本 rulebook の ID は `specdojo:trc-requirements-to-specs-rulebook` とする。
|
|
41
|
-
- 追加分割が必要な場合は `trc-requirements-to-specs-<term>` 形式を用いる。
|
|
30
|
+
- **ファイル名**: `trc-requirements-to-specs.md` とします。分割する場合は `trc-requirements-to-specs-<term>.md` とします。
|
|
31
|
+
- **文書 ID**: 成果物カタログの宣言と一致させます。プロダクト仕様のカタログに置く場合は `trc-requirements-to-specs`、プロジェクト固有の場合は `<project-id>:trc-requirements-to-specs` とします(分割時は末尾に `-<term>`)。
|
|
42
32
|
|
|
43
33
|
## 4. 推奨 Frontmatter 項目
|
|
44
34
|
|
|
45
|
-
[document-metadata-standard
|
|
35
|
+
許可キーと型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
46
36
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
| id | `trc-requirements-to-specs` | ○ |
|
|
50
|
-
| type | `project` | ○ |
|
|
51
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
52
|
-
| rulebook | `specdojo:trc-requirements-to-specs-rulebook` | ○ |
|
|
53
|
-
| based_on | 生成元となる要求・仕様の ID 配列 | 任意 |
|
|
54
|
-
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
37
|
+
- `specdojo.rulebook` は `specdojo:trc-requirements-to-specs-rulebook` とします。
|
|
38
|
+
- `specdojo.based_on` には、生成元とした要求・仕様の文書 ID を記載します。
|
|
55
39
|
|
|
56
|
-
## 5.
|
|
40
|
+
## 5. 本文要件
|
|
57
41
|
|
|
58
|
-
| 章
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
|
|
|
65
|
-
|
|
|
42
|
+
| 章 | 必須 | 内容・受入条件 |
|
|
43
|
+
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
|
|
44
|
+
| 目的と適用範囲 | 必須 | 対象の要求群・仕様群と対象外(理由付き)が分かること |
|
|
45
|
+
| トレース対象の前提 | 必須 | 生成元の ID 体系と範囲、トレース単位(1:1 / 1:N / N:1)、生成の手段(コマンドまたは手順)と生成日が分かること |
|
|
46
|
+
| トレースマトリクス | 必須 | 標準6列で全要求を並べ、対応仕様のない要求と、どの要求にも対応しない仕様が識別できること |
|
|
47
|
+
| 充足状況サマリ | 必須 | 充足状況ごとの件数と、優先して解消する要求 ID が分かること |
|
|
48
|
+
| ギャップと対応方針 | 必須 | ギャップごとに、直す生成元の成果物と解消の判定条件が分かること |
|
|
49
|
+
| 変更履歴と更新ルール | 条件付き | 再生成の契機や前回からの差分を残す必要があるときに置き、生成日と差分の要点を示す |
|
|
66
50
|
|
|
67
|
-
|
|
51
|
+
### 5.1. トレースマトリクスの標準列
|
|
68
52
|
|
|
69
|
-
|
|
53
|
+
| 列名 | 内容・判断条件 |
|
|
54
|
+
| ---------- | ------------------------------------------------------------------------------------- |
|
|
55
|
+
| 要求ID | 追跡対象の要求 ID |
|
|
56
|
+
| 要求要約 | 要求の要点を 1 行で示す |
|
|
57
|
+
| 対応仕様ID | その要求 ID を `relations.satisfies` に持つ仕様 ID(複数可、なければ空とせず `なし`) |
|
|
58
|
+
| 充足状況 | `未着手` / `一部充足` / `充足`。判定は「充足状況の判定」に従う |
|
|
59
|
+
| ギャップ | 未対応点・不整合・未決事項。なければ `なし` |
|
|
60
|
+
| 備考 | 判定の根拠(参照先の `status`、review result など) |
|
|
70
61
|
|
|
71
|
-
|
|
72
|
-
- 対象外(例: 廃止要求、移管済み要求)がある場合は理由付きで記載する。
|
|
62
|
+
どの要求にも対応しない仕様は、同じ表の末尾に要求ID を `なし` として並べるか、別の表で示します。
|
|
73
63
|
|
|
74
|
-
###
|
|
64
|
+
### 5.2. 充足状況の判定
|
|
65
|
+
|
|
66
|
+
| 充足状況 | 条件 |
|
|
67
|
+
| ---------- | ------------------------------------------------------------------ |
|
|
68
|
+
| `未着手` | その要求を `relations.satisfies` に持つ仕様がない |
|
|
69
|
+
| `一部充足` | 対応仕様はあるが、参照先が未作成・`draft` であるか、ギャップが残る |
|
|
70
|
+
| `充足` | 対応仕様がすべて存在して `ready` であり、ギャップが `なし` |
|
|
75
71
|
|
|
76
|
-
|
|
77
|
-
|
|
72
|
+
## 6. 記述ガイド
|
|
73
|
+
|
|
74
|
+
完成例は Frontmatter の `sample` で宣言された sample を参照してください。
|
|
75
|
+
|
|
76
|
+
### 6.1. 目的と適用範囲
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
- **判断基準**: 誰がどのレビュー・変更判断に使い、どのリリースや領域の要求を対象とするかが分かること。
|
|
79
|
+
- **良い例**: 「第 1 リリースの会計・在庫・値引き・監査の要求と、それを充足する仕様の対応を示し、仕様レビューで要求漏れを見つける。次期リリースの要求は対象外とする。」
|
|
80
|
+
- **悪い例**: 「要求と仕様の対応を管理する。」(対象範囲と使う場面が分からない)
|
|
80
81
|
|
|
81
|
-
|
|
82
|
+
### 6.2. トレース対象の前提
|
|
82
83
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
| 要求要約 | 要求内容の要点(1 行) |
|
|
87
|
-
| 対応仕様ID | 対応する仕様 ID(複数可) |
|
|
88
|
-
| 充足状況 | `未着手` / `一部充足` / `充足` |
|
|
89
|
-
| ギャップ | 未対応点・不整合・要確認事項 |
|
|
90
|
-
| 備考 | 根拠、判断日、関連チケットなど |
|
|
84
|
+
- **判断基準**: 別の人が同じ前提で再生成し、同じ表を得られること。
|
|
85
|
+
- **良い例**: 「生成元: `bac-*` と、`relations.satisfies` を持つ `sf-*`・`bes-*`。生成: `<生成コマンド>` で 2026-05-01 に生成。」
|
|
86
|
+
- **悪い例**: 「最新の仕様から作成した。」(生成元の範囲と手段が分からず、検証できない)
|
|
91
87
|
|
|
92
|
-
### 6.
|
|
88
|
+
### 6.3. トレースマトリクスと充足状況サマリ
|
|
93
89
|
|
|
94
|
-
-
|
|
95
|
-
-
|
|
90
|
+
- **判断基準**: 各行の充足状況が「充足状況の判定」の条件から説明でき、サマリの件数が表と一致すること。
|
|
91
|
+
- **良い例**: 「req-r1-002 / 在庫引当をリアルタイムで更新する / bes-stock-allocation, ifx-msg-stock / 一部充足 / 障害時の再送仕様が未確定 / `ifx-msg-stock` が `draft`」
|
|
92
|
+
- **悪い例**: 「req-r1-002 / … / ほぼ対応 / ― / ―」(曖昧語で判定できず、根拠がない)
|
|
96
93
|
|
|
97
|
-
### 6.
|
|
94
|
+
### 6.4. ギャップと対応方針
|
|
98
95
|
|
|
99
|
-
-
|
|
100
|
-
-
|
|
96
|
+
- **判断基準**: 解消は本ビューでなく生成元の成果物で行うこととし、どの成果物をどう直せば解消と判定するかが分かること。担当・期限は登録簿で追跡し、本ビューに列を設けません。
|
|
97
|
+
- **良い例**: 「req-r1-004 / 監査ログの保持先が未決定 / `bes-audit-log` に保持方針を追記し `relations.satisfies` に req-r1-004 を持たせる / 再生成で `充足` になる」
|
|
98
|
+
- **悪い例**: 「監査ログは今後対応する。」(直す成果物も判定条件もない)
|
|
101
99
|
|
|
102
|
-
### 6.
|
|
100
|
+
### 6.5. 変更履歴と更新ルール
|
|
103
101
|
|
|
104
|
-
-
|
|
105
|
-
- 充足状況やギャップをビューへ直接入力せず、生成元となる成果物または検証結果へ記録する。
|
|
102
|
+
- **判断基準**: 再生成の契機(要求・仕様の追加、ID 参照の変更、仕様の `status` 変更)と、前回から充足状況が変わった要求 ID が分かること。
|
|
106
103
|
|
|
107
104
|
## 7. 禁止事項
|
|
108
105
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
106
|
+
| 禁止パターン | 理由 |
|
|
107
|
+
| ------------------------------------------------------------------------ | -------------------------------------------------- |
|
|
108
|
+
| 生成した表を手編集し、`relations.satisfies` と異なる対応や充足状況を書く | 正本と派生ビューが食い違い、再生成で消えるため |
|
|
109
|
+
| 要求本文・仕様本文の全文転記 | 正本との二重管理になり、更新時に不整合が出るため |
|
|
110
|
+
| 要求 ID または対応仕様 ID の空欄 | 未対応なのか記入漏れなのか判別できないため |
|
|
111
|
+
| 充足状況に曖昧語(ほぼ対応、だいたい完了など)を使う | 「充足状況の判定」の条件で確かめられないため |
|
|
112
|
+
| 対応仕様 ID が `なし` の行でギャップを `なし` とする | 要求漏れが表から隠れるため |
|
|
113
|
+
| 「トレース対象の前提」に生成元と生成手段を書かずに表を示す | 再生成して照合できず、表が正しいか検証できないため |
|
|
@@ -11,108 +11,101 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Requirements Traceability (Requirements to Tests) Rulebook
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
テスト成果物の型付き ID 参照から要求とテストの対応を派生ビューとして示し、要求漏れ・テスト漏れを見つける形式を定めます。
|
|
15
15
|
|
|
16
16
|
## 1. 全体方針
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
- 1 行は 1
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
- 本ビューは必要なプロジェクトで生成する任意の管理ビューとし、独立した成果物ドメインやトラックを持たない。
|
|
18
|
+
- **対象**: 要求とテストの対応の可視化を扱い、要求本文・テスト手順は扱いません。テストの実行結果も扱わず、充足状況はテストの対応と作成状態で判定します。
|
|
19
|
+
- **正本と派生**: 対応の正本はテスト成果物の `relations.verifies` とし、本ビューは派生ビューとして生成します。「目的と適用範囲」と「トレース対象の前提」は生成の条件として書き、「トレースマトリクス」「充足状況サマリ」「ギャップと対応方針」は生成元から導出します。充足状況やギャップを直すときは生成元の成果物を直して再生成し、本ビューへ直接書きません。
|
|
20
|
+
- **記載レベル**: 1 行は 1 つの要求 ID とその対応テスト ID 群とします。
|
|
21
|
+
- **任意の管理ビュー**: 必要なプロジェクトだけが生成し、独自のドメインやトラックを持ちません。
|
|
22
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
24
23
|
|
|
25
|
-
## 2.
|
|
24
|
+
## 2. 位置づけ
|
|
26
25
|
|
|
27
|
-
|
|
28
|
-
| ------------ | -------------------------------------------------------------------------- |
|
|
29
|
-
| 要求ID | 要求を一意に識別する ID(例: `req-` 系) |
|
|
30
|
-
| 対応テストID | 要求を検証するテストを一意に識別する ID(例: `utc-` / `itc-` / `atc-` 系) |
|
|
31
|
-
|
|
32
|
-
| 充足状況 | 要求に対するテスト整備の達成状態(未着手 / 一部充足 / 充足) |
|
|
33
|
-
| ギャップ | 要求とテストの間に残る不足・不整合・未確定事項 |
|
|
26
|
+
本ビューは、要求(業務の受入基準 `bac-*` など)と、それを検証するテスト(受入テスト `atc-*`、総合テスト `stc-*` など)の作成後に生成し、テストのレビュー時と要求・テストの変更時に再生成します。要求→仕様の対応は [[specdojo:trc-requirements-to-specs-rulebook|トレーサビリティ(要求→仕様)作成ルール]] が扱います。
|
|
34
27
|
|
|
35
28
|
## 3. ファイル命名・ID規則
|
|
36
29
|
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
- 本 rulebook の ID は `specdojo:trc-requirements-to-tests-rulebook` とする。
|
|
40
|
-
- 追加分割が必要な場合は `trc-requirements-to-tests-<term>` 形式を用いる。
|
|
30
|
+
- **ファイル名**: `trc-requirements-to-tests.md` とします。分割する場合は `trc-requirements-to-tests-<term>.md` とします。
|
|
31
|
+
- **文書 ID**: 成果物カタログの宣言と一致させます。プロダクト仕様のカタログに置く場合は `trc-requirements-to-tests`、プロジェクト固有の場合は `<project-id>:trc-requirements-to-tests` とします(分割時は末尾に `-<term>`)。
|
|
41
32
|
|
|
42
33
|
## 4. 推奨 Frontmatter 項目
|
|
43
34
|
|
|
44
|
-
[document-metadata-standard
|
|
45
|
-
|
|
46
|
-
| 項目 | 説明 | 必須 |
|
|
47
|
-
| -------- | --------------------------------------------- | ---- |
|
|
48
|
-
| id | `trc-requirements-to-tests` | ○ |
|
|
49
|
-
| type | `project` | ○ |
|
|
50
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
51
|
-
| rulebook | `specdojo:trc-requirements-to-tests-rulebook` | ○ |
|
|
35
|
+
許可キーと型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
52
36
|
|
|
53
|
-
|
|
54
|
-
|
|
37
|
+
- `specdojo.rulebook` は `specdojo:trc-requirements-to-tests-rulebook` とします。
|
|
38
|
+
- `specdojo.based_on` は必須とし、生成元とした要求とテストの文書 ID をすべて記載します。索引だけを挙げて要求側を省きません。
|
|
55
39
|
|
|
56
|
-
## 5.
|
|
40
|
+
## 5. 本文要件
|
|
57
41
|
|
|
58
|
-
| 章
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
|
|
|
65
|
-
|
|
|
42
|
+
| 章 | 必須 | 内容・受入条件 |
|
|
43
|
+
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
44
|
+
| 目的と適用範囲 | 必須 | 対象の要求群・テスト群と対象外(理由付き)が分かること |
|
|
45
|
+
| トレース対象の前提 | 必須 | 要求の母集団(`based_on` の要求文書の全要求 ID)、テストの範囲、生成の手段(コマンドまたは手順)と生成日が分かること |
|
|
46
|
+
| トレースマトリクス | 必須 | 標準6列で母集団の全要求を並べ、テストのない要求と、母集団にない要求 ID を `relations.verifies` に持つテストが識別できること |
|
|
47
|
+
| 充足状況サマリ | 必須 | 充足状況ごとの要求 ID の件数(重複なし、合計が母集団の件数と一致)と、優先して解消する要求 ID が分かること |
|
|
48
|
+
| ギャップと対応方針 | 必須 | ギャップごとに、直す生成元の成果物と解消の判定条件が分かること |
|
|
49
|
+
| 変更履歴と更新ルール | 条件付き | 再生成の契機や前回からの差分を残す必要があるときに置き、生成日と差分の要点を示す |
|
|
66
50
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
### 6.1. 目的と適用範囲
|
|
51
|
+
### 5.1. トレースマトリクスの標準列
|
|
70
52
|
|
|
71
|
-
|
|
72
|
-
|
|
53
|
+
| 列名 | 内容・判断条件 |
|
|
54
|
+
| ------------ | ----------------------------------------------------------------------------------------- |
|
|
55
|
+
| 要求ID | 母集団の要求 ID。母集団にない参照は `なし` とし、その参照を持つテストを対応テストIDに書く |
|
|
56
|
+
| 要求要約 | 要求文書の記述から要点を 1 行で示す |
|
|
57
|
+
| 対応テストID | その要求 ID を `relations.verifies` に持つテスト ID(複数可、なければ空とせず `なし`) |
|
|
58
|
+
| 充足状況 | `未着手` / `一部充足` / `充足`。判定は「充足状況の判定」に従う |
|
|
59
|
+
| ギャップ | 未対応点・不整合・未決事項。なければ `なし` |
|
|
60
|
+
| 備考 | 判定の根拠(参照先の `status`、review result など) |
|
|
73
61
|
|
|
74
|
-
###
|
|
62
|
+
### 5.2. 充足状況の判定
|
|
75
63
|
|
|
76
|
-
|
|
77
|
-
|
|
64
|
+
| 充足状況 | 条件 |
|
|
65
|
+
| ---------- | -------------------------------------------------------------------- |
|
|
66
|
+
| `未着手` | その要求を `relations.verifies` に持つテストがない |
|
|
67
|
+
| `一部充足` | 対応テストはあるが、参照先が未作成・`draft` であるか、ギャップが残る |
|
|
68
|
+
| `充足` | 対応テストがすべて存在して `ready` であり、ギャップが `なし` |
|
|
78
69
|
|
|
79
|
-
|
|
70
|
+
## 6. 記述ガイド
|
|
80
71
|
|
|
81
|
-
|
|
72
|
+
完成例は Frontmatter の `sample` で宣言された sample を参照してください。
|
|
82
73
|
|
|
83
|
-
|
|
84
|
-
| -------- | ---------------------- |
|
|
85
|
-
| 要求ID | 追跡対象の要求 ID |
|
|
86
|
-
| 要求要約 | 要求内容の要点(1 行) |
|
|
74
|
+
### 6.1. 目的と適用範囲
|
|
87
75
|
|
|
88
|
-
|
|
76
|
+
- **判断基準**: 誰がどのレビュー・受入判断に使い、どのリリースや領域の要求を対象とするかが分かること。
|
|
77
|
+
- **良い例**: 「第 1 リリースの会計・在庫・値引き・監査の受入基準と、それを検証する受入テスト・総合テストの対応を示し、テストレビューでテスト漏れを見つける。性能試験は対象外とする。」
|
|
78
|
+
- **悪い例**: 「要求とテストの対応を管理する。」(対象範囲と使う場面が分からない)
|
|
89
79
|
|
|
90
|
-
|
|
91
|
-
| ギャップ | 未対応点・不整合・要確認事項 |
|
|
92
|
-
| 備考 | 根拠、判断日、関連チケットなど |
|
|
80
|
+
### 6.2. トレース対象の前提
|
|
93
81
|
|
|
94
|
-
|
|
82
|
+
- **判断基準**: 別の人が同じ前提で再生成し、同じ表を得られること。
|
|
83
|
+
- **良い例**: 「要求の母集団: `bac-sales` の全受入基準。テスト: `relations.verifies` を持つ `atc-*`・`stc-*`。生成: `<生成コマンド>` で 2026-05-01 に生成。」
|
|
84
|
+
- **悪い例**: 「最新のテストから作成した。」(母集団と生成の手段が分からず、検証できない)
|
|
95
85
|
|
|
96
|
-
|
|
97
|
-
- 重大ギャップ(受入判定に影響する項目)は個別 ID を記載して強調する。
|
|
86
|
+
### 6.3. トレースマトリクスと充足状況サマリ
|
|
98
87
|
|
|
99
|
-
|
|
88
|
+
- **判断基準**: 各行の充足状況が「充足状況の判定」の条件から説明でき、サマリの件数が表の要求 ID 数と一致すること。
|
|
89
|
+
- **良い例**: 「req-r1-004 / 監査ログを 1 年保持する / なし / 未着手 / 保持期間を検証するテストがない / ―」
|
|
90
|
+
- **悪い例**: 「req-r1-002 / … / ほぼ対応 / ― / ―」(曖昧語で判定できず、根拠がない)
|
|
100
91
|
|
|
101
|
-
|
|
102
|
-
- 方針未確定の場合は _UNDECIDED_: ラベルで暫定状態を明示する。
|
|
92
|
+
### 6.4. ギャップと対応方針
|
|
103
93
|
|
|
104
|
-
|
|
94
|
+
- **判断基準**: どの生成元の成果物をどう直せば解消と判定するかが分かること。担当・期限は登録簿で追跡し、本ビューに列を設けません。
|
|
95
|
+
- **良い例**: 「req-r1-004 / 保持期間の受入テストがない / `atc-audit-retention` を作成し `relations.verifies` に req-r1-004 を持たせる / 再生成で `一部充足` 以上になる」
|
|
96
|
+
- **悪い例**: 「監査ログのテストは今後対応する。」(直す成果物も判定条件もない)
|
|
105
97
|
|
|
106
|
-
|
|
98
|
+
### 6.5. 変更履歴と更新ルール
|
|
107
99
|
|
|
108
|
-
-
|
|
100
|
+
- **判断基準**: 再生成の契機(要求・テストの追加、ID 参照の変更、テストの `status` 変更)と、前回から充足状況が変わった要求 ID が分かること。
|
|
109
101
|
|
|
110
102
|
## 7. 禁止事項
|
|
111
103
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
104
|
+
| 禁止パターン | 理由 |
|
|
105
|
+
| ----------------------------------------------------------------------- | -------------------------------------------------- |
|
|
106
|
+
| 生成した表を手編集し、`relations.verifies` と異なる対応や充足状況を書く | 正本と派生ビューが食い違い、再生成で消えるため |
|
|
107
|
+
| 要求本文・テスト本文の全文転記 | 正本との二重管理になり、更新時に不整合が出るため |
|
|
108
|
+
| 要求 ID または対応テスト ID の空欄 | 未対応なのか記入漏れなのか判別できないため |
|
|
109
|
+
| 充足状況に曖昧語(ほぼ対応、だいたい完了など)を使う | 「充足状況の判定」の条件で確かめられないため |
|
|
110
|
+
| 対応テスト ID が `なし` の行でギャップを `なし` とする | テスト漏れが表から隠れるため |
|
|
111
|
+
| 「トレース対象の前提」に母集団と生成手段を書かずに表を示す | 再生成して照合できず、表が正しいか検証できないため |
|
|
@@ -13,51 +13,41 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Technology Stack Index (TSD Index) Documentation Rules
|
|
15
15
|
|
|
16
|
-
`tsd-index.md`
|
|
16
|
+
`tsd-index.md` は、採用技術と担当責務を俯瞰し、構築・実装・運用・変更時に詳細な構成や設定の正本へ導く入口文書である。
|
|
17
17
|
|
|
18
18
|
## 1. 全体方針
|
|
19
19
|
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
- 詳細な設定、構築手順、接続方法、資源制約は `tsd-<term>` または設定ファイルなどの正本へ委ねる。
|
|
25
|
-
- 版の粒度と参照元を明確にし、lockfile や詳細 TSD と異なる固定値を二重管理しない。
|
|
20
|
+
- 合意した対象範囲につき一覧の正本を一つにする。複数システムの場合も範囲を明示する。
|
|
21
|
+
- 全依存パッケージではなく、構成や作業の前提として把握すべき技術を選ぶ。網羅範囲は「区分と網羅範囲」に従う。
|
|
22
|
+
- 詳細な設定・手順・資源制約は「位置づけ」の正本に委ね、版や採用状態は「版と採用状態」に従う。
|
|
23
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
26
24
|
|
|
27
25
|
## 2. 位置づけ
|
|
28
26
|
|
|
29
|
-
| 文書・情報 | 役割
|
|
30
|
-
| ------------------------ |
|
|
31
|
-
| `tsd-index` |
|
|
32
|
-
| `tsd-<term>` |
|
|
33
|
-
| 接続設定・日常利用の TSD |
|
|
34
|
-
| 設定ファイル・依存定義 |
|
|
35
|
-
| 採用判断の記録 |
|
|
27
|
+
| 文書・情報 | 役割 | 一覧からの導線 |
|
|
28
|
+
| ------------------------ | ------------------------ | -------------------------------- |
|
|
29
|
+
| `tsd-index` | 採用技術と担当責務の一覧 | 対象範囲を俯瞰する入口 |
|
|
30
|
+
| `tsd-<term>` | 技術領域・実行基盤の詳細 | 構成・前提・設定・導入・動作確認 |
|
|
31
|
+
| 接続設定・日常利用の TSD | クライアント設定や操作 | 初期構築と利用手順を区別する |
|
|
32
|
+
| 設定ファイル・依存定義 | 適用する版・設定の正本 | 正確な版・有効設定 |
|
|
33
|
+
| 採用判断の記録 | 選定理由と未決事項 | 一覧で説明しきれない判断の根拠 |
|
|
36
34
|
|
|
37
|
-
- 詳細 TSD
|
|
38
|
-
-
|
|
39
|
-
- 同じ技術を複数の用途で使う場合は、責務を一行にまとめるか、適用範囲を明示して行を分ける。説明のない重複は作らない。
|
|
35
|
+
- 詳細 TSD が未作成でも、採用を確認できた技術と責務は記載できる。
|
|
36
|
+
- 同じ技術の複数用途は責務を一行にまとめるか、適用範囲で行を分ける。
|
|
40
37
|
|
|
41
38
|
## 3. ファイル命名・ID規則
|
|
42
39
|
|
|
43
40
|
- ファイル名は `tsd-index.md` とする。
|
|
44
|
-
- `id` は `tsd-index`
|
|
45
|
-
-
|
|
46
|
-
- 環境や領域ごとの補足を分冊する場合も、全体一覧の正本を複製せず、本書から参照する。
|
|
41
|
+
- `id` は `tsd-index` を基準とし、名前空間と一意性は共通のメタデータ規約に従う。
|
|
42
|
+
- アーキテクチャまたは技術基盤の文書群に詳細な `tsd-<term>.md` とまとめる。環境・領域別の補足は一覧を複製せず参照する。
|
|
47
43
|
|
|
48
44
|
## 4. 推奨 Frontmatter 項目
|
|
49
45
|
|
|
50
|
-
|
|
46
|
+
共通項目・必須性・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と成果物の Frontmatter スキーマに従う。
|
|
51
47
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
| `type` | ○ | `architecture` |
|
|
56
|
-
| `status` | ○ | `draft` / `ready` / `deprecated` |
|
|
57
|
-
| `rulebook` | 推奨 | `specdojo:tsd-index-rulebook` |
|
|
58
|
-
| `part_of` | 任意 | 所属するアーキテクチャ文書などの ID 配列 |
|
|
59
|
-
| `based_on` | 条件付き | 技術構成の直接の根拠となる設計や採用判断の ID 配列 |
|
|
60
|
-
| `supersedes` | 条件付き | 既存の技術一覧を置き換える場合の旧文書 ID 配列 |
|
|
48
|
+
- `type` は `architecture`、`rulebook` は `specdojo:tsd-index-rulebook` とする。
|
|
49
|
+
- `part_of` は任意で、所属するアーキテクチャ文書の ID 配列を記す。
|
|
50
|
+
- `based_on` は直接の根拠となる設計・採用判断、`supersedes` は置き換える旧一覧がある場合に ID 配列で記す。
|
|
61
51
|
|
|
62
52
|
## 5. 本文要件
|
|
63
53
|
|
|
@@ -67,9 +57,9 @@ Technology Stack Index (TSD Index) Documentation Rules
|
|
|
67
57
|
| 技術スタック一覧 | ○ | 区分、採用技術、担当責務を一つの主一覧表で対応させる |
|
|
68
58
|
| 補足・詳細への導線 | 条件付き | 詳細 TSD や設定の正本がある場合、各参照先の役割と適用条件を示す |
|
|
69
59
|
|
|
70
|
-
-
|
|
71
|
-
-
|
|
72
|
-
-
|
|
60
|
+
- 対象外の領域を空欄や仮の技術で埋めない。
|
|
61
|
+
- 版・利用環境・必須と任意の違いは、判断に必要な場合に列または補足で示す。
|
|
62
|
+
- 補足には全体の共通条件と参照先を記す。
|
|
73
63
|
|
|
74
64
|
## 6. 記述ガイド
|
|
75
65
|
|
|
@@ -84,28 +74,28 @@ Technology Stack Index (TSD Index) Documentation Rules
|
|
|
84
74
|
| 適用範囲 | 条件付き | 対象環境、実行場所、必須・任意など、利用条件の違い |
|
|
85
75
|
| 詳細・備考 | 任意 | 詳細 TSD への参照、短い制約や選定理由 |
|
|
86
76
|
|
|
87
|
-
-
|
|
88
|
-
-
|
|
77
|
+
- 担当責務は対象と役割を一文で示す。「開発用」「利用する」だけにしない。
|
|
78
|
+
- 複数製品を実行基盤としてまとめる場合は、内訳と各役割を詳細 TSD へ導く。
|
|
89
79
|
- 版を採用技術名に含める場合は、別の版列で同じ情報を繰り返さない。
|
|
90
80
|
|
|
91
81
|
### 6.2. 区分と網羅範囲
|
|
92
82
|
|
|
93
|
-
-
|
|
94
|
-
- build・テスト・静的検査・文書化・図解・ソース管理・CI/CD
|
|
95
|
-
- AI
|
|
83
|
+
- 実行時の技術: 言語・ランタイム・フレームワーク、データ保存・連携、ホスティング・ネットワーク。
|
|
84
|
+
- 開発・保守の技術: build・テスト・静的検査・文書化・図解・ソース管理・CI/CD・配布・運用監視。
|
|
85
|
+
- AI 実行環境やローカルモデル基盤など固有の領域は採用範囲で追加する。例示を一律の必須構成にしない。
|
|
96
86
|
|
|
97
87
|
### 6.3. 版と採用状態
|
|
98
88
|
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
89
|
+
- メジャー版や互換性制約など必要な粒度を使い、特定版が採用判断に不可欠なら理由と正本を示す。
|
|
90
|
+
- パッチ版や依存解決結果は lockfile 等の参照先を示し、未確認の版を推測しない。
|
|
91
|
+
- 必須・任意を区別し、任意技術には採用済みであることと適用条件を示す。未採択の候補・将来案は判断の記録へ導く。
|
|
92
|
+
- 「最新版」は取得元・更新方針・使用版の確認方法を示す。
|
|
103
93
|
|
|
104
94
|
### 6.4. 詳細文書と更新
|
|
105
95
|
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
96
|
+
- 初期構築・クライアント接続・日常利用を分冊する場合は、各参照名で目的を示す。
|
|
97
|
+
- 技術の採用・廃止・責務・適用範囲の変更時は一覧と詳細 TSD・設定の正本を照合し、不一致を解消する。
|
|
98
|
+
- 未作成の詳細や未決条件は共通ラベルで示し、仮の参照先や設定値を確定情報にしない。
|
|
109
99
|
|
|
110
100
|
## 7. 禁止事項
|
|
111
101
|
|
|
@@ -116,5 +106,4 @@ Technology Stack Index (TSD Index) Documentation Rules
|
|
|
116
106
|
| 同じ技術や一覧を、適用範囲を示さず重複させる | 責務と更新先が分からなくなるため |
|
|
117
107
|
| 全依存パッケージやすべての版固定値を転載する | 一覧の目的を超え、依存定義と二重管理になるため |
|
|
118
108
|
| 詳細設定、接続先、構築コマンド、コードを一覧の本文へ展開する | 詳細 TSD や設定の正本との責務が重なるため |
|
|
119
|
-
| API キー、トークン、秘密鍵、機密の接続情報を記載する | 一覧の配布や履歴を通じて漏れるため |
|
|
120
109
|
| 任意利用の製品や実例の構成を一律の必須技術にする | 対象範囲や環境による違いを失うため |
|