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
|
@@ -3,92 +3,142 @@ specdojo:
|
|
|
3
3
|
id: specdojo:sf-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: requirement
|
|
6
|
-
status:
|
|
7
|
-
|
|
6
|
+
status: ready
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
8
9
|
sample: specdojo:sf-sample
|
|
9
|
-
template:
|
|
10
|
+
template: not-needed
|
|
10
11
|
---
|
|
11
12
|
|
|
12
|
-
#
|
|
13
|
+
# システム化機能仕様 作成ルール
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
System Function Specification (SF) Documentation Rules
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
業務要件を個別のシステム機能へ割り当て、設計・実装・受入判断に必要な目的、入出力、振る舞い、制約を定義します。値・構文・データ構造は schema・リファレンス・ガイドを正本とします。
|
|
17
18
|
|
|
18
|
-
|
|
19
|
-
| ---------- | ----------------------------- | ---- |
|
|
20
|
-
| id | 機能一覧ID (sf-xxx-xxxx) | ○ |
|
|
21
|
-
| type | `requirement` 固定 | ○ |
|
|
22
|
-
| title | 機能一覧名 | ○ |
|
|
23
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
24
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
19
|
+
## 1. 全体方針
|
|
25
20
|
|
|
26
|
-
|
|
21
|
+
- 1 成果物で 1 機能を扱い、利用者の業務課題・期待価値・対象・対象外から責務を定め、主要要件を上位目的・根拠仕様に対応付けます。
|
|
22
|
+
- 業務プロセス仕様(BPS)や利用接点の要件を、入力・処理・出力・例外・受入条件へつなぎます。画面を持たない CLI・自動実行の機能も対象です。
|
|
23
|
+
- システムとして保証する結果と責務境界を記述します。操作手順、内部実装、schema のフィールド定義や設定値一覧を複製しません。
|
|
24
|
+
- 全体の機能一覧・共通方針は上位の `sf-index` を正本とし、個別機能には差分と対応関係を記述します。
|
|
25
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱います。
|
|
27
26
|
|
|
28
|
-
|
|
27
|
+
## 2. 位置づけ
|
|
29
28
|
|
|
30
|
-
-
|
|
29
|
+
- 一覧ハブには [[specdojo:sf-index-rulebook|システム化機能一覧 作成ルール]] を適用し、本書は一覧行を詳細化する個別機能を扱います。
|
|
30
|
+
- 上流の BPS・ビジネスルール(BR)・業務イベント仕様(BES)から担当する業務ステップと判断の参照先を特定し、利用接点を画面仕様(UIS)・CLI 仕様(CLIS)・外部 I/F 仕様(IFX)へ対応付けます。
|
|
31
|
+
- 下流のコンポーネント設計、データ設計、テスト仕様、運用手順は本仕様を入力にします。変更影響は「未決事項と変更影響」で扱います。
|
|
31
32
|
|
|
32
|
-
|
|
33
|
-
一覧ハブには `sf-index`、個別機能には `sf-<機能名>` を付与してください(例: `sf-product-register`)。
|
|
33
|
+
## 3. ファイル命名・ID規則
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
- ファイル名は `sf-<term>.md`、成果物 ID は `sf-<term>` とします。`<term>` は機能の業務的責務を表す英小文字・数字・ハイフンのスラッグとし、Unit 内で一意にします(例: `sf-task-execution`)。
|
|
36
|
+
- `sf-index.md` と ID `sf-index` は一覧ハブ用に予約します。個別機能の ID にプロジェクト ID、authority、実装クラス名、一時的な連番を付けません。
|
|
37
|
+
- 配置は成果物カタログ、命名・管理境界は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。分割・統合時は一覧と参照元の対応も確認します。
|
|
36
38
|
|
|
37
|
-
|
|
38
|
-
- 機能名・概要は業務観点で記述し、実装技術や画面遷移手順など実装詳細は含めない。
|
|
39
|
-
- 項目の表現は他仕様(BDD/CDSL/CCD/用語集)と整合性を保つ。
|
|
39
|
+
## 4. 推奨 Frontmatter 項目
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
- 共通項目と制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従います。
|
|
42
|
+
- 個別機能の `type` は `requirement`、`rulebook` は `specdojo:sf-rulebook` とします。
|
|
43
|
+
- `part_of` は一覧・親成果物、`based_on` は直接の根拠を表し、カタログの先行依存と照合します。
|
|
42
44
|
|
|
43
|
-
|
|
44
|
-
| ---------------- | ------------------------------------------------------------------------------- |
|
|
45
|
-
| **機能ID** | 機能を識別するID(例: sf-product-register。`sf-` プレフィックスの lower-kebab) |
|
|
46
|
-
| **機能名** | 業務担当が理解できる日本語名(簡潔) |
|
|
47
|
-
| **概要** | 機能の目的/要約(何を実現するか) |
|
|
48
|
-
| **入出力** | 主な入力と出力(データ種別や帳票、外部システムとのインターフェース) |
|
|
49
|
-
| **関連プロセス** | 関連する業務領域(例:調達、販売、会計) |
|
|
50
|
-
| **関連仕様ID** | 関連する他仕様の `id`(業務プロセス / 画面 / 帳票 等のファイルID) |
|
|
51
|
-
| **備考** | 追加説明、依存関係、制約など |
|
|
45
|
+
## 5. 本文要件
|
|
52
46
|
|
|
53
|
-
|
|
47
|
+
次の章を開始時の構成とし、必要に応じて処理や連携ごとの小節を設けます。
|
|
54
48
|
|
|
55
|
-
|
|
49
|
+
| 章 | 章タイトル | 必須 | 目的と記載要件 |
|
|
50
|
+
| --- | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| 1 | 目的と概要 | ○ | 業務課題・期待価値と上位目的の関係、対象・対象外、利用者・読者と利用場面を定義する |
|
|
52
|
+
| 2 | 業務プロセス・画面との対応 | ○ | BPS の処理ステップと機能の責務、UIS・CLIS・IFX・BES など該当する接点と受け渡しを対応付ける。接点がない場合も理由を示す |
|
|
53
|
+
| 3 | 入出力と前提条件 | ○ | 入出力の論理情報、入手元・提供先、必須となる条件、契約の正本、着手条件と正常・異常終了時の事後条件を定義する |
|
|
54
|
+
| 4 | 処理要件・機能振る舞い | ○ | 開始条件、処理の責務、確定する結果、BR・状態定義(STSD)の参照、例外時の通知・保持・回復条件を定義する |
|
|
55
|
+
| 5 | 非機能・技術制約 | ○ | 該当する性能・可用性・権限・秘匿・外部依存・互換性の制約と適用範囲を示す。値・構造・版の正本を特定し、未確定事項を分離する |
|
|
56
|
+
| 6 | 操作手順・コマンド参照 | ○ | 操作・設定・障害回復の参照先と参照目的を示す。運用上の問い合わせ・エスカレーション先をロールと参照文書で特定する |
|
|
57
|
+
| 7 | 検証・受入観点 | ○ | 要件と対応する正常・異常・境界条件、観測できる期待結果、検証方法・確認ロールを示し、第三者が合否を判断できるようにする |
|
|
58
|
+
| 8 | 未決事項 | 条件付き | 未決・仮定・調査事項がある場合に論点と影響を示す。当面の扱いと、確定後に直す要件・受入条件を含める |
|
|
56
59
|
|
|
57
|
-
|
|
60
|
+
## 6. 記述ガイド
|
|
58
61
|
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
id: sf-index
|
|
62
|
-
type: requirement
|
|
63
|
-
title: システム化機能一覧(main)
|
|
64
|
-
status: draft
|
|
62
|
+
各章の判断基準と良い例・悪い例を示します。
|
|
65
63
|
|
|
66
|
-
|
|
64
|
+
### 6.1. 目的と概要
|
|
67
65
|
|
|
68
|
-
|
|
69
|
-
|
|
66
|
+
- 「誰のどの課題を、どの成果によって改善するか」と上位目的・要求を示し、成功の確認を「検証・受入観点」に対応付けます。
|
|
67
|
+
- 対象と対象外を対にして示し、他機能・人の判断へ引き渡す境界を明記します。利用者と設計・検証に使う読者を区別します。
|
|
68
|
+
- 良い例: 「実行担当が停止理由と保存済み成果を確認して再開を判断できる。実行結果の記録までを担当し、業務上の完了判断へ引き渡す」。
|
|
69
|
+
- 悪い例: 「agent を起動する機能である」。起動という手段だけで、解決する課題と責務境界を判断できません。
|
|
70
|
+
|
|
71
|
+
### 6.2. 業務プロセス・画面との対応
|
|
72
|
+
|
|
73
|
+
- BPS の処理ステップと本機能の入出力・処理要件を対応付けます。画面のない機能では CLI・イベント等の起動接点を示します。
|
|
74
|
+
- 上流仕様が未作成なら、確認済みのカタログ等の根拠と暫定範囲を示します。詳細ステップ ID を創作せず、未照合の対応と影響を「未決事項」へ残します。
|
|
75
|
+
- 対応表は「根拠仕様・ステップ」「本機能の責務」「対応要件・入出力」を基本列とし、連携には「接点」「トリガー・受け渡し」「責務境界」を加えます。
|
|
76
|
+
- 良い例: 「検証ステップで結果を受け取り、失敗を記録して統合を止める。検証コマンドの契約は対応するリファレンスを参照する」。
|
|
77
|
+
- 悪い例: 「BPS と対応する」。どのステップの何を担うか不明です。
|
|
78
|
+
|
|
79
|
+
### 6.3. 入出力と前提条件
|
|
80
|
+
|
|
81
|
+
- データは業務論理名で示し、BDD・CDT・BES・IFX・schema 等の正本を特定します。実装上の変数・内部構造の一覧は書きません。
|
|
82
|
+
- 前提条件、正常時の確定結果、失敗時に保持・変更しない情報を区別します。経路や実行方式で条件が異なる場合は、その適用範囲を付けます。
|
|
83
|
+
- 良い例: 「状態追跡する実行では完了状態を記録する。追跡しない単発実行では状態を変更しない」。
|
|
84
|
+
- 悪い例: 「成功したら常にタスクを完了にする」。追跡しない経路にも事後条件を広げています。
|
|
85
|
+
|
|
86
|
+
推奨する入出力表の列と記入断片:
|
|
87
|
+
|
|
88
|
+
| 区分 | 情報 | 入手元 / 提供先 | 必須性・確定条件 | 正本仕様 | 対応要件 |
|
|
89
|
+
| ---- | ------------------------ | ------------------- | ---------------- | ----------------------------- | -------------- |
|
|
90
|
+
| 入力 | 保存済みの成果と停止理由 | 実行記録 / 再開処理 | 再開時に必須 | 記録契約の文書・schema を指定 | 再開の前提条件 |
|
|
91
|
+
|
|
92
|
+
### 6.4. 処理要件・機能振る舞い
|
|
93
|
+
|
|
94
|
+
- 開始条件・処理責務・観測結果をまとめ、設計・テストへ割り当てられる単位に見出しや要件 ID を付けます。
|
|
95
|
+
- 業務判断は BR、状態・遷移は STSD を参照し、機能がその判断結果をどう利用するかを書きます。処理成功、作業完了、人間の受入承認を区別します。
|
|
96
|
+
- 異常系は「条件」「通知と保持する情報」「回復・再開条件」で整理し、外部サービスの失敗を成功扱いにしません。
|
|
97
|
+
- 良い例: 「検証失敗時は失敗結果を残し、未検証の成果を統合しない。修正後の再検証成功を統合条件とする」。
|
|
98
|
+
- 悪い例: 「問題があれば適切に復旧する」。停止位置、保持情報、復旧条件がありません。
|
|
99
|
+
|
|
100
|
+
### 6.5. 非機能・技術制約
|
|
101
|
+
|
|
102
|
+
- 制約の対象、適用経路、根拠、判定方法を示します。性能・同時実行・タイムアウト等の値は設定・契約の正本へ委ね、上書き・省略・適用外の場合も判定できるようにします。
|
|
103
|
+
- 連携双方の責務、障害時の扱い、権限・秘匿要件を示します。公開データ契約は論理契約・schema・版管理の正本と互換性の確認先を特定し、未定義の互換動作を断定しません。
|
|
104
|
+
- 現行動作と要求する変更を区別し、既存動作と異なる制約の下流影響を示します。未確定の値を既定値として書きません。
|
|
105
|
+
- 良い例: 「上限が適用される経路では有効設定値の超過時に停止理由を残す。上限省略時と対象外の経路は設定ガイドの契約で判定する」。
|
|
106
|
+
- 悪い例: 「すべての経路で上限は 1」。正本・対象・設定による差を示さない固定値です。
|
|
107
|
+
|
|
108
|
+
### 6.6. 操作手順・コマンド参照
|
|
109
|
+
|
|
110
|
+
- 「参照先」「種類」「参照目的」の列で利用開始・設定・障害回復の文書を案内し、操作がなければ理由と確認先を示します。
|
|
111
|
+
- 障害時に誰が一次対応し、どの条件でどのロールへ引き渡すかを定めます。手順と連絡先の詳細は運用手順・組織定義へ委ねます。
|
|
112
|
+
- 良い例: 「再開判断は実行担当が運用ガイドで確認する。契約や保護設定の変更が必要なら PM・ARC へ引き渡す」。
|
|
113
|
+
- 悪い例: 「困ったら担当者に連絡する」。担当ロールと参照導線が特定できません。
|
|
70
114
|
|
|
71
|
-
###
|
|
115
|
+
### 6.7. 検証・受入観点
|
|
72
116
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
117
|
+
- 各主要要件に正常系・入力不成立・外部障害・境界条件を対応付け、非該当には理由を示します。成功基準は利用者の成果と失敗時の保護に結び付けます。
|
|
118
|
+
- 表は「観点 ID」「対象要件」「対象条件」「観測する期待結果」「検証方法・証跡」「確認ロール」を基本列とし、条件と結果は合否を判定できる表現にします。
|
|
119
|
+
- 制約値は正本の有効値を使い、上書き・省略・適用外の条件を区別します。計測や実機確認が必要な場合は、その方法と担当を示し、未実施を合格扱いにしません。
|
|
120
|
+
- 良い例: 「検証が失敗した場合、失敗出力が証跡に残り、統合記録と完了記録が作られないことを QE が実行記録で確認する」。
|
|
121
|
+
- 悪い例: 「正常・異常とも正しく動作する」。観測する情報と合否境界がありません。
|
|
77
122
|
|
|
78
|
-
|
|
123
|
+
### 6.8. 未決事項と変更影響
|
|
79
124
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
125
|
+
- 未確定の対応・契約・受入値は、論点と影響(当面の扱い、確定後に直す要件・受入条件)を示します。
|
|
126
|
+
- 入出力・状態・接点・制約・受入条件の変更から、上流仕様、UI・DB・コンポーネント設計、schema・生成処理・コマンド、テスト、運用手順への影響を特定します。互換性、依存作業の着手可否、再確認の条件も示します。
|
|
127
|
+
- 良い例: 「BPS が未作成で、ステップ対応と設計境界は暫定である。確定後に『業務プロセス・画面との対応』と入出力・処理要件を照合し、それまで未照合部分を確定した設計入力に使わない」。
|
|
128
|
+
- 悪い例: 「詳細は後で決める」。未確定の範囲・影響・当面の扱いがありません。
|
|
83
129
|
|
|
84
|
-
|
|
130
|
+
### 6.9. 完成判定と承認
|
|
85
131
|
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
132
|
+
- 完成条件は、必須章の具体化、上流仕様・契約との整合、主要要件と受入条件の対応、カタログの `done_criteria` の確認です。未作成の上流仕様・契約不一致に依存する条件は未充足とします。
|
|
133
|
+
- 「検証・受入観点」の条件で実行・照合・計測し、期待結果と証跡を比較します。受入値が未確定・確認が未実施の範囲は合格にせず、判定済みの範囲と区別します。
|
|
134
|
+
- 良い例: 「再開試験で保存済み成果を引き継げた。資源制約は受入値未確定のため未判定とし、結果を分ける」。
|
|
135
|
+
- 悪い例: 「正常系が動いたので機能全体を受け入れる」。例外・境界条件と未充足条件を確認していません。
|
|
89
136
|
|
|
90
|
-
##
|
|
137
|
+
## 7. 禁止事項
|
|
91
138
|
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
-
|
|
139
|
+
- 一覧ハブと個別機能の責務を混同し、機能一覧表だけで個別仕様を終えない。
|
|
140
|
+
- コマンド構文・引数・オプション一覧・対話手順・画面操作手順を再掲しない。
|
|
141
|
+
- schema の項目一覧、実装クラス・メソッド・内部構造、SQL、物理テーブル定義を転記しない。
|
|
142
|
+
- BPS の全手順、BR の判定ロジック、UIS のレイアウトを複製しない。
|
|
143
|
+
- 未作成の参照先や未合意の値・互換性方針を確定事項として扱わない。
|
|
144
|
+
- 適用範囲のない事後条件や「適切に」「正しく」だけの合否基準を置かない。
|
|
@@ -3,92 +3,162 @@ specdojo:
|
|
|
3
3
|
id: specdojo:sld-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
|
-
status:
|
|
7
|
-
|
|
6
|
+
status: ready
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
8
9
|
sample: specdojo:sld-sample
|
|
9
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
10
13
|
---
|
|
11
14
|
|
|
12
|
-
#
|
|
13
|
-
|
|
14
|
-
業務で管理する物理的・論理的な保管場所を一覧で定義します。各保管場所の主な保管対象・目的・関連プロセス・管理頻度などを明記し、在庫や現金などの流れ・管理単位を明確にします。
|
|
15
|
+
# 保管場所一覧(SLD)作成ルール
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
Storage Location Definition (SLD) Documentation Rules
|
|
17
18
|
|
|
18
|
-
|
|
19
|
-
| ---- | ----------------------------- | ---- |
|
|
20
|
-
| id | 保管場所一覧ID (sll-xxx-xxxx) | ○ |
|
|
21
|
-
| type | `data` 固定 | ○ |
|
|
19
|
+
業務で扱う現物・紙帳票・電子データ・実行時ファイルの保管場所について、置くもの・共有の有無・寿命・消してよいか(削除・処分の可否と条件)を定義する基準を定めます。
|
|
22
20
|
|
|
23
|
-
|
|
24
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
25
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
21
|
+
## 1. 全体方針
|
|
26
22
|
|
|
27
|
-
|
|
23
|
+
- **目的と適用範囲**: `sld-*.md` を対象とします。店舗・倉庫の棚や金庫、紙台帳の保管場所、リポジトリ内のディレクトリ、端末ローカルの状態領域、作業用 worktree、一時ディレクトリなど、「どこに何が置かれ、共有されるか、いつまで残し、消してよいか」を判断する必要がある保管場所を網羅します。
|
|
24
|
+
- **正本参照と責務境界**: 概念上の管理単位・正本区分・更新責務は概念データストア定義(CDSD)、データ項目の構造は業務データ辞書(BDD)や schema、ディレクトリ構造や CLI の詳細はリファレンス・実装を正本とします。SLD はそれらを場所ごとの保管物・共有範囲・寿命・削除可否の観点で整理し、正本の詳細を再掲しません。
|
|
25
|
+
- **記載レベル**: 一覧の1行は、共有範囲・寿命・削除可否の判断が同じになる保管場所の区分とします。個々のファイル名を全列挙せず、誤削除や放置を防げる粒度でまとめます。
|
|
26
|
+
- **実践の型の構成**: 標準6列と5章構成が本 rulebook で定まり、骨組みを別ファイルにすると二重管理になるため、`recipe` と `template` は `not-needed` とします。
|
|
27
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、成果物の業務の検証に含めません。
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
- `type: data` は業務ドメイン仕様であることを示す。
|
|
29
|
+
## 2. 位置づけ
|
|
31
30
|
|
|
32
|
-
|
|
31
|
+
SLD は、CDSD の管理単位と業務プロセス仕様の業務の流れを受け、それらがどの物理的・論理的な場所に置かれ、どう共有・保持・処分されるかを定義します。[[specdojo:deliverables-reference|成果物リファレンス]] の種別名は「保管場所定義(`sld`)」で、個別文書のタイトルと本文では「保管場所一覧」と呼びます。
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
33
|
+
```mermaid
|
|
34
|
+
graph TD
|
|
35
|
+
BPS["業務プロセス・データフロー (BPS / CDFD)"] -->|"入出力・発生契機"| SLD["保管場所一覧 (SLD)"]
|
|
36
|
+
CDSD["概念データストア定義 (CDSD)"] -->|"管理単位・正本区分・更新責務"| SLD
|
|
37
|
+
BDD["業務データ辞書 (BDD)"] -->|"記録・現物の識別と意味"| SLD
|
|
38
|
+
SLD -->|"削除・退避・清掃の判断基準"| OPR["業務運用・保守運用 (OPR)"]
|
|
39
|
+
SLD -.->|"配置先・共有制御の整合確認"| IMPL["実装の配置定義・ディレクトリリファレンス"]
|
|
40
|
+
```
|
|
40
41
|
|
|
41
|
-
|
|
42
|
+
リポジトリ内の文書配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
42
43
|
|
|
43
|
-
|
|
44
|
-
| **保管場所** | 場所の論理名(日本語単数形) |
|
|
45
|
-
| **主な保管対象** | 主に保管する対象(商品在庫、現金など) |
|
|
46
|
-
| **主な内容・目的** | 管理目的や作業内容(名詞句中心で簡潔に) |
|
|
44
|
+
## 3. ファイル命名・ID規則
|
|
47
45
|
|
|
48
|
-
|
|
49
|
-
|
|
46
|
+
- **ファイル名**: `sld-<term>.md` とし、`<term>` は対象システム・業務領域を表す英小文字の kebab-case とします(例: `sld-specdojo.md`、`sld-inventory.md`)。
|
|
47
|
+
- **文書 ID**: プロダクト仕様の成果物は `sld-<term>`、プロジェクト固有の成果物は `<project-id>:sld-<term>` とし、成果物カタログの宣言と一致させます。旧来の `sll-` プレフィックスは新規に採番しません(他文書で言及済みの未作成 ID に限り、移行関係を明記して対応付けます)。
|
|
48
|
+
- **文書タイトル(H1)**: `# 保管場所一覧(<対象領域または対象システム>)` とします。
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
## 4. 推奨 Frontmatter 項目
|
|
52
51
|
|
|
53
|
-
|
|
52
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
54
53
|
|
|
55
|
-
|
|
54
|
+
- `specdojo.type` は `data`、`specdojo.rulebook` は `specdojo:sld-rulebook` とします。
|
|
55
|
+
- `specdojo.based_on` には実際に読んで直接の根拠とした作成済み文書(対応する `cdsd-*` 等)の ID を記載します。成果物カタログに `depends_on` がある場合はその推移閉包内に限定し、未作成文書を含めません。
|
|
56
56
|
|
|
57
57
|
```yaml
|
|
58
58
|
---
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
status: draft
|
|
63
|
-
|
|
59
|
+
specdojo:
|
|
60
|
+
id: sld-specdojo
|
|
61
|
+
type: data
|
|
62
|
+
status: draft
|
|
63
|
+
rulebook: specdojo:sld-rulebook
|
|
64
|
+
based_on:
|
|
65
|
+
- cdsd-planning
|
|
66
|
+
- cdsd-execution
|
|
67
|
+
- cdsd-sharing
|
|
64
68
|
---
|
|
65
69
|
```
|
|
66
70
|
|
|
67
|
-
|
|
71
|
+
## 5. 本文要件
|
|
72
|
+
|
|
73
|
+
本文は次の5章構成を標準とします。
|
|
74
|
+
|
|
75
|
+
| 章 | 必須 | 内容・受入条件 |
|
|
76
|
+
| -------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
77
|
+
| 概要 | 必須 | 対象領域、誰がどの判断に使うか、対象範囲。隣接仕様との分担は「関連仕様・実装配置との対応と検証」にまとめ、ここで再掲しない |
|
|
78
|
+
| 保管場所一覧 | 必須 | 全保管場所を標準6列で定義し、置くもの・共有の有無・寿命・消してよいかと削除前の条件が判別できること |
|
|
79
|
+
| 削除・退避・復旧の判断基準 | 必須 | 削除可否の区分ごとの扱いと、誤削除・残存した状態・消失への場面別の対処、復旧の経路と連絡先を示すこと |
|
|
80
|
+
| 関連仕様・実装配置との対応と検証 | 必須 | 隣接仕様との分担と保管場所の対応を1つの表にまとめ、業務上の受入確認の手順と合格条件を辿れること |
|
|
81
|
+
| 確認事項と変更影響 | 条件付き | 未決事項・前提の欠落・保管場所の追加や変更があるときに置き、論点と影響(当面の扱い)を示す |
|
|
82
|
+
|
|
83
|
+
「確認事項と変更影響」を条件付きとするのは、未決事項も変更予定もない領域で空の章を作らせないためです。
|
|
84
|
+
|
|
85
|
+
### 5.1. 保管場所一覧の標準列
|
|
86
|
+
|
|
87
|
+
「保管場所一覧」の表は、次の6列をこの順序で配置します。物理的な場所と論理的な場所(またはリポジトリ内と端末ローカル)の両方を含む場合は、同じ6列で表を分けるか、区分が分かる順に並べます。
|
|
88
|
+
|
|
89
|
+
| 列名 | 内容・判断条件 |
|
|
90
|
+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
91
|
+
| 保管場所 | 場所の論理名と、物理的な設置場所またはディレクトリパス・環境変数パターン(例: `docs/ja/projects/<id>/execution/`、`${XDG_STATE_HOME}/...`) |
|
|
92
|
+
| 置くもの | 保管する現物・帳票・ファイル群と、その役割(正本・履歴・派生ビュー・ロック・一時データ等)。代表単位で示す |
|
|
93
|
+
| 関連プロセス・操作 | その場所にものを置く・参照する・回収する業務プロセスまたはコマンド(複数ある場合は「、」で区切る) |
|
|
94
|
+
| 共有の有無 | `Git 共有(追跡対象)`、`共有なし(.gitignore・各環境で再生成)`、`共有なし(端末ローカル)`、`店舗内共有(施錠保管)` 等の区分と共有範囲 |
|
|
95
|
+
| 寿命・管理頻度 | 置かれてから消える・移動するまでの期間(恒久、タスク実行中、日次・月次等)と、確認・清掃・ローテーションの契機 |
|
|
96
|
+
| 削除・処分の可否と条件 | `削除不可` / `条件付き削除可` / `削除可`(物理現物は `処分不可` / `条件付き処分可` / `即時処分可`)の区分と、削除前の条件・再生成手段 |
|
|
97
|
+
|
|
98
|
+
セルは判断に要る要点だけにし、手順は「削除・退避・復旧の判断基準」の場面別の表へ寄せます。
|
|
99
|
+
|
|
100
|
+
### 5.2. 削除・退避・復旧の判断要件
|
|
101
|
+
|
|
102
|
+
- 場所ごとの削除前の条件は「保管場所一覧」の表を正とし、ほかの章では表を参照して言い直しません。
|
|
103
|
+
- 区分ごとの扱いとして、`削除不可` の場所が不要になったときに消す代わりに採る手順(`deprecated` 化、アーカイブ領域や別の保管場所への移動、保持期間満了後の承認手続き等)を示します。
|
|
104
|
+
- `条件付き削除可` の場所で条件を満たせないときの扱い(残して持ち越す、責任者へ連絡する等)を示します。
|
|
105
|
+
- 場面別の対処として、誤削除、異常終了で残ったロックや作業領域、消失・破損、容量逼迫などの場面ごとに、確認と対処の手順、担当と連絡先を表にします。`削除可` の場所は削除後の再生成コマンドまたは再作成の契機を示します。
|
|
106
|
+
|
|
107
|
+
### 5.3. 関連仕様・実装配置との対応と検証要件
|
|
108
|
+
|
|
109
|
+
- 依存する CDSD の各管理単位と STSD の状態が、どの保管場所に対応するか(CDSD 側で未登録の管理単位があればその扱い)を追跡できるようにします。
|
|
110
|
+
- ソフトウェア・リポジトリの保管場所を扱う場合は、パス解決や共有除外を担う実装モジュール・設定ファイル(例: `.gitignore`、パス解決関数、ディレクトリレイアウトリファレンス)との対応を示します。関数本体や schema 全文は転記しません。
|
|
111
|
+
- 受入確認では、次の観点ごとに手順と合格条件を定義します。
|
|
112
|
+
1. **配置と技術制約の一致**: パス区分、Git 追跡と除外、端末ローカルや worktree の分離方式が実装・リファレンスと一致すること。欠落・破損時の実装の挙動が削除可否と矛盾しないこと。
|
|
113
|
+
2. **記録・状態の網羅**: `depends_on` の CDSD 等で定義された記録・管理単位に保管場所の欠落がなく、保持・共有の業務要件と矛盾しないこと。
|
|
114
|
+
3. **削除・復旧判断の実効性**: すべての保管場所について、消してよいか、消す前の確認事項、消した後の影響または再生成手順が特定できること。
|
|
115
|
+
|
|
116
|
+
### 5.4. 未決事項と変更影響の要件
|
|
117
|
+
|
|
118
|
+
- 保管先や保持期間が未確定の項目は推測で確定せず、`_UNDECIDED_` または `_TODO_` を付して「確認事項と変更影響」に論点と影響を書きます。管理台帳の区分・担当・判断時期の列は設けず、追跡は登録簿で行います。
|
|
119
|
+
- 保管場所の新設・パス変更・共有区分の変更では、CDSD、ディレクトリリファレンス、`.gitignore`、ビルド・再生成処理、バックアップ・清掃手順への波及を影響として書きます。
|
|
120
|
+
|
|
121
|
+
## 6. 記述ガイド
|
|
122
|
+
|
|
123
|
+
完成例の全体像は Frontmatter の `sample` で宣言された sample を参照してください。各章の記述では次の判断基準と良い例・悪い例に従います。
|
|
124
|
+
|
|
125
|
+
### 6.1. 概要
|
|
126
|
+
|
|
127
|
+
- **判断基準**: 誰がどの運用・設計判断に使う一覧で、何を対象範囲とするかが冒頭で分かること。
|
|
128
|
+
- **良い例**: 「リポジトリ内の正本文書・実行履歴・派生ビューと、端末ローカルの状態ファイル・worktree・一時ディレクトリの保管境界を定義し、清掃や障害復旧時に消してよい場所と残すべき場所を判別できるようにする。」
|
|
129
|
+
- **悪い例**: 「SpecDojo のディレクトリ一覧を示す。」(誰の何の判断に使うかが分からない)
|
|
130
|
+
|
|
131
|
+
### 6.2. 保管場所一覧
|
|
132
|
+
|
|
133
|
+
- **判断基準**: 標準6列がすべて具体化され、「共有の有無」に共有手段(Git 追跡、`.gitignore`、端末固有など)、「削除・処分の可否と条件」に区分と条件が書かれていること。
|
|
134
|
+
- **良い例**: 「`docs/**/generated/` および `.specdojo/doc-index.json` / 派生 Markdown ビューと文書索引 / `specdojo build`、`index build` / 共有なし(`.gitignore` で除外し各環境で生成) / ビルド時に再生成 / `削除可`。`specdojo build` で再生成できる」
|
|
135
|
+
- **悪い例**: 「`generated` フォルダ / 生成ファイル / ビルド / なし / 随時 / 消してよい」(パス範囲、共有除外の仕組み、削除後の復旧手段が曖昧)
|
|
68
136
|
|
|
69
|
-
|
|
70
|
-
| ------------ | ------------------------------------ | ---------------------------------------------------------------- | ------------ | -------------- |
|
|
71
|
-
| バックヤード | 商品在庫(未陳列)、段ボール、予備棚 | 納品された商品を保管し、数量と賞味期限を管理。補充元として機能。 | 調達、販売 | 納品時・補充時 |
|
|
72
|
-
| 売り場棚 | 販売中の商品 | お客様が手に取る商品を配置、価格表示、補充、前出しを行う。 | 販売 | 開店前・営業中 |
|
|
137
|
+
### 6.3. 削除・退避・復旧の判断基準
|
|
73
138
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
139
|
+
- **判断基準**: 場面ごとに「何を確認し、どう対処し、誰へ連絡するか」が行動レベルで書かれ、削除前の条件は一覧の表を参照していること。
|
|
140
|
+
- **良い例**: 「`exec run` が異常終了して `execution/exec/.locks/` にロックが残った / 同じリポジトリで `exec run` が動いていないことを確かめてから削除する。稼働中に消すと二重実行で実行記録が壊れる / DEV」
|
|
141
|
+
- **悪い例**: 「ロックファイルは状況に応じて注意して削除する。」(確認条件も誤削除時の影響も分からない)
|
|
77
142
|
|
|
78
|
-
|
|
143
|
+
### 6.4. 関連仕様・実装配置との対応と検証
|
|
79
144
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
145
|
+
- **判断基準**: 根拠となる CDSD の管理単位や実装ファイル(パス解決・共有設定)を特定し、保管場所との対応と検証の手順が1か所で分かること。
|
|
146
|
+
- **良い例**: 「実行履歴領域(`execution/runs/`、`execution/conventions/`)は [[cdsd-execution|概念データストア定義(プロジェクト実行)]] の実行記録と `src/shared/run-records.ts` のパス解決に対応し、Git 追跡対象の正本として保持する。」
|
|
147
|
+
- **悪い例**: 「実装のソースコード一式と整合していることを確認する。」(どの仕様・どの実装モジュールと対応するか追跡できない)
|
|
83
148
|
|
|
84
|
-
|
|
149
|
+
### 6.5. 確認事項と変更影響
|
|
85
150
|
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
151
|
+
- **判断基準**: 上位仕様(CDSD 等)で未決の事項を隠さず引き継ぎ、決まったときに本書のどの行・どの実装へ影響するかが分かること。
|
|
152
|
+
- **良い例**: 「`_UNDECIDED_`: 監視結果・費用作業記録の保管先パスと保持期間([[cdsd-execution|概念データストア定義(プロジェクト実行)]] の未決事項)。決まったら「保管場所一覧」へ行を足す。」
|
|
153
|
+
- **悪い例**: 未決の保管場所を推測で確定パスとして書き込む、または未決事項があるのに「特になし」と書く。
|
|
89
154
|
|
|
90
|
-
##
|
|
155
|
+
## 7. 禁止事項
|
|
91
156
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
157
|
+
| 禁止パターン | 理由 |
|
|
158
|
+
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
159
|
+
| 「置くもの」「共有の有無」「寿命」「消してよいか」のいずれかを欠いた行定義 | 運用者が誤削除や放置の判断を誤る原因になるため |
|
|
160
|
+
| 「適宜削除」「状況に応じて管理」など条件のない削除可否記述 | 削除前の確認事項や再生成手段を判断できず、正本データや未統合 worktree の消失を招くため |
|
|
161
|
+
| 削除前の条件を「保管場所一覧」以外の章で言い直すこと | 同じ条件が複数か所に書かれ、改訂時に食い違うため |
|
|
162
|
+
| 概念データストアの属性一覧・JSON Schema・ソースコード実装の全文転記 | CDSD・BDD・schema・実装との二重管理になり、正本更新時に不整合が発生するため |
|
|
163
|
+
| 未決の保管先や保持期間を根拠なく推測で確定記載すること | 合意されていない運用制約を既成事実化し、後続の設計・実装と衝突するため |
|
|
164
|
+
| 文書の整形・lint の実行を業務の受入確認に含めること | リポジトリの検証と業務の検証が混ざり、保管・削除の判断を確かめる手順が埋もれるため |
|