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,233 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdfd-overview-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: ready
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:cdfd-overview-recipe
|
|
8
|
+
sample: specdojo:cdfd-overview-sample
|
|
9
|
+
template: specdojo:cdfd-overview-template
|
|
10
|
+
includes:
|
|
11
|
+
- specdojo:cdfd-mermaid-rulebook
|
|
12
|
+
based_on:
|
|
13
|
+
- specdojo:rulebook-authoring-standard
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# 概念データフロー図(全体概要)作成ルール
|
|
17
|
+
|
|
18
|
+
Conceptual Data Flow Diagram Overview Documentation Rulebook
|
|
19
|
+
|
|
20
|
+
業務または運用の全体を、プロセスグループとデータストアの間の情報・実行要求の流れとして定義するためのルールです。プロセス領域の分割とデータストアの一覧を合意し、各プロセスグループをプロセスグループ別 CDFD へ、横断的な業務をユースケース別 CDFD へ重複・欠落なく引き渡せる粒度を定めます。
|
|
21
|
+
|
|
22
|
+
## 1. 全体方針
|
|
23
|
+
|
|
24
|
+
- 全体概要は、業務または運用を構成するプロセス領域、プロセスグループ、データストア、グループとデータストアの間の受け渡し、人間の判断境界を合意する概念仕様とします。
|
|
25
|
+
- プロセス領域は業務の性質が近いものをプロセスグループにまとめ、概念データフローではプロセスグループを一つの代表ノードで表します。領域単位の内部プロセス、状態を変える処理と起点イベント、例外経路はプロセスグループ別 CDFD へ委ね、状態の定義と遷移は STSD へ委ねます。
|
|
26
|
+
- データストアは論理的な正本として一覧化し、マスタ・構成データとトランザクションデータに分けて定義します。図に置くデータストアは一覧の各行と一対一に対応させます。
|
|
27
|
+
- プロセス領域の表を領域定義の正本、「データストア」をデータストア定義の正本、Mermaid 図をグループとデータストアの間の流れの正本として併用し、名称を一致させます。
|
|
28
|
+
- 各プロセスグループには主要入力、主要出力、データストアを割り当て、図の各エッジの根拠にします。各プロセス領域には業務目的、主な担当、起点イベントを割り当てます。
|
|
29
|
+
- 対象者、利用場面、対象範囲、対象外を明示し、人間が担う承認や最終判断をシステムまたは AI Agent に置き換えません。
|
|
30
|
+
|
|
31
|
+
## 2. 位置づけと用語定義
|
|
32
|
+
|
|
33
|
+
| 用語 | 定義 |
|
|
34
|
+
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
35
|
+
| 全体概要 | プロセスグループとデータストアの間の受け渡しを表す最上位の CDFD |
|
|
36
|
+
| プロセス領域 | 固有の業務目的、主な担当、起点イベントを持つ責務のまとまり。`P-01` 形式の領域 ID を持つ |
|
|
37
|
+
| プロセスグループ | 業務の性質が近いプロセス領域をまとめた集合。概念データフローの代表ノードであり、プロセスグループ別 CDFD の単位 |
|
|
38
|
+
| 代表ノード | 全体概要で一つのプロセスグループを表す角丸長方形の Mermaid ノード。`subgraph` ではなくノードとして描く |
|
|
39
|
+
| 起点イベント | プロセス領域を開始させる、発生した時点を判定できる出来事。プロセス領域の表に記載し、全体概要の図には描かない |
|
|
40
|
+
| データストア | プロセスグループが参照または更新する、台帳、文書、ファイル、設定などの論理的な正本。マスタ・構成データとトランザクションデータに区分する |
|
|
41
|
+
| マスタ・構成データ | 他のプロセスから参照される比較的安定した基準情報。更新契機は承認された変更である |
|
|
42
|
+
| トランザクションデータ | 業務活動に伴い都度更新される記録。生成物や退避先を含む |
|
|
43
|
+
| 保管先 | データストアの物理的な所在(ファイルパス、帳簿、システムなど)。概念段階では未確定でよい |
|
|
44
|
+
| STSD | ステータス定義(Status Definition)。状態名、意味、成立条件、遷移元、遷移先、イベント、遷移条件の単一正本。作成規範は `specdojo:stsd-rulebook` |
|
|
45
|
+
| Role code | 責務・判断権限・専門性を表す識別子。共通定義は `specdojo:people-and-organization-definition-standard`、プロジェクトで採用する値は `<project-id>:pm-roles` を正本とする |
|
|
46
|
+
| PO | Project Owner を表す標準 Role code。目的、スコープ、優先順位、公開方針、最終判断を担う |
|
|
47
|
+
| retrofit | 既存実装をエビデンスとして現状の成果物へ反映する作成アプローチ。保管先など実装から確定できる事実を推測せず記録する |
|
|
48
|
+
| Orchestrator | 利用者または自動実行の意図を受け、計画・実行・評価・改善の各プロセスグループへ要求を振り分ける調整役。採用する場合は、対象業務での責務と入力元を本文で定義する |
|
|
49
|
+
| 補助操作 | 一覧、検索、状態参照、検証、dry-run など、独立した業務成果を作らず他の領域を支援する操作 |
|
|
50
|
+
| プロセスグループ別 CDFD | 一つのプロセスグループを引き継ぎ、領域の内部プロセス、起点イベント、例外・復旧、データストアの読み書きを定め、状態定義・遷移は STSD を参照する詳細 CDFD |
|
|
51
|
+
| ユースケース別 CDFD | 複数のプロセスグループをまたぐ業務について、グループ間の順序と引き渡し条件だけを定める詳細 CDFD。構造規範は `specdojo:cdfd-uc-rulebook` |
|
|
52
|
+
|
|
53
|
+
全体概要はプロセスグループとデータストアの分割、およびグループとデータストアの間の受け渡しを定義します。プロセスグループ別 CDFD は一グループの内部を、ユースケース別 CDFD はグループ間の順序を詳細化し、いずれも全体概要と同じ領域 ID、プロセスグループ名、データストア名を引き継ぎます。
|
|
54
|
+
|
|
55
|
+
## 3. ファイル命名・ID規則
|
|
56
|
+
|
|
57
|
+
- ファイル名は `cdfd-overview.md`、ドキュメント ID は `cdfd-overview` を基本とします。product 文書ではプロジェクト修飾(`<project-id>:`)を付けず、プロジェクト固有の現状分析をプロジェクト文書配下へ置く場合だけ `<project-id>:cdfd-overview` とします。
|
|
58
|
+
- 配置は対象プロダクトの業務仕様配下にあるデータフローディレクトリを基本とします。
|
|
59
|
+
- 領域 ID は文書内で一意な `P-01` 形式とし、プロセス領域の表、代表ノードのラベル、詳細 CDFD 一覧で同じ値を使います。採番順に業務上の意味を持たせず、名称変更後も同じ責務を表す限り維持します。
|
|
60
|
+
- プロセスグループ名は英語の短い名詞(例: Plan、Do、Check、Action)または日本語の短い名詞句とし、代表ノードのラベルには `P-02〜P-06` のように含む領域 ID の範囲を併記します。
|
|
61
|
+
- プロセスグループ別 CDFD の ID は `cdfd-<group>`、ユースケース別 CDFD の ID は `cdfd-uc-<topic>` とします。`<group>` はプロセスグループ名の英小文字、`<topic>` はユースケースを表す英小文字のスラッグです。
|
|
62
|
+
- ユースケース ID は文書内で一意な `C-01` 形式とします。
|
|
63
|
+
|
|
64
|
+
## 4. 推奨 Frontmatter 項目
|
|
65
|
+
|
|
66
|
+
| 項目 | 説明 | 必須 |
|
|
67
|
+
| ---------- | ----------------------------------------------------------- | ---- |
|
|
68
|
+
| id | `cdfd-overview` または `<project-id>:cdfd-overview` | ○ |
|
|
69
|
+
| type | `flow` | ○ |
|
|
70
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
71
|
+
| rulebook | `specdojo:cdfd-overview-rulebook` | ○ |
|
|
72
|
+
| based_on | 目的、範囲、業務要求など、作成時に直接参照した先行成果物 ID | 任意 |
|
|
73
|
+
| supersedes | 置き換える旧全体概要の ID | 任意 |
|
|
74
|
+
|
|
75
|
+
- `based_on` は直接の内容根拠だけを列挙し、プロジェクト共通の参考文脈や図中要素を機械的に転記しません。
|
|
76
|
+
- 対象者、対象範囲は本文で定義し、未定義の Frontmatter 項目を追加しません。
|
|
77
|
+
- 作成途中の `status` は `draft` とします。`ready` へ昇格できるのは、「完成判定」の全項目を満たし、対象範囲と領域分割を PO が承認した記録(登録簿の決定記録またはレビュー結果)がある場合です。
|
|
78
|
+
|
|
79
|
+
## 5. 本文要件
|
|
80
|
+
|
|
81
|
+
見出し順・表・記入欄の骨組みは template を正本とします。本章は各章の目的と必須・任意を定めます。
|
|
82
|
+
|
|
83
|
+
| 番号 | 見出し | 必須 | 内容(要点) |
|
|
84
|
+
| ---- | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
85
|
+
| 冒頭 | 導入文 | ○ | 対象業務・運用を一文で定義 |
|
|
86
|
+
| 1 | 目的 | ○ | 対象者と利用場面 |
|
|
87
|
+
| 2 | 適用範囲 | ○ | 対象、対象外(領域内部の詳細化先)、補助操作の扱い、人間と AI Agent の責任分担 |
|
|
88
|
+
| 3 | プロセス領域 | ○ | プロセスグループごとの節。各節に説明文、主要入力・主要出力・データストアの箇条書き、領域の表 |
|
|
89
|
+
| 4 | データストア | ○ | マスタ・構成データとトランザクションデータの 2 表。列はデータストア、主な内容、保管先(条件付き) |
|
|
90
|
+
| 5 | 概念データフロー(概要) | ○ | プロセスグループの代表ノードとデータストアの Mermaid 図。ノード数が多い場合はトランザクションデータの図とマスタ・構成データの図に分ける |
|
|
91
|
+
| 6 | 詳細 CDFD 一覧 | ○ | プロセスグループ別 CDFD の表と、横断するユースケース別 CDFD の表 |
|
|
92
|
+
| 7 | 凡例(本プロダクト共通) | 任意 | 本プロダクトの全 CDFD が共通して参照するノード形状・色・絵文字のサンプル図と対応表 |
|
|
93
|
+
| 8 | 未決事項 | 条件付き | 境界、名称、責務、判断者が未確定な論点。未決事項がある場合だけ設ける |
|
|
94
|
+
|
|
95
|
+
- 「凡例(本プロダクト共通)」を省略する場合、章番号は詰めます。「未決事項」は最終章とします。
|
|
96
|
+
- 「概念データフロー(概要)」を 2 図に分ける場合は `5.1.`、`5.2.` の節を設け、分けない場合は節を設けず 1 図を置きます。
|
|
97
|
+
|
|
98
|
+
## 6. 記述ガイド
|
|
99
|
+
|
|
100
|
+
本章は作成方法と各規則の理由を説明します。`ready` 昇格の pass / fail は「完成判定」だけをチェックリストの正本として判定します。
|
|
101
|
+
|
|
102
|
+
### 6.1. 導入文
|
|
103
|
+
|
|
104
|
+
- 対象業務または運用が何を扱うかを一文で定義します。
|
|
105
|
+
- 詳細な効果、指標、実装方式は列挙しません。
|
|
106
|
+
|
|
107
|
+
### 6.2. 目的
|
|
108
|
+
|
|
109
|
+
- 全体概要を使用する対象者と、承認、詳細化、設計入力、網羅性確認などの利用場面を結び付けて記述します。
|
|
110
|
+
- 「分かりやすくする」のような曖昧な表現ではなく、「PO が対象範囲と領域分割を承認する」のように利用結果を判定できる表現にします。
|
|
111
|
+
- 後続の詳細 CDFD(プロセスグループ別、ユースケース別)の位置付けを明確にすることを目的に含めます。
|
|
112
|
+
|
|
113
|
+
### 6.3. 適用範囲
|
|
114
|
+
|
|
115
|
+
- 対象業務、開始点、終了点、組織またはシステム境界を明示します。
|
|
116
|
+
- 領域内部(個別コマンドの操作手順、ファイル単位の更新内容、処理の分岐、状態を変える処理と起点イベント、例外時の復旧手順)は対象外とし、プロセスグループ別 CDFD へ委ねることを明記します。状態の定義と遷移は STSD が正本であることも示します。
|
|
117
|
+
- 補助操作は独立した業務フローに含めず、各領域を支える操作として扱うことを明記します。
|
|
118
|
+
- 人間と AI Agent の責任分担は、対応するプロジェクト方針文書があればそれを参照し、なければ「承認・完了判断・構成変更の承認・非推奨化の判断は人間が担い、成果物の作成・評価・派生生成は人が担うほか AI Agent へ委譲できる」のように原則を一文で書きます。
|
|
119
|
+
- 特定プロジェクトの実行計画・スケジュール上のフェーズ名は、全体概要では扱いません。
|
|
120
|
+
|
|
121
|
+
### 6.4. プロセス領域
|
|
122
|
+
|
|
123
|
+
- 章の冒頭で、領域数、プロセスグループ数、正本の所在(領域の分割と受け渡しは本書、領域内部はプロセスグループ別 CDFD)を宣言します。
|
|
124
|
+
- プロセスグループごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名(含む領域 ID の範囲)」とします。各節は次の順で構成します。
|
|
125
|
+
- グループの役割と、グループ内の領域がどう連携するかを 1〜3 文で要約した説明文。
|
|
126
|
+
- `**主要入力**`、`**主要出力**`、`**データストア**` の 3 項目の箇条書き。他グループからの要求(例: Orchestrator からの計画要求)も入力に含めます。対象範囲内の参加者が直接渡す情報は「参加者からの〜」と入力元を明記します。
|
|
127
|
+
- 領域の表。
|
|
128
|
+
- プロセスグループの数は 8 以下とします。超える場合は業務の性質が近いグループを統合します。1 領域だけのグループも認めます。
|
|
129
|
+
|
|
130
|
+
<!-- prettier-ignore -->
|
|
131
|
+
| 列 | 記載内容 | 判定基準 |
|
|
132
|
+
| --- | --- | --- |
|
|
133
|
+
| 領域 ID | `P-01` 形式の安定した識別子 | 表、代表ノードのラベル、詳細 CDFD 一覧で同じ ID を使う |
|
|
134
|
+
| プロセス領域 | 業務目的が分かる短い名称 | コマンド名や実装部品名だけにしない |
|
|
135
|
+
| 業務目的 | 対象者に生じる成果または維持する状態 | 手順や機能の列挙にしない |
|
|
136
|
+
| 主な担当 | 主担当ロール。複数ロールが担う場合は管理責任のロールを併記する | 同じ表では採用済み Role code または組織定義にある役割名のどちらかへ統一し、個人名や「全員」だけで終わらせない |
|
|
137
|
+
| 起点イベント | 領域の開始を判定できる出来事。定義系の領域は「要件が判明した」、実行系の領域は「指示された」「到来した」のように区別する | 「必要に応じて」で終わらせない。同じグループ内で同文にしない |
|
|
138
|
+
|
|
139
|
+
- 独立領域にするのは、固有の起点イベントと業務成果を持ち、他領域と区別できる入力、出力、またはデータストアがある場合です。補助操作は、独立した判断結果や更新成果を持たない限り領域にしません。
|
|
140
|
+
- 領域単位の主要入力・主要出力・データストアは本書に書かず、プロセスグループ別 CDFD へ委ねます。本書の箇条書きはグループ単位に留めます。
|
|
141
|
+
- プロジェクト管理を対象とする文書の「主な担当」は、`<project-id>:pm-roles` に定義された Role code を使います。業務担当の役割名を使う文書は組織定義にある名称へ統一し、Role code と自由記述の呼称を同じ列へ混在させません。task owner や runner のような実行主体を補足する場合も、管理責任を持つ Role code または役割名と区別します。
|
|
142
|
+
|
|
143
|
+
### 6.5. データストア
|
|
144
|
+
|
|
145
|
+
- 章の冒頭で、区分の意味、パスの略記(例: `<project-id>` が指す範囲)、データストアとして扱わないもの(リポジトリ基盤、開発環境の設定など)を各一文で示します。
|
|
146
|
+
- マスタ・構成データとトランザクションデータの 2 表に分け、各行は次の列で構成します。
|
|
147
|
+
|
|
148
|
+
<!-- prettier-ignore -->
|
|
149
|
+
| 列 | 記載内容 | 判定基準 |
|
|
150
|
+
| --- | --- | --- |
|
|
151
|
+
| データストア | 論理的な正本の名称 | 図のノードラベル、プロセス領域の箇条書きと同じ名称を使う |
|
|
152
|
+
| 主な内容 | 保持する情報の種別。生成物なら生成元、退避先なら退避対象を書く | 「各種データ」のような抽象語だけにしない |
|
|
153
|
+
| 主な保管先 | 物理的な所在。複数ある場合は `、<br>` で区切る | 原則として別のデータストアと重ならない範囲に限定し、共有・包含する場合は論理境界と共有相手を注記する |
|
|
154
|
+
|
|
155
|
+
- 「主な保管先」列は条件付きです。実装が先にある場合(retrofit)は必須とし、実装エビデンスとして記載します。設計中で候補がある場合は列を置き、未確定のセルは `_UNDECIDED_` とします。保管先を扱わない概念段階では列ごと省略します。
|
|
156
|
+
- 一つの帳簿、ファイル、ディレクトリを複数の論理データストアが共有する場合は、欄、レコード種別、Frontmatter キー、除外するサブディレクトリなど、どの内容をどちらの正本として扱うかを第三者が区別できる境界と共有相手を「主な保管先」または章の冒頭に注記します。境界を特定できない共有は認めません。
|
|
157
|
+
- 親ディレクトリとその配下を別のデータストアにする場合は、親側の範囲から子側を明示的に除外します。別データストアの情報を Frontmatter などへ埋め込む場合は、埋め込み先と埋め込む情報の正本関係を注記します。
|
|
158
|
+
- 区分の判定基準は更新契機です。承認された変更で更新されるものはマスタ・構成データ、業務活動に伴い都度更新されるものはトランザクションデータとします。定義から生成される生成物は、生成元の定義がマスタ・構成データであっても、生成物自体はトランザクションデータとします。
|
|
159
|
+
- 生成物の集約先(評価結果、報告、派生ビューなど)や退避先(保管庫など)も、プロセスグループが更新するならデータストアとして一覧に含めます。
|
|
160
|
+
|
|
161
|
+
### 6.6. 概念データフロー(概要)
|
|
162
|
+
|
|
163
|
+
- 章の冒頭で、ノードの構成(プロセスグループの代表ノードとデータストア)、矢印の意味(情報または実行要求の受け渡しであり実行順ではない)、更新エッジが参照を含むこと、外部主体の扱いを各一文で示します。
|
|
164
|
+
- 代表ノードはプロセスグループごとに一つとし、ラベルにグループ名と含む領域 ID の範囲を書きます。`subgraph` で領域や代表ノードを囲みません。
|
|
165
|
+
- データストアのノードは「データストア」の各行と一対一とし、同じ名称を使います。
|
|
166
|
+
- 対象範囲内の参加者(ロール)は各領域の担当として業務プロセスの内側にいるため、外部主体として描きません。外部主体を描くのは対象範囲外の入力元・出力先だけです。
|
|
167
|
+
- 対象範囲内の参加者から直接受け取る主要入力は、図のエッジとの相互対応の対象外です。「プロセス領域」の箇条書きで入力元を明記し、図直後の注記に図示を省略した参加者由来の入力を列挙します。
|
|
168
|
+
- 起点イベントは「プロセス領域」の表に記載し、図には描きません。
|
|
169
|
+
- 図のノード総数は、代表ノードとデータストアの合計で数え、外部主体は含めません。合計が 16 を超える場合は、トランザクションデータに着目した図とマスタ・構成データに着目した図に分けます。分ける場合は、両図で代表ノードとデータストアの名称を統一し、あるグループから他グループへの要求(Orchestrator の要求など)はトランザクションの図にだけ描きます。
|
|
170
|
+
- 各図の直後に、「凡例(本プロダクト共通)」がある場合はその参照先、ない場合は `specdojo:cdfd-mermaid-rulebook` の既定凡例に従う旨を記載します。併せて、現物の流れの有無、その図に載せていない要素の参照先、外部主体の有無を一段落で注記します。
|
|
171
|
+
- エッジは「プロセス領域」の各グループの主要入力・主要出力から導出し、ラベルは名詞形の具体的なデータ名にします。データストアを更新するエッジは更新前の参照を含むものとし、参照だけのエッジは別に描きます。
|
|
172
|
+
- ノード形状、線種、色、絵文字の記法は `specdojo:cdfd-mermaid-rulebook` に従います。全体概要の図に含める要素の種別(代表ノード、データストア、必要に応じた外部主体)は本節の規定を優先します。
|
|
173
|
+
|
|
174
|
+
### 6.7. 詳細 CDFD 一覧
|
|
175
|
+
|
|
176
|
+
- 章の冒頭で、プロセスグループ別 CDFD とユースケース別 CDFD の役割分担を箇条書きで示します。前者はグループ内部のプロセス・例外・データストア読み書きの正本、後者は `specdojo:cdfd-uc-rulebook` に従ってグループ間の順序と引き渡し条件だけを定め、内部プロセスを再掲しないことを明記します。状態の定義と遷移は STSD が正本であり、詳細 CDFD は参照に留めることも示します。
|
|
177
|
+
- プロセスグループ別 CDFD の表は、プロセスグループ、含む領域、CDFD の ID の 3 列とし、全プロセスグループを 1 行ずつ載せます。各領域はちょうど一つの行に属します。
|
|
178
|
+
- ユースケース別 CDFD の表は、ケース ID、ユースケース、業務目的、横断するプロセスグループ、CDFD の ID の 5 列とし、複数のプロセスグループを横断し順序と引き渡し条件を定める必要がある業務だけを載せます。単一のグループに閉じる業務は載せず、必要になった時点で追加する旨を本文に書きます。
|
|
179
|
+
- 未作成の CDFD に「(未作成)」などの状態表記を付けません。作成状況は登録簿で追跡します。
|
|
180
|
+
|
|
181
|
+
### 6.8. 凡例(本プロダクト共通)
|
|
182
|
+
|
|
183
|
+
- 本プロダクトの詳細 CDFD が複数存在し、共通のノード形状・色・絵文字を使う場合に設けます。単一の CDFD しか存在しない場合は省略できます。
|
|
184
|
+
- 本章を省略した場合、全 CDFD は `specdojo:cdfd-mermaid-rulebook` の既定凡例に従い、各図の直後にその旨を注記します。
|
|
185
|
+
- `specdojo:cdfd-mermaid-rulebook` が定義する全ノード種別について、本プロダクトが実際に採用する色・絵文字の割り当てをサンプル図と対応表で示します。本図自体が業務データフローを表すものではないため、他章のプロセス領域や受け渡しとは独立させます。
|
|
186
|
+
- 本書自身の概念データフローと各詳細 CDFD の凡例は、この章の定義を再掲せず、本章への参照に留めます。
|
|
187
|
+
|
|
188
|
+
### 6.9. 未決事項
|
|
189
|
+
|
|
190
|
+
- 境界、名称、責務、判断者、保管先のいずれかが未確定な論点がある場合だけ設けます。ない場合は章ごと省略します。
|
|
191
|
+
- 表は論点、影響、決定者、決定時期、状態の 5 列とします。本文中の未確定箇所には `_UNDECIDED_` を付け、表の論点と対応させます。
|
|
192
|
+
- 確定した論点は、本文へ反映したうえで表から削除します。
|
|
193
|
+
|
|
194
|
+
### 6.10. 完成判定
|
|
195
|
+
|
|
196
|
+
本節だけを `ready` 昇格のチェックリストの正本とします。記述ガイドと禁止事項は作成方法と理由の説明であり、独立した追加条件ではありません。次の全項目を満たす必要があります。
|
|
197
|
+
|
|
198
|
+
- Frontmatter に `id`、`type: flow`、`status`、`rulebook: specdojo:cdfd-overview-rulebook` があり、`id` と `status` が「推奨 Frontmatter 項目」の制約を満たしています。`based_on` と `supersedes` を記載する場合も同節の条件を満たしています。
|
|
199
|
+
- H1 直下の導入文が対象業務または運用を一文で定義しています。
|
|
200
|
+
- 「目的」に対象者と利用場面が対応付けられ、対象範囲と領域分割の承認、後続のプロセスグループ別・ユースケース別 CDFD への詳細化、設計入力、網羅性確認の利用結果を判定できます。
|
|
201
|
+
- 「適用範囲」に対象業務、開始点、終了点、組織・システム境界、対象外、補助操作の扱い、人間と AI Agent の責任分担があります。領域内部と状態定義・遷移の正本も特定できます。
|
|
202
|
+
- 「プロセス領域」は 8 以下のプロセスグループからなり、各節が説明文、主要入力・主要出力・データストアの 3 項目、領域表の順で構成されています。領域表には「領域 ID」「プロセス領域」「業務目的」「主な担当」「起点イベント」の全列があり、各領域は一つのグループにだけ属しています。
|
|
203
|
+
- 「主な担当」は同じ表内で採用済み Role code または組織定義にある役割名へ統一され、個人名、未定義の呼称、「全員」だけの記載がありません。実行主体を補足する場合は管理責任を持つロールと区別されています。
|
|
204
|
+
- 「データストア」が「マスタ・構成データ」と「トランザクションデータ」に分かれ、各表に「データストア」「主な内容」と、確定度に応じた「主な保管先」があります。図に必要な物理保管も一覧にあります。
|
|
205
|
+
- 「主な保管先」を記載する場合、各所在は原則として一つのデータストアに属しています。共有、包含、埋め込みがある所在は、論理境界、共有相手、正本関係を注記し、同じ内容を二つの正本として数えていません。
|
|
206
|
+
- 概念データフローにはプロセスグループごとの代表ノードが一つずつあり、`subgraph` を使っていません。データストアのノードは「データストア」の各行と一対一で、表、箇条書き、図、詳細 CDFD 一覧の名称が一致しています。
|
|
207
|
+
- 各プロセスグループの主要入力・主要出力・データストアと図のエッジが相互に対応し、全エッジに起点、到達先、名詞形のラベルがあります。対象範囲内の参加者から直接受け取る入力だけは、箇条書きで「参加者からの〜」と明記され、図直後の注記に図示省略の対象として列挙されている場合に相互対応の対象外とします。
|
|
208
|
+
- 図のノード総数を代表ノードとデータストアの合計で数え、外部主体を含めていません。合計が 16 を超える場合はトランザクションデータとマスタ・構成データの 2 図に分かれ、両図で名称が統一され、グループ間要求はトランザクションデータの図にだけあります。各図の直後に、共通凡例への参照または記法 rulebook の既定凡例に従う旨、線種、未掲載要素、外部主体の注記があり、参加者由来入力がある場合は図示を省略した入力も注記されています。
|
|
209
|
+
- 補助操作と領域内部の手順が独立領域として混入せず、起点イベントは図ではなく領域表にあります。人間が担う主要判断、承認、公開可否を AI Agent またはシステムの自動処理へ置き換えていません。
|
|
210
|
+
- 「詳細 CDFD 一覧」の冒頭に二種類の CDFD の役割分担があります。プロセスグループ別 CDFD の表には「プロセスグループ」「含む領域」「プロセスグループ別 CDFD」の全列と全グループがあり、各領域は一つの行にだけ属しています。ユースケース別 CDFD の表には「ケース ID」「ユースケース」「業務目的」「横断するプロセスグループ」「ユースケース別 CDFD」の全列があり、各行は複数グループを横断し、作成状況を含みません。
|
|
211
|
+
- 「凡例(本プロダクト共通)」を設けた場合、記法規範の全ノード種別について採用する形状・色・絵文字を示し、他の CDFD は定義を再掲せず参照しています。
|
|
212
|
+
- `_TODO_` と作業メモの HTML コメントが残っていません。`_UNDECIDED_` がある場合は最終章の「未決事項」に論点、影響、決定者、決定時期、状態があり、本文の未確定箇所と対応しています。
|
|
213
|
+
- 対象範囲と領域分割を PO が承認した記録を、登録簿の決定記録またはレビュー結果から特定できます。
|
|
214
|
+
|
|
215
|
+
## 7. 禁止事項
|
|
216
|
+
|
|
217
|
+
本章は完成判定に反する代表例と、その理由を示します。`ready` 昇格の pass / fail は「完成判定」で判定します。
|
|
218
|
+
|
|
219
|
+
<!-- prettier-ignore -->
|
|
220
|
+
| 禁止事項 | 理由 |
|
|
221
|
+
| --- | --- |
|
|
222
|
+
| プロセスグループを `subgraph` で表す、または一つの領域を複数の代表ノードへ分割する | 代表ノードとプロセスグループ別 CDFD の対応が崩れ、表・図・詳細 CDFD の突き合わせができなくなるため |
|
|
223
|
+
| 業務の性質が異なる領域を、理由の説明なく一つのプロセスグループへ統合する | 詳細化先の境界が不明瞭になり、重複・欠落の確認ができなくなるため |
|
|
224
|
+
| 全体概要に領域単位の主要入力・主要出力・データストアや、領域内の操作手順、状態を変える処理、例外分岐、物理テーブル・カラム、SQL、実装クラス、詳細 API、コマンドオプションを記載する | プロセスグループ別 CDFD の責務であり、二重管理と粒度超過を招くため |
|
|
225
|
+
| 全体概要または詳細 CDFD で状態の定義・遷移表を正本化する | 状態の定義と遷移は STSD が正本であり、CDFD との二重管理を招くため |
|
|
226
|
+
| 一覧、検索、状態参照、検証、dry-run などを、固有の業務成果がないまま独立領域にする | 補助操作を業務成果と誤認させるため |
|
|
227
|
+
| プロセス領域の表、箇条書き、データストア、図、詳細 CDFD 一覧で、同じ領域・グループ・データストアに異なる名称を使う | 読み手が同一対象と判断できなくなるため |
|
|
228
|
+
| ラベルのないエッジ、起点または到達先のないエッジ、「データストア」に行のないデータストアのノードを残す | 受け渡しの内容・方向・対応関係が読み取れなくなるため |
|
|
229
|
+
| 対象範囲内の参加者(ロール)を外部主体として描く | 業務プロセスの内側にいる担当を外部に置き、責任の所在を誤って示すため |
|
|
230
|
+
| 人間が責任を持つ主要判断、承認、公開可否を AI Agent またはシステムの自動処理として表す | 責任の所在を誤って示すため |
|
|
231
|
+
| 特定プロジェクトの実行計画・スケジュール上のフェーズ名を、前提知識なしの読者に説明なく使う | product 仕様書がプロジェクト管理の実装詳細に依存し、可読性を損なうため |
|
|
232
|
+
| 詳細 CDFD 一覧や本文に「未作成」「TODO」などの作成状況を書く | 作成状況は登録簿で追跡するものであり、成果物本文が陳腐化するため |
|
|
233
|
+
| 作業メモや検討中の論点を HTML コメントで本文に残す | 読み手に見えない未決事項が生まれるため。「未決事項」章または登録簿へ移す |
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdfd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: ready
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:cdfd-recipe
|
|
8
|
+
sample: specdojo:cdfd-sample
|
|
9
|
+
template: specdojo:cdfd-template
|
|
10
|
+
includes:
|
|
11
|
+
- specdojo:cdfd-mermaid-rulebook
|
|
12
|
+
based_on:
|
|
13
|
+
- specdojo:rulebook-authoring-standard
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# 概念データフロー図(プロセスグループ別)作成ルール
|
|
17
|
+
|
|
18
|
+
Conceptual Data Flow Diagram Process Group Documentation Rulebook
|
|
19
|
+
|
|
20
|
+
全体概要で定めた一つのプロセスグループを引き継ぎ、グループに属する全領域の内部プロセス、領域間の受け渡し、主要例外、グループ外への委譲を、表と Mermaid 図で合意可能にするためのルールです。状態を変えるプロセスと起動条件は示しますが、状態の定義と遷移は STSD を参照します。
|
|
21
|
+
|
|
22
|
+
## 1. 全体方針
|
|
23
|
+
|
|
24
|
+
- 一文書は、全体概要で定めた一つのプロセスグループと、そのグループに属する一つ以上のプロセス領域を詳細化します。各領域はちょうど一つのプロセスグループ別 CDFD に属します。単一領域のグループも、その領域だけを含む一つのプロセスグループ別 CDFD として扱います。
|
|
25
|
+
- 「プロセス領域」を領域単位の主要入力・主要出力・データストアとプロセスの業務目的・起動条件・完了条件・必須性の正本、「データストア」を本グループが読み書きする上位一覧の部分集合、「個別プロセス主要入出力」をプロセス単位の入出力の正本、図を順序と分岐の正本として併用します。
|
|
26
|
+
- 一つのプロセスノードは、一つの業務目的と完了条件を持つ処理だけを表します。コマンドや画面の一操作を無条件に一プロセスへ分割せず、複数の判断・更新・生成を一ノードに詰め込みません。
|
|
27
|
+
- 同一グループ内の領域間の受け渡しは内部フローとして図に描きます。他グループの内部処理は展開せず、プロセスグループ別 CDFD またはユースケース別 CDFD へ委譲します。
|
|
28
|
+
- 状態を変えるプロセスとその起点イベントは記載しますが、状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とし、本書では参照関係だけを示します。
|
|
29
|
+
- 正常系だけでなく、業務結果を変える主要例外を、検出条件、扱い、継続・再開条件で定義します。ログや内部エラーの全列挙は行いません。
|
|
30
|
+
- 人間の判断、利用者との合意、外部主体との受け渡しを省略しません。AI Agent やシステムは支援主体として記載できても、人間が負う最終判断を置き換えません。
|
|
31
|
+
|
|
32
|
+
## 2. 位置づけと用語定義
|
|
33
|
+
|
|
34
|
+
| 用語 | 定義 |
|
|
35
|
+
| ---------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
36
|
+
| 全体概要 | プロセス領域、プロセスグループ、データストア、グループ間の受け渡しを定める最上位 CDFD |
|
|
37
|
+
| プロセスグループ | 業務の性質が近いプロセス領域をまとめた集合。本 rulebook が扱う一文書の単位 |
|
|
38
|
+
| プロセス領域 | 全体概要で ID、名称、業務目的、担当、起点イベントが定義され、一つのプロセスグループに属する責務のまとまり |
|
|
39
|
+
| プロセス | 起動条件と入力を受け、業務上意味のある出力または状態変化を一つ生む処理単位 |
|
|
40
|
+
| 起点イベント | 対象領域または内部プロセスを開始させる、発生を判定できる出来事 |
|
|
41
|
+
| データストア | 全体概要で名称と区分が定義された、情報の正本または継続的な保管先 |
|
|
42
|
+
| 主要例外 | 正常系と異なる業務判断、生成結果、引き渡し可否を生じさせ、再開条件の合意が必要な分岐 |
|
|
43
|
+
| グループ外委譲 | 他グループの内部処理を作り込まず、委譲先 CDFD、引き渡す情報、戻す条件によって責任境界を示すこと |
|
|
44
|
+
| 状態遷移の参照 | 状態を変えるプロセスから、状態一覧と状態遷移図を統合した STSD をたどる対応。状態名や遷移表そのものは含めない |
|
|
45
|
+
| 個別プロセス主要入出力 | プロセスごとの主要入力・主要出力・データストアを示す章。「プロセス領域」の表と項目を重複させない |
|
|
46
|
+
|
|
47
|
+
全体概要は領域とグループの分割、およびグループとデータストアの間の受け渡しを定義します。プロセスグループ別 CDFD は一グループの内部を詳細化し、ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件だけを定義します。
|
|
48
|
+
|
|
49
|
+
## 3. ファイル命名・ID規則
|
|
50
|
+
|
|
51
|
+
- 対象プロダクトの業務仕様配下にあるデータフローディレクトリへ配置します。
|
|
52
|
+
- ファイル名と成果物 ID は `cdfd-<group>` とし、ファイル名だけ `.md` を付けます。`<group>` は全体概要のプロセスグループ名を表す英小文字・数字・ハイフンのスラッグです。
|
|
53
|
+
- product 成果物の ID にプロジェクト ID や authority は付けません。例: ファイル名 `cdfd-sales.md`、ID `cdfd-sales`。
|
|
54
|
+
- `cdfd-overview` は全体概要、`cdfd-uc-<topic>` はユースケース別 CDFD の ID であり、本 rulebook の対象外です。
|
|
55
|
+
- プロセス ID は、全体概要の領域 ID `P-<nn>` に二桁の枝番を付けた `P-<nn>-<nn>` 形式とします。例: 領域 `P-03` の二番目のプロセスは `P-03-02`。文書内一意の `P-01` 形式は使用しません。
|
|
56
|
+
- 主要例外 ID は、対象領域の番号に二桁の枝番を付けた `E-<nn>-<nn>` 形式とします。複数領域にまたがる例外は、最初に検出するプロセスの領域番号を使います。
|
|
57
|
+
- プロセス ID と例外 ID は名称変更後も同じ対象を示す限り維持し、一覧、図、入出力表、例外表で同じ値を使います。
|
|
58
|
+
|
|
59
|
+
## 4. 推奨 Frontmatter 項目
|
|
60
|
+
|
|
61
|
+
| 項目 | 説明 | 必須 |
|
|
62
|
+
| ---------- | ----------------------------------------------------- | ---- |
|
|
63
|
+
| id | `cdfd-<group>` | ○ |
|
|
64
|
+
| type | `flow` | ○ |
|
|
65
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
66
|
+
| rulebook | `specdojo:cdfd-rulebook` | ○ |
|
|
67
|
+
| based_on | 全体概要など、依存関係上許可された直接の内容根拠の ID | 任意 |
|
|
68
|
+
| supersedes | 置き換える旧 CDFD の ID | 任意 |
|
|
69
|
+
|
|
70
|
+
- product 成果物の `id` はプロジェクト修飾なしとし、`based_on` に全体概要を記載する場合も product 成果物 ID を使用します。
|
|
71
|
+
- `based_on` は成果物カタログの `depends_on` の推移閉包に含まれる直接の内容根拠だけを列挙します。
|
|
72
|
+
- 文書のタイトルと利用目的は本文 H1 と「目的」で示し、未定義の Frontmatter 項目を追加しません。
|
|
73
|
+
- 作成途中の `status` は `draft` とします。`ready` へ昇格できるのは、「完成判定」の全項目を満たし、対象プロジェクトのロール定義または責任分担文書で特定した承認者による業務境界・主要例外・委譲境界の承認記録を、登録簿の決定記録またはレビュー結果から特定できる場合です。
|
|
74
|
+
|
|
75
|
+
## 5. 本文要件
|
|
76
|
+
|
|
77
|
+
| 番号 | 見出し | 必須 | 内容 |
|
|
78
|
+
| ---- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------- |
|
|
79
|
+
| 1 | 目的 | ○ | 対象者と利用場面 |
|
|
80
|
+
| 2 | 適用範囲 | ○ | 対象グループ、対象期間、開始・終了、組織・システム境界、対象外、責任分担の参照 |
|
|
81
|
+
| 3 | プロセス領域 | ○ | 領域ごとの節。説明文、主要入力・主要出力・データストアの箇条書き、業務目的・担当・起動条件・完了条件・必須性の表 |
|
|
82
|
+
| 4 | データストア | ○ | 全体概要と同じ名称・区分を持つ、本グループが読み書きするデータストアの部分集合と読み書きの別 |
|
|
83
|
+
| 5 | 概念データフロー | ○ | 一ノード一プロセスの Mermaid 図。領域または業務の性質ごとに分割し、図直後に省略事項と凡例の適用元を記載 |
|
|
84
|
+
| 6 | 個別プロセス主要入出力 | ○ | プロセスごとの主要入力・主要出力・データストア。図を分割した場合は同じ単位で節を設ける |
|
|
85
|
+
| 7 | 状態遷移の参照 | ○ | 状態を変えるプロセスと STSD の対応。該当プロセスがない場合はその事実と確認根拠 |
|
|
86
|
+
| 8 | 主要例外とグループ外への委譲 | ○ | 主要例外の検出・停止範囲・扱い・再開、および他の CDFD への委譲。各区分が 0 件でも該当なしの事実と確認根拠を記録する |
|
|
87
|
+
| 9 | 未決事項 | 任意 | 未決論点、影響、決定者、決定時期 |
|
|
88
|
+
|
|
89
|
+
## 6. 記述ガイド
|
|
90
|
+
|
|
91
|
+
### 6.1. 目的と適用範囲
|
|
92
|
+
|
|
93
|
+
- 誰が、グループ内部のフロー、領域間の受け渡し、主要例外、グループ外への委譲のどれを合意または後続利用するかを示します。
|
|
94
|
+
- 対象グループと含む領域の範囲は全体概要から引き継ぎます。期間、組織、システム境界と、どのイベントからどの出力までを扱うかを明記します。
|
|
95
|
+
- 対象外は、補助操作、実装詳細、他グループの責務、ユースケース別 CDFD が扱う横断順序に分けます。委譲内容の詳細は「主要例外とグループ外への委譲」にだけ記載します。
|
|
96
|
+
- 人間と AI Agent の責任分担は本文で再定義せず、対応する方針文書を参照します。
|
|
97
|
+
- 特定プロジェクトの実行フェーズ名や一時的な仮称を持ち込まず、対象プロダクトの現在の正本として読める語彙を使います。
|
|
98
|
+
|
|
99
|
+
### 6.2. プロセス領域
|
|
100
|
+
|
|
101
|
+
- 章の冒頭で、対象グループ名、含む領域数、全体概要との正本関係を示します。全体概要の対象グループ名と、そこに属する全領域の ID・名称を引き継ぎ、領域を追加・削除・別グループへ移動しません。
|
|
102
|
+
- 領域ごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「領域名(領域 ID)」とします。各節は、領域の役割と内部プロセスの連携を示す 1〜3 文の説明、`**主要入力**`・`**主要出力**`・`**データストア**` の箇条書き、プロセスの表の順で構成します。
|
|
103
|
+
- 領域 ID、名称、業務目的、主な担当、起点イベントは全体概要を正本とします。本章では領域 ID と名称を見出しの対応キーとして使い、業務目的・担当・起点イベントを書き写しません。
|
|
104
|
+
- 各節の主要入力・主要出力・データストアを合わせると、全体概要にあるグループ単位の箇条書きを過不足なく説明できるようにします。データストアは「データストア」と同じ名称を使います。
|
|
105
|
+
- 各節の表は一行を一つのプロセスノードへ対応させます。主要入力・主要出力・データストアは箇条書きと「個別プロセス主要入出力」へ記載し、表の列には含めません。
|
|
106
|
+
|
|
107
|
+
| 列 | 記載内容 | 判定基準 |
|
|
108
|
+
| ----------- | ---------------------------------------------- | ----------------------------------------------------------- |
|
|
109
|
+
| プロセス ID | 対応領域 ID に枝番を付けた `P-<nn>-<nn>` | プロセス領域のいずれかへ一意に属し、表と図で同じ ID を使う |
|
|
110
|
+
| プロセス | 一つの業務目的が分かる短い名称 | 複数プロセスや操作列を一行へ詰め込まない |
|
|
111
|
+
| 業務目的 | 対象者に生じる成果または維持する状態 | 手順や状態遷移の列挙にしない |
|
|
112
|
+
| 主な担当 | 主担当となるロールまたは外部主体 | 個人名にせず、人間の最終判断を明示する |
|
|
113
|
+
| 起動条件 | 開始を判断できるイベント、前段の完了、承認条件 | 「必要に応じて」で終わらせない |
|
|
114
|
+
| 完了条件 | 業務目的を達成したと判定できる出力または事実 | yes / no で判定でき、主要出力または正本の確定と対応している |
|
|
115
|
+
| 必須性 | 必須、条件付き、選択のいずれか | 条件付き・選択では起動条件と非起動時の正常な扱いを示す |
|
|
116
|
+
|
|
117
|
+
### 6.3. データストア
|
|
118
|
+
|
|
119
|
+
- 全体概要の「データストア」と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、本グループが読み書きする行だけを掲載します。該当する行がない区分は節ごと省略します。
|
|
120
|
+
- 表の列は「データストア」「読み書き」「本グループでの利用」とします。「読み書き」は「参照」「更新」「参照・更新」のいずれかとし、物の保管先を扱う場合は利用内容に現物の受け渡しであることを示します。
|
|
121
|
+
- 名称と区分は全体概要から変更しません。新しいデータストアまたは区分変更が必要なら先に全体概要を変更し、本章だけへ追加しません。
|
|
122
|
+
- プロセス領域の全箇条書きと個別プロセス主要入出力にあるデータストアを過不足なく含め、各データストアがどの領域またはプロセスで参照・更新されるかを利用内容で説明します。
|
|
123
|
+
- 概念データフローを複数図に分けて同じデータストアを再掲する場合を除き、表の各行と図のデータストアノードを一対一に対応させ、名称を一致させます。
|
|
124
|
+
|
|
125
|
+
### 6.4. 概念データフロー
|
|
126
|
+
|
|
127
|
+
- Mermaid のノード、エッジ、形状、線種は Frontmatter の `includes` で指定した記法ルールに従います。
|
|
128
|
+
- 全体概要の各領域を一つの代表ノードとして再掲せず、「プロセス領域」の各表の行を一つずつ個別のプロセスノードとして配置します。
|
|
129
|
+
- 同一グループ内の領域間の受け渡しは、双方のプロセスを同じ図または対応する分割図に置いて示します。他グループは内部プロセスを描かず、委譲先の代表ノードまたは起点・完了イベントだけを置きます。
|
|
130
|
+
- 図は領域ごと、または業務の性質が近いプロセスごとに分けることを基本とします。一図のプロセスノードが目安 15 個を超える場合も分割します。
|
|
131
|
+
- 各図の直後に、全体概要に「凡例(本プロダクト共通)」がある場合はその参照、ない場合は `specdojo:cdfd-mermaid-rulebook` の既定凡例に従う旨を記載します。併せて、線種、図から省略した入出力とその理由、別図と共有するノードを示し、色・絵文字の割り当ては再掲しません。
|
|
132
|
+
- 状態名をノードとして並べたり、状態間の矢印を描いたりしません。状態を変える業務はプロセスと起点イベントだけを示し、「状態遷移の参照」から STSD へ接続します。
|
|
133
|
+
|
|
134
|
+
### 6.5. 個別プロセス主要入出力
|
|
135
|
+
|
|
136
|
+
- 図を領域単位で分けた場合は領域ごと、業務の性質で分けた場合は同じまとまりごとに節を設けます。
|
|
137
|
+
- プロセス ID ごとに、主要入力、主要出力、データストアを表で示します。業務目的、担当、起動条件、必須性は「プロセス領域」の表から重複させません。
|
|
138
|
+
- データストアの名称と区分は「プロセス領域」「データストア」および全体概要と一致させます。論理的な入出力名と保管先を同じ列へ混在させません。
|
|
139
|
+
- 全プロセスをちょうど一度掲載し、一プロセスだけのまとまりでも同じ表構成を省略しません。
|
|
140
|
+
|
|
141
|
+
### 6.6. 状態遷移の参照
|
|
142
|
+
|
|
143
|
+
- 状態を変えるプロセスがある場合、表の列は「対象」「状態を変えるプロセス」「ステータス定義(STSD)」とします。該当プロセスがない場合は、その事実と確認根拠を一文で記載して表を省略します。
|
|
144
|
+
- STSD は状態名・意味・成立条件と、遷移元・遷移先・イベント・遷移条件の単一正本として参照します。
|
|
145
|
+
- CDFD には状態の一覧、遷移表、状態を頂点とする状態遷移図を複製しません。参照先が未作成なら文書 ID をバッククォートで仮置きし、作成状況は登録簿で追跡します。
|
|
146
|
+
- プロセスの業務目的や入出力は CDFD に残し、状態定義だけを STSD へ委ねます。参照によってフローの説明を空洞化させません。
|
|
147
|
+
|
|
148
|
+
### 6.7. 主要例外とグループ外への委譲
|
|
149
|
+
|
|
150
|
+
- 主要例外は「例外 ID」「対象プロセス」「検出条件」「停止範囲」「本グループでの扱い」「継続・再開条件」の表で示します。「停止範囲」には、例外の検出後に確定または起動してはならない後続プロセス、出力、委譲を記載します。単なる内部エラー名やログメッセージは列挙しません。
|
|
151
|
+
- 条件付きプロセスを起動しない判断そのものは主要例外に含めません。非起動時の正常な扱いは「プロセス領域」の表にある必須性と図で示します。
|
|
152
|
+
- グループ外委譲は「委譲先」「委譲する事項」「引き渡す情報」「本グループへ戻す条件」の表で示します。
|
|
153
|
+
- 委譲先は、他のプロセスグループ別 CDFD `cdfd-<group>` または複数グループの順序を扱うユースケース別 CDFD `cdfd-uc-<topic>` とします。同一グループ内の領域を委譲先にしません。
|
|
154
|
+
- 委譲先 CDFD の内部プロセス、状態遷移、例外処理は展開しません。未作成の委譲先は文書 ID をバッククォートで示します。
|
|
155
|
+
- 主要例外が 0 件の場合も「主要例外」の節を残し、正常系・条件付きプロセス・更新失敗を確認した範囲と、業務結果または後続起動を変える例外がないという結論を一文で記載して表を省略します。
|
|
156
|
+
- グループ外委譲が 0 件の場合も「グループ外への委譲」の節を残し、対象外とした他グループの責務と横断ユースケースを確認した範囲、および委譲がないという結論を一文で記載して表を省略します。
|
|
157
|
+
|
|
158
|
+
### 6.8. 完成判定
|
|
159
|
+
|
|
160
|
+
- Frontmatter に必須の `id`、`type`、`status`、`rulebook` があり、`id` とファイル名が命名規則に一致します。`ready` の場合は、対象プロジェクトの責任分担から承認者を特定でき、登録簿の決定記録またはレビュー結果に承認記録があります。
|
|
161
|
+
- 「目的」に対象者と利用結果が対応付けられ、「適用範囲」に対象グループ、対象期間、開始・終了、組織・システム境界、対象外、状態遷移と責任分担の参照があります。
|
|
162
|
+
- 全体概要で対象グループに属する全領域が「プロセス領域」にちょうど一つの節として登場し、各領域の表に内部プロセスが一つ以上あります。
|
|
163
|
+
- 各プロセスに業務目的、主な担当、起動条件、完了条件、必須性があり、完了条件は主要出力または正本の確定から yes / no で判定できます。
|
|
164
|
+
- 領域単位の主要入力・主要出力・データストアを合算すると、全体概要のグループ単位の箇条書きと矛盾せず、名称と区分が一致します。
|
|
165
|
+
- 全プロセスが領域ごとの表、図、個別プロセス主要入出力へ同じ ID と名称で登場し、ID が所属領域を示します。
|
|
166
|
+
- 「データストア」が全体概要の部分集合であり、名称・区分が一致します。各行は図の同名ノードと対応し、読み書きの別がプロセス領域と個別プロセス主要入出力に矛盾しません。
|
|
167
|
+
- 同一グループ内の領域間受け渡しを内部フローとしてたどれ、他グループの内部処理を作り込んでいません。
|
|
168
|
+
- 状態を変えるプロセスは STSD を参照し、CDFD 本文に状態の定義、遷移表、状態遷移図を重複記載していません。
|
|
169
|
+
- 主要例外の検出、停止範囲、継続・再開条件と、グループ外への引き渡しを確認者が説明できます。
|
|
170
|
+
- 主要例外またはグループ外委譲が 0 件の場合は、対応する節に確認範囲と該当なしの結論があり、空表やプレースホルダーが残っていません。
|
|
171
|
+
|
|
172
|
+
## 7. 禁止事項
|
|
173
|
+
|
|
174
|
+
- 複数領域を持つグループから一部の領域だけを切り出して別文書にしたり、一つの領域を複数のプロセスグループ別 CDFD に重複配置したりしません。全体概要で単一領域として定義されたグループは、その一領域をグループ全体として一文書にします。
|
|
175
|
+
- product 成果物の ID を `<project-id>:cdfd-<group>` にしたり、領域名を使った `cdfd-<domain>` を新規採用したりしません。
|
|
176
|
+
- 文書内一意の `P-01` 形式を内部プロセス ID に使ったり、領域 ID と対応しないプロセス ID を付けたりしません。
|
|
177
|
+
- 全体概要と異なるデータストア名・区分を使用したり、物理テーブル名、物理カラム名、SQL、実装クラス、詳細 API を概念フローへ記載したりしません。
|
|
178
|
+
- 状態名・意味を CDFD で定義したり、遷移元・遷移先・遷移条件の表や状態遷移図を複製したりしません。
|
|
179
|
+
- 他グループの内部プロセスを展開したり、同一グループ内の領域間受け渡しをグループ外委譲として扱ったりしません。
|
|
180
|
+
- 一覧、検索、状態参照、検証、dry-run など、独自の業務成果を持たない補助操作を独立プロセスにしません。
|
|
181
|
+
- プロセス領域の表と個別プロセス主要入出力、図直後の注記、例外表の間で同じ事実を重複記載しません。
|
|
182
|
+
- すべての内部エラー、ログ、再試行を主要例外として列挙せず、停止範囲や再開条件を判定できない曖昧な記述を残しません。
|