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
|
@@ -1,84 +1,14 @@
|
|
|
1
|
-
##
|
|
2
|
-
|
|
3
|
-
この規約は、生成される全 exec plan に共通で適用される。result の完了条件、他文書を参照する際のリンク記法、成果物の状態(status)の扱いを統一する。
|
|
4
|
-
|
|
5
|
-
要点(次の `plan-essentials` マーカーの間の箇条書き)は、plan の本文にもそのまま転記される。plan に転記するとき、`_SCHEMA_REF_` はタスクごとに解決した schema のパスに置き換わり、schema の無いタスクではその行が除かれる。
|
|
1
|
+
## edit: 成果物の編集規約
|
|
6
2
|
|
|
7
3
|
<!-- plan-essentials:start -->
|
|
8
4
|
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
- リンクを表(テーブル)のセル内に置く場合は、区切りの `|` を `[[id\|title]]` のようにエスケープする。エスケープしないと列がずれて表が壊れ、prettier 整形でセルが分割されて固定化される。
|
|
13
|
-
- まだ存在しない文書を参照する場合は、`[[...]]` ではなく `` `id` `` または `` `filename` `` のようにバッククォートで仮置きする。
|
|
14
|
-
- Markdown の自由記述では、`_` を含む識別子・フィールド名(例: `depends_on`)を必ずインラインコードで囲む。result に描画される executor evidence や reporter の自由記述も同じ記法にする。
|
|
15
|
-
- 成果物 frontmatter の `status` を `ready` に変更しない。`ready` への昇格は人間のみが行うため、`draft` のまま据え置く(exec のコミット時ガードでも昇格はブロックされる)。
|
|
16
|
-
- ファイルの読み取り・書き込み・編集は、作業ディレクトリ(カレントディレクトリ)からの相対パスで指定する。絶対パスを自分で組み立てたり、作業ディレクトリ名を推測して指定したりしない(作業ディレクトリ名の取り違えは外部パス扱いになり拒否される)。
|
|
17
|
-
- 検査を実行する前に、リポジトリの `package.json`、`.specdojo/specdojo.config.json`、hook 設定(`lefthook.yml` など)を読み、本共通規約の詳細にある検査表の適用条件で、実行する検査を決める。
|
|
18
|
-
- 適用条件を満たさない検査は実行せず、executor evidence の validations に `not_applicable` と非適用の理由を `reason` へ記録する。適用される検査が 1 つもない場合も同じく、該当する検査ごとに `not_applicable` と理由を記録する。
|
|
19
|
-
- `not_run` は、適用される検査を実行できたのに実行しなかった場合だけに使う。runner は `not_run` を検証失敗として扱い、タスクを先へ進めない。
|
|
20
|
-
- `pipeline.parent_validations` に設定された検査は executor evidence の validations に含めなくてよい。executor が同じ検査を `not_run` または `not_applicable` として含めても、同じリポジトリで実行した親 runner の結果を正とする。
|
|
5
|
+
- 冗長さの判定は [[specdojo:pm-review-viewpoints|共通レビュー観点一覧]] の `vp-arc-conciseness` を正本とする。
|
|
6
|
+
- 同じ主張の繰り返し、表と本文の二重の説明、図をなぞる文、目的に要らない背景、正本の再掲は書かず、既存の記述は削る・まとめる・参照に置き換える。
|
|
7
|
+
- 判断に要る背景・制約・例外・完了条件は残し、長さだけでは削らない。
|
|
21
8
|
- YAML 成果物を編集した場合、対応 schema `_SCHEMA_REF_` に従って記述する。`package.json` に `validate:schema:file` script がある場合だけ、`npm run validate:schema:file -- --schema _SCHEMA_REF_ --data <対象ファイル>` で schema 検査を実施する。適用した検査でエラーが出た場合は修正してから完了とする。
|
|
22
9
|
|
|
23
10
|
<!-- plan-essentials:end -->
|
|
24
11
|
|
|
25
|
-
- 成果物に変更が不要と判断した場合でも、result の記入は省略しない。変更不要と判断した理由と根拠を result に記入してから完了する。
|
|
26
|
-
- result の変更ファイル欄には、変更したファイル(成果物・ソース・テストなど)ごとの実施内容を具体的に記入する。
|
|
27
|
-
- result が未記入・プレースホルダのまま終了コード 0 で終了すると、runner は成果物未完了(block)として扱い、タスクはやり直しになる。完了前に result の記入漏れがないことを必ず確認する。
|
|
28
|
-
- result の frontmatter は scaffold 済みの構造を正本とする。`id` / `task_id` / `mode` / `project_id` / `plan_ref` / `agent` / `execution` / `approach` / `targets` はキーの追加・削除・改名をせず、scaffold された値のまま維持する。見出し構成(`# Edit Result` などの H1、`## 1.` 以降の章立て)も独自の構成に置き換えない。埋めるのは本文セクションの `_TODO_` プレースホルダの中身だけである。`status` と `completed_at` は完了処理(runner 側)が更新するため、自分で書き換えない。
|
|
29
12
|
- plan に「プロジェクトコンテキスト」章がある場合、そこに挙がる文書はプロジェクト共通の前提を読むための参照であり、成果物 frontmatter の `based_on` へ転記しない。参照して得た前提は本文の記述内容へ反映する。
|
|
30
13
|
- 成果物 frontmatter の `based_on` に書けるのは、その成果物の `depends_on` の推移閉包に含まれる先行成果物だけである。閉包外の ID を書くと `catalog validate` が「`based_on` が `depends_on` の推移閉包に含まれていません」としてエラーになり、コミットがブロックされる。`based_on` を増やす必要が生じた場合は、自分で転記せず、根拠不足として result に記録する。
|
|
31
|
-
- 編集・書き込みが作業ディレクトリ外(`external_directory`)として拒否された場合、原因はパス指定の誤り(誤った絶対パス・ディレクトリ名の取り違え)である。bash の heredoc などへ回避的に切り替えず、相対パスに直したうえで同じ編集ツールで再実行する。
|
|
32
|
-
- 作業用のファイル(編集用スクリプト、検証用の一時データなど)はリポジトリの外(一時ディレクトリ)または worktree の `tmp/` 配下に置き、終了前に削除する。使い捨てのファイルを最上位に作らない。`tmp/` 配下のファイルは commit の対象から除外される。
|
|
33
|
-
- 整形・静的検査は、この plan の完了手順または本共通規約で明示されたコマンドを実行する。変更対象に必要な test、build、schema 検証は、plan に個別記載がなくても実行してよい。同じ test script では対象限定と全件を同一 executor run 内で連続実行せず、どちらか一方に絞る。下表、plan、またはプロジェクト標準が全件 test を求める場合は、全件を1回だけ実行して対象限定の実行を省く。この制約は executor が sandbox 内で実行する test script の回数に対するものであり、親検証に設定された ID のコマンドは対象外である(親 runner が別途実行する)。実行したコマンド・対象・結果は result に記録する。
|
|
34
|
-
- executor / reporter pipeline で親 runner の検証が設定されている場合、executor は設定済み ID に対応するコマンドを sandbox 内で実行せず、executor 終了後に親 runner が固定許可リストから実行して evidence へ追記する。`validate-schema` は `npm run validate:schema`、`test-unit` は `npm run test:unit`、`test-integration` は `npm run test:integration` に対応する。executor は親検証と同じコマンドの対象限定版も追加せず、二重実行しない。executor が親検証のコマンドを validations に含めた場合も、同じリポジトリで実行された親 runner の結果を正とし、executor の `not_run` / `not_applicable` は pipeline を失敗させない。
|
|
35
|
-
- 適用条件の判定と `not_applicable` / `not_run` の使い分けは、要点に記した規則に従う。誤って `not_run` と記録しても、npm script・依存 package の不在、または SpecDojo サブコマンドの設定上の非適用を runner が機械的に確定できる場合は適用外として扱われるが、この救済を前提に記録を省略しない。
|
|
36
|
-
- 依存パッケージの有無は、対象リポジトリの `package.json` の `dependencies` / `devDependencies` と、リポジトリに固定された package manager の設定を基準に判断する。`npx` が未導入パッケージをネットワークから一時取得できることは、導入済みとはみなさない。設定ファイルがない、壊れているなどの理由で適用条件を確定できない検査は実行せず、validations に `not_applicable` として理由と次の確認事項を記録する。
|
|
37
|
-
- `npm init` が `package.json` に入れる仮の `test` script(`echo "Error: no test specified" && exit 1` と、引用符の有無・種類や空白だけが違う変種)は、常に失敗する仮置きであり、`test` script がないものとみなす。`npm test` は実行せず、validations に `not_applicable` と、仮の script である旨を `reason` に記録する。runner も同じ判断で `not_applicable` を受け付ける。本物の test script がある場合は適用される。
|
|
38
14
|
- Markdown 成果物を編集した場合、Prettier が導入されているときだけ `npx prettier --write <対象ファイル>` で整形する。`markdownlint-cli` または `markdownlint` が導入されているときだけ `npx markdownlint <対象ファイル>` を実行し、`markdownlint-cli2` を採用するリポジトリでは、そのリポジトリで定めた CLI2 のコマンドを実行する。適用した検査でエラーが出た場合は修正してから完了とする。
|
|
39
|
-
- 終了する前に、コミット時に実行される検査(pre-commit 相当)のうち、現在のリポジトリに設定され、上記の適用条件を満たすものを先回りで実行する。適用した検査の失敗はすべて修正してから完了する。
|
|
40
|
-
- 実行対象は、変更したファイルの種別で判断する。下表のうち、変更したファイルが該当し、かつ適用条件を満たす行の検査を実行する。該当行がない場合や適用条件を満たさない場合は追加の検査は不要である。ただし親検証に設定された ID のコマンドは下表よりも優先し、executor は実行しない。下表に同じコマンドが挙がっていても、親 runner の実行に委ねる。
|
|
41
|
-
- 検査コマンドの正本はリポジトリの hook 設定(`lefthook.yml` など)である。下表と設定が食い違う場合は、適用条件を満たす設定側のコマンドに合わせ、実行したコマンドと結果を result に記録する。`specdojo` コマンドは、リポジトリで定められた起動方法(`npx specdojo <subcommand>`、`npx tsx src/specdojo.ts <subcommand>` など)で実行する。ただし、sandbox 環境で `tsx` の IPC エラー(`EPERM`)が発生する場合は、代わりに `node --import tsx src/specdojo.ts <subcommand>` を使用して実行する。
|
|
42
|
-
|
|
43
|
-
| 変更したファイル | 適用条件 | 実行する検査 |
|
|
44
|
-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
-
| `*.md` | 対応するローカル依存が `package.json` にある | `npx prettier --write <対象ファイル>`、導入済み実装に対応する markdownlint コマンド |
|
|
46
|
-
| `*.ts` / `*.js` / `*.json` / `*.yaml` / `*.yml` | Prettier が `package.json` にある | `npx prettier --write <対象ファイル>` |
|
|
47
|
-
| `src/`、`tests/`、`scripts/`、`tools/`、`tsconfig*.json` | `package.json` に `typecheck` script がある | `npm run typecheck` |
|
|
48
|
-
| `src/`、`tests/`、`docs/ja/specdojo/templates/`、`docs/ja/specdojo/exec-templates/`、`vitest.config.*` | pipeline executor は `test:unit`、それ以外は `test` script が `package.json` にある(`npm init` の仮の `test` script は、ないものとみなす) | pipeline executor は `npm run test:unit`、それ以外は `npm test`(`test-unit` が親検証に設定されている場合は executor では実行しない) |
|
|
49
|
-
| `docs/ja/projects/` 配下 | 対象 project に `catalog_path` が設定されている | `specdojo catalog validate` |
|
|
50
|
-
| `dct-*.yaml` | 対象 project に `catalog_path` が設定されている | `specdojo catalog build` |
|
|
51
|
-
| `pjr-index.md` | 対象 project に `project_register_path` が設定されている | `specdojo register build` |
|
|
52
|
-
| `sch-*.yaml` | 対象 project に `schedule_path` が設定されている | `specdojo exec refresh` |
|
|
53
|
-
| `docs/` 配下 | リポジトリで定められた起動方法により SpecDojo CLI を実行できる | `specdojo index build` |
|
|
54
|
-
|
|
55
|
-
<!-- review-only:start -->
|
|
56
|
-
|
|
57
|
-
### review の判断手順
|
|
58
|
-
|
|
59
|
-
review plan に共通で適用する。review はタスクの成果を判定し、成果物の品質は判定しない。成果物の品質は grade が一度だけ評価する。review はその評価結果(grade・finding)を事実として受け取り、このタスクを完了してよいかを判断する([[bps-task-completion]])。
|
|
60
|
-
|
|
61
|
-
- 成果物を再評価しない。観点ごとの pass / fail を付け直したり、評価結果の判定を自分の判断で置き換えたりしない。評価結果の内容に疑義がある場合は、疑義の内容と再評価が必要な理由を改善指示に記録する。
|
|
62
|
-
- 評価結果の鮮度を最初に確認する(`E-01`)。plan の「評価結果」章に示す評価対象と `--target` を使い、`specdojo grade list --target <対象種別> --path <評価対象> --changed-only` を実行する。`--target deliverable` の場合は `--dependency-changed` でも同様に実行する。いずれかが評価対象のパスを出力した場合、または評価結果サイドカーが存在しない場合は、評価結果が最新でない。成果物を自分で評価して補わず、verdict を `grade-stale` とする。
|
|
63
|
-
- 評価結果を確定できない場合(`E-02`)は、verdict を `grade-unavailable` とする。サイドカーを読み取れない場合と、`specdojo grade list --target <対象種別> --path <評価対象> --incomplete` が評価対象のパスを出力する場合(評価パイプラインが未完了)が該当する。
|
|
64
|
-
- 評価結果が最新であれば、サイドカーの `verdict` / `score` / `finding_counts` / `findings`、および `done_criteria`(存在する場合)を読み取る。
|
|
65
|
-
- 変更内容・この plan・実行記録・完了条件・最新の finding を照合し、このタスクの範囲と完了条件を満たすかを判断する(`S-02`)。完了条件の充足は、評価結果に判定がある場合はそれを事実として用いる。評価結果が扱わない事項を review で確かめる。対象は、フェーズ説明が求めた変更が行われたか、対象外の変更が混入していないか、実行記録の検証結果が成功しているかである。実行記録(先行する edit タスクの result)を特定できない場合は、確認できなかったことを判断根拠に記録する。
|
|
66
|
-
- finding が残っていても、このタスクの範囲と完了条件を満たしていれば完了できる。その場合は finding を消去・再評価せず、完了を妨げない理由と必要な改善指示を記録する。
|
|
67
|
-
- 判断の根拠は、評価結果・成果物・plan・実行記録を実際に読んで得た具体的な事実に限る。executor の最終メッセージや result の自己申告を、そのまま、または言い換えて根拠にしない。
|
|
68
|
-
- verdict を記録する直前に鮮度の確認を再実行する。最初の確認の後に成果物が変更されて評価結果が最新でなくなった場合は、verdict を `changed-during-review` とする(review 中の成果物変更)。
|
|
69
|
-
|
|
70
|
-
verdict は次の 6 値から 1 つを選ぶ。各値は [[bps-task-completion]] の検証・受入観点と一対一に対応する。
|
|
71
|
-
|
|
72
|
-
| verdict | 受入観点 | 選ぶ条件 | 記録すること |
|
|
73
|
-
| ------------------------ | ----------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
74
|
-
| `complete` | 完了可能 | 評価結果が最新で、plan と完了条件を満たし、完了を妨げる未充足事項がない | 照合した根拠 |
|
|
75
|
-
| `complete-with-findings` | 品質 finding を伴う完了 | 評価結果に finding があるが、このタスクの範囲と完了条件は満たしている | finding が完了を妨げない理由と改善指示 |
|
|
76
|
-
| `incomplete` | 品質良好だが未完了 | plan または完了条件に未充足事項がある(grade の良否は問わない) | 未充足事項と、再計画に使う改善指示 |
|
|
77
|
-
| `grade-stale` | 評価結果が最新でない | 評価結果がない、`content_hash` が一致しない、または評価コンテキストの変化が未反映 | 鮮度確認のコマンドと出力。完了可否は判断しない |
|
|
78
|
-
| `grade-unavailable` | 評価不能 | 評価結果を読み取れない、または評価パイプラインが未完了で grade・finding が未確定 | 評価不能の理由と不足情報。完了は保留する |
|
|
79
|
-
| `changed-during-review` | review 中の成果物変更 | 最初の鮮度確認の後に成果物が変更され、評価結果が最新でなくなった | 変更を検知した確認の出力。verdict を確定せず再評価を求める |
|
|
80
|
-
|
|
81
|
-
- verdict が `complete` 以外でも、review result を記録できた場合は正常終了する(終了コード 0)。runner は verdict に応じて再評価または再計画へ進む。
|
|
82
|
-
- review result の章立ては `評価結果の確認`、`判断根拠`、`未充足事項・改善指示`、`approach に応じた確認`、`decision` である。`decision` の `verdict` は必ず上表の値で埋める。
|
|
83
|
-
|
|
84
|
-
<!-- review-only:end -->
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
_FRONTMATTER_
|
|
2
|
+
|
|
3
|
+
# Condense Plan: _TASK_ID_
|
|
4
|
+
|
|
5
|
+
## 1. このフェーズで行うこと
|
|
6
|
+
|
|
7
|
+
_PHASE_DESCRIPTION_
|
|
8
|
+
|
|
9
|
+
既存の 1 文書の中の冗長さを直す。内容を書き足す最後の edit(標準では磨き込み)の後、review の前に実行する。文書をまたぐ重複の整理は `cross-deliverable-dedup` に委ねる。
|
|
10
|
+
|
|
11
|
+
## 2. 対象と参照
|
|
12
|
+
|
|
13
|
+
- `name`: _DELIVERABLE_NAME_
|
|
14
|
+
- `path`: `_DELIVERABLE_PATH_`
|
|
15
|
+
- `rulebook`: `_RULEBOOK_REF_`
|
|
16
|
+
- `recipe`: `_RECIPE_REF_`
|
|
17
|
+
- `sample`: `_SAMPLE_REF_`
|
|
18
|
+
- `template`: `_TEMPLATE_REF_`
|
|
19
|
+
- `result`: `_RESULT_REF_`
|
|
20
|
+
|
|
21
|
+
判定の正本は [[specdojo:pm-review-viewpoints|共通レビュー観点一覧]] の `vp-arc-conciseness`。対象の rulebook と完了条件、原因の根拠に必要な宣言済み Kata だけを読む。ほかの文書は変更しない。
|
|
22
|
+
|
|
23
|
+
_DONE_CRITERIA_GOALS_
|
|
24
|
+
|
|
25
|
+
## 3. 進め方
|
|
26
|
+
|
|
27
|
+
1. 対象文書を読み、繰り返し(`repetition`)、表と本文の二重の説明(`table-prose`)、図をなぞる文(`figure-prose`)、目的に要らない背景(`unneeded-background`)、正本の再掲(`canonical-restatement`)の候補を場所ごとに洗い出す。判定は上記の観点の正本で確かめる。
|
|
28
|
+
2. 判断に要る背景・制約・例外・完了条件は残す。長さだけで削らず、内容・決定・完了条件の意味を変えない。新しい内容を足さない。
|
|
29
|
+
3. 候補ごとに削る(`delete`)・まとめる(`merge`)・既存の正本への参照に置き換える(`reference`)のどれかで直す。残す必要がある候補は `retain` として理由を記録する。
|
|
30
|
+
4. 原因は `FindingCause` の `document` または `kata` とする。`kata` は宣言済み Kata の種類(`kind`)と根拠の箇所(`location`)を示せる場合だけ使い、示せない場合は `document` とする。Kata 自身は編集しない。
|
|
31
|
+
5. 修正前の場所・種類・直し方・意味を保った根拠または残した理由・原因を 1 件ずつ記録し、必須情報が維持されたことを確認する。候補がなければ変更不要の理由を報告する。
|
|
32
|
+
|
|
33
|
+
## 4. result への記録
|
|
34
|
+
|
|
35
|
+
[[specdojo:plan-result-lifecycle-guide]] の condense の記録形式に従い、result の frontmatter の `condense_records` と本文の表を対応させる。リストが空の場合も `[]` を明示する。
|
|
36
|
+
|
|
37
|
+
pipeline executor は result を編集せず、最終報告の `<specdojo_executor_evidence>` 内に `condense_records` を追加する。各要素は `location`、`category`、`action`、`reason`、`cause` の 5 項目とし、原因は `{"type":"document"}` または `{"type":"kata","kind":"recipe","location":"見出し・行・引用"}` の形で書く。runner が検証し、frontmatter と表へ同じ記録を転記する。
|
|
38
|
+
|
|
39
|
+
## 5. 完了手順
|
|
40
|
+
|
|
41
|
+
1. 対象文書だけを修正し、意味と必須情報が維持されたことを確認する。
|
|
42
|
+
2. 共通規約に従って整形・静的検査を行う。
|
|
43
|
+
3. 修正・保持の記録と検証結果を報告する。単独実行では result の必須セクションを埋める。
|
|
44
|
+
|
|
45
|
+
## 6. 異常終了の条件
|
|
46
|
+
|
|
47
|
+
- 対象が未作成・対象が複数・意味の維持を判断できない・静的検査未解消の場合は終了コード 1 とし、理由・根拠・次の行動を報告する。
|
|
48
|
+
- 標準エラー出力には `blocked: <reason>; need=<next action>; ref=<path>` を記録する。状態遷移は runner が行う。
|
|
49
|
+
|
|
50
|
+
_COMMON_CONVENTIONS_
|
|
@@ -38,7 +38,7 @@ draft は、文脈で任された範囲を調べて成果物を下書きする
|
|
|
38
38
|
|
|
39
39
|
### 4.1. 参照範囲
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
参照してよい文書・情報は次のとおり。存在する資料を実際に読み込む。宣言の無い項目は推測で補わない。
|
|
42
42
|
|
|
43
43
|
- rulebook(構造・必須要素・禁止事項): `_RULEBOOK_REF_`
|
|
44
44
|
- 併せて適用する rulebook(記法など): _RULEBOOK_INCLUDES_
|
|
@@ -46,14 +46,25 @@ draft は、文脈で任された範囲を調べて成果物を下書きする
|
|
|
46
46
|
- sample(完成例の粒度・文体・表現): `_SAMPLE_REF_`
|
|
47
47
|
- template(開始時の雛形): `_TEMPLATE_REF_`
|
|
48
48
|
- 対象成果物の `depends_on` 成果物と frontmatter の `based_on`(「対象成果物」に表示)。
|
|
49
|
+
- 「実装エビデンスと未作成の依存」に列挙した実装の根拠(読み取り専用)。
|
|
49
50
|
- プロジェクトコンテキスト(`project_context`)。
|
|
50
51
|
- 個票の `入力` とカタログの `brief`(「対象成果物」に表示。値が無いときは載せない)。
|
|
51
52
|
- 対象成果物内の文脈(`_CONTEXT_:` など、人が記入した指示)。
|
|
52
53
|
- 文脈で任された調査・選定に必要な外部の情報(出典つき)。
|
|
53
54
|
|
|
54
|
-
rulebook
|
|
55
|
+
rulebook を構造の基準とし、書き方が文書間で矛盾する場合は rulebook を正とする。sample は形式の参考とし、その業務内容・固有名詞・値を対象成果物の事実として転記しない。`_MISSING_` は未宣言・未整備または非適用を示す。必要な型の欠落や内容の薄さは result に記録し、存在する型・対象成果物・上記の文脈を用いて進める。
|
|
55
56
|
|
|
56
|
-
### 4.2.
|
|
57
|
+
### 4.2. 実装エビデンスと未作成の依存
|
|
58
|
+
|
|
59
|
+
次の参照は成果物カタログの `evidence_refs` から展開した読み取り専用の実装の根拠である。`targets`、変更許可範囲、commit 対象には含めない。
|
|
60
|
+
|
|
61
|
+
_IMPLEMENTATION_EVIDENCE_
|
|
62
|
+
|
|
63
|
+
実装エビデンスは現在動作の事実、rulebook は書き方、`depends_on` と個票の `入力` は意図された仕様の根拠として使い分ける。食い違いは実装へ無条件に合わせず、承認根拠のある現在動作だけを反映し、未承認の乖離は意図された仕様を保持して result に記録する。実装から目的・業務判断・将来方針を推測しない。
|
|
64
|
+
|
|
65
|
+
`depends_on` の「未作成」は参照できる本文がまだないことを示す。未作成の依存だけを理由に異常終了せず、存在する資料で進める。内容を推測で埋めず、必要な箇所は _TODO_ / _ASSUMPTION_ として、不足する根拠と次のアクションを残す。
|
|
66
|
+
|
|
67
|
+
### 4.3. 調査・下書きと具体化の許可
|
|
57
68
|
|
|
58
69
|
1. 文脈から、対象成果物の責務、固定された前提、調査・選定を任された範囲を特定する。指示が曖昧なら、任されていない範囲まで選定を広げない。
|
|
59
70
|
2. 文脈で任された範囲に限り「根拠のない具体化の禁止」を外し、外部の情報を調べて値を決めてよい。技術・設定値などを選ぶ場合は、出典を確認し、対象の前提と選定理由を説明する。
|
|
@@ -67,7 +78,7 @@ _GRADE_FINDINGS_
|
|
|
67
78
|
|
|
68
79
|
plan に展開された finding は、message と同じ viewpoint ID の判定根拠に照らして解消する。未解消、根拠不足、または判断不能の場合は、理由と次のアクションを result に記録する。grade result サイドカーは本タスクでは直接編集しない。
|
|
69
80
|
|
|
70
|
-
### 4.
|
|
81
|
+
### 4.4. 判断根拠の記録
|
|
71
82
|
|
|
72
83
|
result の `進め方と実践の型の適用` セクションに、任された範囲、参照した型と文脈、選んだ提案値ごとの出典と選定理由、本文へ反映した元の指示、未決事項を記録する。外部の情報には URL・文書名など、後から出典へ到達できる情報を付ける。下書きの後は fully-guided で磨き込み、finalize で人が確定する。
|
|
73
84
|
|
|
@@ -86,7 +97,8 @@ _DONE_CRITERIA_GOALS_
|
|
|
86
97
|
|
|
87
98
|
## 7. 異常終了の条件
|
|
88
99
|
|
|
89
|
-
-
|
|
100
|
+
- 実行に必要なツール・パッケージの依存を解決できない、対象ファイルのパスが特定できない、または lint/test 未解消の場合は異常終了する(終了コード 1)。
|
|
101
|
+
- 未作成の `depends_on` と `evidence_refs` の欠落だけでは異常終了しない。未作成の依存の内容は推測せず _TODO_ / _ASSUMPTION_ と次のアクションを残す。
|
|
90
102
|
- 標準エラー出力に理由を出力する(例: `blocked: <reason>; need=<next action>; ref=<path>`)。
|
|
91
103
|
- agent 自身は claim / complete / reopen / block を記録せず、終了コードと標準エラー出力で runner に結果を返す。
|
|
92
104
|
|
|
@@ -50,18 +50,30 @@ fully-guided は既存成果物の磨き込み専用である。雛形からの
|
|
|
50
50
|
3. recipe: `_MISSING_` でなければ指定された recipe を読み込み、示された問い・観点・深掘り手順に沿って内容を組み立てる。
|
|
51
51
|
4. sample: `_MISSING_` でなければ指定された sample を読み込み、rulebook の要求を満たす完成例の形式(章・表・記述の粒度)を確認する。sample は形式の参照に限って使い、sample の業務内容・固有名詞・値を対象成果物へ転記しない。
|
|
52
52
|
|
|
53
|
-
磨き込みでは template は読み込まない。粒度・文体・表現・章構成は、既存の対象成果物を基準としてそろえる。sample は既存の対象成果物に該当する記述が無い箇所や、rulebook の要求を形式に落とす方法が判断できない箇所の参考に限る。既存の対象成果物と sample の形式が異なる場合は、rulebook
|
|
53
|
+
磨き込みでは template は読み込まない。粒度・文体・表現・章構成は、既存の対象成果物を基準としてそろえる。sample は既存の対象成果物に該当する記述が無い箇所や、rulebook の要求を形式に落とす方法が判断できない箇所の参考に限る。既存の対象成果物と sample の形式が異なる場合は、rulebook の許容範囲内である限り既存の対象成果物を優先する。書き方が複数の文書間で矛盾する場合は rulebook を正とする。
|
|
54
54
|
|
|
55
55
|
### grade result から展開された finding
|
|
56
56
|
|
|
57
57
|
_GRADE_FINDINGS_
|
|
58
58
|
|
|
59
|
+
`cause` は原因の所在を示す。`kata:<kind>` の指摘も成果物側の修正が必要なため、この plan に載るすべての指摘を扱う。Kata の手入れは対応する maintenance の段で行う。
|
|
60
|
+
|
|
59
61
|
plan に展開された finding は、message と同じ viewpoint ID の判定根拠に照らして解消する。未解消、根拠不足、または判断不能の場合は、理由と次のアクションを result の `進め方と実践の型の適用` セクションに記録する。grade result サイドカーは再評価時に更新されるため、本タスクでは直接編集しない。
|
|
60
62
|
|
|
61
|
-
参照してよい文書は、宣言された文書だけに限る。具体的には、対象成果物、本セクションの rulebook / 併せて適用する rulebook / recipe / sample、`対象成果物` セクションの `depends_on` 成果物、対象成果物の frontmatter の `based_on`、プロジェクトコンテキスト(`project_context`)、個票の `入力`、カタログの `brief`
|
|
63
|
+
参照してよい文書は、宣言された文書だけに限る。具体的には、対象成果物、本セクションの rulebook / 併せて適用する rulebook / recipe / sample、`対象成果物` セクションの `depends_on` 成果物、対象成果物の frontmatter の `based_on`、プロジェクトコンテキスト(`project_context`)、個票の `入力`、カタログの `brief` である。加えて、下記「実装エビデンスと未作成の依存」に列挙した実装の根拠を読み取り専用で参照する。`入力` と `brief` は値が無いときは載せない。これらに宣言されていない他のプロジェクト文書・実装や外部の情報を独自に探索・参照しない。磨き込みは宣言された資料とこの plan 自身の記述(フェーズ説明・完了の狙い)だけを根拠に行い、不足があっても未宣言の文書を追加で読んで補わない。それでも判断できない箇所は憶測で埋めず _TODO_ / _ASSUMPTION_ として論点を残す。
|
|
62
64
|
|
|
63
65
|
本タスクの実行に必要な fully-guided の参照方針は、このセクションで完結する。approach 全体の定義(他 approach との対比や review への適用)を確認したい場合のみ、参考として [[specdojo:ryu-guide]] を参照する。
|
|
64
66
|
|
|
67
|
+
### 実装エビデンスと未作成の依存
|
|
68
|
+
|
|
69
|
+
次の参照は成果物カタログの `evidence_refs` から展開した読み取り専用の実装の根拠である。`targets`、変更許可範囲、commit 対象には含めない。
|
|
70
|
+
|
|
71
|
+
_IMPLEMENTATION_EVIDENCE_
|
|
72
|
+
|
|
73
|
+
実装エビデンスは現在動作の事実、rulebook は書き方、`depends_on` と個票の `入力` は意図された仕様の根拠として使い分ける。食い違いは実装へ無条件に合わせず、承認根拠のある現在動作だけを反映し、未承認の乖離は意図された仕様を保持して result に記録する。実装から目的・業務判断・将来方針を推測しない。
|
|
74
|
+
|
|
75
|
+
`depends_on` の「未作成」は参照できる本文がまだないことを示す。未作成の依存だけを理由に異常終了せず、存在する資料で進める。内容を推測で埋めず、必要な箇所は _TODO_ / _ASSUMPTION_ として、不足する根拠と次のアクションを残す。
|
|
76
|
+
|
|
65
77
|
### 4.1. 必要な実践の型が存在しない・内容が薄い場合
|
|
66
78
|
|
|
67
79
|
- `not-needed` ではない rulebook / recipe が存在しない、または基準として機能しないほど内容が薄い場合は、その事実と判断を result の `進め方と実践の型の適用` セクションに記録する。
|
|
@@ -111,7 +123,8 @@ _DONE_CRITERIA_GOALS_
|
|
|
111
123
|
|
|
112
124
|
## 7. 異常終了の条件
|
|
113
125
|
|
|
114
|
-
-
|
|
126
|
+
- 実行に必要なツール・パッケージの依存を解決できない、対象ファイルのパスが特定できない、または lint/test 未解消の場合は異常終了する(終了コード 1)。
|
|
127
|
+
- 未作成の `depends_on` と `evidence_refs` の欠落だけでは異常終了しない。未作成の依存の内容は推測せず _TODO_ / _ASSUMPTION_ と次のアクションを残す。
|
|
115
128
|
- 標準エラー出力に理由を出力する(例: `blocked: <reason>; need=<next action>; ref=<path>`)。
|
|
116
129
|
- agent 自身は claim / complete / reopen / block を記録せず、終了コードと標準エラー出力で runner に結果を返す。
|
|
117
130
|
|
|
@@ -10,6 +10,7 @@ _PHASE_DESCRIPTION_
|
|
|
10
10
|
|
|
11
11
|
- `name`: _DELIVERABLE_NAME_
|
|
12
12
|
- `depends_on`: _DELIVERABLE_DEPENDS_ON_
|
|
13
|
+
- 個票の `入力`: _REGISTER_INPUT_
|
|
13
14
|
- `overview`: _DELIVERABLE_OVERVIEW_
|
|
14
15
|
- `path`: `_DELIVERABLE_PATH_`
|
|
15
16
|
- `result`: `_RESULT_REF_`
|
|
@@ -34,14 +35,22 @@ _OWNER_ROLE_VIEWPOINTS_
|
|
|
34
35
|
主な基準とする recipe(rulebook frontmatter から解決): `_RECIPE_REF_`(`_MISSING_` の場合は「recipe が存在しない・内容が薄い場合」に従う)。
|
|
35
36
|
|
|
36
37
|
1. recipe: 指定された recipe を読み込み、示された構成・問い・観点・深掘り手順に沿って成果物を組み立てる。
|
|
37
|
-
2. recipe が答えを示さない箇所は、`depends_on` 成果物およびプロジェクトコンテキストとの整合で補う。参照してよい文書は、この plan に記載された recipe、`対象成果物` セクションの `depends_on`
|
|
38
|
+
2. recipe が答えを示さない箇所は、`depends_on` 成果物およびプロジェクトコンテキストとの整合で補う。参照してよい文書は、この plan に記載された recipe、`対象成果物` セクションの `depends_on` 成果物、プロジェクトコンテキスト、下記「実装エビデンスと未作成の依存」に列挙した読み取り専用の実装の根拠、個票の `入力` に限る。plan に列挙されていない他のプロジェクト文書・実装を独自に探索・参照せず、判断できない箇所は憶測で埋めず _TODO_ / _ASSUMPTION_ として論点を残す。
|
|
38
39
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
rulebook / sample / template は未成熟と判断されているため、存在しても構造・文体・粒度の必須基準としては扱わない。recipe の指示が他の文書と矛盾する場合は recipe を優先する。
|
|
40
|
+
rulebook / sample / template は未成熟と判断されているため、存在しても構造・文体・粒度の必須基準としては扱わない。書き方について recipe の指示が他の文書と矛盾する場合は recipe を優先する。
|
|
42
41
|
|
|
43
42
|
本タスクの実行に必要な recipe-guided の参照方針は、このセクションで完結する。approach 全体の定義(他 approach との対比や review への適用)を確認したい場合のみ、参考として [[specdojo:ryu-guide]] を参照する。
|
|
44
43
|
|
|
44
|
+
### 実装エビデンスと未作成の依存
|
|
45
|
+
|
|
46
|
+
次の参照は成果物カタログの `evidence_refs` から展開した読み取り専用の実装の根拠である。`targets`、変更許可範囲、commit 対象には含めない。
|
|
47
|
+
|
|
48
|
+
_IMPLEMENTATION_EVIDENCE_
|
|
49
|
+
|
|
50
|
+
実装エビデンスは現在動作の事実、recipe(この approach では rulebook を構造・文体の基準にしない)は書き方、`depends_on` と個票の `入力` は意図された仕様の根拠として使い分ける。食い違いは実装へ無条件に合わせず、承認根拠のある現在動作だけを反映し、未承認の乖離は意図された仕様を保持して result に記録する。実装から目的・業務判断・将来方針を推測しない。
|
|
51
|
+
|
|
52
|
+
`depends_on` の「未作成」は参照できる本文がまだないことを示す。未作成の依存だけを理由に異常終了せず、存在する資料で進める。内容を推測で埋めず、必要な箇所は _TODO_ / _ASSUMPTION_ として、不足する根拠と次のアクションを残す。
|
|
53
|
+
|
|
45
54
|
### 4.1. recipe が存在しない・内容が薄い場合
|
|
46
55
|
|
|
47
56
|
- recipe は recipe-guided の唯一の主基準であるため、存在しない、または基準として機能しないほど内容が薄い場合は、その事実と判断を result の `進め方と実践の型の適用` セクションに記録する。
|
|
@@ -75,7 +84,8 @@ _DONE_CRITERIA_GOALS_
|
|
|
75
84
|
|
|
76
85
|
## 7. 異常終了の条件
|
|
77
86
|
|
|
78
|
-
-
|
|
87
|
+
- 実行に必要なツール・パッケージの依存を解決できない、対象ファイルのパスが特定できない、または lint/test 未解消の場合は異常終了する(終了コード 1)。
|
|
88
|
+
- 未作成の `depends_on` と `evidence_refs` の欠落だけでは異常終了しない。未作成の依存の内容は推測せず _TODO_ / _ASSUMPTION_ と次のアクションを残す。
|
|
79
89
|
- 標準エラー出力に理由を出力する(例: `blocked: <reason>; need=<next action>; ref=<path>`)。
|
|
80
90
|
- agent 自身は claim / complete / reopen / block を記録せず、終了コードと標準エラー出力で runner に結果を返す。
|
|
81
91
|
|
|
@@ -45,6 +45,12 @@ _OWNER_ROLE_VIEWPOINTS_
|
|
|
45
45
|
|
|
46
46
|
_GRADE_FINDINGS_
|
|
47
47
|
|
|
48
|
+
### 成果物から届いた Kata が原因の finding
|
|
49
|
+
|
|
50
|
+
_KATA_CAUSE_FINDINGS_
|
|
51
|
+
|
|
52
|
+
各記録の `source=grade` / `source=condense` を確認する。grade は成果物・行・viewpoint・内容、condense は result・修正前の場所・種類・直し方・理由を読み、`cause.location` と照合して、見直し対象の Kata の該当箇所を確認する。この節の condense の記録も Kata の見直しの根拠とし、判定は `vp-arc-conciseness` を参照する。以下の手順は、この節と Kata そのものの grade の finding に適用する。
|
|
53
|
+
|
|
48
54
|
1. 見直し対象の recipe を読み込み、現状の問い・観点・深掘り手順・レビュー観点を把握する。
|
|
49
55
|
2. plan に展開された finding は severity にかかわらず、message と同じ viewpoint ID の判定根拠を修正要件として読み取る。message と判定根拠から指摘の根拠となる規範を特定し、対象 recipe の frontmatter から辿れる rulebook、該当する執筆標準のうち必要な文書を読み、指摘された問題を解消するよう該当箇所を修正する。
|
|
50
56
|
3. 修正後、各 finding の問題が判定根拠に照らして解消したことを確認する。未解消、根拠不足、または判断不能の finding は、理由と次のアクションを result の `進め方と実践の型の適用` セクションに記録する。grade result サイドカーは再評価時に更新されるため、本タスクでは直接編集しない。
|
|
@@ -25,7 +25,7 @@ _REGISTER_INPUT_
|
|
|
25
25
|
1. 個票(存在する場合)を読み、目的・完了条件・制約を把握する。登録簿の一覧は大きいため読まない。
|
|
26
26
|
2. 個票に完了条件がある場合はそれを作業の基準にする。無い場合はタイトルと説明から完了条件の仮説を立て、記録する。pipeline では個票の対応結果と executor の報告の `handoff` に書き、result を直接書ける実行形式では result に明記する。
|
|
27
27
|
3. 関連する成果物・設計書・実装を確認し、対象ファイルを特定して変更する。
|
|
28
|
-
4.
|
|
28
|
+
4. 個票が存在する場合は、個票の作業内容・対応結果セクションを実施内容で更新する。作業内容の表は、各行の状態とメモを実績に合わせる。終えた行は状態を `done` にし、`_TODO_` を残さない。executor が実行できない行(grade の起動など)は状態を `open` のまま残し、その理由をメモに書く。理由のない `done` 以外の行や `_TODO_` の残る行があると、post-review と `register close` は完了にしない。
|
|
29
29
|
5. 個票の完了条件が result への記載を求める場合、pipeline の executor は個票の対応結果と報告の `handoff` の両方に書く。reporter と runner が result の申し送りへ反映する。executor は result を直接編集しない。
|
|
30
30
|
6. 判断に迷う箇所は _TODO_ / _ASSUMPTION_ で残し、根拠と次のアクションを記録する。pipeline では個票の対応結果と報告の `handoff` に書き、result を直接書ける実行形式では result に書く。
|
|
31
31
|
|
|
@@ -45,6 +45,12 @@ _OWNER_ROLE_VIEWPOINTS_
|
|
|
45
45
|
|
|
46
46
|
_GRADE_FINDINGS_
|
|
47
47
|
|
|
48
|
+
### 成果物から届いた Kata が原因の finding
|
|
49
|
+
|
|
50
|
+
_KATA_CAUSE_FINDINGS_
|
|
51
|
+
|
|
52
|
+
各記録の `source=grade` / `source=condense` を確認する。grade は成果物・行・viewpoint・内容、condense は result・修正前の場所・種類・直し方・理由を読み、`cause.location` と照合して、見直し対象の Kata の該当箇所を確認する。この節の condense の記録も Kata の見直しの根拠とし、判定は `vp-arc-conciseness` を参照する。以下の手順は、この節と Kata そのものの grade の finding に適用する。
|
|
53
|
+
|
|
48
54
|
1. 見直し対象の rulebook を読み込み、現状の章構成・必須項目・禁止事項・判定基準を把握する。
|
|
49
55
|
2. plan に展開された finding は severity にかかわらず、message と同じ viewpoint ID の判定根拠を修正要件として読み取る。message と判定根拠から指摘の根拠となる規範を特定し、対象 rulebook の frontmatter から辿れる recipe / sample / template、`併せて適用する rulebook`、該当する執筆標準のうち必要な文書を読み、指摘された問題を解消するよう該当箇所を修正する。
|
|
50
56
|
3. 修正後、各 finding の問題が判定根拠に照らして解消したことを確認する。未解消、根拠不足、または判断不能の finding は、理由と次のアクションを result の `進め方と実践の型の適用` セクションに記録する。grade result サイドカーは再評価時に更新されるため、本タスクでは直接編集しない。
|
|
@@ -45,6 +45,12 @@ _OWNER_ROLE_VIEWPOINTS_
|
|
|
45
45
|
|
|
46
46
|
_GRADE_FINDINGS_
|
|
47
47
|
|
|
48
|
+
### 成果物から届いた Kata が原因の finding
|
|
49
|
+
|
|
50
|
+
_KATA_CAUSE_FINDINGS_
|
|
51
|
+
|
|
52
|
+
各記録の `source=grade` / `source=condense` を確認する。grade は成果物・行・viewpoint・内容、condense は result・修正前の場所・種類・直し方・理由を読み、`cause.location` と照合して、見直し対象の Kata の該当箇所を確認する。この節の condense の記録も Kata の見直しの根拠とし、判定は `vp-arc-conciseness` を参照する。以下の手順は、この節と Kata そのものの grade の finding に適用する。
|
|
53
|
+
|
|
48
54
|
1. 見直し対象の sample を読み込み、現状の粒度・文体・表の書き方を把握する。
|
|
49
55
|
2. plan に展開された finding は severity にかかわらず、message と同じ viewpoint ID の判定根拠を修正要件として読み取る。message と判定根拠から指摘の根拠となる規範を特定し、対象 sample の frontmatter から辿れる rulebook と recipe、該当する執筆標準のうち必要な文書を読み、指摘された問題を解消するよう該当箇所を修正する。rulebook との構成不整合を指摘する finding では、成果物の有無にかかわらず rulebook を正として照合する。
|
|
50
56
|
3. 修正後、各 finding の問題が判定根拠に照らして解消したことを確認する。未解消、根拠不足、または判断不能の finding は、理由と次のアクションを result の `進め方と実践の型の適用` セクションに記録する。grade result サイドカーは再評価時に更新されるため、本タスクでは直接編集しない。
|
|
@@ -45,6 +45,12 @@ _OWNER_ROLE_VIEWPOINTS_
|
|
|
45
45
|
|
|
46
46
|
_GRADE_FINDINGS_
|
|
47
47
|
|
|
48
|
+
### 成果物から届いた Kata が原因の finding
|
|
49
|
+
|
|
50
|
+
_KATA_CAUSE_FINDINGS_
|
|
51
|
+
|
|
52
|
+
各記録の `source=grade` / `source=condense` を確認する。grade は成果物・行・viewpoint・内容、condense は result・修正前の場所・種類・直し方・理由を読み、`cause.location` と照合して、見直し対象の Kata の該当箇所を確認する。この節の condense の記録も Kata の見直しの根拠とし、判定は `vp-arc-conciseness` を参照する。以下の手順は、この節と Kata そのものの grade の finding に適用する。
|
|
53
|
+
|
|
48
54
|
1. 見直し対象の template を読み込み、現状の章構成の骨組みとプレースホルダの配置・網羅性を把握する。
|
|
49
55
|
2. plan に展開された finding は severity にかかわらず、message と同じ viewpoint ID の判定根拠を修正要件として読み取る。message と判定根拠から指摘の根拠となる規範を特定し、対象 template の frontmatter から辿れる rulebook / recipe / sample、該当する執筆標準のうち必要な文書を読み、指摘された問題を解消するよう該当箇所を修正する。
|
|
50
56
|
3. 修正後、各 finding の問題が判定根拠に照らして解消したことを確認する。未解消、根拠不足、または判断不能の finding は、理由と次のアクションを result の `進め方と実践の型の適用` セクションに記録する。grade result サイドカーは再評価時に更新されるため、本タスクでは直接編集しない。
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
_FRONTMATTER_
|
|
2
|
+
|
|
3
|
+
# Condense Result
|
|
4
|
+
|
|
5
|
+
## 1. 実施内容
|
|
6
|
+
|
|
7
|
+
_TODO_: 冗長さの整理内容と、内容・決定・完了条件の意味および必須情報を維持した確認結果を書く。変更不要の場合は根拠を書く。
|
|
8
|
+
|
|
9
|
+
## 2. 変更ファイル
|
|
10
|
+
|
|
11
|
+
_TODO_: 対象文書と変更内容を書く。
|
|
12
|
+
|
|
13
|
+
## 3. 申し送り
|
|
14
|
+
|
|
15
|
+
_TODO_: 後続への申し送りを書く。なければ「なし」。
|
|
16
|
+
|
|
17
|
+
## 4. 進め方と実践の型の適用
|
|
18
|
+
|
|
19
|
+
_TODO_: `vp-arc-conciseness` と宣言済み Kata の適用、意味の維持の根拠を書く。
|
|
20
|
+
|
|
21
|
+
## 5. 修正・保持の記録
|
|
22
|
+
|
|
23
|
+
frontmatter の `condense_records` と 1 対 1 に対応する表を記入する。場所は修正前の見出し・行・引用、種類は 5 種類、直し方は `delete` / `merge` / `reference` / `retain`、理由は意味を保った根拠または保持の必要性、原因は `FindingCause`。Kata が原因なら種類と根拠の箇所も示す。候補がなければ表の代わりに「なし」と記入する。
|
|
24
|
+
|
|
25
|
+
_TODO_: 場所・種類・直し方・残した理由/意味の維持・原因の表。
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
## 共通: 記法・成果物規約
|
|
2
|
+
|
|
3
|
+
この規約は、生成される全 exec plan に共通で適用される。result の完了条件、他文書を参照する際のリンク記法、成果物の状態(status)の扱いを統一する。
|
|
4
|
+
|
|
5
|
+
要点(次の `plan-essentials` マーカーの間の箇条書き)は、plan の本文にもそのまま転記される。plan に転記するとき、`_SCHEMA_REF_` はタスクごとに解決した schema のパスに置き換わり、schema の無いタスクではその行が除かれる。
|
|
6
|
+
|
|
7
|
+
<!-- plan-essentials:start -->
|
|
8
|
+
|
|
9
|
+
- result(review plan の場合は review result)への記入は、タスク完了に必須の作業である。成果物の編集とは別に、最後に必ず実施する。
|
|
10
|
+
- 終了コード 0 で完了する前に、result の必須セクションをすべて実際の内容で埋め、プレースホルダ(_TODO_ など)や未記入のセクションを残さない。
|
|
11
|
+
- 文書へのリンクは、対象文書が既に存在する場合は `[[id|title]]` 形式で記載する(`id` は project 修飾 doc id)。
|
|
12
|
+
- リンクを表(テーブル)のセル内に置く場合は、区切りの `|` を `[[id\|title]]` のようにエスケープする。エスケープしないと列がずれて表が壊れ、prettier 整形でセルが分割されて固定化される。
|
|
13
|
+
- まだ存在しない文書を参照する場合は、`[[...]]` ではなく `` `id` `` または `` `filename` `` のようにバッククォートで仮置きする。
|
|
14
|
+
- Markdown の自由記述では、`_` を含む識別子・フィールド名(例: `depends_on`)を必ずインラインコードで囲む。result に描画される executor evidence や reporter の自由記述も同じ記法にする。
|
|
15
|
+
- 成果物 frontmatter の `status` を `ready` に変更しない。`ready` への昇格は人間のみが行うため、`draft` のまま据え置く(exec のコミット時ガードでも昇格はブロックされる)。
|
|
16
|
+
- ファイルの読み取り・書き込み・編集は、作業ディレクトリ(カレントディレクトリ)からの相対パスで指定する。絶対パスを自分で組み立てたり、作業ディレクトリ名を推測して指定したりしない(作業ディレクトリ名の取り違えは外部パス扱いになり拒否される)。
|
|
17
|
+
- 検査を実行する前に、リポジトリの `package.json`、`.specdojo/specdojo.config.json`、hook 設定(`lefthook.yml` など)を読み、本共通規約の詳細にある検査表の適用条件で、実行する検査を決める。
|
|
18
|
+
- 適用条件を満たさない検査は実行せず、executor evidence の validations に `not_applicable` と非適用の理由を `reason` へ記録する。適用される検査が 1 つもない場合も同じく、該当する検査ごとに `not_applicable` と理由を記録する。
|
|
19
|
+
- `not_run` は、適用される検査を実行できたのに実行しなかった場合だけに使う。runner は `not_run` を検証失敗として扱い、タスクを先へ進めない。
|
|
20
|
+
- `pipeline.parent_validations` に設定された検査は executor evidence の validations に含めなくてよい。executor が同じ検査を `not_run` または `not_applicable` として含めても、同じリポジトリで実行した親 runner の結果を正とする。含める場合は検査ごとに 1 行ずつ、実際のコマンド(例: `npm run lint:md`)で書き、複数の検査を 1 行にまとめない。
|
|
21
|
+
|
|
22
|
+
<!-- plan-essentials:end -->
|
|
23
|
+
|
|
24
|
+
- 成果物に変更が不要と判断した場合でも、result の記入は省略しない。変更不要と判断した理由と根拠を result に記入してから完了する。
|
|
25
|
+
- result の変更ファイル欄には、変更したファイル(成果物・ソース・テストなど)ごとの実施内容を具体的に記入する。
|
|
26
|
+
- result が未記入・プレースホルダのまま終了コード 0 で終了すると、runner は成果物未完了(block)として扱い、タスクはやり直しになる。完了前に result の記入漏れがないことを必ず確認する。
|
|
27
|
+
- result の frontmatter は scaffold 済みの構造を正本とする。`id` / `task_id` / `mode` / `project_id` / `plan_ref` / `agent` / `execution` / `approach` / `targets` はキーの追加・削除・改名をせず、scaffold された値のまま維持する。見出し構成(`# Edit Result` などの H1、`## 1.` 以降の章立て)も独自の構成に置き換えない。埋めるのは本文セクションの `_TODO_` プレースホルダの中身だけである。`status` と `completed_at` は完了処理(runner 側)が更新するため、自分で書き換えない。
|
|
28
|
+
- 編集・書き込みが作業ディレクトリ外(`external_directory`)として拒否された場合、原因はパス指定の誤り(誤った絶対パス・ディレクトリ名の取り違え)である。bash の heredoc などへ回避的に切り替えず、相対パスに直したうえで同じ編集ツールで再実行する。
|
|
29
|
+
- 作業用のファイル(編集用スクリプト、検証用の一時データなど)はリポジトリの外(一時ディレクトリ)または worktree の `tmp/` 配下に置き、終了前に削除する。使い捨てのファイルを最上位に作らない。`tmp/` 配下のファイルは commit の対象から除外される。
|
|
30
|
+
- 整形・静的検査は、この plan の完了手順または本共通規約で明示されたコマンドを実行する。変更対象に必要な test、build、schema 検証は、plan に個別記載がなくても実行してよい。同じ test script では対象限定と全件を同一 executor run 内で連続実行せず、どちらか一方に絞る。下表、plan、またはプロジェクト標準が全件 test を求める場合は、全件を1回だけ実行して対象限定の実行を省く。この制約は executor が sandbox 内で実行する test script の回数に対するものであり、親検証に設定された ID のコマンドは対象外である(親 runner が別途実行する)。実行したコマンド・対象・結果は result に記録する。
|
|
31
|
+
- executor / reporter pipeline で親 runner の検証が設定されている場合、executor は設定済み ID に対応するコマンドを sandbox 内で実行せず、executor 終了後に親 runner が固定許可リストから実行して evidence へ追記する。`validate-schema` は `npm run validate:schema`、`test-unit` は `npm run test:unit`、`test-integration` は `npm run test:integration` に対応する。executor は親検証と同じコマンドの対象限定版も追加せず、二重実行しない。executor が親検証のコマンドを validations に含めた場合も、同じリポジトリで実行された親 runner の結果を正とし、executor の `not_run` / `not_applicable` は pipeline を失敗させない。
|
|
32
|
+
- 適用条件の判定と `not_applicable` / `not_run` の使い分けは、要点に記した規則に従う。誤って `not_run` と記録しても、npm script・依存 package の不在、または SpecDojo サブコマンドの設定上の非適用を runner が機械的に確定できる場合は適用外として扱われるが、この救済を前提に記録を省略しない。
|
|
33
|
+
- 依存パッケージの有無は、対象リポジトリの `package.json` の `dependencies` / `devDependencies` と、リポジトリに固定された package manager の設定を基準に判断する。`npx` が未導入パッケージをネットワークから一時取得できることは、導入済みとはみなさない。設定ファイルがない、壊れているなどの理由で適用条件を確定できない検査は実行せず、validations に `not_applicable` として理由と次の確認事項を記録する。
|
|
34
|
+
- `npm init` が `package.json` に入れる仮の `test` script(`echo "Error: no test specified" && exit 1` と、引用符の有無・種類や空白だけが違う変種)は、常に失敗する仮置きであり、`test` script がないものとみなす。`npm test` は実行せず、validations に `not_applicable` と、仮の script である旨を `reason` に記録する。runner も同じ判断で `not_applicable` を受け付ける。本物の test script がある場合は適用される。
|
|
35
|
+
- 終了する前に、コミット時に実行される検査(pre-commit 相当)のうち、現在のリポジトリに設定され、上記の適用条件を満たすものを先回りで実行する。適用した検査の失敗はすべて修正してから完了する。
|
|
36
|
+
- 実行対象は、executor 自身が変更したファイルの種別で判断する。runner が生成・更新する実行管理ファイル(`exec/plans/`・`exec/results/`・`exec/evidence/`・`exec/events/`・`exec/.locks/`、および状態遷移で書き換わる `pjr-index.md`)は、executor の変更ファイルには含めない。下表のうち、変更したファイルが該当し、かつ適用条件を満たす行の検査を実行する。該当行がない場合や適用条件を満たさない場合は追加の検査は不要である。ただし親検証に設定された ID のコマンドは下表よりも優先し、executor は実行しない。下表に同じコマンドが挙がっていても、親 runner の実行に委ねる。
|
|
37
|
+
- 検査コマンドの正本はリポジトリの hook 設定(`lefthook.yml` など)である。下表と設定が食い違う場合は、適用条件を満たす設定側のコマンドに合わせ、実行したコマンドと結果を result に記録する。`specdojo` コマンドは、リポジトリで定められた起動方法(`npx specdojo <subcommand>`、`npx tsx src/specdojo.ts <subcommand>` など)で実行する。ただし、sandbox 環境で `tsx` の IPC エラー(`EPERM`)が発生する場合は、代わりに `node --import tsx src/specdojo.ts <subcommand>` を使用して実行する。
|
|
38
|
+
|
|
39
|
+
| 変更したファイル | 適用条件 | 実行する検査 |
|
|
40
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
41
|
+
| `*.md` | 対応するローカル依存が `package.json` にある | `npx prettier --write <対象ファイル>`、導入済み実装に対応する markdownlint コマンド |
|
|
42
|
+
| `*.ts` / `*.js` / `*.json` / `*.yaml` / `*.yml` | Prettier が `package.json` にある | `npx prettier --write <対象ファイル>` |
|
|
43
|
+
| `src/`、`tests/`、`scripts/`、`tools/`、`tsconfig*.json` | `package.json` に `typecheck` script がある | `npm run typecheck` |
|
|
44
|
+
| `src/`、`tests/`、`docs/ja/specdojo/templates/`、`docs/ja/specdojo/exec-templates/`、`vitest.config.*` | pipeline executor は `test:unit`、それ以外は `test` script が `package.json` にある(`npm init` の仮の `test` script は、ないものとみなす) | pipeline executor は `npm run test:unit`、それ以外は `npm test`(`test-unit` が親検証に設定されている場合は executor では実行しない) |
|
|
45
|
+
| `docs/ja/projects/` 配下(runner が書く `exec/` 配下を除く) | 対象 project に `catalog_path` が設定されている | `specdojo catalog validate`(または `npm run validate:catalog`) |
|
|
46
|
+
| 履歴蓄積ファイル(`pjr-*.md`(`pjr-index.md` を除く)、または executor 自身が変更した既存の `exec/plans/**/*.md`・`exec/results/**/*.md`) | `package.json` に `validate:history-links` script がある | `npm run validate:history-links` |
|
|
47
|
+
| `dct-*.yaml` | 対象 project に `catalog_path` が設定されている | `specdojo catalog build` |
|
|
48
|
+
| `pjr-index.md` | 対象 project に `project_register_path` が設定されている | `specdojo register build` |
|
|
49
|
+
| `sch-*.yaml` | 対象 project に `schedule_path` が設定されている | `specdojo exec refresh` |
|
|
50
|
+
| `docs/` 配下 | リポジトリで定められた起動方法により SpecDojo CLI を実行できる | `specdojo index build` |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<!-- plan-essentials:start -->
|
|
2
|
+
|
|
3
|
+
### review の判断手順
|
|
4
|
+
|
|
5
|
+
review plan に共通で適用する。review はタスクの成果を判定し、成果物の品質は判定しない。成果物の品質は grade が一度だけ評価する。review はその評価結果(grade・finding)を事実として受け取り、このタスクを完了してよいかを判断する([[bps-task-completion]])。
|
|
6
|
+
|
|
7
|
+
- 成果物を再評価しない。観点ごとの pass / fail を付け直したり、評価結果の判定を自分の判断で置き換えたりしない。評価結果の内容に疑義がある場合は、疑義の内容と再評価が必要な理由を改善指示に記録する。
|
|
8
|
+
- 評価結果の鮮度を最初に確認する(`E-01`)。plan の「評価結果」章に示す評価対象と `--target` を使い、`specdojo grade list --target <対象種別> --path <評価対象> --changed-only` を実行する。`--target deliverable` の場合は `--dependency-changed` でも同様に実行する。いずれかが評価対象のパスを出力した場合、または評価結果サイドカーが存在しない場合は、評価結果が最新でない。成果物を自分で評価して補わず、verdict を `grade-stale` とする。
|
|
9
|
+
- 評価結果を確定できない場合(`E-02`)は、verdict を `grade-unavailable` とする。サイドカーを読み取れない場合と、`specdojo grade list --target <対象種別> --path <評価対象> --incomplete` が評価対象のパスを出力する場合(評価パイプラインが未完了)が該当する。
|
|
10
|
+
- 評価結果が最新であれば、サイドカーの `verdict` / `score` / `finding_counts` / `findings`、および `done_criteria`(存在する場合)を読み取る。
|
|
11
|
+
- 変更内容・この plan・実行記録・完了条件・最新の finding を照合し、このタスクの範囲と完了条件を満たすかを判断する(`S-02`)。完了条件の充足は、評価結果に判定がある場合はそれを事実として用いる。評価結果が扱わない事項を review で確かめる。対象は、フェーズ説明が求めた変更が行われたか、対象外の変更が混入していないか、実行記録の検証結果が成功しているかである。実行記録(先行する edit タスクの result)を特定できない場合は、確認できなかったことを判断根拠に記録する。
|
|
12
|
+
- finding が残っていても、このタスクの範囲と完了条件を満たしていれば完了できる。その場合は finding を消去・再評価せず、完了を妨げない理由と必要な改善指示を記録する。
|
|
13
|
+
- 判断の根拠は、評価結果・成果物・plan・実行記録を実際に読んで得た具体的な事実に限る。executor の最終メッセージや result の自己申告を、そのまま、または言い換えて根拠にしない。
|
|
14
|
+
- verdict を記録する直前に鮮度の確認を再実行する。最初の確認の後に成果物が変更されて評価結果が最新でなくなった場合は、verdict を `changed-during-review` とする(review 中の成果物変更)。
|
|
15
|
+
|
|
16
|
+
verdict は次の 6 値から 1 つを選ぶ。各値は [[bps-task-completion]] の検証・受入観点と一対一に対応する。
|
|
17
|
+
|
|
18
|
+
| verdict | 受入観点 | 選ぶ条件 | 記録すること |
|
|
19
|
+
| ------------------------ | ----------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
20
|
+
| `complete` | 完了可能 | 評価結果が最新で、plan と完了条件を満たし、完了を妨げる未充足事項がない | 照合した根拠 |
|
|
21
|
+
| `complete-with-findings` | 品質 finding を伴う完了 | 評価結果に finding があるが、このタスクの範囲と完了条件は満たしている | finding が完了を妨げない理由と改善指示 |
|
|
22
|
+
| `incomplete` | 品質良好だが未完了 | plan または完了条件に未充足事項がある(grade の良否は問わない) | 未充足事項と、再計画に使う改善指示 |
|
|
23
|
+
| `grade-stale` | 評価結果が最新でない | 評価結果がない、`content_hash` が一致しない、または評価コンテキストの変化が未反映 | 鮮度確認のコマンドと出力。完了可否は判断しない |
|
|
24
|
+
| `grade-unavailable` | 評価不能 | 評価結果を読み取れない、または評価パイプラインが未完了で grade・finding が未確定 | 評価不能の理由と不足情報。完了は保留する |
|
|
25
|
+
| `changed-during-review` | review 中の成果物変更 | 最初の鮮度確認の後に成果物が変更され、評価結果が最新でなくなった | 変更を検知した確認の出力。verdict を確定せず再評価を求める |
|
|
26
|
+
|
|
27
|
+
- verdict が `complete` 以外でも、review result を記録できた場合は正常終了する(終了コード 0)。runner は verdict に応じて再評価または再計画へ進む。
|
|
28
|
+
- review result の章立ては `評価結果の確認`、`判断根拠`、`未充足事項・改善指示`、`approach に応じた確認`、`decision` である。`decision` の `verdict` は必ず上表の値で埋める。
|
|
29
|
+
|
|
30
|
+
<!-- plan-essentials:end -->
|
|
@@ -158,7 +158,7 @@ git status --short
|
|
|
158
158
|
|
|
159
159
|
自動実行では、SpecDojo が worktree の準備、agent 実行、commit、現在ブランチへの統合、状態更新を行います。
|
|
160
160
|
|
|
161
|
-
worktree 実行の `prepare execution` / `apply task changes` と実行管理の記帳は exec ブランチに保持されます。成功時に project `develop` の first-parent へ追加されるのは `--no-ff` の merge commit 1件だけで、subject は Schedule タスクなら `exec(<task-id>): <task name>`、register 項目なら `exec(register <PJR-ID>): <title>` です。register 実行では `start → review` の遷移をこの merge commit に同梱し、失敗時は `start → waiting` の遷移、plan、result を `wait` commit 1件にまとめます(worktree は再開のため保持します)。再開後に成功した場合も merge commit 1件です。squash / rebase は使わず、既存履歴は書き換えません。
|
|
161
|
+
worktree 実行の `prepare execution` / `apply task changes` と実行管理の記帳は exec ブランチに保持されます。成功時に project `develop` の first-parent へ追加されるのは `--no-ff` の merge commit 1件だけで、subject は Schedule タスクなら `exec(<task-id>): <task name>`、register 項目なら `exec(register <PJR-ID>): <title>` です。register 実行では `start → review` の遷移をこの merge commit に同梱し、失敗時は `start → waiting` の遷移、plan、result を `wait` commit 1件にまとめます(worktree は再開のため保持します)。再開後に成功した場合も merge commit 1件です。Schedule の run(`exec run` / `exec resume` / `exec cycle`)の終わりには、統合の後に runner が書いたイベントと run の記録をまとめた記帳の commit(`exec(run): record execution events and run records`)が run ごとに 1 件加わります([Schedule実行運用ガイド](schedule-operation-guide.md) の「実行記録の記帳」)。squash / rebase は使わず、既存履歴は書き換えません。
|
|
162
162
|
|
|
163
163
|
```bash
|
|
164
164
|
specdojo exec run \
|
|
@@ -69,6 +69,7 @@ SpecDojo 拡張は、ワークスペースの `.specdojo/doc-index.json` を使
|
|
|
69
69
|
| 文書リンクの表示・遷移 | Markdown の SpecDojo 文書リンクをクリックして対象文書を開きます。プレビュー内のリンクにも対応します |
|
|
70
70
|
| ID で文書を開く | コマンドパレットで `SpecDojo: Open Document by ID` を実行し、文書 ID を入力します |
|
|
71
71
|
| Markdown 表の整形 | 表内へカーソルを置き、コマンドパレットで `SpecDojo: Format Markdown Table` を実行します |
|
|
72
|
+
| 対話のプレビュー | `chat` を吹き出し、`chat tui` を TUI 風に表示します |
|
|
72
73
|
|
|
73
74
|
文書リンクは、本文では `[[id]]` または `[[id|表示名]]` と記述します。Markdown 表のセル内では、
|
|
74
75
|
列区切りとの衝突を避けるため `[[id\|表示名]]` と記述してください。
|
|
@@ -136,6 +137,17 @@ VS Code では、Markdown ファイルを編集しながら、
|
|
|
136
137
|
|
|
137
138
|
現在の Markdown ファイルのプレビューが開きます。
|
|
138
139
|
|
|
140
|
+
SpecDojo 拡張を導入すると、次の `chat` ブロックが吹き出しで表示されます。利用者は右、相手側は左に配置されます。`chat tui` に変えると、暗い背景と等幅文字を使い、利用者の発言に `>`、相手側に `●` を添えます。
|
|
141
|
+
|
|
142
|
+
```chat
|
|
143
|
+
あなた: 設定を確認してください。
|
|
144
|
+
|
|
145
|
+
オーケストレーター: `specdojo.config.json` を確認しました。
|
|
146
|
+
プロジェクトの設定が見つかりました。
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
発言の間には 1 行空け、続き行は字下げします。空行なしでも描画でき、空白・タブだけの行を含む空行は続き行の間でも読み飛ばします。空行の後の続き行も直前の発言に含まれ、空行以外の改行・字下げは維持されます。インラインコードにはバッククォートを使えます。文書サイトも同じ表示に対応し、GitHub や拡張未導入の VS Code ではコードブロックとして読めます。
|
|
150
|
+
|
|
139
151
|
#### 3.1.2. 編集画面とプレビューを並べて表示(推奨)
|
|
140
152
|
|
|
141
153
|
- Windows / Linux: `Ctrl + K` → `V`
|