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,293 +3,123 @@ specdojo:
|
|
|
3
3
|
id: specdojo:cpd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: architecture
|
|
6
|
-
status:
|
|
7
|
-
|
|
6
|
+
status: ready
|
|
7
|
+
target_format: markdown
|
|
8
|
+
includes:
|
|
9
|
+
- specdojo:cpd-mermaid-rulebook
|
|
10
|
+
recipe: specdojo:cpd-recipe
|
|
8
11
|
sample: specdojo:cpd-sample
|
|
9
|
-
template:
|
|
12
|
+
template: specdojo:cpd-template
|
|
13
|
+
based_on:
|
|
14
|
+
- specdojo:rulebook-authoring-standard
|
|
10
15
|
---
|
|
11
16
|
|
|
12
|
-
# C4
|
|
17
|
+
# C4コンポーネント図(CPD)作成ルール
|
|
13
18
|
|
|
14
|
-
C4 Component Diagram (CPD)
|
|
19
|
+
C4 Component Diagram (CPD) Authoring Rule
|
|
15
20
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
この章の成果物は、次の2つをセットで扱います。
|
|
19
|
-
|
|
20
|
-
- **C4コンポーネント図(Mermaid)**: 対象コンテナ(実行/配備単位)の内部を主要コンポーネント(責務のまとまり)に分解し、外部要素との関係を俯瞰で合意する
|
|
21
|
-
- **説明(Markdown)**: 図の要素(人/境界/コンポーネント/DB/外部/関係)の意味を文章で合意する
|
|
22
|
-
|
|
23
|
-
Mermaid 記法そのもののルールは [cpd-mermaid-rulebook.md](cpd-mermaid-rulebook.md) を参照してください。
|
|
21
|
+
一つのコンテナ内部を主要な責務へ分け、依存方向と境界で受け渡す情報を定義する規約です。実装配置と結合テストの設計入力を扱い、クラス構造や連携構文は各詳細仕様へ委ねます。
|
|
24
22
|
|
|
25
23
|
## 1. 全体方針
|
|
26
24
|
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
|
|
32
|
-
## 2. ファイル命名・ID規則
|
|
33
|
-
|
|
34
|
-
- ファイル名: `cpd-<番号>-<短い日本語名>.md`
|
|
35
|
-
- 例: `cpd-010-販売API-コンポーネント.md`
|
|
36
|
-
- Frontmatter:
|
|
37
|
-
- `id`: 小文字ハイフン形式(例: `cpd-sales-api-components`)
|
|
38
|
-
- `title`: 「〇〇のC4コンポーネント図」のように対象が分かる表現
|
|
39
|
-
|
|
40
|
-
## 3. 推奨 Frontmatter 項目
|
|
41
|
-
|
|
42
|
-
Frontmatter の共通ルールは [document-metadata-standard.md](../standards/document-metadata-standard.md) に従います。
|
|
43
|
-
|
|
44
|
-
| 項目 | 説明 | 必須 |
|
|
45
|
-
| ---------- | ---------------------------------------------- | ---- |
|
|
46
|
-
| id | ドキュメントID(小文字ハイフン) | ○ |
|
|
47
|
-
| type | `architecture` 固定 | ○ |
|
|
48
|
-
| title | ドキュメント名 | ○ |
|
|
49
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
50
|
-
| part_of | 上位ドキュメントID(分割している場合) | 任意 |
|
|
51
|
-
| based_on | 根拠となる定義(用語集、外部IF、上位方針など) | 任意 |
|
|
52
|
-
| supersedes | 置き換え関係(古い図→新しい図) | 任意 |
|
|
53
|
-
|
|
54
|
-
### 3.1. `based_on` の考え方(例)
|
|
55
|
-
|
|
56
|
-
- 用語集(`gl-...`)や業務データ辞書(`bdd-...`)
|
|
57
|
-
- 外部システムIFの仕様(IF章のドキュメント)
|
|
58
|
-
- 参照する上位の方針(DEC、非機能要件など)
|
|
59
|
-
- 上位のコンテナ図(CND)の該当ページ
|
|
60
|
-
|
|
61
|
-
## 4. CPDで合意すること(スコープ)
|
|
62
|
-
|
|
63
|
-
### 4.1. 合意したいこと
|
|
64
|
-
|
|
65
|
-
- 対象コンテナ(Container Boundary)と、責務の一言(何をするコンテナか)
|
|
66
|
-
- 主要コンポーネント(Component)の一覧と、それぞれの責務(1〜2文)
|
|
67
|
-
- 主要DB(Database)がある場合、その役割(何を永続化するか)
|
|
68
|
-
- 外部システム(External Software System)と、連携の意図(何をやり取りするか)
|
|
69
|
-
- 関係(Relationship)の向きと意味(誰が主に呼び出す/依存するか)
|
|
70
|
-
|
|
71
|
-
### 4.2. 合意しないこと(この図で扱わない)
|
|
72
|
-
|
|
73
|
-
- クラス設計、内部の関数構成、ソースコード構造の網羅
|
|
74
|
-
- APIエンドポイント、HTTPメソッド、リクエスト/レスポンスJSONなどのIF詳細
|
|
75
|
-
- 物理テーブル名・物理カラム名・SQL全文
|
|
76
|
-
- 画面遷移やクリック手順の逐語列挙
|
|
77
|
-
|
|
78
|
-
## 5. CPDの要素定義(図と文章の両方で説明する)
|
|
79
|
-
|
|
80
|
-
この章では、図に描いた要素について **最低限の説明**を併記し、レビュー可能にします。
|
|
81
|
-
|
|
82
|
-
### 5.1. Person(人/ロール)
|
|
83
|
-
|
|
84
|
-
Personは、対象コンテナに対して目的をもって関わる主体(人/役割/組織)です。
|
|
85
|
-
|
|
86
|
-
- 書くこと(推奨):
|
|
87
|
-
- ロール名(例: 店員、店主、経理担当)
|
|
88
|
-
- どのコンポーネントを、何のために利用するか(例: UI で売上登録を行う)
|
|
89
|
-
- 書かないこと:
|
|
90
|
-
- 個人名、UI操作手順の逐語列挙
|
|
91
|
-
|
|
92
|
-
### 5.2. Container Boundary(対象コンテナ境界)
|
|
93
|
-
|
|
94
|
-
境界は「この図で扱う対象コンテナの範囲」を表します。
|
|
95
|
-
|
|
96
|
-
- 書くこと(推奨):
|
|
97
|
-
- 境界に含めるもの(主要コンポーネント/主要DB等)
|
|
98
|
-
- 境界に含めないもの(外部システム/外部サービス等)
|
|
99
|
-
|
|
100
|
-
### 5.3. Component(コンポーネント)
|
|
101
|
-
|
|
102
|
-
コンポーネントは、責務のまとまり(モジュール/サービス/層など)です。
|
|
25
|
+
- 上位 C4 コンテナ図から対象コンテナを一つ選び、利用者、外部依存、ストアの境界を引き継ぎます。別コンテナを内部コンポーネントへ取り込みません。
|
|
26
|
+
- 分割単位は固有の責務と入出力を持つまとまりです。主要コンポーネントは 5〜15 個程度を目安とし、数合わせやコマンド・ファイル単位の機械的な分割はしません。
|
|
27
|
+
- 図は主要依存、定義表は責務・情報の受け渡し・制約を担います。主要経路を選んだ理由と省略範囲を示し、全関数・全呼び出しの一覧にしません。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
29
|
+
- 記法は `includes` で適用する [[specdojo:cpd-mermaid-rulebook|CPD Mermaid 記法ルール]] を正本とし、形状・色・構文は本書で再定義しません。
|
|
103
30
|
|
|
104
|
-
|
|
105
|
-
- コンポーネント名
|
|
106
|
-
- 責務(1〜2文)
|
|
107
|
-
- 書くこと(推奨):
|
|
108
|
-
- 主な入出力の種類(例: 売上登録、在庫照会)
|
|
109
|
-
- 関係するデータストア(例: 販売DBを更新する)
|
|
110
|
-
- 書かないこと:
|
|
111
|
-
- 内部クラス/関数、パッケージ構成の網羅
|
|
31
|
+
## 2. 位置づけと用語定義
|
|
112
32
|
|
|
113
|
-
|
|
33
|
+
コンテナは上位図が定める実行・配備単位、コンポーネントはその内部の論理的な責務のまとまりです。依存方向は主たる利用・依頼の起点から終点への向きであり、時系列や応答データの向きとは区別します。
|
|
114
34
|
|
|
115
|
-
|
|
35
|
+
上位図は実行単位間の境界、本図は一単位の内部責務を扱います。物理配置、内部クラス、値・構文・データ構造はインフラ設計、実装、リファレンス、schema、外部 IF 仕様を正本とします。
|
|
116
36
|
|
|
117
|
-
|
|
118
|
-
- DBの論理名(例: 販売DB、在庫DB)
|
|
119
|
-
- 何を永続化するか(例: 売上・在庫・仕入の記録)
|
|
120
|
-
- 書かないこと:
|
|
121
|
-
- 物理テーブル名・物理カラム名・SQL
|
|
37
|
+
## 3. ファイル命名・ID規則
|
|
122
38
|
|
|
123
|
-
|
|
39
|
+
- 共通規則は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] と [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
40
|
+
- ファイル名は `cpd-<context>.md` とし、対象コンテナを識別する英小文字・数字・ハイフンの名前を使います。プロダクト文書の配置は原則 `docs/<lang>/product/030-architecture/010-c4/` とします。
|
|
41
|
+
- プロダクト文書の ID は `cpd-<context>`、プロジェクト文書は `<project-id>:cpd-<context>` とし、H1 に対象名と図の種別を示します。
|
|
42
|
+
- 関係には文書内で一意な `REL-01` 形式の ID を付け、図の端点・ラベルと関係表を対応付けます。名称変更だけでは ID を振り直しません。
|
|
124
43
|
|
|
125
|
-
|
|
44
|
+
## 4. 推奨 Frontmatter 項目
|
|
126
45
|
|
|
127
|
-
-
|
|
128
|
-
- 外部システム名(一般名でよい)
|
|
129
|
-
- 連携の目的(例: 決済を依頼する、仕訳を送る)
|
|
130
|
-
- 連携の方向性(誰が主に呼び出す/依存するか)
|
|
131
|
-
- 書かないこと:
|
|
132
|
-
- API仕様の詳細、データ項目一覧(それらはIF仕様へ)
|
|
46
|
+
共通項目の型・値・必須条件は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
133
47
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
- 書くこと(必須):
|
|
139
|
-
- 方向(誰が主に利用/依存/送信するか)
|
|
140
|
-
- ラベル(短い日本語。名詞句または短い動詞句)
|
|
141
|
-
- 書かないこと:
|
|
142
|
-
- HTTP詳細、データ項目列挙、SQL、実装条件式
|
|
143
|
-
|
|
144
|
-
## 6. 本文構成(標準テンプレ)
|
|
145
|
-
|
|
146
|
-
各 CPD 成果物は、以下見出しを順番に並べます。
|
|
147
|
-
|
|
148
|
-
1. 概要
|
|
149
|
-
2. C4コンポーネント図(Mermaid)
|
|
150
|
-
3. 要素の説明
|
|
151
|
-
4. 補足
|
|
152
|
-
|
|
153
|
-
## 7. 記述ガイド詳細
|
|
154
|
-
|
|
155
|
-
### 7.1. 概要
|
|
156
|
-
|
|
157
|
-
- 「この図が何を表すか」「対象コンテナ」「前提」を1〜3文で書きます。
|
|
158
|
-
|
|
159
|
-
### 7.2. C4コンポーネント図(Mermaid)
|
|
160
|
-
|
|
161
|
-
- Mermaid のコードブロックで図を記述します。
|
|
162
|
-
- Mermaid 記法ルールは [cpd-mermaid-rulebook.md](cpd-mermaid-rulebook.md) に従います。
|
|
163
|
-
- 図には、少なくとも以下を含めます。
|
|
164
|
-
- Person(いる場合)
|
|
165
|
-
- 境界(Container Boundary)
|
|
166
|
-
- 主要コンポーネント(5〜15個程度を目安)
|
|
167
|
-
- 主要DB(ある場合)
|
|
168
|
-
- 外部システム(ある場合)
|
|
169
|
-
- 関係(Relationship。全矢印にラベル)
|
|
170
|
-
|
|
171
|
-
### 7.3. 要素の説明
|
|
172
|
-
|
|
173
|
-
- 図に登場する要素を、レビューしやすい粒度で説明します。
|
|
174
|
-
- 推奨スタイル:
|
|
175
|
-
- `###` レベルの小見出しで要素名(境界/人/コンポーネント/DB/外部/関係)
|
|
176
|
-
- 1〜3文で意味・前提・境界条件(含む/含まない)を説明
|
|
177
|
-
|
|
178
|
-
### 7.4. 補足
|
|
179
|
-
|
|
180
|
-
- 未確定な外部連携、境界が揺れている論点、図を分ける必要がありそうな論点を列挙します。
|
|
181
|
-
|
|
182
|
-
## 8. 命名・記述スタイル
|
|
183
|
-
|
|
184
|
-
- 用語はこの図の中で揺らさない(同じ要素を別名で呼ばない)。
|
|
185
|
-
- ラベルは短くし、長い場合は改行(`<br>`)で読みやすくする(詳細はIF仕様へ)。
|
|
186
|
-
- コンポーネント名は「責務が読める短い名前」を優先し、実装都合(ファイル名/クラス名)に寄せすぎない。
|
|
187
|
-
|
|
188
|
-
## 9. 禁止事項
|
|
189
|
-
|
|
190
|
-
次の記述は、CPDの粒度を超えるため避けます。
|
|
191
|
-
|
|
192
|
-
| 項目 | 理由 |
|
|
193
|
-
| --------------------------------------- | -------------------------------- |
|
|
194
|
-
| 物理テーブル名・物理カラム名・SQL全文 | 図の粒度を超える(DB設計に記述) |
|
|
195
|
-
| APIエンドポイント/HTTP/JSON等の詳細 | IF仕様に記述する |
|
|
196
|
-
| 実装クラス/関数名、内部モジュールの網羅 | 変更に弱い・合意の対象がずれる |
|
|
197
|
-
| 画面遷移やクリック手順の逐語列挙 | UI変更に弱い・図の目的から逸脱 |
|
|
198
|
-
| 矢印ラベルなしの関係 | 何の関係か合意できない |
|
|
199
|
-
|
|
200
|
-
## 10. レビュー観点(チェックリスト)
|
|
201
|
-
|
|
202
|
-
- 対象コンテナは1つに絞れているか
|
|
203
|
-
- 境界の内外が説明され、責任分界が曖昧でないか
|
|
204
|
-
- 主要コンポーネントが多すぎず(目安: 5〜15)、過不足なく俯瞰できるか
|
|
205
|
-
- Person/外部システム/DBがある場合、必要十分に含まれているか
|
|
206
|
-
- すべての関係にラベルがあり、意味が解釈一致するか
|
|
207
|
-
- 図が「クラス/実装詳細」や「IF詳細」に踏み込んでいないか
|
|
208
|
-
|
|
209
|
-
## 11. サンプル(簡易)
|
|
210
|
-
|
|
211
|
-
```yaml
|
|
212
|
-
---
|
|
213
|
-
id: cpd-sales-api-components
|
|
214
|
-
type: architecture
|
|
215
|
-
title: 販売APIのC4コンポーネント図
|
|
216
|
-
status: draft
|
|
217
|
-
part_of: []
|
|
218
|
-
based_on: []
|
|
219
|
-
---
|
|
220
|
-
```
|
|
48
|
+
- メタ情報は `specdojo:` 配下に置き、`type` は `architecture`、主 `rulebook` は `specdojo:cpd-rulebook` とします。記法部品を主 rulebook にしません。
|
|
49
|
+
- `based_on` には対象コンテナの根拠となる上位 CND を接続します。適用する外部 IF・用語定義は本文の該当箇所から参照します。
|
|
50
|
+
- 未同梱の上位図を使う学習用例は、架空参照と `based_on` 未接続の理由を概要へ明記します。実案件の依存未接続を、この例外で解決済みにはできません。
|
|
221
51
|
|
|
222
|
-
##
|
|
52
|
+
## 5. 本文要件
|
|
223
53
|
|
|
224
|
-
|
|
54
|
+
見出し順・表の列・記入欄の骨組みは template を正本とし、ここでは意味要件を定めます。
|
|
225
55
|
|
|
226
|
-
|
|
56
|
+
| 章の役割 | 必須 | 満たす内容 |
|
|
57
|
+
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
|
|
58
|
+
| 概要 | 必須 | 上位図の対象コンテナ、業務目的との対応、分割の目的、利用する設計判断、対象外、確定度 |
|
|
59
|
+
| 構成図 | 必須 | 一つのコンテナ境界、主要コンポーネント、接点となる利用者・ストア・外部依存、ラベル付きの関係 |
|
|
60
|
+
| 要素・境界の定義 | 必須 | 内外の分界、コンポーネントの責務・入出力・論理配置と採用理由、外部依存の利用条件、関係の授受情報と詳細の正本 |
|
|
61
|
+
| 技術前提・検証対象 | 必須 | 依存の制約、失敗時に区別する結果、関係 ID に結び付く結合検証の観測点 |
|
|
62
|
+
| 未確定事項の引き継ぎ | 条件付き | 仮定・未確認箇所がある場合の対象・論点、影響する要素・関係と後続設計、当面の扱い・解消条件 |
|
|
227
63
|
|
|
228
|
-
|
|
229
|
-
flowchart LR
|
|
230
|
-
%% Person
|
|
231
|
-
店員["👤店員"]
|
|
64
|
+
Person・ストア・外部システムが該当しない場合は、定義欄へ非該当の理由を書きます。論理配置はコンテナ内部の責務の配置までとし、確認できていないソースパスを断定しません。
|
|
232
65
|
|
|
233
|
-
|
|
234
|
-
会計システム["会計システム"]
|
|
66
|
+
## 6. 記述ガイド
|
|
235
67
|
|
|
236
|
-
|
|
237
|
-
subgraph 境界["対象コンテナ(例: 販売API)"]
|
|
238
|
-
売上受付("売上受付")
|
|
239
|
-
在庫照会("在庫照会")
|
|
240
|
-
認証("認証")
|
|
241
|
-
販売DB[("販売DB")]
|
|
242
|
-
end
|
|
68
|
+
共通のメタ情報・命名は上位標準を参照し、以下ではコンポーネント分割に固有の判断を扱います。
|
|
243
69
|
|
|
244
|
-
|
|
245
|
-
店員 -->|"売上登録"| 売上受付
|
|
246
|
-
売上受付 -->|"売上データ"| 販売DB
|
|
247
|
-
売上受付 -->|"会計仕訳連携"| 会計システム
|
|
248
|
-
在庫照会 -->|"在庫データ参照"| 販売DB
|
|
249
|
-
売上受付 -->|"認証"| 認証
|
|
70
|
+
### 6.1. 概要
|
|
250
71
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
class 店員 person;
|
|
256
|
-
class 売上受付,在庫照会,認証,販売DB system;
|
|
257
|
-
class 会計システム external;
|
|
258
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
259
|
-
```
|
|
72
|
+
- 上位図のどのコンテナを展開するか、何の設計入力に使うか、何を扱わないかを書きます。
|
|
73
|
+
- 対象者の業務課題、放置時の影響、期待価値・成功基準は、上位の要求・目的の該当箇所へ必ず参照を置きます。上位に定義がなければ論点として残し、CPD だけで業務上の成功を確定しません。
|
|
74
|
+
- 設計案と実装の確認済み構成を区別し、未確認の分割は _ASSUMPTION_: として影響と確認先を残します。
|
|
75
|
+
- 良い例: 「販売処理サービス内部を分け、保存と印字の責任境界を結合設計へ渡す。再送の詳細は連携仕様へ委ねる」。悪い例: 「システム全体の詳細を示す」。対象と用途を限定できるかが基準です。
|
|
260
76
|
|
|
261
|
-
|
|
77
|
+
### 6.2. C4コンポーネント図(Mermaid)
|
|
262
78
|
|
|
263
|
-
|
|
79
|
+
- 上位図で対象外のストア・他コンテナは境界外に置きます。同じ端末で動くことを境界内に置く理由にしません。
|
|
80
|
+
- 矢印が依存・依頼を表すかを明示し、応答を同じ関係に含めるか説明します。主要経路の省略範囲も短く示します。
|
|
81
|
+
- 良い例: 「会計処理 → 印字連携: 保存済み控えの印字依頼」。悪い例: 「会計処理 ↔ 共通処理: 処理」。責務と依存方向を読めるかが基準です。
|
|
264
82
|
|
|
265
|
-
|
|
83
|
+
### 6.3. 要素と境界の定義
|
|
266
84
|
|
|
267
|
-
|
|
85
|
+
- コンポーネントは固有の責務、入力と出力の種類、コンテナ内での論理配置を記述します。実装上の配置を示す場合は根拠を付け、未確認なら論点に残します。
|
|
86
|
+
- 主要な分割・共通化・依存の採用理由を、概要で参照した業務目的または技術制約へ対応付けます。同じ理由で分けた責務はまとめて説明し、各行で上位の目的を繰り返しません。
|
|
87
|
+
- 関係表の推奨列は「関係 ID / 起点 → 終点 / 授受情報・条件 / 詳細の正本」です。外部の別コンテナ、ストア、外部システムを区別し、未作成の正本はバッククォートで仮置きします。
|
|
88
|
+
- 良い例: 「会計処理は確認済み明細を受け、確定結果を返す。印字の成否は印字連携が扱う」。悪い例: 「会計処理は販売のすべてを行う」。他コンポーネントとの更新責任を分けられるかが基準です。
|
|
268
89
|
|
|
269
|
-
|
|
90
|
+
### 6.4. 技術前提・制約と検証観点
|
|
270
91
|
|
|
271
|
-
|
|
92
|
+
- 共通機構への依存、外部依頼、正本と派生物の区別を、対象コンテナに必要な範囲で示します。未確認の排他・原子性・再試行保証は置きません。
|
|
93
|
+
- 関係 ID または要素名に、入力条件と観測する結果を対応付けます。テストケースの全件列挙や実施結果の記録は行いません。
|
|
94
|
+
- 良い例: 「保存成功後の印字失敗で、販売結果と未印字を別々に観測する」。悪い例: 「正常系と異常系を十分テストする」。境界ごとの確認対象を識別できるかが基準です。
|
|
272
95
|
|
|
273
|
-
|
|
274
|
-
- 在庫照会: 在庫の参照要求を受け付けます。
|
|
275
|
-
- 認証: 利用者の認証を行います。
|
|
96
|
+
### 6.5. メモ / 将来課題
|
|
276
97
|
|
|
277
|
-
|
|
98
|
+
- 仮定・未確認事項は共通ラベルで確定事項と区別し、対象要素・関係 ID と対応付けます。
|
|
99
|
+
- 記録項目は「対象・論点 / 影響と後続成果物 / 当面の扱い・解消条件」とし、境界・契約・結合設計・作業順への影響を示します。
|
|
100
|
+
- 良い例: 「`REL-08` の印字応答欠落では結果不明が生じる。外部 IF の回復条件と結合観測点が定まるまで自動再送を認めず、当該経路の受入を保留する」。悪い例: 「将来検討する」。未確認の条件と、後続設計で決めるべき内容を特定できるかが基準です。
|
|
278
101
|
|
|
279
|
-
|
|
102
|
+
### 6.6. 検証と合意の判定
|
|
280
103
|
|
|
281
|
-
|
|
104
|
+
受入確認では次の順に照合します。
|
|
282
105
|
|
|
283
|
-
|
|
106
|
+
1. 図の全要素を定義表または境界の説明へ、全関係を一意な関係 ID へ対応付けます。定義表だけにある要素・関係には省略理由が必要です。
|
|
107
|
+
2. 上位図と内外配置・依存方向を比較し、説明のない差異が残らないことを確認します。描画した図で要素名・関係ラベルが欠けず、境界内外と矢印の端点を判読できることも確かめます。
|
|
108
|
+
3. 主要経路の通常時と失敗・応答欠落時について、入力条件・観測結果・詳細契約を関係 ID から辿ります。すべて対応し、結果を区別できれば合格、矛盾や欠落は不合格、契約や観測方法が未整備なら未判定として当該経路の受入を保留します。
|
|
284
109
|
|
|
285
|
-
|
|
110
|
+
良い例: 「保存後の印字応答欠落をたどり、保存済み販売と印字の結果不明を別々に確認できる」。悪い例: 「矢印がつながっているので受入可能」。境界ごとの結果と未確認の範囲を説明できるかが基準です。
|
|
286
111
|
|
|
287
|
-
|
|
112
|
+
### 6.7. 変更・保守時の影響確認
|
|
288
113
|
|
|
289
|
-
|
|
114
|
+
更新契機は上位 CND の境界変更、責務の追加・統合・廃止、外部 IF・ストアの契約変更、実装との不一致、結合検証での前提否定です。
|
|
290
115
|
|
|
291
|
-
-
|
|
116
|
+
- 変更する要素・関係 ID から、上位 CND、用語定義、外部 IF、下位のデータ・詳細設計への影響をたどります。図と定義表の対応を保ちます。
|
|
117
|
+
- 実装・schema・参照元・生成物・運用手順、結合観測点・テスト仕様の追従要否を確認します。値・構文・構造は各正本を更新し、CPD に複製しません。
|
|
118
|
+
- 良い例: 「保存責務の統合で `REL-05` の終点が変わり、図・関係表とデータ設計、実装対応、保存失敗の観測点、結合作業の開始条件に影響する」。悪い例: 「図だけ差し替える」。影響先ごとに更新要否と根拠を説明できるかが基準です。
|
|
292
119
|
|
|
293
|
-
##
|
|
120
|
+
## 7. 禁止事項
|
|
294
121
|
|
|
295
|
-
-
|
|
122
|
+
- 複数の実行・配備単位を一つのコンテナとして描くことや、コンポーネントを別サービスと根拠なく断定すること。
|
|
123
|
+
- クラス・関数・ファイル一覧、コマンドオプション、API 構文、データ項目・値制約を詳細仕様と重複して管理すること。
|
|
124
|
+
- ラベルのない関係、方向の意味が混在する矢印、図と表で対応しない名称・接続。
|
|
125
|
+
- 未確認の依存・物理配置・障害回復保証を確定事項として記載すること。
|
|
@@ -16,11 +16,7 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
C4 Context Diagram (CXD) Documentation Rules using Mermaid
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
C4 コンテキスト図は「対象システム」と、その周辺の **利用者(人)**・**外部システム**・**関係(やり取り)** を、概念レベルで合意するために用います。
|
|
22
|
-
|
|
23
|
-
---
|
|
19
|
+
Mermaid の `flowchart` 構文で C4 コンテキスト図を描くための記法を定めます。要素の選定と責任分界は [[specdojo:cxd-rulebook|C4コンテキスト図(CXD)作成ルール]] に従います。
|
|
24
20
|
|
|
25
21
|
## 1. 全体方針
|
|
26
22
|
|
|
@@ -29,6 +25,7 @@ C4 コンテキスト図は「対象システム」と、その周辺の **利
|
|
|
29
25
|
- 対象は「システム境界の外側との関係」であり、内部構造(コンテナ/コンポーネント)や実装詳細は含めない。
|
|
30
26
|
- 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
|
|
31
27
|
- 1つの図には **対象システムを1つ**だけ置く(複数対象は図を分ける)。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認には含めません。
|
|
32
29
|
|
|
33
30
|
## 2. C4要素と Mermaid 記号の対応
|
|
34
31
|
|
|
@@ -42,7 +39,7 @@ C4 の要素を、以下のように Mermaid の記号にマッピングする
|
|
|
42
39
|
| System Boundary(境界) | 対象システムの範囲 | `subgraph 境界["対象システム"] ... end` |
|
|
43
40
|
| Relationship(関係) | 依存・利用・連携(概念) | `店員 -->\| "売上登録" \| 販売管理システム` |
|
|
44
41
|
|
|
45
|
-
|
|
42
|
+
### 2.1. 標準の色分け(推奨)
|
|
46
43
|
|
|
47
44
|
C4コンテキスト図は色が必須ではありませんが、読み手が「人 / 対象システム / 外部システム」を一目で区別できるよう、以下の色分けを推奨します。
|
|
48
45
|
|
|
@@ -53,7 +50,7 @@ C4コンテキスト図は色が必須ではありませんが、読み手が「
|
|
|
53
50
|
|
|
54
51
|
Mermaid `flowchart` では `classDef` + `class`、境界は `style` を使用します。
|
|
55
52
|
|
|
56
|
-
|
|
53
|
+
#### 2.1.1. 標準スタイル定義(コピーして利用)
|
|
57
54
|
|
|
58
55
|
```mermaid
|
|
59
56
|
flowchart LR
|
|
@@ -69,15 +66,7 @@ flowchart LR
|
|
|
69
66
|
|
|
70
67
|
```
|
|
71
68
|
|
|
72
|
-
|
|
73
|
-
flowchart LR
|
|
74
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
75
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
76
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
77
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### 2.1.2 適用ルール
|
|
69
|
+
#### 2.1.2. 適用ルール
|
|
81
70
|
|
|
82
71
|
- Personノードには `person` クラスを付ける
|
|
83
72
|
- 対象システムノードには `system` クラスを付ける
|
|
@@ -100,23 +89,9 @@ flowchart LR
|
|
|
100
89
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
101
90
|
```
|
|
102
91
|
|
|
103
|
-
```plainText
|
|
104
|
-
flowchart LR
|
|
105
|
-
店員["店員"]
|
|
106
|
-
会計システム["会計システム"]
|
|
107
|
-
subgraph 境界["対象システム"]
|
|
108
|
-
販売管理システム("販売管理システム")
|
|
109
|
-
end
|
|
110
|
-
|
|
111
|
-
class 店員 person;
|
|
112
|
-
class 販売管理システム system;
|
|
113
|
-
class 会計システム external;
|
|
114
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
115
|
-
```
|
|
116
|
-
|
|
117
92
|
## 3. ノードのルール
|
|
118
93
|
|
|
119
|
-
### 3.1 Person(人/ロール)
|
|
94
|
+
### 3.1. Person(人/ロール)
|
|
120
95
|
|
|
121
96
|
- **四角 `[]`** を使用する。
|
|
122
97
|
- 表示ラベルは業務ロール/主体を短い日本語で表す。
|
|
@@ -132,16 +107,7 @@ flowchart LR
|
|
|
132
107
|
class 店員,店主 person;
|
|
133
108
|
```
|
|
134
109
|
|
|
135
|
-
|
|
136
|
-
flowchart LR
|
|
137
|
-
店員["👤店員"]
|
|
138
|
-
店主["👤店主"]
|
|
139
|
-
|
|
140
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
141
|
-
class 店員,店主 person;
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### 3.2 Software System(対象システム)
|
|
110
|
+
### 3.2. Software System(対象システム)
|
|
145
111
|
|
|
146
112
|
- **角丸長方形 `()`** を使用する。
|
|
147
113
|
- 図の中心として扱い、表示ラベルは「システム名(+必要なら短い補足)」とする。
|
|
@@ -157,15 +123,7 @@ flowchart LR
|
|
|
157
123
|
class 販売管理システム system;
|
|
158
124
|
```
|
|
159
125
|
|
|
160
|
-
|
|
161
|
-
flowchart LR
|
|
162
|
-
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
163
|
-
|
|
164
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
165
|
-
class 販売管理システム system;
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### 3.3 External Software System(外部システム)
|
|
126
|
+
### 3.3. External Software System(外部システム)
|
|
169
127
|
|
|
170
128
|
- **四角 `[]`** を使用する。
|
|
171
129
|
- 表示ラベルは外部システムの一般名(例: 決済、会計、EC、配送など)。
|
|
@@ -181,16 +139,7 @@ flowchart LR
|
|
|
181
139
|
class 会計システム,決済サービス external;
|
|
182
140
|
```
|
|
183
141
|
|
|
184
|
-
|
|
185
|
-
flowchart LR
|
|
186
|
-
会計システム["会計システム"]
|
|
187
|
-
決済サービス["決済サービス"]
|
|
188
|
-
|
|
189
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
190
|
-
class 会計システム,決済サービス external;
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
### 3.4 System Boundary(境界)
|
|
142
|
+
### 3.4. System Boundary(境界)
|
|
194
143
|
|
|
195
144
|
- 対象システムは **サブグラフ `subgraph ... end`** で囲う。
|
|
196
145
|
- 境界内には、原則として **対象システムのノード1つ**だけを置く(コンテキスト図の過密化防止)。
|
|
@@ -208,27 +157,16 @@ flowchart LR
|
|
|
208
157
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
209
158
|
```
|
|
210
159
|
|
|
211
|
-
```plainText
|
|
212
|
-
flowchart LR
|
|
213
|
-
subgraph 境界["対象システム"]
|
|
214
|
-
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
215
|
-
end
|
|
216
|
-
|
|
217
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
218
|
-
class 販売管理システム system;
|
|
219
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
220
|
-
```
|
|
221
|
-
|
|
222
160
|
## 4. エッジ(関係)のルール
|
|
223
161
|
|
|
224
|
-
### 4.1 方向
|
|
162
|
+
### 4.1. 方向
|
|
225
163
|
|
|
226
164
|
- `A --> B` を基本とする。
|
|
227
165
|
- 方向は「主たる依存/利用/送信の向き」が分かるように統一する。
|
|
228
166
|
- 例: 人がシステムを利用する: `人 -->|"利用"| 対象システム`
|
|
229
167
|
- 例: 対象システムが外部システムに連携する: `対象システム -->|"連携"| 外部システム`
|
|
230
168
|
|
|
231
|
-
### 4.2 ラベル
|
|
169
|
+
### 4.2. ラベル
|
|
232
170
|
|
|
233
171
|
- すべてのエッジにラベルを付ける(「何の関係か」を合意するため)。
|
|
234
172
|
- ラベルは **短い名詞句**または **短い動詞句**で書く。
|
|
@@ -239,7 +177,7 @@ flowchart LR
|
|
|
239
177
|
|
|
240
178
|
```mermaid
|
|
241
179
|
flowchart LR
|
|
242
|
-
店員["
|
|
180
|
+
店員["店員"] -->|"売上登録"| 販売管理システム("販売管理システム")
|
|
243
181
|
販売管理システム -->|"会計仕訳<br>連携"| 会計システム["会計システム"]
|
|
244
182
|
|
|
245
183
|
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
@@ -250,29 +188,12 @@ flowchart LR
|
|
|
250
188
|
class 会計システム external;
|
|
251
189
|
```
|
|
252
190
|
|
|
253
|
-
```plainText
|
|
254
|
-
flowchart LR
|
|
255
|
-
店員["一店員"] -->|"売上登録"| 販売管理システム("販売管理システム")
|
|
256
|
-
販売管理システム -->|"会計仕訳<br>連携"| 会計システム["会計システム"]
|
|
257
|
-
|
|
258
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
259
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
260
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
261
|
-
class 店員 person;
|
|
262
|
-
class 販売管理システム system;
|
|
263
|
-
class 会計システム external;
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
191
|
## 5. 命名・表記ルール
|
|
269
192
|
|
|
270
193
|
- ノードIDは日本語でもよいが、記号や空白は避け、短い識別子にする(例: `販売管理システム`, `会計システム`, `店員`)。
|
|
271
194
|
- 表示ラベルは `"..."` で囲ってよい(混乱を避けるため、必要に応じて統一)。
|
|
272
195
|
- 同じ主体/システムは、図の中で名称を揺らさない。
|
|
273
196
|
|
|
274
|
-
---
|
|
275
|
-
|
|
276
197
|
## 6. 禁止事項
|
|
277
198
|
|
|
278
199
|
| 項目 | 理由 |
|
|
@@ -283,8 +204,6 @@ flowchart LR
|
|
|
283
204
|
| 対象システムの内部プロセス/内部データストアの詳細 | コンテナ図/コンポーネント図で表す |
|
|
284
205
|
| 矢印ラベルなしの関係 | 合意が取れない |
|
|
285
206
|
|
|
286
|
-
---
|
|
287
|
-
|
|
288
207
|
## 7. サンプル(最小)
|
|
289
208
|
|
|
290
209
|
```mermaid
|
|
@@ -320,34 +239,6 @@ flowchart LR
|
|
|
320
239
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
321
240
|
```
|
|
322
241
|
|
|
323
|
-
```plainText
|
|
324
|
-
flowchart LR
|
|
325
|
-
店員["👤店員"]
|
|
326
|
-
店主["👤店主"]
|
|
327
|
-
|
|
328
|
-
会計システム["会計システム"]
|
|
329
|
-
決済サービス["決済サービス"]
|
|
330
|
-
|
|
331
|
-
subgraph 境界["対象システム"]
|
|
332
|
-
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
333
|
-
end
|
|
334
|
-
|
|
335
|
-
店員 -->|"売上登録"| 販売管理システム
|
|
336
|
-
店主 -->|"商品・在庫管理"| 販売管理システム
|
|
337
|
-
|
|
338
|
-
販売管理システム -->|"会計仕訳連携"| 会計システム
|
|
339
|
-
販売管理システム -->|"決済依頼"| 決済サービス
|
|
340
|
-
決済サービス -->|"決済結果"| 販売管理システム
|
|
341
|
-
|
|
342
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
343
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
344
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
345
|
-
class 店員,店主 person;
|
|
346
|
-
class 販売管理システム system;
|
|
347
|
-
class 会計システム,決済サービス external;
|
|
348
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
349
|
-
```
|
|
350
|
-
|
|
351
242
|
## 8. 凡例(推奨)
|
|
352
243
|
|
|
353
244
|
凡例は下記のように表現する(必要な場合のみ)。
|
|
@@ -376,27 +267,3 @@ flowchart LR
|
|
|
376
267
|
class 外部 external;
|
|
377
268
|
style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
378
269
|
```
|
|
379
|
-
|
|
380
|
-
```plainText
|
|
381
|
-
flowchart LR
|
|
382
|
-
subgraph 凡例["凡例"]
|
|
383
|
-
direction LR
|
|
384
|
-
人["👤Person<br>(人/ロール)"]
|
|
385
|
-
|
|
386
|
-
subgraph 境界例["システム境界"]
|
|
387
|
-
対象("Software System<br>(対象システム)")
|
|
388
|
-
end
|
|
389
|
-
外部["External System<br>(外部システム)"]
|
|
390
|
-
|
|
391
|
-
人 -->|"Relationship(関係)"| 対象
|
|
392
|
-
対象 -->|"Relationship(関係)"| 外部
|
|
393
|
-
end
|
|
394
|
-
|
|
395
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
396
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
397
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
398
|
-
class 人 person;
|
|
399
|
-
class 対象 system;
|
|
400
|
-
class 外部 external;
|
|
401
|
-
style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
402
|
-
```
|