specdojo 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +125 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +141 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -3,11 +3,11 @@ specdojo:
|
|
|
3
3
|
id: specdojo:ccd-mermaid-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
|
-
status:
|
|
6
|
+
status: ready
|
|
7
7
|
target_format: markdown
|
|
8
|
-
recipe:
|
|
8
|
+
recipe: not-needed
|
|
9
9
|
sample: specdojo:ccd-sample
|
|
10
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
11
|
based_on:
|
|
12
12
|
- specdojo:rulebook-authoring-standard
|
|
13
13
|
---
|
|
@@ -16,265 +16,145 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Conceptual Class Diagram (CCD) Rules using Mermaid
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
業務分析・要求定義で用いる概念クラス図(CCD)の内容要件と判断基準を定義します。
|
|
20
|
+
Mermaid の `classDiagram` で主キーと関連を表し、業務データ辞書(BDD)と照合できる概念モデルを作ります。
|
|
21
21
|
|
|
22
22
|
## 1. 全体方針
|
|
23
23
|
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
24
|
+
- 対象概念と関連の意味を業務の言葉で合意でき、設計と整合性検証の入力として使えることを必須とします。
|
|
25
|
+
- クラスの属性は主キー(PK)のみとし、そのほかの属性は BDD に委ねます。
|
|
26
|
+
- 図は関係種別・役割名・多重度を示し、本文はその業務上の根拠と成立条件を補います。線を文章でなぞるだけの説明は置きません。
|
|
27
|
+
- 対象領域と、初期状態・確定後など図が扱う時点を定めます。同じ関係でも状態によって必要数が異なる場合は、適用条件を本文で区別します。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、成果物の業務の検証に含めません。
|
|
28
29
|
|
|
29
|
-
## 2.
|
|
30
|
+
## 2. 位置づけ
|
|
30
31
|
|
|
31
|
-
-
|
|
32
|
-
- **クラス名は日本語の単数形**を基本とする。
|
|
33
|
-
- 属性は改行で列挙する。
|
|
34
|
-
- 型・可視性(+ - #)・セミコロンなどは書かない。
|
|
32
|
+
CCD は業務仕様のデータモデルを扱い、属性の業務的意味は BDD([[specdojo:bdd-rulebook|業務データ辞書 作成ルール]])、値・型・構造の詳細は BDD が参照する schema・型定義・リファレンスを正本とします。配置・命名の共通事項は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
## 3. ファイル命名・ID規則
|
|
37
35
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
商品ID: PK
|
|
42
|
-
商品名
|
|
43
|
-
価格
|
|
44
|
-
}
|
|
45
|
-
```
|
|
36
|
+
- ファイル名は `ccd-<term>.md` とし、`<term>` は対象業務領域を表す kebab-case とします(例: `ccd-project-planning.md`)。
|
|
37
|
+
- プロジェクト成果物の文書 ID は `<project-id>:ccd-<term>` とし、同じ主題のファイル名と対応させます。
|
|
38
|
+
- 配置は成果物カタログで宣言したパスに従います。カタログの分類は `kind: work`、成果物の種別は `data` とします。
|
|
46
39
|
|
|
47
|
-
##
|
|
40
|
+
## 4. 推奨 Frontmatter 項目
|
|
48
41
|
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
- 属性の順序は自由だが、キーは先頭に置くことを推奨。
|
|
52
|
-
- 外部キー項目は属性としてではなく、クラス間の関連(--> や --)で表す。
|
|
42
|
+
- `type` は `data`、`rulebook` は `specdojo:ccd-mermaid-rulebook` とします。
|
|
43
|
+
- `based_on` には、実際に読み直接の根拠とした作成済み辞書を記録します。カタログがある場合は `depends_on` の推移閉包内に限定し、未作成辞書や単なる参照候補を追加しません。直接の根拠がなければ省略できます。成果物の依存はカタログの `depends_on` に置き、`based_on` を依存一覧の代用にしません。
|
|
53
44
|
|
|
54
|
-
##
|
|
45
|
+
## 5. 本文要件
|
|
55
46
|
|
|
56
|
-
|
|
57
|
-
- 複合キーは複数行で記述可能。
|
|
47
|
+
CCD 成果物(`ccd-<term>.md`)は以下の章構成を標準とします。
|
|
58
48
|
|
|
59
|
-
|
|
49
|
+
| 章番号 | 章タイトル | 必須 | 内容・受入条件 |
|
|
50
|
+
| ------ | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| 1 | 目的と適用範囲 | 必須 | 利用目的、対象領域・対象外、扱う時点を示す。領域の境界や規則は正本へ参照できること |
|
|
52
|
+
| 2 | 概念クラス図 | 必須 | Mermaid `classDiagram` に概念・主キー・関連を示す。継承したキーや抽象概念など、図だけでは誤解する点は短く補足すること |
|
|
53
|
+
| 3 | 関連定義と多重度の根拠 | 必須 | 図中の全関連を表で網羅し、両端の必要数、関係種別、役割名を業務上の理由から説明できること |
|
|
54
|
+
| 4 | 参照業務データ辞書 | 必須 | 全エンティティと辞書の対応、主キーの対応名・識別範囲を示す。未作成・未照合を区別すること |
|
|
55
|
+
| 5 | 未解決事項 | 条件付き | 未作成辞書・根拠不足・文書間矛盾がある場合は必須。論点、影響と当面の扱い、解消時に直す箇所を示す。なければ省略または「なし」とする |
|
|
60
56
|
|
|
61
|
-
|
|
62
|
-
classDiagram
|
|
63
|
-
class 売上明細 {
|
|
64
|
-
伝票番号: PK
|
|
65
|
-
行番号: PK
|
|
66
|
-
商品ID
|
|
67
|
-
数量
|
|
68
|
-
金額
|
|
69
|
-
}
|
|
70
|
-
```
|
|
57
|
+
## 6. 記述ガイド
|
|
71
58
|
|
|
72
|
-
|
|
59
|
+
### 6.1. 目的と適用範囲
|
|
73
60
|
|
|
74
|
-
|
|
75
|
-
|
|
61
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
62
|
+
| ------------------------------ | ---------------------------------------------------------------------- | ---------------------------------------- |
|
|
63
|
+
| 誰が何の判断に使うかを示す | 「担当交代時に計画対象と作業責務を引き継ぐため、概念間の関係を定める」 | 「データを図にする」のみ |
|
|
64
|
+
| 含める概念と対象外を区別する | 「成果物定義を扱い、成果物本体と実行記録は対象外とする」 | 関連する保存ファイルをすべてクラスにする |
|
|
65
|
+
| 多重度が成立する時点を特定する | 「立上げ途中の未展開状態を含む」 | 確定後の必須数を初期状態にも適用する |
|
|
76
66
|
|
|
77
|
-
|
|
67
|
+
### 6.2. 概念クラス図
|
|
78
68
|
|
|
79
|
-
|
|
69
|
+
#### 6.2.1. クラスと主キー
|
|
80
70
|
|
|
81
|
-
|
|
71
|
+
- クラス名は日本語の単数形とし、BDD の論理名と対応させます。抽象概念を置く場合は、共通化する識別・関連と、独立した保存対象かどうかを補足します。
|
|
72
|
+
- 主キーの各属性行に `: PK` を付け、複合主キーは構成項目ごとに分けます。親からキーを継承する下位クラスは `class お菓子 {}` のように空の属性ブロックとし、継承元を本文または辞書対応表で示します。
|
|
73
|
+
- 同じキー構成でも、役割と変更・参照の単位が異なれば別概念にできます。同じ名前の識別子でも一意性の範囲が異なれば、必要な文脈をキーに含めます。
|
|
82
74
|
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
75
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
76
|
+
| ------------------------------ | ------------------------------------------------------------ | -------------------------------------------------- |
|
|
77
|
+
| 業務上の識別単位を表す | 明細に「売上ID」と「明細番号」をそれぞれ PK として記載 | 明細番号だけで全売上の明細を識別する |
|
|
78
|
+
| 実装構造から独立させる | 計画要素をタスク・節目の識別と依存を共通化する概念として説明 | 共通の保存ファイルがないという理由だけで概念を除く |
|
|
79
|
+
| 個々の属性の定義を辞書へ委ねる | 主キーだけを図示し、名称・単価の意味は BDD へ参照する | 型・桁数・enum 一覧をクラス内に書く |
|
|
88
80
|
|
|
89
|
-
|
|
81
|
+
#### 6.2.2. 関係種別と役割名
|
|
90
82
|
|
|
91
|
-
|
|
92
|
-
| -------- | ------------------------------------------------------ |
|
|
93
|
-
| 継承 | 種類 / 分類 / 区分 |
|
|
94
|
-
| 親子 | 構成する / 保有する / 含む / 明細 / 行 / 履歴 |
|
|
95
|
-
| 参照 | 参照する / 対象 / 元伝票 / 請求先 / 商品 / 起点 / 出典 |
|
|
83
|
+
次の三種を使い分けます。全線に短い日本語の役割名を付け、親子・参照の両端には引用符付きの多重度を付けます。
|
|
96
84
|
|
|
97
|
-
|
|
85
|
+
| 関係種別・記法 | 選ぶ基準 | 良い例 | 悪い例 |
|
|
86
|
+
| ------------------ | ---------------------------------------- | ---------------------------------------- | -------------------------------------------------- |
|
|
87
|
+
| 継承 `親 <\|-- 子` | 下位概念が上位概念の識別と性質を引き継ぐ | 商品からお菓子へ「種類」の関係を置く | 所属するだけの明細を伝票の下位概念にする |
|
|
88
|
+
| 親子 `親 *-- 子` | 子が親の業務上のまとまりに属して成立する | 伝票が明細を「構成する」 | 同じファイルに保存するという理由だけで親子にする |
|
|
89
|
+
| 参照 `A --> B` | 参照先を別の管理単位として追跡する | 明細から商品を「対象商品」として参照する | 構成から参照を外すと参照先も廃棄されると決めつける |
|
|
98
90
|
|
|
99
|
-
|
|
91
|
+
同じクラス間の複数の関連や自己関連は、役割名で意味を区別します。例えば登録項目の「起票元をたどる」と「先行項目の完了を必要とする」は別の関連です。「関連」「リンク」だけのラベルや、起票元から実行順序を推測する表現では区別できません。
|
|
100
92
|
|
|
101
|
-
|
|
102
|
-
| -------- | ------------- | ----------------------- |
|
|
103
|
-
| 継承関係 | `子 <\|-- 親` | is-a(一般化・特化) |
|
|
104
|
-
| 親子関係 | `親 *-- 子` | 所有・構造(part-of) |
|
|
105
|
-
| 参照関係 | `A --> B` | ゆるい関連(reference) |
|
|
93
|
+
#### 6.2.3. 図の向き
|
|
106
94
|
|
|
107
|
-
|
|
95
|
+
- 既定は上→下とし、`direction` を書かないか `direction TB` とします。継承・親子では親を上、子を下に置きます。
|
|
96
|
+
- 関連の連なりが長く、横に並べた方が読みやすい場合だけ `direction LR` とし、その理由を図の直後の本文に書きます。
|
|
97
|
+
- 線の交差や重なりで読めない場合は、向きを変える前にクラスの宣言や関連の順番を並べ替えます。
|
|
108
98
|
|
|
109
|
-
|
|
110
|
-
|
|
99
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
100
|
+
| ---------------------- | -------------------------------------------------------------------- | ---------------------------------------------- |
|
|
101
|
+
| 既定の向きにそろえる | `direction` を書かず、商品の下にお菓子・玩具を置く | 理由を書かずに `direction LR` とする |
|
|
102
|
+
| 例外の理由を本文に示す | 「工程の連なりが長く縦では収まらないため LR とする」と図の直後に書く | 図ごとに向きが異なり、読み手が理由をたどれない |
|
|
111
103
|
|
|
112
|
-
### 6.
|
|
104
|
+
### 6.3. 関連定義と多重度の根拠
|
|
113
105
|
|
|
114
|
-
|
|
106
|
+
関連表は次のカラムを持ちます。起点・先が同じ関連も、役割名ごとに一行を設けます。
|
|
115
107
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
108
|
+
| カラム | 記載する判断情報 |
|
|
109
|
+
| ------------------ | ------------------------------------------------------------------------ |
|
|
110
|
+
| 関連(起点 - 先) | 図のクラス名と向きを一致させる |
|
|
111
|
+
| 関係種別 | 継承・親子・参照の選択 |
|
|
112
|
+
| 多重度 | 起点側・先側の順で表示する。継承は「—」など数を定めない表記とする |
|
|
113
|
+
| 役割名 | 図のラベルと一致させ、同じクラス間の関連を識別する |
|
|
114
|
+
| 業務上の理由・根拠 | 両端の最小・最大数が成立する理由、状態・例外、必要なら規則の正本への参照 |
|
|
119
115
|
|
|
120
|
-
|
|
116
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
117
|
+
| ------------------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
|
118
|
+
| 両端の制約を説明できる | 「明細は必ず一つの商品を指す。未販売の商品も同じ商品を扱う複数明細もあるため、明細側は0件以上」 | 「多対一だから」のみ |
|
|
119
|
+
| 状態による最小数の違いを示す | 「伝票は一時保存時に明細0件を許す。確定時は1件以上を別途必須とする」 | 理由なく `0..*` とする、または一時保存にも `1..*` を強制する |
|
|
120
|
+
| 任意の対応を両方向から確認する | 「戦略作成後の未展開期間と、戦略を持たない既存トラックを許すため、両端を `0..1` とする」 | 「対応する戦略は一つ」で逆側の任意性を説明しない |
|
|
121
121
|
|
|
122
|
-
|
|
123
|
-
| ------------- | --------------------- | -------------------------- |
|
|
124
|
-
| 1件のみ | `"1"` | 常に1つ |
|
|
125
|
-
| 0または1 | `"0..1"` | 任意、存在しない場合もある |
|
|
126
|
-
| 複数(1以上) | `"1..*"` | 最低1つは存在 |
|
|
127
|
-
| 複数(0以上) | `"0..*"` または `"*"` | 数の制約なし |
|
|
122
|
+
一意性の範囲、参照先の存在、循環の可否など、線だけでは示せない整合性条件はこの章に補います。先行依存の循環禁止など業務ごとの規則は正本を参照し、すべての自己関連を一律に禁止しません。
|
|
128
123
|
|
|
129
|
-
|
|
124
|
+
### 6.4. 参照業務データ辞書
|
|
130
125
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
126
|
+
- 対応表は「エンティティ」「主キーの対応」「参照先業務データ辞書」を持ちます。キーを継承する下位概念はまとめて記載でき、図の全クラスを照合できることを必須とします。
|
|
127
|
+
- キーの対応には BDD のフィールド名と、全体・project 内・親の内部など識別範囲を示します。図の日本語名と辞書の物理名が異なる場合に対応を省きません。
|
|
128
|
+
- 作成済み辞書は project 修飾 ID のリンク、未作成辞書は予定 ID のコード表記と「未作成」で示します。未作成・未読の辞書を確認済みの根拠にはしません。
|
|
134
129
|
|
|
135
|
-
|
|
130
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
131
|
+
| ------------------------ | --------------------------------------------------------------- | ----------------------------------------------- |
|
|
132
|
+
| 識別範囲を追跡できる | 「成果物定義は project の識別子と `local_id` で識別する」 | `local_id` が全 project で一意と読み取れる記載 |
|
|
133
|
+
| 未作成を未照合として扱う | 予定 ID に「未作成」を添え、未解決事項に照合の条件を残す | 存在しない辞書へリンクし、属性の一致を断定する |
|
|
134
|
+
| 定義の正本を一つに保つ | 対応名だけを示し、属性の意味・許容値は BDD とその参照先に委ねる | schema のキー一覧・構文・制約を対応表に複写する |
|
|
136
135
|
|
|
137
|
-
|
|
138
|
-
販売明細 "*" --> "1" 商品 : 商品を参照
|
|
139
|
-
```
|
|
136
|
+
### 6.5. 未解決事項
|
|
140
137
|
|
|
141
|
-
|
|
138
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
139
|
+
| ---------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
140
|
+
| 不足根拠と影響を限定する | 「未作成辞書とのキー対応は未照合。図には主キー以外を追加しない」 | 不足を隠して「すべて整合」とする |
|
|
141
|
+
| 解消時に直す箇所を示す | 「辞書作成後に名称・識別範囲を照合し、対応表と関連表を直す」 | 「後で確認」のみ |
|
|
142
|
+
| 矛盾・未確認・乖離を区別する | 文書 ID と相反する記述を示し、現時点で採用する根拠と確認の条件を記す | 調査対象がコマンド入口だけなのに実装全体との一致・乖離を断定する |
|
|
142
143
|
|
|
143
|
-
|
|
144
|
-
classDiagram
|
|
145
|
-
direction LR
|
|
146
|
-
商品 <|-- お菓子 : 種類
|
|
147
|
-
伝票 *-- 明細 : 構成する
|
|
148
|
-
明細 --> 商品 : 商品を参照
|
|
149
|
-
```
|
|
144
|
+
未確定の前提・判断は共通ラベル(`_ASSUMPTION_`・`_UNDECIDED_`)で区別します。解消した論点は本文へ反映し、未解決事項として残し続けません。
|
|
150
145
|
|
|
151
|
-
|
|
146
|
+
### 6.6. 整合性の照合と改訂時の確認
|
|
152
147
|
|
|
153
|
-
|
|
154
|
-
- 関係名(役割名)は **短く・直感的な日本語**で書く。
|
|
155
|
-
- ラベルは以下のように「名詞句」または「短い動詞句」を使う:
|
|
148
|
+
キーや多重度の業務上の妥当性は、構文検査ではなく次の照合で判定します。
|
|
156
149
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
| 継承 | `種類` `分類` `区分` |
|
|
160
|
-
| 親子 | `構成する` `保有する` `含む` |
|
|
161
|
-
| 参照 | `参照する` `対象商品` `起点` `元伝票` `請求先` |
|
|
150
|
+
- 図の全クラスと辞書対応表、全関連と根拠表を突き合わせ、名前・向き・種別・役割名・多重度が一致することを確認します。多重度は両方向から読み、最小数と上限を業務条件に照らします。
|
|
151
|
+
- BDD のキー・識別範囲、業務フローや業務規則の変更時は、該当するクラスと関連の根拠を再確認します。実装との照合を行う場合は、確認した範囲と不足根拠を分けて記録します。
|
|
162
152
|
|
|
163
|
-
|
|
153
|
+
## 7. 禁止事項
|
|
164
154
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
-
|
|
168
|
-
-
|
|
169
|
-
-
|
|
170
|
-
|
|
171
|
-
避けるべき混在:`商品` と `Invoice` のようなランダム混在。用途別に図を分割するか名称を統一する。
|
|
172
|
-
|
|
173
|
-
## 8. 関係選択の判断基準
|
|
174
|
-
|
|
175
|
-
| 判断項目 | 親子(\*--)を使う条件 | 参照(-->)で十分な条件 | 継承(<\|--)を使う条件 |
|
|
176
|
-
| -------------- | -------------------------- | ---------------------------- | ---------------------------------- |
|
|
177
|
-
| ライフサイクル | 親と同時に生成・削除される | 独立して生成/削除される | 下位概念が上位の性質を恒常的に持つ |
|
|
178
|
-
| 意味の自立性 | 子単独では意味が弱い | 子単独でも意味が成立する | 「種類」「分類」による階層自然発生 |
|
|
179
|
-
| 複数親の可能性 | ほぼ無い | あり得る / 複数参照 | 下位は単一上位を持つ |
|
|
180
|
-
| 再利用性 | 子は親に密結合 | 子は他コンテキストでも再利用 | 共通属性を上位へ抽象化 |
|
|
181
|
-
| 変更影響 | 親変更は子へ波及 | 親変更影響は限定的 | 上位変更は全下位へ波及 |
|
|
182
|
-
|
|
183
|
-
ガイド:
|
|
184
|
-
|
|
185
|
-
- 迷ったらまず「参照(-->)」でモデル化 → 後続レビューで親子/継承へ昇格させる。
|
|
186
|
-
- 継承は濫用しない(2階層程度を推奨)。属性共通率が低いなら参照で表現。
|
|
187
|
-
|
|
188
|
-
## 9. 継承適用ガイドライン
|
|
189
|
-
|
|
190
|
-
継承(一般化/特化)を使うべき典型条件:
|
|
191
|
-
|
|
192
|
-
1. 下位概念群で 60% 以上の属性が共通。
|
|
193
|
-
2. 将来的に下位種類が増加する見込みが高い。
|
|
194
|
-
3. 上位概念が「分類語(種別、タイプ、カテゴリ)」として自然言語上認知されている。
|
|
195
|
-
4. ビジネスルールが上位で一括説明でき、下位差分だけが重要。
|
|
196
|
-
|
|
197
|
-
避けるべきケース:
|
|
198
|
-
|
|
199
|
-
- 単一の特殊概念しか存在しない(下位が1種類のみ)
|
|
200
|
-
- 共通属性が2~3個程度しかなく、抽象化が冗長になる場合
|
|
201
|
-
- 実装都合(ORM最適化等)だけが理由
|
|
202
|
-
|
|
203
|
-
## 10. 禁止事項
|
|
204
|
-
|
|
205
|
-
次の記述は概念モデルルールに反するため禁止:
|
|
206
|
-
|
|
207
|
-
- 型・可視性(public / private / `+` `-` `#`)
|
|
208
|
-
- メソッド定義(`calculateTotal()` 等)
|
|
209
|
-
- テーブル設計専用のカラム(`created_at` など技術的属性)を概念に含めること
|
|
210
|
-
- DTO/API リクエスト構造そのもののクラス化
|
|
211
|
-
- 英語と日本語のランダム混在
|
|
212
|
-
- 過剰な階層継承(3階層以上)
|
|
213
|
-
- 関係線ラベル未記載、または曖昧語(「関連」「関係」)のみ
|
|
214
|
-
|
|
215
|
-
## 11. サンプル
|
|
216
|
-
|
|
217
|
-
```mermaid
|
|
218
|
-
classDiagram
|
|
219
|
-
direction LR
|
|
220
|
-
|
|
221
|
-
class 伝票 {
|
|
222
|
-
伝票番号: PK
|
|
223
|
-
日付
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
class 明細 {
|
|
227
|
-
行番号: PK
|
|
228
|
-
数量
|
|
229
|
-
小計
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
class 商品 {
|
|
233
|
-
商品ID: PK
|
|
234
|
-
商品名
|
|
235
|
-
価格
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
伝票 "1" *-- "0..*" 明細 : 構成する
|
|
239
|
-
明細 "*" --> "1" 商品 : 商品を参照
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
## 12. 凡例
|
|
243
|
-
|
|
244
|
-
```mermaid
|
|
245
|
-
classDiagram
|
|
246
|
-
|
|
247
|
-
class 上位分類 {
|
|
248
|
-
ID: PK
|
|
249
|
-
名称
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
class 下位分類 {
|
|
253
|
-
ID: PK
|
|
254
|
-
名称
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
class 親 {
|
|
258
|
-
親ID: PK
|
|
259
|
-
親名称
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
class 子 {
|
|
263
|
-
子ID: PK
|
|
264
|
-
子名称
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
class A {
|
|
268
|
-
AID: PK
|
|
269
|
-
属性1
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
class B {
|
|
273
|
-
BID: PK
|
|
274
|
-
属性2
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
上位分類 <|-- 下位分類 : 継承(一般化)
|
|
278
|
-
親 "1" *-- "0..*" 子 : 所有(構造)
|
|
279
|
-
A "*" --> "1" B : 参照(関連)
|
|
280
|
-
```
|
|
155
|
+
- **主キー以外の属性**: 名称・金額・日付・状態などの一般属性(BDD に委ねる)。
|
|
156
|
+
- **メソッド・型・可視性**: `calculateTotal()` などの操作、`+`・`-`・`#` や `string`・`number` などの実装依存の記法。
|
|
157
|
+
- **実装・技術的要素**: `created_at`・`is_deleted` 等のシステム管理カラム、DTO のクラス化、schema・リファレンスの値・構文・構造の再掲。
|
|
158
|
+
- **ラベルの省略・曖昧語**: 役割名の未記載、「関係」「リンク」だけのラベル。
|
|
159
|
+
- **多重度の誤り**: 親子・参照での省略、継承への付与。
|
|
160
|
+
- **継承の逆転・過剰な階層**: `親 <|-- 子` の向きを誤ること、3 階層以上の継承。
|
|
@@ -16,18 +16,17 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Conceptual Data Flow Diagram Notation Rulebook for D2
|
|
18
18
|
|
|
19
|
-
D2
|
|
19
|
+
D2 で CDFD のプロセス・イベント・データストア・外部主体・受け渡しを表す記法ルールです。全体概要・プロセスグループ別・ユースケース別 CDFD の主 rulebook の `includes` から適用します。プロダクト固有の割り当ては全体概要の「凡例(本プロダクト共通)」、共通凡例がなければ本書の既定凡例を使います。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
23
|
-
-
|
|
24
|
-
|
|
25
|
-
- 図が読みにくくなる原因は方向ではなく規模です。ノード数が多く一画面で関係を追いにくい場合は、方向を変えるのではなく、「凡例と可読性」の分割方針に従って図を分けます。分割の観点(全体概要はデータストアの区分、プロセスグループ別 CDFD は業務の性質が近いプロセス)とノード数の目安は包含元の rulebook が定めます。
|
|
23
|
+
- 方向は `direction: down`、配置エンジンは文書サイトと同じ ELK を基本とし、横長に適する場合は `direction: right` を選べます。矢印は情報・物・実行要求の受け渡しを示し、包含元が明示した場合だけ業務順序も示します。プロセスの並び順と戻りの矢印は「エッジ」に従います。以下、プロセスグループ別とユースケース別を「詳細 CDFD」と呼びます。
|
|
24
|
+
- 一画面で関係を追いにくい場合は「凡例と可読性」に従って分割します。分割単位とノード数の目安は包含元が定めます。
|
|
26
25
|
- 全体概要とユースケース別 CDFD では、一つのプロセスグループを一つの代表ノードで表し、グループ内の領域や処理へ展開しません。ただし、ユースケース別 CDFD の包含元が系統の詳細をプロセス領域単位で描くと定めた場合は、その単位に従います。プロセスグループ別 CDFD では、一つのプロセスを一つのプロセスノードで表します。
|
|
27
26
|
- 一つの記号へ一つの意味を割り当て、ノード形状だけでプロセス、イベント、データストア、外部主体を区別できるようにします。
|
|
28
|
-
|
|
29
27
|
- 情報の流れと物の流れは線種(線の太さ)で区別し、すべてのエッジへ内容を表す名詞形のラベルを付けます。
|
|
30
|
-
-
|
|
28
|
+
- 業務上の合意に必要な概念を形状で区別し、色は「見栄えを整える最小限スタイル」に従う補助表現とします。物理名や詳細な操作は使いません。
|
|
29
|
+
- **共通の運用**: 役割は適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
31
30
|
|
|
32
31
|
| 概念 | D2 表現 | 表示例 |
|
|
33
32
|
| -------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
@@ -43,12 +42,7 @@ D2 の構文で CDFD のプロセス、イベント、データストア、外
|
|
|
43
42
|
|
|
44
43
|
## 2. 位置づけと用語定義
|
|
45
44
|
|
|
46
|
-
|
|
47
|
-
| ------------ | ----------------------------------------------------------------------------- |
|
|
48
|
-
| ノード ID | D2 コード内で要素を参照する識別子。短い英単語または英数字スネークケースを使う |
|
|
49
|
-
| 表示ラベル | 図上で読み手に見せる名称。業務用語と領域 ID を必要に応じて併記する |
|
|
50
|
-
| エッジラベル | 移動する情報・物、またはイベントから伝わる起動条件の名称 |
|
|
51
|
-
| コンテナ | 関連するプロセスを囲む視覚上のまとまり。プロセスグループの表現には使わない |
|
|
45
|
+
コード内で要素を参照するノード ID と、図上に見せる表示ラベルを区別します。表示ラベルは業務用語に必要な領域 ID を併記し、エッジラベルは渡す情報・物・起動条件の名称とします。
|
|
52
46
|
|
|
53
47
|
- ノード ID には日本語文字や記号を避け、`sales_record` や `sales_ledger` のような英数字・スネークケースを基本とします。
|
|
54
48
|
- 表示ラベルは `"..."` で指定し、改行が必要な場合は `\n` を使います。
|
|
@@ -64,23 +58,11 @@ D2 の構文で CDFD のプロセス、イベント、データストア、外
|
|
|
64
58
|
|
|
65
59
|
## 4. 推奨 Frontmatter 項目
|
|
66
60
|
|
|
67
|
-
|
|
68
|
-
- 成果物の `rulebook` は、図種別に応じて構造を定義する上記いずれかの主 CDFD rulebook を指定します。例えばプロセスグループ別 CDFD は `rulebook: specdojo:cdfd-rulebook` とします。
|
|
69
|
-
- 記法だけを別ファイルで適用する運用は行わず、主 CDFD rulebook と組み合わせます。
|
|
70
|
-
|
|
71
|
-
プロセスグループ別 CDFD の記載例:
|
|
72
|
-
|
|
73
|
-
```yaml
|
|
74
|
-
specdojo:
|
|
75
|
-
id: cdfd-purchasing
|
|
76
|
-
type: flow
|
|
77
|
-
status: draft
|
|
78
|
-
rulebook: specdojo:cdfd-rulebook
|
|
79
|
-
```
|
|
61
|
+
成果物の `rulebook` は図種別を定める主 CDFD rulebook とし、本記法を重複記載しません。記法単独では適用しません。プロセスグループ別なら `rulebook: specdojo:cdfd-rulebook` とします。
|
|
80
62
|
|
|
81
63
|
## 5. 本文構成(標準テンプレ)
|
|
82
64
|
|
|
83
|
-
|
|
65
|
+
コードは次表の順を基本とします。全体概要はグループ代表・データストア・情報の流れ、プロセスグループ別は個別プロセス・イベント・データストア・情報/物の流れを必須とします。外部主体・物理保管は存在する場合だけ置き、全図に直後の注記を付けます。ユースケース別のイベントも必須です。ユースケース別の開始・終了は通常の流れ全体で必須とし、分割図や任意の戻りの図への再掲は不要です。
|
|
84
66
|
|
|
85
67
|
| 順序 | 区分 | 必須 | 内容 |
|
|
86
68
|
| ---- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -107,81 +89,30 @@ D2 コードブロック内は、次の順序を基本とします。必須の
|
|
|
107
89
|
|
|
108
90
|
```d2
|
|
109
91
|
direction: down
|
|
110
|
-
|
|
111
92
|
classes: {
|
|
112
93
|
process: {
|
|
113
94
|
shape: rectangle
|
|
114
95
|
style.border-radius: 8
|
|
115
96
|
}
|
|
116
|
-
event: {
|
|
117
|
-
shape: hexagon
|
|
118
|
-
}
|
|
119
|
-
store: {
|
|
120
|
-
shape: cylinder
|
|
121
|
-
}
|
|
122
|
-
actor: {
|
|
123
|
-
shape: rectangle
|
|
124
|
-
}
|
|
125
97
|
}
|
|
126
|
-
|
|
127
98
|
sales_area: "販売領域" {
|
|
128
|
-
sales_record: "P-01-01 販売記録\n(担当: 店員)" {
|
|
129
|
-
class: process
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
purchase_request: "顧客が商品の購入を要求した" {
|
|
133
|
-
class: event
|
|
134
|
-
}
|
|
135
|
-
customer: "顧客" {
|
|
136
|
-
class: actor
|
|
137
|
-
}
|
|
138
|
-
sales_ledger: "販売記録簿" {
|
|
139
|
-
class: store
|
|
99
|
+
sales_record: "P-01-01 販売記録\n(担当: 店員)" { class: process }
|
|
140
100
|
}
|
|
141
101
|
```
|
|
142
102
|
|
|
143
103
|
### 6.2. 絵文字アイコン(任意)
|
|
144
104
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
- 絵文字は任意です(なくても成立します)。
|
|
148
|
-
- 絵文字は表示ラベルのみに付け、ノード ID には付けません。
|
|
149
|
-
- 1ノードにつき1個までとし、表示ラベルの先頭に付けます。
|
|
150
|
-
- 絵文字だけに頼らず、必ずプロセス名・データストア名などのテキストも併記します。
|
|
105
|
+
表示差・幅崩れを考慮し、絵文字は任意とします。表示ラベルの先頭に一つまで付け、名称のテキストを併記します。ノード ID には付けません。
|
|
151
106
|
|
|
152
107
|
```d2
|
|
153
108
|
direction: down
|
|
154
|
-
|
|
155
109
|
classes: {
|
|
156
110
|
process: {
|
|
157
111
|
shape: rectangle
|
|
158
112
|
style.border-radius: 8
|
|
159
113
|
}
|
|
160
|
-
event: {
|
|
161
|
-
shape: hexagon
|
|
162
|
-
}
|
|
163
|
-
store: {
|
|
164
|
-
shape: cylinder
|
|
165
|
-
}
|
|
166
|
-
actor: {
|
|
167
|
-
shape: rectangle
|
|
168
|
-
}
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
sales_area: "販売領域" {
|
|
172
|
-
sales_record: "📋 P-01-01 販売記録\n(担当: 店員)" {
|
|
173
|
-
class: process
|
|
174
|
-
}
|
|
175
|
-
}
|
|
176
|
-
purchase_request: "⚡ 顧客が商品の購入を要求した" {
|
|
177
|
-
class: event
|
|
178
|
-
}
|
|
179
|
-
customer: "🏢 顧客" {
|
|
180
|
-
class: actor
|
|
181
|
-
}
|
|
182
|
-
sales_ledger: "🗄️ 販売記録簿" {
|
|
183
|
-
class: store
|
|
184
114
|
}
|
|
115
|
+
sales_record: "📋 P-01-01 販売記録\n(担当: 店員)" { class: process }
|
|
185
116
|
```
|
|
186
117
|
|
|
187
118
|
禁止例(絵文字がノード ID に付いている、または表示ラベルに無い):
|
|
@@ -238,22 +169,17 @@ sales_record -> sales_ledger: "販売情報"
|
|
|
238
169
|
|
|
239
170
|
### 6.4. 凡例と可読性
|
|
240
171
|
|
|
241
|
-
-
|
|
242
|
-
-
|
|
172
|
+
- 図直後に、共通凡例の参照先、使用線種、省略した入出力と理由、別図と共有するノードを示します。共通凡例がなければ「ノード形状・線種・色・絵文字は `specdojo:cdfd-d2-rulebook` の既定凡例に従う」と書きます。
|
|
173
|
+
- 共通凡例の割り当てを再掲せず、未定義の割り当ても使いません。共通凡例がなければ本書の対応表と「見栄えを整える最小限スタイル」を使い、図ごとの独自割り当ては追加しません。
|
|
243
174
|
- 物の流れを使わない場合は「`->` は情報・実行要求の流れ。本図は物の流れを対象外とする」と記述します。
|
|
244
|
-
|
|
245
175
|
- 図を分ける観点とノード数の目安は包含元の rulebook に従います(全体概要はトランザクションデータの図とマスタ・構成データの図、プロセスグループ別 CDFD は業務の性質が近いプロセス単位、ユースケース別 CDFD は連続する業務の範囲)。分けた図の間で同じプロセス ID・名称を維持します。ユースケース別 CDFD では、共有する参加単位・データストアの名称と領域 ID で接続を追跡し、引き渡し ID は付けません。
|
|
246
176
|
- ノードの表示ラベルは1行あたり全角20字(半角40字)程度を目安にし、超える場合は `\n` で改行して2行程度に収めます。エッジラベルは改行に頼らず短い名詞句に収めます。
|
|
247
177
|
|
|
248
178
|
### 6.5. 見栄えを整える最小限スタイル(任意)
|
|
249
179
|
|
|
250
|
-
-
|
|
251
|
-
-
|
|
252
|
-
|
|
253
|
-
- 色は必ずプロセス/イベント/データストア/外部主体という概念の大分類単位で色相(Hue)を統一し、異なる大分類の間で色相を混同しません。
|
|
254
|
-
- 大分類の中に業務上意味のあるサブ分類がある場合(例: データストアにおけるマスタ・構成データとトランザクションデータの違い)は、大分類の色相を保ったまま、濃淡・彩度を変えた同系統色でサブ分類を塗り分けられます。サブ分類の色分けを行う場合は、本プロダクト共通の凡例にサブ分類の名称と対応する色を定義し、「凡例と可読性」の方針で参照します。
|
|
255
|
-
- サブ分類の色分けは、業務上の判断(変更頻度、更新契機、参照される側か更新される側かなど)で区別できる場合にだけ使います。区別基準を説明できないサブ分類の塗り分けはしません。
|
|
256
|
-
- 色を使わなくても意味が読み取れる図では、無理に色を付けません。
|
|
180
|
+
- 形状で意味を読めれば色は不要です。色を付ける場合は `classes` と `class` に限り、ノード単位の `style` 指定はしません。
|
|
181
|
+
- プロセス/イベント/データストア/外部主体ごとに色相を統一し、大分類間で混同しません。
|
|
182
|
+
- 大分類内は、変更頻度・更新契機・参照側/更新側などの業務上の区別を説明できる場合だけ、同系統色の濃淡・彩度で分けられます。サブ分類名と色は共通凡例に定義します。
|
|
257
183
|
|
|
258
184
|
```d2
|
|
259
185
|
direction: down
|
|
@@ -353,7 +279,7 @@ sales_ledger: "販売記録簿" {
|
|
|
353
279
|
}
|
|
354
280
|
```
|
|
355
281
|
|
|
356
|
-
|
|
282
|
+
この例の凡例では形状に加え、薄い緑(`#e8f5e9` / `#43a047`)をマスタ・構成データ、中間の緑(`#c8e6c9` / `#2e7d32`)をトランザクションデータ、同色の大角丸四角形を物理保管と定義します。
|
|
357
283
|
|
|
358
284
|
## 7. 禁止事項
|
|
359
285
|
|
|
@@ -361,7 +287,6 @@ sales_ledger: "販売記録簿" {
|
|
|
361
287
|
- プロセスとデータストア、イベントと外部主体など、異なる概念へ同じノード形状を使用しません。
|
|
362
288
|
- 全体概要にプロセスグループ内の領域や処理を複数ノードで展開したり、プロセスグループをコンテナで表したり、プロセスグループ別 CDFD に他グループの内部処理を作り込んだりしません。
|
|
363
289
|
- 物理テーブル、物理カラム、実装クラス、関数、詳細 API、コマンドオプションをノードやエッジへ記載しません。
|
|
364
|
-
-
|
|
365
|
-
- 大分類間で色相を混同する、または区別基準を説明できないままサブ分類の色を増やすことはしません。
|
|
290
|
+
- 独自形状、根拠のないノード単位の色付け、大分類間での色相の混同、区別基準のないサブ分類を追加しません。スタイルは「見栄えを整える最小限スタイル」に従います。
|
|
366
291
|
- 起点も到達先も説明できないノード、自己ループだけで完結するプロセス、読み手が解釈できない略語を残しません。
|
|
367
292
|
- 外部ファイルのインポート(import)、および layers・scenarios・steps による複数ページ出力を使いません(1 ブロック 1 SVG 出力の描画仕様に従います)。
|