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,42 +11,32 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Project Issues and Approach Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
本書では問い、深掘り手順、具体化のコツ、レビュー観点を扱います。
|
|
14
|
+
プロジェクト課題と解決アプローチを、関係者が何が課題で、どれを、どう解く方針かを合意できる内容に仕上げるための作り方を示す。
|
|
16
15
|
|
|
17
16
|
## 1. このレシピの使い方
|
|
18
17
|
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
- 目指す価値と課題の影響(Why)、優先課題と到達方針(What)、解決策候補・採用アプローチ・軽減策(How)を整理し、課題 ID、案 ID、根拠、採否理由、記録先で追跡する(Trace)。方式設計と実装詳細は後続成果物へ委譲する。
|
|
18
|
+
- 本書は、概要の目指す価値(Why)を引き継ぎ、優先課題と採用方針(What)を定め、解決策候補・採否理由・軽減策(How)を書く。課題 ID と案 ID で、課題から原因・候補・採否までたどれるようにする(Trace)。方式設計と実装詳細は書かない。
|
|
19
|
+
- 「作成前に集める情報」をメモでそろえてから、「全体の作成手順」の順に書く。
|
|
20
|
+
- 書き終えたら「レビュー観点」で読み直し、「仕上げチェック」で確かめる。
|
|
23
21
|
|
|
24
22
|
## 2. 作成前に集める情報
|
|
25
23
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
| 原因の手がかり | 情報不足、判断基準の不在、手順のばらつき、システム制約など |
|
|
34
|
-
| 解決の選択肢 | 取りうる方針(2 件以上)と、代替・補完の関係 |
|
|
35
|
-
| 判断軸 | 効果、コスト、期間、リスク、再利用性、公開適性など重視する観点 |
|
|
36
|
-
| 前提・制約 | スコープ、前提・制約・依存関係から、守るべき境界と成立条件 |
|
|
37
|
-
| 未確定事項 | 追加調査、確認、承認が必要な事項と、その責任ロール |
|
|
24
|
+
| 項目 | 集める情報 | 取り出し元 |
|
|
25
|
+
| -------------- | ---------------------------------------------------- | -------------------------------------- |
|
|
26
|
+
| 目指す価値 | 誰のどの業務価値に近づけたいか、放置で何が悪化するか | プロジェクト概要 |
|
|
27
|
+
| 困っている現象 | 利用者や運用で実際に起きていること(解決策ではなく) | 利用者・運用担当への聞き取り、観察記録 |
|
|
28
|
+
| 境界と成立条件 | 対象範囲・対象外、守るべき前提・制約 | スコープ、前提・制約・依存関係 |
|
|
29
|
+
| 原因の手がかり | 確認できた事実と、まだ推測の段階のこと | 観察記録、既存の成果物、聞き取り |
|
|
30
|
+
| 判断軸の順序 | 効果・費用・期間・負荷などを、今回どの順で重視するか | 承認者への確認 |
|
|
38
31
|
|
|
39
32
|
## 3. 全体の作成手順
|
|
40
33
|
|
|
41
|
-
1.
|
|
42
|
-
2.
|
|
43
|
-
3.
|
|
44
|
-
4.
|
|
45
|
-
5.
|
|
46
|
-
6.
|
|
47
|
-
7. 次の検討事項で、未確定事項と責任ロールを書く。
|
|
48
|
-
8. 見直しと変更管理で、本書を見直す契機・確認観点・対応方針と記録先を書く。
|
|
49
|
-
9. 最後に、設計詳細や曖昧表現を書きすぎていないか確認する。
|
|
34
|
+
1. 課題一覧を最初に書き、課題 ID を振る。原因と候補が課題 ID を参照するため、ここが決まらないとほかの章が書けない。
|
|
35
|
+
2. 原因を、課題ごとに事実と仮説に分けて書く。
|
|
36
|
+
3. 解決策候補を 2 件以上挙げ、代替か補完かと対応課題を添える。
|
|
37
|
+
4. 採用アプローチと理由を、判断軸の順序に沿って書く。
|
|
38
|
+
5. 必要な場合だけ、トレードオフ/リスク、次の検討事項(ToDo)、見直しと変更管理を書く。書く内容がなければ置かない。
|
|
39
|
+
6. 最後に H1 直下の導入部(目的、承認者と利用ロール、合意対象と合意対象外)を書く。採用方針が決まってから書くと、本文の言い直しにならない。
|
|
50
40
|
|
|
51
41
|
## 4. 各章の書き方
|
|
52
42
|
|
|
@@ -55,120 +45,91 @@ Project Issues and Approach Writing Recipe
|
|
|
55
45
|
問い:
|
|
56
46
|
|
|
57
47
|
- 利用者や運用で、実際に困っている現象は何か。
|
|
58
|
-
-
|
|
59
|
-
- どの課題から先に決めるべきか(優先度)。
|
|
60
|
-
|
|
61
|
-
書き方:
|
|
62
|
-
|
|
63
|
-
- 課題は「困っている現象」で書き、解決策の欠落(例:「自動発注がない」)にしない。
|
|
64
|
-
- 各課題に最低限「影響」と「優先度」を添える。
|
|
65
|
-
- 課題ID(例: P-01)を振り、原因表や決定記録から参照できるようにする。
|
|
48
|
+
- 放置すると、誰がどの業務価値で困るか。
|
|
66
49
|
|
|
67
|
-
|
|
50
|
+
コツ:
|
|
68
51
|
|
|
69
|
-
-
|
|
70
|
-
|
|
71
|
-
悪い例:
|
|
72
|
-
|
|
73
|
-
- 共通テンプレートがない。
|
|
52
|
+
- 「〜がない」と書き始めたら解決策の先取りなので、それがないと何が起きているかを聞き直す。
|
|
53
|
+
- 概要の背景を写したくなったら、概要への参照に置き換え、本書では課題の影響だけを書く。
|
|
74
54
|
|
|
75
55
|
### 4.2. 原因(仮説でも可)
|
|
76
56
|
|
|
77
57
|
問い:
|
|
78
58
|
|
|
79
59
|
- その課題は、なぜ起きているか。
|
|
80
|
-
-
|
|
81
|
-
- 根拠となる文書や観察事実は何か。
|
|
60
|
+
- それは確認した事実か、まだ推測か。
|
|
82
61
|
|
|
83
|
-
|
|
62
|
+
コツ:
|
|
84
63
|
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
- 根拠文書、観察事実、補足を添える。
|
|
64
|
+
- 仮説には、何を見れば確かめられるかを添えるよう聞く。確認方法がない仮説は、検証できないまま採否の根拠になりやすい。
|
|
65
|
+
- 一つの課題に原因を一つだけ書くと、候補が一つに絞られやすい。情報・判断基準・手順・制約の別に分けて聞く。
|
|
88
66
|
|
|
89
67
|
### 4.3. 解決策候補
|
|
90
68
|
|
|
91
69
|
問い:
|
|
92
70
|
|
|
93
|
-
-
|
|
94
|
-
-
|
|
95
|
-
- 各案は、どの業務価値に近づけるか。
|
|
96
|
-
- 案ごとに失うもの・効果は何か。
|
|
71
|
+
- 候補は、同じ判断を置き換える代替案か、別の課題・原因を扱う補完策か。
|
|
72
|
+
- 各案は、どの課題に効き、何を失うか。
|
|
97
73
|
|
|
98
|
-
|
|
74
|
+
コツ:
|
|
99
75
|
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
- 案IDを振り、採用アプローチや代替案比較から参照できるようにする。
|
|
103
|
-
- 同じ判断を置き換える案の詳細比較は代替案比較へ委譲し、本書では比較が必要な論点を示す。
|
|
76
|
+
- 案が一つしか出ないときは、「この案を採らないなら何をするか」と聞いて代替案を引き出す。
|
|
77
|
+
- 代替案どうしの詳細な比較を書き始めたら、比較が要る論点だけを残す。
|
|
104
78
|
|
|
105
79
|
### 4.4. 採用アプローチと理由
|
|
106
80
|
|
|
107
81
|
問い:
|
|
108
82
|
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
- 採用・非採用の判断軸は何で、今回重視する順序はどうか。
|
|
112
|
-
- 採用しない案は、なぜ採用しないか。
|
|
83
|
+
- どの案を採用し、単独で採用した場合に何が不足するか。
|
|
84
|
+
- 採用しない案は、どの判断軸で外れたか。
|
|
113
85
|
|
|
114
|
-
|
|
86
|
+
コツ:
|
|
115
87
|
|
|
116
|
-
-
|
|
117
|
-
-
|
|
118
|
-
- 補完策を組み合わせる場合は、併用する理由を説明する。中核・補助または実行順序がある場合だけ、その関係も示す。
|
|
119
|
-
- 判断軸の優先順位を 1 文で示す。
|
|
88
|
+
- 判断軸の順序は承認者に先に聞く。順序が決まらないまま書くと、理由が「よさそう」に戻る。
|
|
89
|
+
- 補完策は、各案が担う課題・原因が重ならないかを確かめる。重なるなら代替の関係である。
|
|
120
90
|
|
|
121
91
|
### 4.5. トレードオフ/リスク
|
|
122
92
|
|
|
123
93
|
問い:
|
|
124
94
|
|
|
125
|
-
-
|
|
126
|
-
-
|
|
127
|
-
- それぞれの軽減策は何か。
|
|
95
|
+
- 採用の代償として、何を捨てる・先送りするか。
|
|
96
|
+
- 起きうる失敗と、その軽減策は何か。
|
|
128
97
|
|
|
129
|
-
|
|
98
|
+
コツ:
|
|
130
99
|
|
|
131
|
-
-
|
|
132
|
-
- リスクは「起きうること」と「軽減策」をセットで書く。
|
|
100
|
+
- 採用理由の判断軸で劣る点を探すと、トレードオフが見つかりやすい。
|
|
133
101
|
|
|
134
102
|
### 4.6. 次の検討事項(ToDo)
|
|
135
103
|
|
|
136
104
|
問い:
|
|
137
105
|
|
|
138
|
-
-
|
|
139
|
-
-
|
|
106
|
+
- 次の意思決定に必要な調査・確認・承認は何で、誰が担うか。
|
|
107
|
+
- 何が決まれば完了で、いつまでに決める必要があるか。
|
|
140
108
|
|
|
141
|
-
|
|
109
|
+
コツ:
|
|
142
110
|
|
|
143
|
-
-
|
|
144
|
-
- ToDo の項目は、未確定事項を示す場合は _TODO_: または _UNDECIDED_ ラベルを先頭に付け、後続で検索・フィルタできるようにする(例: _TODO_: 公開先にGitHub を採用するか決定する)。
|
|
145
|
-
- 責任ロールは、体制定義で採用済みのロールまたは担当単位で書く。
|
|
111
|
+
- 採否を保留した論点と、仮説の確認方法から拾うと漏れにくい。
|
|
146
112
|
|
|
147
113
|
### 4.7. 見直しと変更管理
|
|
148
114
|
|
|
149
115
|
問い:
|
|
150
116
|
|
|
151
|
-
-
|
|
152
|
-
-
|
|
153
|
-
- 見直し結果は、どこに記録するか。
|
|
117
|
+
- どんな変化があれば本書の合意を見直すか。
|
|
118
|
+
- そのとき何を確認し、どう対応するか。
|
|
154
119
|
|
|
155
|
-
|
|
120
|
+
コツ:
|
|
156
121
|
|
|
157
|
-
-
|
|
158
|
-
- 契機ごとに、確認する観点と対応方針をセットで書く。
|
|
159
|
-
- 記録先(プロジェクト登録簿、決定記録など)と、監視・取りまとめ・最終判断のロールを示す。
|
|
122
|
+
- 原因の仮説ごとに「反証されたら何を見直すか」を聞くと、契機と対応が対で決まる。
|
|
160
123
|
|
|
161
124
|
## 5. 深掘り手順
|
|
162
125
|
|
|
163
|
-
|
|
126
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
164
127
|
|
|
165
|
-
1.
|
|
166
|
-
2.
|
|
167
|
-
3.
|
|
168
|
-
4.
|
|
169
|
-
5.
|
|
170
|
-
6. **採用・非採用の理由** を判断軸で説明する。
|
|
171
|
-
7. **未確定事項と責任ロール** を残す。
|
|
128
|
+
1. 各課題の影響が、目指す価値のどれに当たるかを確かめ、対応のない課題を外すか価値を問い直す。
|
|
129
|
+
2. 各原因が課題 ID に結び付き、仮説に確認方法があるかを確かめる。
|
|
130
|
+
3. 各候補が、どの課題・原因を扱うかを確かめ、対応先のない案を外す。
|
|
131
|
+
4. 採否の理由が判断軸のどれによるかを確かめる。
|
|
132
|
+
5. 設計詳細や特定技術の採否を書いた箇所を、後続の成果物への参照に戻す。
|
|
172
133
|
|
|
173
134
|
## 6. 良い例 / 悪い例
|
|
174
135
|
|
|
@@ -178,28 +139,18 @@ Project Issues and Approach Writing Recipe
|
|
|
178
139
|
| 原因 | 事実: 担当ごとに記述様式が異なる / 仮説: 共通様式が浸透していない | なんとなく属人化している |
|
|
179
140
|
| 解決策候補 | A 案と B 案は同じ課題への代替、C 案は別原因への補完と整理する | とにかく標準化する |
|
|
180
141
|
| 採用理由 | A 案と C 案が異なる原因を扱い、単独では不足するため併用する | A 案がよさそうだから採用 |
|
|
181
|
-
| リスク | 実践の型の整合が崩れる → 品質管理とレビューで確認する | 特に問題はない |
|
|
182
142
|
|
|
183
143
|
## 7. レビュー観点
|
|
184
144
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
| 事実と仮説の区別 | 原因で事実と仮説が混ざっていないか |
|
|
192
|
-
| 候補の関係 | 方針が 2 件以上あり、代替・補完の関係と対応課題が明確か |
|
|
193
|
-
| 採用理由の説明可能性 | 採用・非採用が判断軸で説明され、後から再現できるか |
|
|
194
|
-
| 関係者・利用場面 | 関係者、利用場面、確認者、合意対象が読み取れるか |
|
|
195
|
-
| 責務分担 | 設計詳細・実装詳細・テスト設計を書きすぎていないか |
|
|
196
|
-
| 未確定の明示 | 未確定事項が _TODO_ / _UNDECIDED_ 等で明示されているか |
|
|
145
|
+
| 観点 | 確認内容 |
|
|
146
|
+
| ---------------- | -------------------------------------------------------------- |
|
|
147
|
+
| 業務価値との対応 | 課題と採用方針が、目指す価値・利用者・期待効果と対応しているか |
|
|
148
|
+
| 関係者・利用場面 | 承認者、利用ロール、合意対象が読み取れるか |
|
|
149
|
+
| 採否の再現性 | 後から読んだ人が、判断軸の順序から同じ採否を導けるか |
|
|
150
|
+
| 委譲の境界 | 設計詳細・実装詳細・特定技術の採否を書きすぎていないか |
|
|
197
151
|
|
|
198
152
|
## 8. 仕上げチェック
|
|
199
153
|
|
|
200
|
-
-
|
|
201
|
-
-
|
|
202
|
-
-
|
|
203
|
-
- 採用アプローチに判断軸と採用理由がある。
|
|
204
|
-
- 各採用アプローチを、目指す価値、課題・原因、候補案、採否理由、見直し記録へ ID で追跡できる。
|
|
205
|
-
- 曖昧表現や設計詳細を書きすぎていない。
|
|
154
|
+
- 各課題が原因・候補・採否まで課題 ID と案 ID でたどれる。
|
|
155
|
+
- 仮説を事実として書いていない。
|
|
156
|
+
- 課題・原因・リスクの記述に、個人や特定の組織を識別できる情報や非公開の観察事実がない。
|
|
@@ -11,42 +11,31 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Project Scope Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
本書では問い、深掘り手順、具体化のコツ、レビュー観点を扱います。
|
|
14
|
+
プロジェクトスコープを、関係者が今回やることとやらないことを合意できる内容に仕上げるための作り方を示す。
|
|
16
15
|
|
|
17
16
|
## 1. このレシピの使い方
|
|
18
17
|
|
|
19
|
-
-
|
|
20
|
-
- 次に、対象業務、対象システム、対象期間、スコープ外を分けて書く。
|
|
21
|
-
- 最後に、境界の判断基準とスコープ変更方針を置き、迷ったときの扱いを決める。
|
|
22
|
-
- 上位の目的・期待効果(Why)、対象業務・対象システム・対象期間・対象外(What)、境界判断と変更方針(How)を整理し、上位参照、対象項目、理由、変更記録で追跡する(Trace)。受入条件と設計・実装詳細は後続成果物へ委譲する。
|
|
18
|
+
- スコープは、プロジェクト概要の目的・期待効果(Why)を引き継ぎ、対象業務・対象システム・対象期間・スコープ外(What)を定め、任意で境界の判断基準と変更方針(How)を決める。各行は、上位の期待効果と境界の理由で、変更後は変更記録でもたどれるようにする(Trace)。
|
|
23
19
|
|
|
24
20
|
## 2. 作成前に集める情報
|
|
25
21
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
| 初期対象期間 | いつからいつまで、またはどのイベントまでを対象にするか。未確定なら _UNDECIDED_: で残す |
|
|
35
|
-
| 明示的な対象外 | やらないこと、理由、後続で扱う条件 |
|
|
36
|
-
| 境界で迷う項目 | 含めるか外すか判断が必要な候補 |
|
|
37
|
-
| 変更時の決め方 | 提案入口、影響評価、承認者、記録先 |
|
|
38
|
-
| 下流文書への委譲先 | 成功基準、前提・制約、課題、設計、実装、テストへ委譲する内容 |
|
|
22
|
+
| 項目 | 集める情報 | 取り出し元 |
|
|
23
|
+
| ---------------- | ------------------------------------------------------------ | ------------------------ |
|
|
24
|
+
| 目的と期待効果 | 取り組む理由、放置したときに悪化すること | プロジェクト概要 |
|
|
25
|
+
| 利用者と利用場面 | 誰が使い、誰の作業や判断が変わるか | プロジェクト概要、利用者 |
|
|
26
|
+
| 整備するもの | 作る・変える・運用するシステム、ツール、正本データ、生成物 | 既存の構成、実行責任者 |
|
|
27
|
+
| 期間の区切り | 初期対象の終わりを決める日付またはイベント | スケジュール、承認責任者 |
|
|
28
|
+
| 外す候補 | やらないことと理由、再検討する条件 | 関係者への確認 |
|
|
29
|
+
| 迷う候補 | 含めるか外すかで意見が分かれた項目と、そのときの判断のしかた | 確認の過程のメモ |
|
|
39
30
|
|
|
40
31
|
## 3. 全体の作成手順
|
|
41
32
|
|
|
42
|
-
1.
|
|
43
|
-
2.
|
|
44
|
-
3.
|
|
45
|
-
4.
|
|
46
|
-
5.
|
|
47
|
-
6.
|
|
48
|
-
7. スコープ変更方針で、提案入口、影響評価、承認者、記録先を定義する。
|
|
49
|
-
8. 最後に、設計詳細や受入条件を書きすぎていないか確認する。
|
|
33
|
+
1. 対象外の候補を先に書き出す。外すものが決まると、対象業務の範囲が狭まり書きやすくなる。
|
|
34
|
+
2. 対象業務を、利用者の作業や判断の単位で書く。
|
|
35
|
+
3. 対象システムを、対象業務を支えるものに限って並べる。
|
|
36
|
+
4. 対象期間で、初期対象と継続改善を分ける。
|
|
37
|
+
5. スコープ外に、1 で出した候補を理由と再検討条件を添えて書く。
|
|
38
|
+
6. 迷う候補が残った場合は境界の判断基準を、変更の決め方を合意した場合はスコープ変更方針を書く。どちらも任意の章で、なければ省く。
|
|
50
39
|
|
|
51
40
|
## 4. 各章の書き方
|
|
52
41
|
|
|
@@ -54,148 +43,103 @@ Project Scope Writing Recipe
|
|
|
54
43
|
|
|
55
44
|
問い:
|
|
56
45
|
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
- 対象にすることで、どの業務価値に近づくか。
|
|
60
|
-
- 何を運用・管理できる状態にしたいか。
|
|
61
|
-
|
|
62
|
-
書き方:
|
|
63
|
-
|
|
64
|
-
- 機能名だけでなく、利用者が行う作業や判断で書く。
|
|
65
|
-
- 「対象利用者」「利用場面」「利用者影響」を読み取れる粒度にする。
|
|
66
|
-
- 業務アプリケーション以外のプロジェクトでは、文書整備、公開準備、運用基盤整備などを活動領域として書く。
|
|
46
|
+
- 対象にすると、誰のどの作業や判断が変わるか。
|
|
47
|
+
- 作るだけでなく、運用・管理できる状態にしたいものは何か。
|
|
67
48
|
|
|
68
|
-
|
|
49
|
+
コツ:
|
|
69
50
|
|
|
70
|
-
-
|
|
71
|
-
|
|
72
|
-
悪い例:
|
|
73
|
-
|
|
74
|
-
- 販売管理機能を作る。
|
|
51
|
+
- 機能名を書き始めたら、利用者に「その機能で何をするか」を聞いて作業の言葉に直す。
|
|
52
|
+
- 背景や期待効果を概要から写したくなったら、写さず概要への参照に置き換える。
|
|
75
53
|
|
|
76
54
|
### 4.2. 対象システム
|
|
77
55
|
|
|
78
56
|
問い:
|
|
79
57
|
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
- 生成物の正本はどれで、直接編集してよいか。
|
|
83
|
-
- 外部連携や公開基盤はどこまで含めるか。
|
|
84
|
-
- 対象業務と対象システムの粒度は揃っているか。
|
|
85
|
-
- 後続の設計文書へ委譲すべき詳細を書いていないか。
|
|
58
|
+
- プロジェクトが整備・変更するツール、正本データ、生成物は何か。
|
|
59
|
+
- 外部サービスのうち、プロジェクトが担うのは設定・接続・利用のどこまでか。
|
|
86
60
|
|
|
87
|
-
|
|
61
|
+
コツ:
|
|
88
62
|
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
- 外部ツール本体を開発しない場合は、設定・接続・利用のみを対象とするなど責務境界を書く。
|
|
93
|
-
- UI、API、DB、テストケースの詳細は書かない。
|
|
63
|
+
- 業務機能と文書体系、補助ツールが混ざると粒度がずれやすい。並べた後で、同じ大きさの項目かを見直す。
|
|
64
|
+
- 生成物は、生成元の正本と直接編集してよいかを聞くと、責務の境界が決まる。
|
|
65
|
+
- 画面・API・DB の名前が出てきたら、設計の話なので書かない。
|
|
94
66
|
|
|
95
67
|
### 4.3. 対象期間
|
|
96
68
|
|
|
97
69
|
問い:
|
|
98
70
|
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
- 初回公開、初期リリース、運用定着、継続改善をどう分けるか。
|
|
102
|
-
- どのスケジュール文書を期間判断の根拠にするか。
|
|
71
|
+
- 初期対象はどの日付、または何が起きたら終わるか。
|
|
72
|
+
- 継続改善のうち、今回の範囲に含めるものはあるか。
|
|
103
73
|
|
|
104
|
-
|
|
74
|
+
コツ:
|
|
105
75
|
|
|
106
|
-
-
|
|
107
|
-
- 継続改善を含める場合は、初期スコープと継続改善フェーズを分ける。
|
|
108
|
-
- 未決事項は _UNDECIDED_: を優先し、決める文書またはタイミングを添える。実施待ちの作業を残す場合のみ _TODO_: を使い分ける。
|
|
76
|
+
- 日付が出ないときは「初回公開まで」のようにイベントで聞く。決まっていなければ _UNDECIDED_ を残し、決める時期を添える。
|
|
109
77
|
|
|
110
78
|
### 4.4. スコープ外
|
|
111
79
|
|
|
112
80
|
問い:
|
|
113
81
|
|
|
114
|
-
-
|
|
115
|
-
-
|
|
116
|
-
- 利用者に影響がある対象外項目は、後続でいつ再検討するか。
|
|
117
|
-
- 対象外を書かないことで誤解される項目はないか。
|
|
82
|
+
- 今回やらないことは何で、なぜ外すのか。
|
|
83
|
+
- 外したことで困る利用者がいる項目は、いつ再検討するか。
|
|
118
84
|
|
|
119
|
-
|
|
85
|
+
コツ:
|
|
120
86
|
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
- 「将来やるかもしれない」だけで終わらせず、再検討条件を添える。
|
|
87
|
+
- 「必要なら考える」は対象外になっていない。含めないと言い切り、再検討の条件を添える。
|
|
88
|
+
- 書かないと「含まれる」と誤解されやすい項目を、関係者に聞いて拾う。
|
|
124
89
|
|
|
125
|
-
### 4.5.
|
|
90
|
+
### 4.5. 境界の判断基準(任意)
|
|
126
91
|
|
|
127
92
|
問い:
|
|
128
93
|
|
|
129
94
|
- 含めるか外すかで迷ったとき、何を優先するか。
|
|
130
|
-
-
|
|
131
|
-
- 特定の技術、手法、個別要望に引っ張られたとき、どう判断するか。
|
|
95
|
+
- 個別の要望や特定の技術に引っ張られたとき、何で判断するか。
|
|
132
96
|
|
|
133
|
-
|
|
97
|
+
コツ:
|
|
134
98
|
|
|
135
|
-
-
|
|
136
|
-
- 判断基準は、後続のスコープ変更や優先度判断に再利用できる表現にする。
|
|
99
|
+
- 迷う候補で実際に判断した理由から書くと、後の変更判断にも使える原則になる。
|
|
137
100
|
|
|
138
|
-
### 4.6.
|
|
101
|
+
### 4.6. スコープ変更方針(任意)
|
|
139
102
|
|
|
140
103
|
問い:
|
|
141
104
|
|
|
142
|
-
-
|
|
143
|
-
-
|
|
144
|
-
- 何を確認してから判断するか。
|
|
145
|
-
- 誰が承認するか。
|
|
146
|
-
- 変更により影響を受ける成果物は何か。
|
|
105
|
+
- 誰がどこに変更を提案し、誰が決めるか。
|
|
106
|
+
- 初期リリース前に足すとき、何を外すか延期するか。
|
|
147
107
|
|
|
148
|
-
|
|
108
|
+
コツ:
|
|
149
109
|
|
|
150
|
-
-
|
|
151
|
-
- 初期リリース前に追加する場合は、同時に外すものや延期するものを示す。
|
|
152
|
-
- 判断理由を DEC、課題一覧、Issue、PR、変更要求ログのいずれかに残す。
|
|
110
|
+
- 「関係者で相談する」で止めず、決める人と判断理由を残す場所を聞く。
|
|
153
111
|
|
|
154
112
|
## 5. 深掘り手順
|
|
155
113
|
|
|
156
|
-
|
|
114
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
157
115
|
|
|
158
|
-
1.
|
|
159
|
-
2.
|
|
160
|
-
3.
|
|
161
|
-
4.
|
|
162
|
-
5. **初期対象と継続改善** を分ける。
|
|
163
|
-
6. **迷ったときの判断順序** を 2〜5 件に絞る。
|
|
164
|
-
7. **変更時の承認者と記録先** を決める。
|
|
116
|
+
1. 対象業務の各行が、概要のどの期待効果に応えるかを確かめ、対応のない行を外すかスコープ外へ移す。
|
|
117
|
+
2. 対象システムの各行が、どの対象業務を支えるかを確かめる。
|
|
118
|
+
3. スコープ外の各行に、外す理由と再検討条件があるかを確かめる。
|
|
119
|
+
4. 受入条件・設計・実装の詳細を書いた箇所を見つけ、後続の成果物へ移す。
|
|
165
120
|
|
|
166
121
|
## 6. 良い例 / 悪い例
|
|
167
122
|
|
|
168
|
-
| 観点 | 良い例 | 悪い例
|
|
169
|
-
| ------------ | --------------------------------------------------------------------- |
|
|
170
|
-
| 対象業務 | 店主代表以外が店番する場合でも販売・在庫・つけ残高を確認できる状態 | 販売管理を改善する
|
|
171
|
-
| 対象システム | 販売登録、管理データ、生成レポートを分け、編集・責務の境界を示す | 画面名、API、DBを混在させる
|
|
172
|
-
| 対象期間 | 初期リリースから2週間の記録継続確認までを対象にする | できるだけ早く公開する
|
|
173
|
-
| スコープ外 | EC は店頭販売の記録継続を優先するため対象外とし、次フェーズで検討する | 必要なら EC も考える
|
|
174
|
-
| 境界判断 | 日々使う業務を優先し、高度な分析は記録安定後に扱う | 便利そうなものは入れる
|
|
175
|
-
| 変更方針 | 提案入口、影響評価、承認者、記録先を表で示す | 関係者で相談して柔軟に決める |
|
|
123
|
+
| 観点 | 良い例 | 悪い例 |
|
|
124
|
+
| ------------ | --------------------------------------------------------------------- | --------------------------- |
|
|
125
|
+
| 対象業務 | 店主代表以外が店番する場合でも販売・在庫・つけ残高を確認できる状態 | 販売管理を改善する |
|
|
126
|
+
| 対象システム | 販売登録、管理データ、生成レポートを分け、編集・責務の境界を示す | 画面名、API、DBを混在させる |
|
|
127
|
+
| 対象期間 | 初期リリースから2週間の記録継続確認までを対象にする | できるだけ早く公開する |
|
|
128
|
+
| スコープ外 | EC は店頭販売の記録継続を優先するため対象外とし、次フェーズで検討する | 必要なら EC も考える |
|
|
129
|
+
| 境界判断 | 日々使う業務を優先し、高度な分析は記録安定後に扱う | 便利そうなものは入れる |
|
|
176
130
|
|
|
177
131
|
## 7. レビュー観点
|
|
178
132
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
|
182
|
-
|
|
|
183
|
-
|
|
|
184
|
-
| 利用者影響 | 対象利用者、利用場面、影響範囲が読み取れるか |
|
|
185
|
-
| 対象範囲 | 対象業務、対象システム、対象期間が判断可能な粒度か |
|
|
186
|
-
| システム境界 | 実行ツール、正本データ、生成物、外部サービスの責務を区別できるか |
|
|
187
|
-
| 対象外 | やらないこと、理由、再検討条件が明示されているか |
|
|
188
|
-
| 境界判断 | 迷ったときに使える優先順位や判断原則があるか |
|
|
189
|
-
| 変更運用 | 変更入口、影響評価、承認者、記録先があるか |
|
|
190
|
-
| 責務分担 | 受入条件、設計詳細、実装詳細を書きすぎていないか |
|
|
191
|
-
| 公開適性 | 個人情報、非公開情報、機密情報が含まれていないか |
|
|
133
|
+
| 観点 | 確認内容 |
|
|
134
|
+
| ------------ | -------------------------------------------------------------- |
|
|
135
|
+
| 業務価値 | 対象業務が概要の期待効果に対応し、利用者への影響が読み取れるか |
|
|
136
|
+
| システム境界 | ツール、正本データ、生成物、外部サービスの責務を区別できるか |
|
|
137
|
+
| 境界の合意 | 関係者が、迷う候補を含めるか外すかをこの文書だけで判断できるか |
|
|
192
138
|
|
|
193
139
|
## 8. 仕上げチェック
|
|
194
140
|
|
|
195
|
-
-
|
|
196
|
-
-
|
|
197
|
-
-
|
|
198
|
-
-
|
|
199
|
-
-
|
|
200
|
-
- 成功基準、受入条件、設計詳細、実装詳細を書きすぎていない。
|
|
201
|
-
- 各対象・対象外を上位の目的または期待効果、境界理由、再検討条件、変更記録へ追跡できる。
|
|
141
|
+
- 対象業務・対象システムの各行が、概要の期待効果と境界の理由へたどれる。変更した行は、変更記録にもたどれる。
|
|
142
|
+
- 未確定の期間に _UNDECIDED_ と決める時期がある。
|
|
143
|
+
- 境界の判断基準・スコープ変更方針は、書いた場合だけ、後の判断に使える原則と決める人があるかを確かめる。
|
|
144
|
+
- 受入条件・設計・実装の詳細を書いていない。
|
|
145
|
+
- 個人情報、公開できない情報、機密情報を含めていない。
|