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,279 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:ccd-mermaid-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: undecided
|
|
8
|
+
sample: specdojo:ccd-sample
|
|
9
|
+
template: undecided
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Mermaid を用いた概念クラス図(CCD)作成ルール
|
|
15
|
+
|
|
16
|
+
Conceptual Class Diagram (CCD) Rules using Mermaid
|
|
17
|
+
|
|
18
|
+
本ドキュメントは、業務分析・要求定義のために **概念クラ図を Mermaid の `classDiagram` で記述する標準ルール**です。
|
|
19
|
+
実装とは切り離し、概念(エンティティ)とその関係を簡潔に表すことを目的とします。
|
|
20
|
+
|
|
21
|
+
## 1. 全体方針
|
|
22
|
+
|
|
23
|
+
- Mermaid の **`classDiagram` 構文**を利用する。
|
|
24
|
+
- あくまで「概念レベル」のモデルであり、**実装に関わる要素(可視性、型、制御構文など)は書かない**。
|
|
25
|
+
- エンティティ(概念)、属性(概念データ)、キー(主キー)、関係の種類と意味を最小限で表す。
|
|
26
|
+
- 業務理解・要求定義・用語統一に役立つ表記を優先する。
|
|
27
|
+
|
|
28
|
+
## 2. クラス(エンティティ)のルール
|
|
29
|
+
|
|
30
|
+
- `class クラス名 { ... }` を用いる。
|
|
31
|
+
- **クラス名は日本語の単数形**を基本とする。
|
|
32
|
+
- 属性は改行で列挙する。
|
|
33
|
+
- 型・可視性(+ - #)・セミコロンなどは書かない。
|
|
34
|
+
|
|
35
|
+
### 例
|
|
36
|
+
|
|
37
|
+
```mermaid
|
|
38
|
+
classDiagram
|
|
39
|
+
class 商品 {
|
|
40
|
+
商品ID: PK
|
|
41
|
+
商品名
|
|
42
|
+
価格
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## 3. 属性のルール
|
|
47
|
+
|
|
48
|
+
- 属性は **名前のみ記述する**(型は記述しない)。
|
|
49
|
+
- 可視性(+ - #)は記述しない。
|
|
50
|
+
- 属性の順序は自由だが、キーは先頭に置くことを推奨。
|
|
51
|
+
- 外部キー項目は属性としてではなく、クラス間の関連(--> や --)で表す。
|
|
52
|
+
|
|
53
|
+
## 4. キー(主キー)のルール
|
|
54
|
+
|
|
55
|
+
- 主キーは **`: PK`** を属性名の直後に記述する。
|
|
56
|
+
- 複合キーは複数行で記述可能。
|
|
57
|
+
|
|
58
|
+
### 複合キーの記述例
|
|
59
|
+
|
|
60
|
+
```mermaid
|
|
61
|
+
classDiagram
|
|
62
|
+
class 売上明細 {
|
|
63
|
+
伝票番号: PK
|
|
64
|
+
行番号: PK
|
|
65
|
+
商品ID
|
|
66
|
+
数量
|
|
67
|
+
金額
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## 5. メソッドの扱い
|
|
72
|
+
|
|
73
|
+
- **概念クラス図ではメソッドは原則記載しない。**
|
|
74
|
+
- 業務上どうしても必要な概念的操作のみ例外的に記述可(推奨はしない)。
|
|
75
|
+
|
|
76
|
+
## 6. 関係(リレーション)のルール
|
|
77
|
+
|
|
78
|
+
概念モデルとして扱う関係は以下の 3 種類に限定する。
|
|
79
|
+
|
|
80
|
+
### 6.1 関係の種類と意味
|
|
81
|
+
|
|
82
|
+
| 関係の種類 | 別名(Alias) | 意味・役割 | 特徴(概念モデルとして) | 例 |
|
|
83
|
+
| ---------- | -------------------------- | -------------------------------------------------------- | ------------------------------------ | ------------- |
|
|
84
|
+
| 継承関係 | is-a(一般化) | 上位概念を継承し、下位概念は特殊化された種類を表す | 共通属性を上位にまとめ階層構造を作る | 商品 → お菓子 |
|
|
85
|
+
| 親子関係 | parent-child(所有・構造) | 親が子を束ねる「構造上のまとまり」を表す | 子は親と一体的/単独では意味が薄い | 伝票 → 明細 |
|
|
86
|
+
| 参照関係 | reference(関連) | ゆるやかに関連する概念同士のつながりで、参照・依存を示す | 双方向・単方向どちらも可 | 明細 → 商品 |
|
|
87
|
+
|
|
88
|
+
### 6.2. 関係ラベル推奨語彙
|
|
89
|
+
|
|
90
|
+
| カテゴリ | 推奨ラベル例 |
|
|
91
|
+
| -------- | ------------------------------------------------------ |
|
|
92
|
+
| 継承 | 種類 / 分類 / 区分 |
|
|
93
|
+
| 親子 | 構成する / 保有する / 含む / 明細 / 行 / 履歴 |
|
|
94
|
+
| 参照 | 参照する / 対象 / 元伝票 / 請求先 / 商品 / 起点 / 出典 |
|
|
95
|
+
|
|
96
|
+
禁止: 抽象的過ぎる「関係」「リンク」「関連」。
|
|
97
|
+
|
|
98
|
+
### 6.3 Mermaid における書き方
|
|
99
|
+
|
|
100
|
+
| 関係 | Mermaid 記法 | 説明 |
|
|
101
|
+
| -------- | ------------- | ----------------------- |
|
|
102
|
+
| 継承関係 | `子 <\|-- 親` | is-a(一般化・特化) |
|
|
103
|
+
| 親子関係 | `親 *-- 子` | 所有・構造(part-of) |
|
|
104
|
+
| 参照関係 | `A --> B` | ゆるい関連(reference) |
|
|
105
|
+
|
|
106
|
+
### 6.4 接続線に「意味(役割名)」を必ず記述する
|
|
107
|
+
|
|
108
|
+
- 全ての関係線に **`: 関係の意味(役割名)` を付与することを推奨(必須)**
|
|
109
|
+
- 関係の意味は短く明確にする(例:`参照する`、`構成する`、`種類`)
|
|
110
|
+
|
|
111
|
+
### 6.5 多重度(Multiplicity)のルール
|
|
112
|
+
|
|
113
|
+
多重度は、Mermaid の以下の位置に記述する(原則必須):
|
|
114
|
+
|
|
115
|
+
```plaintext
|
|
116
|
+
A "多重度A" --> "多重度B" B : 関係名
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
#### 基本表記の例
|
|
120
|
+
|
|
121
|
+
| 意味 | 多重度 | 説明 |
|
|
122
|
+
| ------------- | --------------------- | -------------------------- |
|
|
123
|
+
| 1件のみ | `"1"` | 常に1つ |
|
|
124
|
+
| 0または1 | `"0..1"` | 任意、存在しない場合もある |
|
|
125
|
+
| 複数(1以上) | `"1..*"` | 最低1つは存在 |
|
|
126
|
+
| 複数(0以上) | `"0..*"` または `"*"` | 数の制約なし |
|
|
127
|
+
|
|
128
|
+
#### 記述例(親子)
|
|
129
|
+
|
|
130
|
+
```plaintext
|
|
131
|
+
売上記録 "1" *-- "0..*" 販売明細 : 構成する
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
#### 記述例(参照)
|
|
135
|
+
|
|
136
|
+
```plaintext
|
|
137
|
+
販売明細 "*" --> "1" 商品 : 商品を参照
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
#### 例
|
|
141
|
+
|
|
142
|
+
```mermaid
|
|
143
|
+
classDiagram
|
|
144
|
+
direction LR
|
|
145
|
+
商品 <|-- お菓子 : 種類
|
|
146
|
+
伝票 *-- 明細 : 構成する
|
|
147
|
+
明細 --> 商品 : 商品を参照
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## 7. 命名・表記ルール
|
|
151
|
+
|
|
152
|
+
- **クラス名・属性名は日本語の単数形**で書く。
|
|
153
|
+
- 関係名(役割名)は **短く・直感的な日本語**で書く。
|
|
154
|
+
- ラベルは以下のように「名詞句」または「短い動詞句」を使う:
|
|
155
|
+
|
|
156
|
+
| 関係種別 | 例(推奨ラベル) |
|
|
157
|
+
| -------- | ---------------------------------------------- |
|
|
158
|
+
| 継承 | `種類` `分類` `区分` |
|
|
159
|
+
| 親子 | `構成する` `保有する` `含む` |
|
|
160
|
+
| 参照 | `参照する` `対象商品` `起点` `元伝票` `請求先` |
|
|
161
|
+
|
|
162
|
+
### 多言語(英語)命名の方針
|
|
163
|
+
|
|
164
|
+
原則は日本語単数形。英語併用を行う場合は以下のいずれかに揃える。
|
|
165
|
+
|
|
166
|
+
- ドメイン固有語の国際化が必要:英語 CamelCase に統一(例: `Invoice`, `LineItem`)
|
|
167
|
+
- 日本語と英語の混在禁止:同一図内ではどちらか一方に統一。
|
|
168
|
+
- 用語集に英語欄がある場合は、その翻訳を優先。図中は日本語、ドキュメント本文で英語対応を示す。
|
|
169
|
+
|
|
170
|
+
避けるべき混在:`商品` と `Invoice` のようなランダム混在。用途別に図を分割するか名称を統一する。
|
|
171
|
+
|
|
172
|
+
## 8. 関係選択の判断基準
|
|
173
|
+
|
|
174
|
+
| 判断項目 | 親子(\*--)を使う条件 | 参照(-->)で十分な条件 | 継承(<\|--)を使う条件 |
|
|
175
|
+
| -------------- | -------------------------- | ---------------------------- | ---------------------------------- |
|
|
176
|
+
| ライフサイクル | 親と同時に生成・削除される | 独立して生成/削除される | 下位概念が上位の性質を恒常的に持つ |
|
|
177
|
+
| 意味の自立性 | 子単独では意味が弱い | 子単独でも意味が成立する | 「種類」「分類」による階層自然発生 |
|
|
178
|
+
| 複数親の可能性 | ほぼ無い | あり得る / 複数参照 | 下位は単一上位を持つ |
|
|
179
|
+
| 再利用性 | 子は親に密結合 | 子は他コンテキストでも再利用 | 共通属性を上位へ抽象化 |
|
|
180
|
+
| 変更影響 | 親変更は子へ波及 | 親変更影響は限定的 | 上位変更は全下位へ波及 |
|
|
181
|
+
|
|
182
|
+
ガイド:
|
|
183
|
+
|
|
184
|
+
- 迷ったらまず「参照(-->)」でモデル化 → 後続レビューで親子/継承へ昇格させる。
|
|
185
|
+
- 継承は濫用しない(2階層程度を推奨)。属性共通率が低いなら参照で表現。
|
|
186
|
+
|
|
187
|
+
## 9. 継承適用ガイドライン
|
|
188
|
+
|
|
189
|
+
継承(一般化/特化)を使うべき典型条件:
|
|
190
|
+
|
|
191
|
+
1. 下位概念群で 60% 以上の属性が共通。
|
|
192
|
+
2. 将来的に下位種類が増加する見込みが高い。
|
|
193
|
+
3. 上位概念が「分類語(種別、タイプ、カテゴリ)」として自然言語上認知されている。
|
|
194
|
+
4. ビジネスルールが上位で一括説明でき、下位差分だけが重要。
|
|
195
|
+
|
|
196
|
+
避けるべきケース:
|
|
197
|
+
|
|
198
|
+
- 単一の特殊概念しか存在しない(下位が1種類のみ)
|
|
199
|
+
- 共通属性が2~3個程度しかなく、抽象化が冗長になる場合
|
|
200
|
+
- 実装都合(ORM最適化等)だけが理由
|
|
201
|
+
|
|
202
|
+
## 10. 禁止事項
|
|
203
|
+
|
|
204
|
+
次の記述は概念モデルルールに反するため禁止:
|
|
205
|
+
|
|
206
|
+
- 型・可視性(public / private / `+` `-` `#`)
|
|
207
|
+
- メソッド定義(`calculateTotal()` 等)
|
|
208
|
+
- テーブル設計専用のカラム(`created_at` など技術的属性)を概念に含めること
|
|
209
|
+
- DTO/API リクエスト構造そのもののクラス化
|
|
210
|
+
- 英語と日本語のランダム混在
|
|
211
|
+
- 過剰な階層継承(3階層以上)
|
|
212
|
+
- 関係線ラベル未記載、または曖昧語(「関連」「関係」)のみ
|
|
213
|
+
|
|
214
|
+
## 11. サンプル
|
|
215
|
+
|
|
216
|
+
```mermaid
|
|
217
|
+
classDiagram
|
|
218
|
+
direction LR
|
|
219
|
+
|
|
220
|
+
class 伝票 {
|
|
221
|
+
伝票番号: PK
|
|
222
|
+
日付
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
class 明細 {
|
|
226
|
+
行番号: PK
|
|
227
|
+
数量
|
|
228
|
+
小計
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
class 商品 {
|
|
232
|
+
商品ID: PK
|
|
233
|
+
商品名
|
|
234
|
+
価格
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
伝票 "1" *-- "0..*" 明細 : 構成する
|
|
238
|
+
明細 "*" --> "1" 商品 : 商品を参照
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
## 12. 凡例
|
|
242
|
+
|
|
243
|
+
```mermaid
|
|
244
|
+
classDiagram
|
|
245
|
+
|
|
246
|
+
class 上位分類 {
|
|
247
|
+
ID: PK
|
|
248
|
+
名称
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
class 下位分類 {
|
|
252
|
+
ID: PK
|
|
253
|
+
名称
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
class 親 {
|
|
257
|
+
親ID: PK
|
|
258
|
+
親名称
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
class 子 {
|
|
262
|
+
子ID: PK
|
|
263
|
+
子名称
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
class A {
|
|
267
|
+
AID: PK
|
|
268
|
+
属性1
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
class B {
|
|
272
|
+
BID: PK
|
|
273
|
+
属性2
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
上位分類 <|-- 下位分類 : 継承(一般化)
|
|
277
|
+
親 "1" *-- "0..*" 子 : 所有(構造)
|
|
278
|
+
A "*" --> "1" B : 参照(関連)
|
|
279
|
+
```
|
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdfd-mermaid-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: not-needed
|
|
9
|
+
template: not-needed
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Mermaid を用いた概念データフロー図 作成ルール
|
|
15
|
+
|
|
16
|
+
Conceptual Data Flow Diagram Notation Rulebook for Mermaid
|
|
17
|
+
|
|
18
|
+
Mermaid の `flowchart` 構文で CDFD のプロセス、イベント、データストア、外部主体、情報・物の流れを一貫して表すための記法ルールです。`specdojo:cdfd-overview-rulebook`、`specdojo:cdfd-rulebook`、`specdojo:cdfd-uc-rulebook` の `includes` から適用される共通部品です。対象プロダクトの `cdfd-overview` に「凡例(本プロダクト共通)」がある場合はその割り当てを正本とし、共通凡例がない場合は本 rulebook の形状・線種と既定の色・絵文字方針に従います。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
- Mermaid の `flowchart` を使用し、方向は全体概要・プロセスグループ別・ユースケース別 CDFD を問わず `LR` を基本とします。CDFD の矢印は情報・物・実行要求の受け渡しを表し、ユースケース別など包含元が明示した場合だけ業務上の順序も表します。`TB` は、対象が階層構造(組織・分類など)を表す場合にだけ使用します。以下では、プロセスグループ別とユースケース別を合わせて「詳細 CDFD」と呼びます。
|
|
23
|
+
|
|
24
|
+
- 図が読みにくくなる原因は方向ではなく規模です。ノード数が多く一画面で関係を追いにくい場合は、方向を変えるのではなく、「凡例と可読性」の分割方針に従って図を分けます。分割の観点(全体概要はデータストアの区分、プロセスグループ別 CDFD は業務の性質が近いプロセス)とノード数の目安は包含元の rulebook が定めます。
|
|
25
|
+
- 全体概要とユースケース別 CDFD では、一つのプロセスグループを一つの代表ノードで表し、グループ内の領域や処理へ展開しません。プロセスグループ別 CDFD では、一つのプロセスを一つのプロセスノードで表します。
|
|
26
|
+
- 一つの記号へ一つの意味を割り当て、ノード形状だけでプロセス、イベント、データストア、外部主体を区別できるようにします。
|
|
27
|
+
|
|
28
|
+
- 情報の流れと物の流れは線種で区別し、すべてのエッジへ内容を表す名詞形のラベルを付けます。
|
|
29
|
+
- 図の目的は業務上の合意であり、装飾や実装構造の再現ではありません。ノード形状で意味を区別することを基本とし、色は形状だけでは判別しにくい場合の視認性向上に、プロセス/イベント/データストア/外部主体という概念の大分類単位で付けます。業務上の区別が必要な場合は、大分類内を同系統色の濃淡・彩度で分けられます。物理名、詳細な操作は使用しません。
|
|
30
|
+
|
|
31
|
+
| 概念 | Mermaid 表現 | 表示例 |
|
|
32
|
+
| -------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------ |
|
|
33
|
+
| プロセス | 角丸長方形 `("...")` | `販売記録("P-01-01 販売記録<br>(担当: 店員)")` |
|
|
34
|
+
| プロセスグループ | 角丸長方形 `("...")`(全体概要・ユースケース別 CDFD の代表ノード) | `販売("販売<br>P-01〜P-02")` |
|
|
35
|
+
| サブグラフ | `subgraph ... end`(関連プロセスを囲む視覚上のまとまり。グループの表現には使わない) | `subgraph 販売領域["販売領域"]` |
|
|
36
|
+
| データストア | 円柱 `[(...)]` | `販売記録簿[("販売記録簿")]` |
|
|
37
|
+
| 物理保管 | スタジアム形 `(["..."])`(現物の保管先。データストアと同系統色を使う) | `売場棚(["売場棚"])` |
|
|
38
|
+
| 外部主体 | 四角 `[...]` | `顧客["顧客"]` |
|
|
39
|
+
| イベント | 六角形 `{{...}}` | `購入要求{{"顧客が商品の購入を要求した"}}` |
|
|
40
|
+
| 情報・実行要求の流れ | ラベル付き `-->\|"..."\|` | `販売記録 -->\|"販売情報"\| 販売記録簿` |
|
|
41
|
+
| 物の流れ | ラベル付き `==>\|"..."\|` | `売場棚 ==>\|"商品"\| 販売記録` |
|
|
42
|
+
|
|
43
|
+
## 2. 位置づけと用語定義
|
|
44
|
+
|
|
45
|
+
| 用語 | 定義 |
|
|
46
|
+
| ------------ | -------------------------------------------------------------------------- |
|
|
47
|
+
| ノード ID | Mermaid コード内で要素を参照する識別子。短い日本語または英数字を使う |
|
|
48
|
+
| 表示ラベル | 図上で読み手に見せる名称。業務用語と領域 ID を必要に応じて併記する |
|
|
49
|
+
| エッジラベル | 移動する情報・物、またはイベントから伝わる起動条件の名称 |
|
|
50
|
+
| サブグラフ | 関連するプロセスを囲む視覚上のまとまり。プロセスグループの表現には使わない |
|
|
51
|
+
|
|
52
|
+
- ノード ID と表示ラベルは同じ名称を基本とし、空白、記号、補足を含む表示が必要な場合だけ分けます。
|
|
53
|
+
- 担当を表示する場合は、プロセスの表示ラベル末尾へ `<br>(担当: ロール)` を付けます。
|
|
54
|
+
- イベントは「〜された」「〜が到来した」「〜を要求した」など、発生を判断できる短い文にします。
|
|
55
|
+
|
|
56
|
+
## 3. ファイル命名・ID規則
|
|
57
|
+
|
|
58
|
+
- 本 rulebook は独立した成果物を生成せず、`cdfd-*.md` 内の Mermaid コードブロックへ適用します。
|
|
59
|
+
- Mermaid コードブロックに独立した文書 ID は付けず、包含する CDFD の ID とプロセス ID で追跡します。
|
|
60
|
+
- ノード ID は一つのコードブロック内で一意にし、同じ対象には表と図で同じ領域 ID または名称を使用します。
|
|
61
|
+
- 複数図に分ける場合は、包含する CDFD 本文の見出しで図の観点を識別します。
|
|
62
|
+
|
|
63
|
+
## 4. 推奨 Frontmatter 項目
|
|
64
|
+
|
|
65
|
+
- 本 rulebook は `specdojo:cdfd-overview-rulebook`、`specdojo:cdfd-rulebook`、`specdojo:cdfd-uc-rulebook` の `includes` から適用されるため、成果物 Frontmatter に記法 rulebook を重複記載しません。
|
|
66
|
+
- 成果物の `rulebook` は、図種別に応じて構造を定義する上記いずれかの主 CDFD rulebook を指定します。例えばプロセスグループ別 CDFD は `rulebook: specdojo:cdfd-rulebook` とします。
|
|
67
|
+
- 記法だけを別ファイルで適用する運用は行わず、主 CDFD rulebook と組み合わせます。
|
|
68
|
+
|
|
69
|
+
プロセスグループ別 CDFD の記載例:
|
|
70
|
+
|
|
71
|
+
```yaml
|
|
72
|
+
specdojo:
|
|
73
|
+
id: cdfd-purchasing
|
|
74
|
+
type: flow
|
|
75
|
+
status: draft
|
|
76
|
+
rulebook: specdojo:cdfd-rulebook
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## 5. 本文構成(標準テンプレ)
|
|
80
|
+
|
|
81
|
+
Mermaid コードブロック内は、次の順序を基本とします。必須の判定は図種別で異なります。全体概要ではプロセスグループの代表ノード、データストア、情報の流れを必須とし、イベントはプロセス領域の表に記載して図に描きません。プロセスグループ別 CDFD では個別プロセス、イベント、データストア、情報・物の流れを必須とします。ユースケース別 CDFD ではプロセスグループの代表ノード、開始・引き渡し・終了のイベント、情報・物の流れを必須とし、データストアは引き渡し条件の判定に必要な場合だけ置きます。外部主体と物理保管はいずれの図種別でも存在する場合だけ置きます。全図で図直後の注記を必須とし、共通凡例の有無に応じて参照先または本 rulebook の既定凡例を使う旨を示します。
|
|
82
|
+
|
|
83
|
+
| 順序 | 区分 | 必須 | 内容 |
|
|
84
|
+
| ---- | -------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
|
85
|
+
| 1 | flowchart 宣言 | ○ | `flowchart LR` または `flowchart TB` |
|
|
86
|
+
| 2 | プロセスノード | ○ | 全体概要・ユースケース別はグループ代表ノード、プロセスグループ別は個々のプロセス |
|
|
87
|
+
| 3 | イベント | 条件付き | プロセスグループ別では開始契機、ユースケース別では開始・引き渡し・終了条件。全体概要では描かない |
|
|
88
|
+
| 4 | 外部主体 | 任意 | 対象範囲外の入力元・出力先 |
|
|
89
|
+
| 5 | データストア | 条件付き | 読み書きする主要な情報の保管先。ユースケース別では引き渡し条件の判定に必要なものだけ置く |
|
|
90
|
+
| 6 | 物理保管 | 条件付き | 現物の保管先が情報・物の受け渡しまたは境界の理解に必要な場合だけ置く |
|
|
91
|
+
| 7 | 情報・物の流れ | ○ | ラベル付きエッジ |
|
|
92
|
+
| 8 | 図直後の注記 | ○ | 共通凡例がある場合はその参照、ない場合は本 rulebook の既定凡例に従う旨、使用線種、省略事項、共有ノード |
|
|
93
|
+
|
|
94
|
+
## 6. 記述ガイド
|
|
95
|
+
|
|
96
|
+
### 6.1. ノード
|
|
97
|
+
|
|
98
|
+
- プロセスは角丸長方形、外部主体は四角、イベントは六角形、データストアは円柱で表します。現物の保管先を図へ置く場合は物理保管としてスタジアム形を使い、プロセス、外部主体、データストアの代替にはしません。
|
|
99
|
+
- プロセス名は「販売記録」「計画展開」のように、何を扱う処理か分かる短い名詞句にします。
|
|
100
|
+
- 全体概要では一プロセスグループを一つの代表ノードとして表し、表示ラベルにグループ名と含む領域 ID の範囲を記載します。グループ内の領域や処理を別ノードとして追加しません。
|
|
101
|
+
- プロセスグループ別 CDFD ではグループ内の主要プロセスを個別ノードにし、全体概要の代表ノードをプロセスとして重複配置しません。
|
|
102
|
+
- ユースケース別 CDFD では参加する各プロセスグループを一つの代表ノードにし、正常系の通過順に配置します。内部プロセスは描かず、引き渡し条件をイベントノードで示します。
|
|
103
|
+
- `subgraph` はプロセスグループ別 CDFD で関連プロセスを視覚的にまとめる場合にだけ使用できます。プロセスグループの表現や代表ノードの代替には使いません。
|
|
104
|
+
|
|
105
|
+
```mermaid
|
|
106
|
+
flowchart LR
|
|
107
|
+
subgraph 販売領域["販売領域"]
|
|
108
|
+
販売記録("P-01-01 販売記録<br>(担当: 店員)")
|
|
109
|
+
end
|
|
110
|
+
購入要求{{"顧客が商品の購入を要求した"}}
|
|
111
|
+
顧客["顧客"]
|
|
112
|
+
販売記録簿[("販売記録簿")]
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### 6.2. 絵文字アイコン(任意)
|
|
116
|
+
|
|
117
|
+
絵文字は人間の視認性向上には有効ですが、表示差や幅崩れが起きる環境もあるため、次のルールで運用します。
|
|
118
|
+
|
|
119
|
+
- 絵文字は任意です(なくても成立します)。
|
|
120
|
+
- 絵文字は表示ラベルのみに付け、ノード ID には付けません。
|
|
121
|
+
- 1ノードにつき1個までとし、表示ラベルの先頭に付けます。
|
|
122
|
+
- 絵文字だけに頼らず、必ずプロセス名・データストア名などのテキストも併記します。
|
|
123
|
+
|
|
124
|
+
```mermaid
|
|
125
|
+
flowchart LR
|
|
126
|
+
subgraph 販売領域["販売領域"]
|
|
127
|
+
販売記録("📋 P-01-01 販売記録<br>(担当: 店員)")
|
|
128
|
+
end
|
|
129
|
+
購入要求{{"⚡ 顧客が商品の購入を要求した"}}
|
|
130
|
+
顧客["🏢 顧客"]
|
|
131
|
+
販売記録簿[("🗄️ 販売記録簿")]
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
禁止例(絵文字がノード ID に付いている、または表示ラベルに無い):
|
|
135
|
+
|
|
136
|
+
```text
|
|
137
|
+
flowchart LR
|
|
138
|
+
📋販売記録("販売記録")
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 6.3. エッジ
|
|
142
|
+
|
|
143
|
+
- 情報は `-->`、物は `==>` を使用します。イベントからプロセスへのエッジも `-->|"起動条件"|` のようにラベルを付けます。
|
|
144
|
+
- エッジラベルは「販売情報」「在庫数量」「実行結果」のような名詞形にし、「処理する」など動作だけの語を使用しません。
|
|
145
|
+
- 一つのエッジに異なる責務の情報を詰め込まず、受け手が別ならエッジを分けます。
|
|
146
|
+
|
|
147
|
+
```mermaid
|
|
148
|
+
flowchart LR
|
|
149
|
+
顧客["顧客"] -->|"購入依頼"| 購入要求{{"顧客が商品の購入を要求した"}}
|
|
150
|
+
購入要求 -->|"販売開始条件"| 販売記録("P-01-01 販売記録")
|
|
151
|
+
販売記録 -->|"販売情報"| 販売記録簿[("販売記録簿")]
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### 6.4. 凡例と可読性
|
|
155
|
+
|
|
156
|
+
- 各図の直後に凡例の適用元を注記します。対象プロダクトの `cdfd-overview` に「凡例(本プロダクト共通)」がある場合はその章を参照し、ない場合は「ノード形状・線種・色・絵文字は `specdojo:cdfd-mermaid-rulebook` の既定凡例に従う」と記述します。いずれの場合も、図で使用した線種、図から省略した入出力と理由、別図と共有するノードを併記します。
|
|
157
|
+
- 共通凡例がある場合、ノード形状、色、絵文字のプロダクト固有の割り当ては共通凡例を正本とし、図ごとに再掲しません。共通凡例にない割り当ては使用しません。共通凡例がない場合は、本 rulebook の対応表と「見栄えを整える最小限スタイル」を既定凡例とし、図ごとの独自割り当てを追加しません。
|
|
158
|
+
- 物の流れを使わない場合は「`-->` は情報・実行要求の流れ。本図は物の流れを対象外とする」と記述します。
|
|
159
|
+
|
|
160
|
+
- 図を分ける観点とノード数の目安は包含元の rulebook に従います(全体概要はトランザクションデータの図とマスタ・構成データの図、プロセスグループ別 CDFD は業務の性質が近いプロセス単位、ユースケース別 CDFD は連続する引き渡し単位)。分けた図の間で同じプロセス ID・名称または引き渡し ID を維持します。
|
|
161
|
+
- ノードの表示ラベルは1行あたり全角20字(半角40字)程度を目安にし、超える場合は `<br>` で改行して2行程度に収めます。LR ではラベルの行の長さがそのままノード幅となり横方向の占有幅に直結するため、特にイベント・データストアで長い説明文になりやすい箇所に注意します。エッジラベルは改行に頼らず短い名詞句に収めます。
|
|
162
|
+
|
|
163
|
+
### 6.5. 見栄えを整える最小限スタイル(任意)
|
|
164
|
+
|
|
165
|
+
- ノード形状による意味区別を優先し、色は形状だけでは見分けにくい場合の補助として使います。
|
|
166
|
+
- 色を付ける場合は `classDef` のみを使用し、`style` によるノード単位の個別指定はしません。
|
|
167
|
+
|
|
168
|
+
- 色は必ずプロセス/イベント/データストア/外部主体という概念の大分類単位で色相(Hue)を統一し、異なる大分類の間で色相を混同しません。
|
|
169
|
+
- 大分類の中に業務上意味のあるサブ分類がある場合(例: データストアにおけるマスタ・構成データとトランザクションデータの違い)は、大分類の色相を保ったまま、濃淡・彩度を変えた同系統色でサブ分類を塗り分けられます。サブ分類の色分けを行う場合は、本プロダクト共通の凡例にサブ分類の名称と対応する色を定義し、「凡例と可読性」の方針で参照します。
|
|
170
|
+
- サブ分類の色分けは、業務上の判断(変更頻度、更新契機、参照される側か更新される側かなど)で区別できる場合にだけ使います。区別基準を説明できないサブ分類の塗り分けはしません。
|
|
171
|
+
- 色を使わなくても意味が読み取れる図では、無理に色を付けません。
|
|
172
|
+
|
|
173
|
+
```mermaid
|
|
174
|
+
flowchart LR
|
|
175
|
+
classDef process fill:#e3f2fd,stroke:#1e88e5,color:#000
|
|
176
|
+
classDef event fill:#fff3e0,stroke:#fb8c00,color:#000
|
|
177
|
+
classDef store fill:#e8f5e9,stroke:#43a047,color:#000
|
|
178
|
+
classDef actor fill:#f5f7fa,stroke:#607d8b,color:#000
|
|
179
|
+
|
|
180
|
+
顧客["顧客"]
|
|
181
|
+
購入要求{{"顧客が商品の購入を要求した"}}
|
|
182
|
+
販売記録("P-01-01 販売記録<br>(担当: 店員)")
|
|
183
|
+
販売記録簿[("販売記録簿")]
|
|
184
|
+
|
|
185
|
+
顧客 -->|"購入依頼"| 購入要求
|
|
186
|
+
購入要求 -->|"販売開始条件"| 販売記録
|
|
187
|
+
販売記録 -->|"販売情報"| 販売記録簿
|
|
188
|
+
|
|
189
|
+
class 顧客 actor
|
|
190
|
+
class 購入要求 event
|
|
191
|
+
class 販売記録 process
|
|
192
|
+
class 販売記録簿 store
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
大分類「データストア」の中でマスタ・構成データとトランザクションデータを同系統色(緑系の濃淡)で塗り分ける例:
|
|
196
|
+
|
|
197
|
+
```mermaid
|
|
198
|
+
flowchart LR
|
|
199
|
+
classDef storeMaster fill:#a5d6a7,stroke:#1b5e20,color:#000
|
|
200
|
+
classDef storeTransaction fill:#e8f5e9,stroke:#43a047,color:#000
|
|
201
|
+
|
|
202
|
+
商品マスタ[("商品マスタ")]
|
|
203
|
+
販売記録簿[("販売記録簿")]
|
|
204
|
+
|
|
205
|
+
class 商品マスタ storeMaster
|
|
206
|
+
class 販売記録簿 storeTransaction
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
凡例には「円柱(濃い緑)はマスタ・構成データ、円柱(薄い緑)はトランザクションデータ」のように、大分類の形状の意味に加えてサブ分類の色の意味を明記します。
|
|
210
|
+
|
|
211
|
+
## 7. 禁止事項
|
|
212
|
+
|
|
213
|
+
- ラベルのないエッジ、同じ線種へ情報と物の両方の意味を持たせたエッジを記載しません。
|
|
214
|
+
- プロセスとデータストア、イベントと外部主体など、異なる概念へ同じノード形状を使用しません。
|
|
215
|
+
- 全体概要にプロセスグループ内の領域や処理を複数ノードで展開したり、プロセスグループを `subgraph` で表したり、プロセスグループ別 CDFD に他グループの内部処理を作り込んだりしません。
|
|
216
|
+
- 物理テーブル、物理カラム、実装クラス、関数、詳細 API、コマンドオプションをノードやエッジへ記載しません。
|
|
217
|
+
- 独自形状の追加、根拠のないノード単位の色付け、`style` による個別指定は行いません。色は概念の大分類単位、または大分類内の同系統色によるサブ分類単位の `classDef` としてのみ使用します。
|
|
218
|
+
- 大分類間で色相を混同する、または区別基準を説明できないままサブ分類の色を増やすことはしません。
|
|
219
|
+
- 起点も到達先も説明できないノード、自己ループだけで完結するプロセス、読み手が解釈できない略語を残しません。
|