specdojo 0.1.0 → 0.2.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/LICENSE +22 -0
- package/README.md +82 -38
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +980 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +45 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +15 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +55 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +120 -24
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdfd-uc-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: draft
|
|
6
|
+
rulebook: specdojo:cdfd-uc-rulebook
|
|
7
|
+
sample: specdojo:cdfd-uc-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 概念データフロー図(ユースケース別)作成レシピ
|
|
11
|
+
|
|
12
|
+
Conceptual Data Flow Diagram Use Case Writing Recipe
|
|
13
|
+
|
|
14
|
+
全体概要で選定した横断ユースケースを、プロセスグループの順序、引き渡す情報、引き渡し条件、条件不成立時の戻り先へ具体化し、グループ内部を重複させずに合意するための作成手順です。
|
|
15
|
+
|
|
16
|
+
## 1. このレシピの使い方
|
|
17
|
+
|
|
18
|
+
- 最初に、全体概要から一つのケース ID、業務目的、横断するプロセスグループを抜き出し、開始イベントと終了条件を短いメモにします。
|
|
19
|
+
- 次に、正常系のグループごとに、説明文、主要入力・主要出力・データストアの箇条書き、横断上の役割表を作ります。
|
|
20
|
+
- 全体概要の「データストア」から引き渡しに使う部分集合を切り出し、グループ代表ノードと引き渡し条件だけで図を作ります。
|
|
21
|
+
- その後、隣接するグループ間ごとに渡す情報、受け側を開始できる条件、受け取れない場合の戻す条件を具体化し、条件不成立時の戻り先と再開条件を表へ整理します。
|
|
22
|
+
- 最後に、全体概要との名称整合、全引き渡しの追跡、グループ内部と状態遷移の非重複をレビューします。
|
|
23
|
+
|
|
24
|
+
この成果物は、上位で合意した業務目的を Why として引き継ぎ、グループ間で成立させる情報と条件を What、順序と戻し方を How、ケース ID・引き渡し ID・参照先の対応を Trace として整理します。内部プロセスや状態遷移を複製せず、責任を持つ文書へ接続します。
|
|
25
|
+
|
|
26
|
+
## 2. 作成前に集める情報
|
|
27
|
+
|
|
28
|
+
| 項目 | 集める情報 |
|
|
29
|
+
| ---------------- | ---------------------------------------------------------------------------------- |
|
|
30
|
+
| 対象ケース | 全体概要にある `C-<nn>`、ユースケース名、業務目的 |
|
|
31
|
+
| 開始と終了 | 最初のグループを起動するイベント、最後のグループが成果を利用可能と判断する条件 |
|
|
32
|
+
| 参加グループ | 正常系で通過する二つ以上のプロセスグループ名、領域 ID、通過順、主要入出力 |
|
|
33
|
+
| グループ別責務 | 各グループが前段から受け取るものと、次段へ引き渡す成果 |
|
|
34
|
+
| グループ別 CDFD | 各参加グループの `cdfd-<group>` と、そこに定義された境界入出力 |
|
|
35
|
+
| 引き渡す情報 | 受け側が業務を始めるために必要な情報・物・承認結果 |
|
|
36
|
+
| 引き渡し条件 | 必須情報の充足、承認、記録確定、現物との一致など、受け側が確認できる条件 |
|
|
37
|
+
| 戻す条件 | 情報不足、不一致、承認未了など、受け側が引き渡しを受理できない条件 |
|
|
38
|
+
| 関連データストア | 引き渡す情報または条件判定の正本となる、全体概要の「データストア」にある名称と区分 |
|
|
39
|
+
| 判断者 | 引き渡し可否、戻し、再開を最終判断する人間のロール |
|
|
40
|
+
| 状態の参照先 | 状態一覧と状態遷移図を統合した STSD。内容は転記せず参照先だけ控える |
|
|
41
|
+
| 未決事項 | 横断境界、条件、戻り先、判断者が未確定な論点と、影響、決定者、決定時期 |
|
|
42
|
+
|
|
43
|
+
## 3. 全体の作成手順
|
|
44
|
+
|
|
45
|
+
1. 全体概要から対象のケース ID、ユースケース名、業務目的、参加グループを抜き出します。
|
|
46
|
+
2. 最初のグループが動き始める出来事を開始イベント、最後のグループが成果を受理した状態を終了条件として一文ずつ書きます。
|
|
47
|
+
3. 正常系の参加グループを順に並べ、各グループについて役割の説明文、主要入力・主要出力・データストアの箇条書き、横断上の役割表を作ります。
|
|
48
|
+
4. グループ名、含む領域 ID、境界入出力を全体概要と各 `cdfd-<group>` で突き合わせ、名称ゆれを解消します。
|
|
49
|
+
5. 隣接グループ間ごとに引き渡し候補を作り、正常順序に沿って `H-<nn>` を仮置きします。
|
|
50
|
+
6. 全体概要の「データストア」から、引き渡す情報または条件判定に使う行だけを同じ区分で転記し、関連する引き渡し ID と利用内容を記入します。
|
|
51
|
+
7. 開始イベント、グループ代表ノード、引き渡し条件、終了条件を左から右へ並べ、引き渡し ID と情報名を付けて図にします。
|
|
52
|
+
8. 「データストア」の各行を同名ノードとして図へ加え、行とノードが一対一で対応することを確認します。
|
|
53
|
+
9. 各引き渡しについて、情報、受け側が yes / no で判定できる引き渡し条件、送り元へ戻す条件を書きます。
|
|
54
|
+
10. 条件不成立ごとに、補完責任を持つ戻り先、戻す情報、同じ引き渡しを再評価できる再開条件を整理します。
|
|
55
|
+
11. 内部プロセス名、内部例外、状態名・遷移、実装項目を探し、対応する `cdfd-<group>` と STSD の参照へ置き換えます。
|
|
56
|
+
12. ケース ID と引き渡し ID を使って、範囲、プロセス領域、データストア、図、引き渡し表、戻り先表の重複・欠落を解消します。
|
|
57
|
+
|
|
58
|
+
## 4. 各章の書き方
|
|
59
|
+
|
|
60
|
+
### 4.1. 目的
|
|
61
|
+
|
|
62
|
+
問い:
|
|
63
|
+
|
|
64
|
+
- 誰がグループの通過順と責任境界を承認しますか。
|
|
65
|
+
- 誰が引き渡す情報と条件を設計入力として使いますか。
|
|
66
|
+
- 誰がグループ間の重複・欠落と戻り経路を確認しますか。
|
|
67
|
+
|
|
68
|
+
「業務を分かりやすくする」ではなく、「店主代表が在庫・仕入・販売の引き渡し条件を承認する」のように、対象者と利用結果を結び付けます。上位の業務目的はケース ID で引き継ぎ、同じ背景説明を繰り返しません。
|
|
69
|
+
|
|
70
|
+
### 4.2. 適用範囲
|
|
71
|
+
|
|
72
|
+
問い:
|
|
73
|
+
|
|
74
|
+
- ケース ID、ユースケース名、参加グループは全体概要と一致していますか。
|
|
75
|
+
- どの出来事で最初のグループが始まり、どの成果を誰が受理すれば終わりますか。
|
|
76
|
+
- 対象となる組織、システム境界、現物の範囲を説明できますか。
|
|
77
|
+
- 内部プロセス、補助操作、状態遷移、実装詳細をどこへ委ねますか。
|
|
78
|
+
- 承認と最終判断を担う人間のロールを参照できますか。
|
|
79
|
+
|
|
80
|
+
開始と終了は単なる期間ではなく、発生または成立を判定できる出来事・成果で区切ります。参加グループの追加や削除が必要なら、横断図だけで補正せず、全体概要へ判断を戻します。
|
|
81
|
+
|
|
82
|
+
### 4.3. プロセス領域
|
|
83
|
+
|
|
84
|
+
問い:
|
|
85
|
+
|
|
86
|
+
- 正常系のグループを開始から終了まで一節ずつ順に並べましたか。
|
|
87
|
+
- 各節が、説明文、主要入力・主要出力・データストアの箇条書き、横断上の役割表の順になっていますか。
|
|
88
|
+
- 各グループの名称と領域 ID は全体概要と同じですか。
|
|
89
|
+
- 主要入力・主要出力と横断上の役割は、前段から受け取るものと次段へ渡すものに限定されていますか。
|
|
90
|
+
- 各グループの内部を確認できる `cdfd-<group>` を一意に示せますか。
|
|
91
|
+
|
|
92
|
+
各節の表の一行を一つの代表ノードへ対応させます。同じグループが正常系で再登場する場合は節を分け、前回と異なる引き渡し目的を説明します。内部の処理順や担当は書き写しません。
|
|
93
|
+
|
|
94
|
+
### 4.4. データストア
|
|
95
|
+
|
|
96
|
+
問い:
|
|
97
|
+
|
|
98
|
+
- 引き渡す情報または引き渡し条件の判定に必要なデータストアだけを掲載していますか。
|
|
99
|
+
- 名称と区分は全体概要の「データストア」と一致していますか。
|
|
100
|
+
- 各行に関連する引き渡し ID と、横断上の利用内容がありますか。
|
|
101
|
+
- 各行が概念データフローの同名ノードに対応していますか。
|
|
102
|
+
|
|
103
|
+
全体概要の「データストア」から必要な行を切り出し、マスタ・構成データとトランザクションデータの区分を保ちます。グループ内部だけで使うデータストアは載せません。新しい名称や区分が必要なら、先に全体概要を見直します。
|
|
104
|
+
|
|
105
|
+
### 4.5. 概念データフロー
|
|
106
|
+
|
|
107
|
+
問い:
|
|
108
|
+
|
|
109
|
+
- 一つの角丸長方形が一つのプロセスグループを表していますか。
|
|
110
|
+
- 開始イベントから終了条件まで、正常系のグループ順序を左から右へ追えますか。
|
|
111
|
+
- 引き渡し ID と情報名を、図と引き渡し表で対応付けられますか。
|
|
112
|
+
- 図へ置いたデータストアは、引き渡し条件または引き渡す情報の正本として必要ですか。
|
|
113
|
+
- グループ内部のプロセス、例外、状態遷移を図へ混ぜていませんか。
|
|
114
|
+
|
|
115
|
+
グループ代表ノードの間に、引き渡し条件を表すイベントノードを置きます。データストアを加える場合も、どの内部処理が読む・書くかは描かず、横断条件の根拠となる情報だけを示します。図直後の注記で凡例、線種、省略境界、選定したデータストアを説明します。
|
|
116
|
+
|
|
117
|
+
### 4.6. 引き渡し
|
|
118
|
+
|
|
119
|
+
問い:
|
|
120
|
+
|
|
121
|
+
- 隣接するすべてのグループ間に一つ以上の引き渡しがありますか。
|
|
122
|
+
- 引き渡す情報は、受け側が何を受け取るか分かる名詞になっていますか。
|
|
123
|
+
- 引き渡し条件は、情報の充足、承認、記録確定、現物との一致を判定できますか。
|
|
124
|
+
- 条件を満たさないとき、何をどのグループへ戻すか分かりますか。
|
|
125
|
+
|
|
126
|
+
まず受け側が開始前に確認するチェックを列挙し、そのチェックに必要な情報だけを引き渡しへ残します。送り元の作業完了を条件にするのではなく、受け側が受理できる成果の状態を記述します。
|
|
127
|
+
|
|
128
|
+
### 4.7. 例外時の戻り先
|
|
129
|
+
|
|
130
|
+
問い:
|
|
131
|
+
|
|
132
|
+
- 各引き渡しの戻す条件を、戻り先表の条件不成立へ対応させましたか。
|
|
133
|
+
- 不足を補完または再判断できるグループが戻り先になっていますか。
|
|
134
|
+
- 戻す情報から、不足・不一致・判断待ちの内容が分かりますか。
|
|
135
|
+
- 再開条件は同じ引き渡しを再評価できる形になっていますか。
|
|
136
|
+
|
|
137
|
+
戻り先は内部プロセスではなくグループまでに留めます。受け側内部の再試行やログは扱わず、先行グループへ情報・判断を戻すことで横断順序が変わる場合だけを記載します。
|
|
138
|
+
|
|
139
|
+
### 4.8. 未決事項(任意)
|
|
140
|
+
|
|
141
|
+
- 調査で確定できる不足情報は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: とします。
|
|
142
|
+
- 未決論点には、影響するケース ID または引き渡し ID、決定者、決定時期を添えます。
|
|
143
|
+
- 未決事項がない場合は章を省略し、空表や「なし」だけの章を残しません。
|
|
144
|
+
|
|
145
|
+
## 5. 深掘り手順
|
|
146
|
+
|
|
147
|
+
1. 最後のグループが受理する成果から逆向きにたどり、直前の引き渡し情報と条件が本当に必要かを確認します。
|
|
148
|
+
2. 開始イベントから順方向にたどり、各グループが前段から受け取らないと作れない成果を特定します。
|
|
149
|
+
3. 各引き渡し条件を yes / no の質問へ置き換え、判定者と根拠情報を答えられない条件を具体化します。
|
|
150
|
+
4. グループ代表ノードを隠し、内部プロセス名が図や表に残っていないか検索します。残っていればグループ責務または参照へ置き換えます。
|
|
151
|
+
5. 状態を表す語を検索し、状態の意味や遷移を定義している箇所を STSD の参照へ移します。
|
|
152
|
+
6. 引き渡し ID を一つずつ追い、データストア、図、引き渡し表、戻り先表で情報と条件が一致するか確認します。
|
|
153
|
+
7. 条件不成立を一つずつ仮定し、戻り先が不足を補完でき、再開条件の成立後に同じ引き渡しへ戻れるか確認します。
|
|
154
|
+
8. データストアを一つずつ外しても引き渡し条件を説明できるか試し、不要なものを図から削除します。
|
|
155
|
+
|
|
156
|
+
## 6. 良い例 / 悪い例
|
|
157
|
+
|
|
158
|
+
| 観点 | 良い例 | 悪い例 |
|
|
159
|
+
| -------------- | ------------------------------------------------------------- | ---------------------------------------------------- |
|
|
160
|
+
| 対象ケース | `C-02` の在庫 → 仕入 → 販売を扱う | 在庫グループ内の在庫確認だけを扱う |
|
|
161
|
+
| グループノード | 「在庫(P-05〜P-06)」を一つの代表ノードにする | 補充判定や在庫更新を別々のプロセスノードにする |
|
|
162
|
+
| 引き渡す情報 | 在庫から仕入へ「補充対象、数量、判断者」を渡す | 必要なデータ一式を渡す |
|
|
163
|
+
| 引き渡し条件 | 補充対象と数量が確定し、店主代表が発注判断を承認した | 在庫処理が適切に完了した |
|
|
164
|
+
| 戻す条件 | 商品または数量を一意に特定できない場合は在庫へ戻す | エラー時は前へ戻す |
|
|
165
|
+
| 再開条件 | 修正済みの補充依頼を店主代表が再承認し、`H-01` を再評価できる | 問題が解決したら再開する |
|
|
166
|
+
| データストア | 引き渡し判定に使う在庫記録を全体概要と同じ名称で置く | 図だけ「在庫 DB」と改名し、内部テーブルまで描く |
|
|
167
|
+
| 状態責務 | 商品状態は STSD を参照し、図には引き渡し成立条件だけを描く | 未発注 → 入荷済み → 販売可能の遷移を横断図で定義する |
|
|
168
|
+
| グループ内例外 | 発注不可の結果を在庫へ戻す条件だけを扱う | 仕入先選定、再発注、返品処理の手順を横断図へ展開する |
|
|
169
|
+
|
|
170
|
+
## 7. レビュー観点
|
|
171
|
+
|
|
172
|
+
| 観点 | 確認内容 | 主な確認者 |
|
|
173
|
+
| ------------ | -------------------------------------------------------------------------------- | -------------------------- |
|
|
174
|
+
| 業務価値 | ケースの終了条件が上位の業務目的を満たし、各引き渡しがその成立に必要と説明できる | 業務分析担当、店主代表 |
|
|
175
|
+
| 横断範囲 | 二つ以上の参加グループ、通過順、領域 ID が全体概要と一致する | 業務分析担当 |
|
|
176
|
+
| 引き渡し | 情報、条件、戻す条件を受け側が yes / no で判定できる | 業務分析担当、技術メンター |
|
|
177
|
+
| 責任境界 | 戻り先と判断者が明確で、内部プロセスを横断側で再定義していない | 店主代表、アーキテクト |
|
|
178
|
+
| 図の追跡性 | ケース ID、引き渡し ID、グループ名、領域 ID を表と図で対応付けられる | 品質確認担当 |
|
|
179
|
+
| データ整合 | 関連データストアの名称・区分が全体概要と一致し、条件判定に必要なものだけがある | 技術メンター、品質確認担当 |
|
|
180
|
+
| 状態責務 | 状態定義・遷移を複製せず、必要な STSD へ接続している | 技術メンター |
|
|
181
|
+
| 例外時の再開 | 条件不成立から戻り先、戻す情報、再開条件、再評価する引き渡しまでたどれる | 品質確認担当、店主代表 |
|
|
182
|
+
|
|
183
|
+
「業務分析担当」「品質確認担当」「技術メンター」「アーキテクト」は、対象プロジェクトのロール定義または責任分担文書で正式な担当へ対応付けます。
|
|
184
|
+
|
|
185
|
+
## 8. 仕上げチェック
|
|
186
|
+
|
|
187
|
+
- 全体概要から一つのケース ID、ユースケース名、業務目的、二つ以上の参加グループを引き継いだ。
|
|
188
|
+
- 開始イベントと終了条件を第三者が判定できる形で記述した。
|
|
189
|
+
- 参加グループを正常系の順序で一節ずつ並べ、各節を説明文、三つの箇条書き、役割表の順で構成した。
|
|
190
|
+
- 隣接グループ間へ `H-<nn>` を付け、情報、引き渡し条件、戻す条件を記述した。
|
|
191
|
+
- 図の一つのプロセスノードが一つのプロセスグループを表し、内部プロセスを描いていない。
|
|
192
|
+
- 図の開始から終了までをたどれ、引き渡し ID と情報名を表へ対応付けられる。
|
|
193
|
+
- 「データストア」は全体概要と同じ名称・区分の部分集合で、各行を引き渡し ID と図の同名ノードへ対応させた。
|
|
194
|
+
- 全引き渡しについて、条件不成立、戻り先、戻す情報、再開条件を確認した。
|
|
195
|
+
- グループ内部の領域・プロセス・主要例外・操作手順を再掲していない。
|
|
196
|
+
- 状態の定義、遷移表、状態遷移図を記載せず、必要な STSD を参照した。
|
|
197
|
+
- 未決事項は共通ラベルで確定情報と区別し、ない場合は章を設けていない。
|
|
198
|
+
- 個人情報、秘密情報、非公開の組織情報など、公開範囲に不適切な内容を含めていない。
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:exec-human-finalize-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: ready
|
|
6
|
+
rulebook: none
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Human Finalize 実行レシピ
|
|
10
|
+
|
|
11
|
+
Human Finalize Execution Recipe
|
|
12
|
+
|
|
13
|
+
`execution: human` の finalize タスクを、plan を介さず result だけで確認・修正・確定する手順を示します。
|
|
14
|
+
|
|
15
|
+
## 1. このレシピの使い方
|
|
16
|
+
|
|
17
|
+
- Ready になった human タスクを claim し、生成された result を作業の入口にします。
|
|
18
|
+
- result の `targets` とチェックリストから、確認対象と完了条件を特定します。
|
|
19
|
+
- 確認・必要な修正・`ready` 昇格・確定判断を行い、同じ result に証跡を残します。
|
|
20
|
+
- この実行では、タスクの目的と完了条件(Why)、確定対象と到達状態(What)、検証・修正・確定判断(How)を扱い、`done_criteria` ごとの結果を同じ result で追跡します(Trace)。
|
|
21
|
+
|
|
22
|
+
## 2. 実行前に集める情報
|
|
23
|
+
|
|
24
|
+
| 項目 | 集める情報 |
|
|
25
|
+
| ---------- | ------------------------------------------------------------------ |
|
|
26
|
+
| タスク | task ID、`approach`、実行者、現在の exec state |
|
|
27
|
+
| 確認対象 | result frontmatter の `targets` を doc-index で解決した文書 |
|
|
28
|
+
| 完了条件 | result の「確認チェックリスト」に展開された `done_criteria` |
|
|
29
|
+
| 確定対象 | result の「確定対象」に展開された成果物と実践の型 |
|
|
30
|
+
| 検証方法 | 対象文書に適用される整形、静的検査、schema 検証 |
|
|
31
|
+
| 判断の証跡 | 承認または差し戻しの理由、確認中に行った修正、後続への申し送り事項 |
|
|
32
|
+
|
|
33
|
+
## 3. 全体の実行手順
|
|
34
|
+
|
|
35
|
+
1. `specdojo exec refresh --project <project-id>` を実行し、対象タスクが Ready であることを確認します。refresh は human plan を生成しません。
|
|
36
|
+
2. `specdojo exec claim --project <project-id> --task <task-id> --by <actor> --msg "<message>"` で claim し、生成された result を開きます。
|
|
37
|
+
3. result frontmatter の `targets` を確認し、doc-index で対象文書を解決します。
|
|
38
|
+
4. result の「確認チェックリスト」に従って完成版を確認し、満たせない項目があれば最小限の修正を加えます。
|
|
39
|
+
5. `approach: bootstrap-finalize` の場合は「実践の型の確認」も実施し、存在しない種別の行は削除します。
|
|
40
|
+
6. 対象文書に必要な整形・静的検査・schema 検証を行い、確定できる文書の `status` を `ready` に更新します。
|
|
41
|
+
7. result のチェックリスト、確定判断、備考を実際の結果で埋めます。未確認項目が残る場合は差し戻しとし、その理由を記録します。
|
|
42
|
+
8. `specdojo exec complete --project <project-id> --task <task-id> --by <actor> --msg "<message>"` で完了を記録し、再度 build して次の Ready を更新します。
|
|
43
|
+
|
|
44
|
+
## 4. 各確認の進め方
|
|
45
|
+
|
|
46
|
+
### 4.1. 対象と完了条件の特定
|
|
47
|
+
|
|
48
|
+
- `targets` の先頭を主成果物、以降を approach に応じた実践の型として扱います。
|
|
49
|
+
- 確認対象は result に焼き込まれた値を使い、schedule の命名や過去の plan から推測しません。
|
|
50
|
+
- チェックリストが未展開の場合は確定せず、catalog の解決不備として差し戻します。
|
|
51
|
+
|
|
52
|
+
### 4.2. 成果物の最終確認
|
|
53
|
+
|
|
54
|
+
- 各 `done_criteria` について、完成版のどの記述が満たすかを確認します。
|
|
55
|
+
- 不足を直す場合は既存の責務と文脈を保ち、確定に必要な範囲だけを修正します。
|
|
56
|
+
- 修正後は対象形式に対応する検証を再実行し、エラーがない状態にします。
|
|
57
|
+
|
|
58
|
+
### 4.3. 実践の型の最終確認
|
|
59
|
+
|
|
60
|
+
- rulebook は章構成、必須項目、禁止事項、判定基準が完成版と整合するか確認します。
|
|
61
|
+
- recipe / sample / template は、作成手順、完成例、雛形として再利用できるかを種別ごとに確認します。
|
|
62
|
+
- 既に `ready` の実践の型も、今回の成果物変更で劣化していないことを確認します。
|
|
63
|
+
|
|
64
|
+
### 4.4. 確定判断と記録
|
|
65
|
+
|
|
66
|
+
- すべての確認と昇格が済んだ場合だけ `judgement: 承認` とします。
|
|
67
|
+
- 未充足、検証エラー、対象解決不能のいずれかがある場合は `judgement: 差し戻し` とします。
|
|
68
|
+
- 備考には修正内容、差し戻し理由、次に必要な行動のうち該当するものを具体的に残します。
|
|
69
|
+
|
|
70
|
+
## 5. 深掘り手順
|
|
71
|
+
|
|
72
|
+
1. `done_criteria` の文言と成果物の根拠箇所を一対一で対応させます。
|
|
73
|
+
2. 根拠が複数文書に散る場合は、主成果物の責務を越えていないかを確認します。
|
|
74
|
+
3. 修正が必要なら、未充足条件を満たす最小差分を特定します。
|
|
75
|
+
4. 修正後に根拠箇所と検証結果を再確認し、result のチェック状態を更新します。
|
|
76
|
+
|
|
77
|
+
## 6. 良い例 / 悪い例
|
|
78
|
+
|
|
79
|
+
| 観点 | 良い例 | 悪い例 |
|
|
80
|
+
| -------- | ------------------------------------------------ | -------------------------------------- |
|
|
81
|
+
| 対象特定 | result の `targets` を doc-index で解決する | task ID や古い plan からパスを推測する |
|
|
82
|
+
| 完了確認 | `done_criteria` ごとに根拠を確認してチェックする | 文書を眺めただけで一括してチェックする |
|
|
83
|
+
| 修正範囲 | 未充足条件に必要な最小差分だけを加える | 確定と無関係な改善を同じ作業へ混ぜる |
|
|
84
|
+
| 確定判断 | 未確認項目があれば理由付きで差し戻す | 空欄や未確認項目を残したまま承認する |
|
|
85
|
+
| 証跡 | 修正内容、検証結果、判断を同じ result に記録する | 口頭確認や作業者の記憶だけに依存する |
|
|
86
|
+
|
|
87
|
+
## 7. レビュー観点
|
|
88
|
+
|
|
89
|
+
- result だけで対象、完了条件、確定対象、判断結果を追跡できるか。
|
|
90
|
+
- `targets` に含まれない文書を確定作業へ混ぜていないか。
|
|
91
|
+
- `done_criteria` と実践の型の確認に未チェック項目が残っていないか。
|
|
92
|
+
- `ready` 昇格と確定判断が一致し、差し戻し理由が判定可能に書かれているか。
|
|
93
|
+
|
|
94
|
+
## 8. 仕上げチェック
|
|
95
|
+
|
|
96
|
+
- result frontmatter に `execution: human`、`approach`、`targets` がある。
|
|
97
|
+
- result に `_TODO_`、未記入の判断、未処理のチェック項目が残っていない。
|
|
98
|
+
- 確定対象の検証が成功し、承認対象の `status` が `ready` である。
|
|
99
|
+
- 完了 event と次の Ready 更新まで実施している。
|
|
100
|
+
- 各 `done_criteria` に、確認した対象、実施した検証または修正、確定判断の根拠が対応している。
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:ifx-cmd-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: draft
|
|
6
|
+
rulebook: specdojo:ifx-cmd-rulebook
|
|
7
|
+
sample: specdojo:ifx-cmd-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 外部コマンド連携仕様 作成レシピ
|
|
11
|
+
|
|
12
|
+
External Command Interface Specification Writing Recipe
|
|
13
|
+
|
|
14
|
+
外部 CLI とのプロセス境界を、呼び出し元と運用担当が同じ判定条件で実装・検証できる契約に仕上げるための作り方を示します。
|
|
15
|
+
|
|
16
|
+
## 1. このレシピの使い方
|
|
17
|
+
|
|
18
|
+
- 最初に、連携で実現する目的と、外部 CLI の安定した公開契約を分けて確認する。CLI の便利機能を先に列挙しない。
|
|
19
|
+
- 次に、実行可能ファイル、引数、入出力、終了コードを、成功と主要失敗を再現できる粒度で整理する。
|
|
20
|
+
- その後、認証注入、タイムアウト、冪等性、再試行を確認し、秘密値を含めずに運用可能な契約にする。
|
|
21
|
+
- 最後に、ESIL の連携目的(Why)、コマンド契約(What)、実行・失敗時の扱い(How)、`spec_ref` と終了カテゴリ(Trace)が一貫しているか確認する。
|
|
22
|
+
|
|
23
|
+
## 2. 作成前に集める情報
|
|
24
|
+
|
|
25
|
+
| 項目 | 集める情報 |
|
|
26
|
+
| ------------ | ------------------------------------------------------------------------ |
|
|
27
|
+
| 連携の目的 | 誰がどのシステムに何を依頼し、成功後にどの状態にするか |
|
|
28
|
+
| ESIL 項目 | 連携名、source、target、direction、timing、`spec_ref` |
|
|
29
|
+
| CLI 公開契約 | 実行ファイル名、サブコマンド、対応バージョン、引数、構造化出力 |
|
|
30
|
+
| ストリーム | stdin の必須性、stdout のデータ形式、stderr の用途、文字コード |
|
|
31
|
+
| 終了状態 | 成功、入力不正、認証・認可失敗、制限、一時失敗、恒久失敗の識別方法 |
|
|
32
|
+
| 認証・権限 | 認証方式、プロセスへの注入方式、必要権限、シークレット管理境界 |
|
|
33
|
+
| 実行制約 | タイムアウト、並列数、ネットワーク要否、実行ディレクトリ、副作用と冪等性 |
|
|
34
|
+
| 運用時の判定 | 再試行できる条件、打ち切り条件、再認証が必要な条件、ログから除外する値 |
|
|
35
|
+
|
|
36
|
+
## 3. 全体の作成手順
|
|
37
|
+
|
|
38
|
+
1. ESIL の 1 連携に対応する実行目的を 1 文で書き、別の入出力契約を持つサブコマンドが混じっていないか確認する。
|
|
39
|
+
2. ID、タイトル、状態、準拠ルール、仕様バージョンを設定し、ESIL の `spec_ref` と対応させる。
|
|
40
|
+
3. 実行可能ファイルとサブコマンドを分離し、利用できる CLI バージョン範囲を固定する。
|
|
41
|
+
4. 引数を option と positional に分け、必須性、値の型、供給元、公開可能な例を記載する。
|
|
42
|
+
5. stdin、stdout、stderr の契約を別々に書き、呼び出し元が解析する stdout の安定フィールドを固定する。
|
|
43
|
+
6. 公開された終了コードを共通カテゴリへ写像し、同じ入力で再試行できるか判定する。
|
|
44
|
+
7. 認証方式と注入機構を定義し、秘密値が引数、入出力例、ログに現れないことを確認する。
|
|
45
|
+
8. タイムアウト、並列度、冪等性、再試行、出力解析失敗、認証失敗の処置を定義する。
|
|
46
|
+
9. 最小の成功ケース、入力不正、認証失敗、タイムアウトを想定し、実行側の分岐が一意になるかレビューする。
|
|
47
|
+
|
|
48
|
+
## 4. 各要素の書き方
|
|
49
|
+
|
|
50
|
+
### 4.1. 実行目的とコマンド
|
|
51
|
+
|
|
52
|
+
問い:
|
|
53
|
+
|
|
54
|
+
- このコマンドの成功によって、連携先または呼び出し元の何が変わるか。
|
|
55
|
+
- 実行可能ファイル名とサブコマンドは、対応バージョンで安定しているか。
|
|
56
|
+
- 1 回の起動に異なる目的、権限、出力契約が混在していないか。
|
|
57
|
+
|
|
58
|
+
書き方:
|
|
59
|
+
|
|
60
|
+
- `purpose` はツールの説明ではなく、呼び出し側から見た成果を記載する。
|
|
61
|
+
- 実行可能ファイル、サブコマンド、引数を別要素にし、シェル構文を含む 1 本の文字列にしない。
|
|
62
|
+
- バージョン範囲は、出力契約と終了コードを確認した範囲だけにする。
|
|
63
|
+
|
|
64
|
+
### 4.2. 引数とストリーム
|
|
65
|
+
|
|
66
|
+
問い:
|
|
67
|
+
|
|
68
|
+
- 各引数は誰が生成し、必須性と型をどのように検証できるか。
|
|
69
|
+
- stdin を使う理由と、終端なしで入力が完結する条件は何か。
|
|
70
|
+
- stdout のどのフィールドを正本とし、stderr のどの情報を診断に使うか。
|
|
71
|
+
|
|
72
|
+
書き方:
|
|
73
|
+
|
|
74
|
+
- 引数の例は公開可能なダミー値にし、認証情報と個人環境の絶対パスは使わない。
|
|
75
|
+
- 機械処理する stdout は JSON/JSONL など安定形式を選び、必要なフィールドの意味を書く。
|
|
76
|
+
- stdout と stderr は別々に記録し、進捗文言を成功値として解析しない。
|
|
77
|
+
|
|
78
|
+
### 4.3. 終了コードとエラー処理
|
|
79
|
+
|
|
80
|
+
問い:
|
|
81
|
+
|
|
82
|
+
- 成功、利用者が修正すべき失敗、運用者が解消すべき失敗、自動再試行できる失敗を区別できるか。
|
|
83
|
+
- 同じ終了コードが複数の意味に使われる場合、追加の判定信号はあるか。
|
|
84
|
+
- 副作用のある実行を再試行しても、結果が重複しない条件は何か。
|
|
85
|
+
|
|
86
|
+
書き方:
|
|
87
|
+
|
|
88
|
+
- CLI 固有の終了コードを共通カテゴリに写像し、リトライ可否を同じ行に置く。
|
|
89
|
+
- 汎用的な exit 1 のみで制限や一時失敗と判定せず、専用コードや構造化エラーがある場合だけ自動分類する。
|
|
90
|
+
- タイムアウト、出力解析失敗、認証失敗は別の処置とし、一律の再試行にしない。
|
|
91
|
+
|
|
92
|
+
### 4.4. 認証注入と実行制約
|
|
93
|
+
|
|
94
|
+
問い:
|
|
95
|
+
|
|
96
|
+
- 認証状態はどの管理境界から、どの機構でプロセスへ渡されるか。
|
|
97
|
+
- 呼び出しに必要な最小権限と、認証失敗時の再開条件は何か。
|
|
98
|
+
- ネットワーク、実行ディレクトリ、タイムアウト、並列数の制約は何か。
|
|
99
|
+
|
|
100
|
+
書き方:
|
|
101
|
+
|
|
102
|
+
- 環境変数名、CLI プロファイル名、workload identity の識別名など、注入の参照だけを書く。
|
|
103
|
+
- 秘密値の実値、シークレットファイルの実パス、トークン付き URL は残さない。
|
|
104
|
+
- ログのマスク方針とプロセス強制終了後の不完全出力の扱いまで決める。
|
|
105
|
+
|
|
106
|
+
## 5. 深掘り手順
|
|
107
|
+
|
|
108
|
+
1. ESIL の対象行から、連携の目的、方向、タイミング、失敗時の影響を抽出する。
|
|
109
|
+
2. CLI のヘルプまたは公式の機械可読仕様から、引数、出力形式、終了コードを抜き出す。
|
|
110
|
+
3. 成功、入力不正、認証失敗、レート制限、接続失敗、不正出力の各ケースで観測可能な信号を並べる。
|
|
111
|
+
4. 自動再試行候補ごとに、冪等性、重複防止キー、試行上限、打ち切り後の操作を確認する。
|
|
112
|
+
5. 引数、stdin、stdout、stderr、エラー文言に秘密値が出る可能性を列挙し、それぞれのマスク条件を決める。
|
|
113
|
+
6. 呼び出し側が「成功」「再試行」「人の対応待ち」「入力修正」を仕様だけで分岐できるか確認する。
|
|
114
|
+
|
|
115
|
+
## 6. 良い例 / 悪い例
|
|
116
|
+
|
|
117
|
+
| 観点 | 良い例 | 悪い例 |
|
|
118
|
+
| ------------ | ----------------------------------------------------------- | -------------------------------------------------- |
|
|
119
|
+
| コマンド分離 | `executable: supplier-cli`、`subcommands: [orders, submit]` | `command: "supplier-cli orders submit $FILE"` |
|
|
120
|
+
| 引数の供給元 | `value_source: generated` とし、生成元の意味を説明する | 値が固定、設定、利用者入力のどれか不明 |
|
|
121
|
+
| stdout | `format: json` と安定フィールドを定義する | 人向けの「成功しました」を文字列一致で判定する |
|
|
122
|
+
| stderr | 診断用とし、成否は終了コードと構造化出力で判定する | stderr が空なら成功とみなす |
|
|
123
|
+
| 終了カテゴリ | 専用コードと意味を `transient_failure` へ写像する | すべての exit 1 を `rate_limit` と扱う |
|
|
124
|
+
| 認証注入 | 環境変数名とシークレットストアの境界だけを記載する | トークン実値または認証ファイルの個人パスを記載する |
|
|
125
|
+
| 再試行 | 冪等性キーがある一時失敗だけを上限付きで再試行する | 副作用の有無を確認せず非 0 をすべて再試行する |
|
|
126
|
+
| タイムアウト | 子プロセスを終了し、不完全出力を破棄して失敗とする | 親プロセスだけが待機を止め、子プロセスを残す |
|
|
127
|
+
|
|
128
|
+
## 7. レビュー観点
|
|
129
|
+
|
|
130
|
+
| 観点 | 確認内容 |
|
|
131
|
+
| ---------------- | ---------------------------------------------------------------------------------- |
|
|
132
|
+
| 目的と境界 | ESIL の 1 連携と対応し、API/ファイル/メッセージ仕様の責務を重複定義していないか |
|
|
133
|
+
| 実行可能性 | 実行ファイル、サブコマンド、引数、対応バージョンが一意で、シェルに依存しないか |
|
|
134
|
+
| 入出力契約 | stdin/stdout/stderr の形式と用途が分離され、機械処理する出力が安定しているか |
|
|
135
|
+
| 失敗の識別 | 終了コードと追加信号から、入力修正、再認証、再試行、恒久失敗を分けられるか |
|
|
136
|
+
| 認証と秘密保護 | 注入機構と必要権限が明確で、秘密値、個人パス、トークン付き URL が含まれていないか |
|
|
137
|
+
| 回復可能性 | タイムアウト、再試行、打ち切り、不完全出力の扱いが定義され、副作用の重複を防げるか |
|
|
138
|
+
| トレーサビリティ | 仕様 ID、ESIL の `spec_ref`、終了カテゴリ、根拠文書を安定した識別子でたどれるか |
|
|
139
|
+
|
|
140
|
+
## 8. 仕上げチェック
|
|
141
|
+
|
|
142
|
+
- 仕様 ID と ESIL の `spec_ref` が対応し、`kind: コマンド` の連携を 1 件だけ扱っている。
|
|
143
|
+
- 実行可能ファイル、サブコマンド、引数が分離され、シェル構文や秘密値を含む引数がない。
|
|
144
|
+
- stdin、stdout、stderr の使用有無、形式、文字コード、意味が判定可能な記述になっている。
|
|
145
|
+
- 成功と主要失敗の終了コードが共通カテゴリへ写像され、自動再試行の可否と一致している。
|
|
146
|
+
- 認証方式、注入機構、参照名、シークレット管理境界、ログのマスク方針が揃っている。
|
|
147
|
+
- タイムアウト、並列数、ネットワーク要否、冪等性、再試行条件、出力解析失敗時の処置を呼び出し側が実装できる。
|
|
148
|
+
- 認証情報、個人環境のパス、内部クラス名、プロセス起動ライブラリの実装詳細が残っていない。
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:pm-communication-plan-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: ready
|
|
6
|
+
rulebook: specdojo:pm-communication-plan-rulebook
|
|
7
|
+
sample: specdojo:pm-communication-plan-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# コミュニケーション計画 作成レシピ
|
|
11
|
+
|
|
12
|
+
Communication Plan Writing Recipe
|
|
13
|
+
|
|
14
|
+
ステークホルダーの情報要求を、必要なコミュニケーション機会と証跡へ変換する作り方です。
|
|
15
|
+
|
|
16
|
+
## 1. このレシピの使い方
|
|
17
|
+
|
|
18
|
+
- ステークホルダー登録簿から必要な合意・確認だけを選びます。
|
|
19
|
+
- 会議、報告、通知を一つの機会表へ統合します。
|
|
20
|
+
- エスカレーションと情報取扱いを加え、重複を削除します。
|
|
21
|
+
- 判断・情報要求(Why)、合意・確認する内容と時期(What)、機会・手段・責任(How)を整理し、ステークホルダー ID と証跡で対応を追跡します(Trace)。会議の進行詳細や関係者一覧は本書へ再掲しません。
|
|
22
|
+
|
|
23
|
+
## 2. 作成前に集める情報
|
|
24
|
+
|
|
25
|
+
| 項目 | 集める情報 |
|
|
26
|
+
| -------- | ------------------------------------------ |
|
|
27
|
+
| 対象 | 判断者、当事者、利用者、協力者、実行ロール |
|
|
28
|
+
| 情報要求 | 何を判断・確認・共有する必要があるか |
|
|
29
|
+
| 契機 | 作業節目、代表試行、上限超過、公開、変更 |
|
|
30
|
+
| 手段 | 登録簿、Pull Request、Issue、試行記録など |
|
|
31
|
+
| 証跡 | 判断・確認結果を残す正本 |
|
|
32
|
+
| 取扱い | 公開、限定共有、入力禁止の情報 |
|
|
33
|
+
|
|
34
|
+
## 3. 全体の作成手順
|
|
35
|
+
|
|
36
|
+
1. 対象とする主要な合意・確認を決めます。
|
|
37
|
+
2. 各機会について対象、内容、時期、手段、責任、証跡を書きます。
|
|
38
|
+
3. 同じ内容の会議・報告・通知を一行へ統合します。
|
|
39
|
+
4. 人間の判断が必要なエスカレーション条件を定義します。
|
|
40
|
+
5. 情報区分と取扱いを最小限で定義します。
|
|
41
|
+
6. 見直し条件と未決事項を記載します。
|
|
42
|
+
|
|
43
|
+
## 4. 各章の書き方
|
|
44
|
+
|
|
45
|
+
### 4.1. 方針と適用範囲
|
|
46
|
+
|
|
47
|
+
- 常設会議か非同期確認かを決めます。
|
|
48
|
+
- 関係者名簿は再掲せず、対象IDまたはRole codeを使います。
|
|
49
|
+
- AI Agentは伝達・整理を支援しても、合意主体にしません。
|
|
50
|
+
|
|
51
|
+
### 4.2. コミュニケーション機会
|
|
52
|
+
|
|
53
|
+
- 一行は一つの判断・確認機会にします。
|
|
54
|
+
- 伝える内容より、相手が何を判断・確認するかを明確にします。
|
|
55
|
+
- 結果を残す証跡を必ず置きます。
|
|
56
|
+
|
|
57
|
+
### 4.3. エスカレーション
|
|
58
|
+
|
|
59
|
+
- 当事者価値、費用・負荷、品質・安全、公開・権利を分けます。
|
|
60
|
+
- 一次対応と最終判断者を区別します。
|
|
61
|
+
- 「必要に応じて」だけで終わらせません。
|
|
62
|
+
|
|
63
|
+
### 4.4. 情報管理と公開
|
|
64
|
+
|
|
65
|
+
- 公開可能情報と入力禁止情報を区別します。
|
|
66
|
+
- 個人情報や秘密情報を公開記録とAgent入力へ含めません。
|
|
67
|
+
- 生成ビューではなく正本を更新します。
|
|
68
|
+
|
|
69
|
+
## 5. 深掘り手順
|
|
70
|
+
|
|
71
|
+
1. そのコミュニケーションがなければ誰の判断が止まるか確認します。
|
|
72
|
+
2. 同じ対象・内容・時期の行を統合します。
|
|
73
|
+
3. 証跡のない会議や報告を削除します。
|
|
74
|
+
4. 日常課題を登録簿へ移します。
|
|
75
|
+
|
|
76
|
+
## 6. 良い例 / 悪い例
|
|
77
|
+
|
|
78
|
+
| 観点 | 良い例 | 悪い例 |
|
|
79
|
+
| ---- | ---------------------------------------- | ------------------------ |
|
|
80
|
+
| 機会 | 代表試行後に利用者が価値と負荷を確認する | 利用者会議を定期開催する |
|
|
81
|
+
| 証跡 | 評価結果と採否を試行記録へ残す | 議論したことだけを書く |
|
|
82
|
+
| 対象 | ステークホルダーIDまたはRole code | 個人名と連絡先 |
|
|
83
|
+
|
|
84
|
+
## 7. レビュー観点
|
|
85
|
+
|
|
86
|
+
- ステークホルダーの必要な合意を漏らしていないか。
|
|
87
|
+
- 会議・報告・チャネルが重複していないか。
|
|
88
|
+
- 判断者と証跡が明確か。
|
|
89
|
+
- 公開・非公開の境界が守られているか。
|
|
90
|
+
|
|
91
|
+
## 8. 仕上げチェック
|
|
92
|
+
|
|
93
|
+
- コミュニケーション機会、エスカレーション、情報取扱いがある。
|
|
94
|
+
- 目的のない定例会議がない。
|
|
95
|
+
- 関係者一覧やRole code定義を再掲していない。
|
|
96
|
+
- Agentに合意・承認を委ねていない。
|
|
97
|
+
- 各コミュニケーション機会が、元の判断・情報要求と結果の証跡に対応している。
|