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,285 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cnd-mermaid-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: undecided
|
|
8
|
+
sample: specdojo:cnd-sample
|
|
9
|
+
template: undecided
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Mermaid を用いたC4コンテナ図 作成ルール
|
|
15
|
+
|
|
16
|
+
C4 Container Diagram (CND) Documentation Rules using Mermaid
|
|
17
|
+
|
|
18
|
+
本ドキュメントは、アーキテクチャ設計のために、**Mermaid の `flowchart` 構文を使って C4 コンテナ図を描く際の標準ルール**です。
|
|
19
|
+
|
|
20
|
+
C4 コンテナ図は「対象システム」を、**実行/配備単位(コンテナ)** に分割して俯瞰し、利用者(人)・外部システム・データストアとの関係(やり取り)を、概念レベルで合意するために用います。
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 1. 全体方針
|
|
25
|
+
|
|
26
|
+
- Mermaid の **`flowchart` を C4 コンテナ図風に利用**する。
|
|
27
|
+
- 対象は「対象システム内の主要コンテナ」と「境界外(人/外部システム)との関係」であり、コンポーネント/クラス等の内部構造は含めない。
|
|
28
|
+
- 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
|
|
29
|
+
- 1つの図には **対象システムを1つ**だけ置く(複数対象は図を分ける)。
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 2. C4要素と Mermaid 記号の対応
|
|
34
|
+
|
|
35
|
+
C4 の要素を、以下のように Mermaid の記号にマッピングする。
|
|
36
|
+
|
|
37
|
+
| C4要素 | 意味 | Mermaid での表現例 |
|
|
38
|
+
| ---------------------------------------- | ---------------------------------- | -------------------------------------------------------------------- |
|
|
39
|
+
| Person(人/ロール) | 利用者・関係者 | `店員["店員"]` |
|
|
40
|
+
| Container(コンテナ) | 実行/配備単位(Web/API/バッチ等) | `Webアプリ("Webアプリ<br>(React)")` |
|
|
41
|
+
| Database(データベース) | 永続データストア | `販売DB[("販売DB")]` |
|
|
42
|
+
| External Software System(外部システム) | 連携先システム | `会計システム["会計システム"]` |
|
|
43
|
+
| System Boundary(境界) | 対象システムの範囲 | `subgraph 境界["対象システム"] ... end` |
|
|
44
|
+
| Relationship(関係) | 利用・連携・参照・データ入出力概念 | `店員 -->\|"売上登録"\| Webアプリ`/`API --> \|"売上データ"\| 販売DB` |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 2.1 標準の色分け(推奨)
|
|
49
|
+
|
|
50
|
+
C4コンテナ図は色が必須ではありませんが、読み手が「人 / 対象システム内の要素 / 外部システム」を一目で区別できるよう、以下の色分けを推奨します。
|
|
51
|
+
|
|
52
|
+
- Person(人/ロール): 暖色系
|
|
53
|
+
- 対象システム内(Container / Database): 寒色系(主役)
|
|
54
|
+
- 外部システム(External System): 無彩色系(脇役)
|
|
55
|
+
- 境界(System Boundary): 破線枠
|
|
56
|
+
|
|
57
|
+
Mermaid `flowchart` では `classDef` + `class`、境界は `style` を使用します。
|
|
58
|
+
|
|
59
|
+
### 2.1.1 標準スタイル定義(コピーして利用)
|
|
60
|
+
|
|
61
|
+
※ 既存の C4 コンテキスト図(CXD)と同じ色指定を利用します。
|
|
62
|
+
|
|
63
|
+
```mermaid
|
|
64
|
+
flowchart LR
|
|
65
|
+
%% --- Standard styles (recommended) ---
|
|
66
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
67
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
68
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
69
|
+
|
|
70
|
+
%% System boundary style (subgraph)
|
|
71
|
+
%% NOTE: '境界' は subgraph のID(名前)に合わせる
|
|
72
|
+
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 2.1.2 適用ルール
|
|
76
|
+
|
|
77
|
+
- Personノードには `person` クラスを付ける
|
|
78
|
+
- 対象システム内の Container / Database には `system` クラスを付ける
|
|
79
|
+
- 外部システムノードには `external` クラスを付ける
|
|
80
|
+
- 境界は `subgraph 境界[...]` として、`style 境界 ...` で枠線を指定する
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## 3. ノードのルール
|
|
85
|
+
|
|
86
|
+
### 3.1 Person(人/ロール)
|
|
87
|
+
|
|
88
|
+
- **四角 `[]`** を使用する。
|
|
89
|
+
- 表示ラベルは業務ロール/主体を短い日本語で表す。
|
|
90
|
+
|
|
91
|
+
例:
|
|
92
|
+
|
|
93
|
+
```mermaid
|
|
94
|
+
flowchart LR
|
|
95
|
+
店員["👤店員"]
|
|
96
|
+
店主["👤店主"]
|
|
97
|
+
|
|
98
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
99
|
+
class 店員,店主 person;
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### 3.2 Container(コンテナ)
|
|
103
|
+
|
|
104
|
+
- **角丸長方形 `()`** を使用する。
|
|
105
|
+
- 表示ラベルは「コンテナ名(+必要なら技術/役割の短い補足)」とする。
|
|
106
|
+
- 改行は `<br>` を使用してよい(長文化防止)。
|
|
107
|
+
|
|
108
|
+
例:
|
|
109
|
+
|
|
110
|
+
```mermaid
|
|
111
|
+
flowchart LR
|
|
112
|
+
Webアプリ("Webアプリ<br>(レジ/管理画面)")
|
|
113
|
+
API("API<br>(販売/在庫)")
|
|
114
|
+
|
|
115
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
116
|
+
class Webアプリ,API system;
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### 3.3 Database(データベース)
|
|
120
|
+
|
|
121
|
+
- **円柱ノード `[(...)]`** を使用する。
|
|
122
|
+
- DBの論理名を短く書く(例: `販売DB`, `在庫DB`)。
|
|
123
|
+
|
|
124
|
+
例:
|
|
125
|
+
|
|
126
|
+
```mermaid
|
|
127
|
+
flowchart LR
|
|
128
|
+
販売DB[("販売DB")]
|
|
129
|
+
|
|
130
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
131
|
+
class 販売DB system;
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### 3.4 External Software System(外部システム)
|
|
135
|
+
|
|
136
|
+
- **四角 `[]`** を使用する。
|
|
137
|
+
- 表示ラベルは外部システムの一般名(例: 会計、決済、EC、配送など)。
|
|
138
|
+
|
|
139
|
+
例:
|
|
140
|
+
|
|
141
|
+
```mermaid
|
|
142
|
+
flowchart LR
|
|
143
|
+
会計システム["会計システム"]
|
|
144
|
+
決済サービス["決済サービス"]
|
|
145
|
+
|
|
146
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
147
|
+
class 会計システム,決済サービス external;
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### 3.5 System Boundary(境界)
|
|
151
|
+
|
|
152
|
+
- 対象システムは **サブグラフ `subgraph ... end`** で囲う。
|
|
153
|
+
- 境界内には、対象システムの **主要コンテナ**(2〜7個程度を目安)と、必要なら主要DBを置く。
|
|
154
|
+
- 境界内の要素を増やしすぎない(詳細化はコンポーネント図へ)。
|
|
155
|
+
|
|
156
|
+
例:
|
|
157
|
+
|
|
158
|
+
```mermaid
|
|
159
|
+
flowchart LR
|
|
160
|
+
subgraph 境界["対象システム"]
|
|
161
|
+
Webアプリ("Webアプリ")
|
|
162
|
+
API("API")
|
|
163
|
+
販売DB[("販売DB")]
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
167
|
+
class Webアプリ,API,販売DB system;
|
|
168
|
+
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## 4. エッジ(関係)のルール
|
|
174
|
+
|
|
175
|
+
### 4.1 方向
|
|
176
|
+
|
|
177
|
+
- `A --> B` を基本とする。
|
|
178
|
+
- 方向は「主たる依存/利用/送信の向き」が分かるように統一する。
|
|
179
|
+
- 例: 人がシステムを利用する: `人 -->|"利用"| 対象システム内のコンテナ`
|
|
180
|
+
- 例: コンテナ間の呼び出し: `Webアプリ -->|"API呼び出し"| API`
|
|
181
|
+
- 例: DBへの入出力: `API -->|"売上データ"| 販売DB`
|
|
182
|
+
|
|
183
|
+
### 4.2 ラベル
|
|
184
|
+
|
|
185
|
+
- すべてのエッジにラベルを付ける(「何の関係か」を合意するため)。
|
|
186
|
+
- ラベルは **短い名詞句**または **短い動詞句**で書く。
|
|
187
|
+
- 例: `売上登録` / `在庫照会` / `会計仕訳連携` / `決済結果を受信`
|
|
188
|
+
- 長い場合は `<br>` で改行してよい。
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## 5. 命名・表記ルール
|
|
193
|
+
|
|
194
|
+
- ノードIDは日本語でもよいが、記号や空白は避け、短い識別子にする(例: `Webアプリ`, `API`, `販売DB`, `会計システム`, `店員`)。
|
|
195
|
+
- 表示ラベルは `"..."` で囲ってよい(混乱を避けるため、必要に応じて統一)。
|
|
196
|
+
- 同じ主体/システム/コンテナ/DBは、図の中で名称を揺らさない。
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## 6. 禁止事項
|
|
201
|
+
|
|
202
|
+
| 項目 | 理由 |
|
|
203
|
+
| ----------------------------------------------------- | ------------------------------- |
|
|
204
|
+
| 物理テーブル名・物理カラム名・SQL全文 | コンテナ図の粒度を超える |
|
|
205
|
+
| APIエンドポイント/HTTPメソッド/リクエストJSON等の詳細 | IF仕様に記述する |
|
|
206
|
+
| 実装クラス/関数名、内部モジュールの列挙 | 変更に弱い |
|
|
207
|
+
| 画面遷移やクリック手順の逐語列挙 | UI変更に弱い・図の目的から逸脱 |
|
|
208
|
+
| コンポーネント/クラス等の内部構造の詳細 | コンポーネント図/実装設計で表す |
|
|
209
|
+
| 矢印ラベルなしの関係 | 合意が取れない |
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## 7. サンプル(最小)
|
|
214
|
+
|
|
215
|
+
```mermaid
|
|
216
|
+
flowchart LR
|
|
217
|
+
%% Person
|
|
218
|
+
店員["👤店員"]
|
|
219
|
+
|
|
220
|
+
%% External Systems
|
|
221
|
+
会計システム["会計システム"]
|
|
222
|
+
決済サービス["決済サービス"]
|
|
223
|
+
|
|
224
|
+
%% Target System Boundary
|
|
225
|
+
subgraph 境界["対象システム"]
|
|
226
|
+
Webアプリ("Webアプリ<br>(レジ/管理画面)")
|
|
227
|
+
API("API<br>(販売/在庫)")
|
|
228
|
+
販売DB[("販売DB")]
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
%% Relationships
|
|
232
|
+
店員 -->|"売上登録"| Webアプリ
|
|
233
|
+
Webアプリ -->|"API呼び出し"| API
|
|
234
|
+
API -->|"売上データ"| 販売DB
|
|
235
|
+
|
|
236
|
+
API -->|"会計仕訳連携"| 会計システム
|
|
237
|
+
API -->|"決済依頼"| 決済サービス
|
|
238
|
+
決済サービス -->|"決済結果"| API
|
|
239
|
+
|
|
240
|
+
%% Styles
|
|
241
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
242
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
243
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
244
|
+
class 店員 person;
|
|
245
|
+
class Webアプリ,API,販売DB system;
|
|
246
|
+
class 会計システム,決済サービス external;
|
|
247
|
+
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
## 8. 凡例(推奨)
|
|
253
|
+
|
|
254
|
+
凡例は下記のように表現する(必要な場合のみ)。
|
|
255
|
+
|
|
256
|
+
```mermaid
|
|
257
|
+
flowchart LR
|
|
258
|
+
subgraph 凡例["凡例"]
|
|
259
|
+
direction LR
|
|
260
|
+
|
|
261
|
+
人["👤Person<br>(人/ロール)"]
|
|
262
|
+
|
|
263
|
+
subgraph 境界例["システム境界"]
|
|
264
|
+
Web("Container<br>(コンテナ)")
|
|
265
|
+
DB[("Database<br>(データベース)")]
|
|
266
|
+
end
|
|
267
|
+
|
|
268
|
+
外部["External System<br>(外部システム)"]
|
|
269
|
+
|
|
270
|
+
人 -->|"Relationship(関係)"| Web
|
|
271
|
+
Web -->|"Relationship(関係)"| DB
|
|
272
|
+
Web -->|"Relationship(関係)"| 外部
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
%% Styles
|
|
276
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
277
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
278
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
279
|
+
class 人 person;
|
|
280
|
+
class Web,DB system;
|
|
281
|
+
class 外部 external;
|
|
282
|
+
style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
---
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cnd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:cnd-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# C4コンテナ図 ドキュメント作成ルール
|
|
12
|
+
|
|
13
|
+
C4 Container Diagram (CND) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、アーキテクチャ設計のために **C4コンテナ図と、その図を説明する文章**を、統一した粒度・表現で作成するためのルールです。
|
|
16
|
+
|
|
17
|
+
この章の成果物は、次の2つをセットで扱います。
|
|
18
|
+
|
|
19
|
+
- **C4コンテナ図(Mermaid)**: 対象システムを主要コンテナ(実行/配備単位)に分割し、利用者・外部システム・データストアとの関係を俯瞰で合意する
|
|
20
|
+
- **説明(Markdown)**: 図の要素(人/境界/コンテナ/DB/外部/関係)の意味を文章で合意する
|
|
21
|
+
|
|
22
|
+
Mermaid 記法そのもののルールは [cnd-mermaid-rulebook.md](cnd-mermaid-rulebook.md) を参照してください。
|
|
23
|
+
|
|
24
|
+
## 1. 全体方針
|
|
25
|
+
|
|
26
|
+
- CND は「対象システムが、どの実行/配備単位(コンテナ)で構成され、何とやり取りするか」を合意するための図である。
|
|
27
|
+
- 図に入れるのは **コンテナ粒度**までとし、コンポーネント/クラス等の内部構造や実装詳細は含めない。
|
|
28
|
+
- 1つの図には **対象システムを1つ**だけ置く(複数対象がある場合は図を分ける)。
|
|
29
|
+
- 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
|
|
30
|
+
|
|
31
|
+
## 2. ファイル命名・ID規則
|
|
32
|
+
|
|
33
|
+
- ファイル名: `cnd-<番号>-<短い日本語名>.md`
|
|
34
|
+
- 例: `cnd-010-駄菓子屋きぬや販売管理システム-コンテナ.md`
|
|
35
|
+
- Frontmatter:
|
|
36
|
+
- `id`: 小文字ハイフン形式(例: `cnd-candy-shop-sales-container`)
|
|
37
|
+
- `title`: 「〇〇のC4コンテナ図」のように対象が分かる表現
|
|
38
|
+
|
|
39
|
+
## 3. 推奨 Frontmatter 項目
|
|
40
|
+
|
|
41
|
+
Frontmatter の共通ルールは [document-metadata-standard.md](../standards/document-metadata-standard.md) に従います。
|
|
42
|
+
|
|
43
|
+
| 項目 | 説明 | 必須 |
|
|
44
|
+
| ---------- | ---------------------------------------------- | ---- |
|
|
45
|
+
| id | ドキュメントID(小文字ハイフン) | ○ |
|
|
46
|
+
| type | `architecture` 固定 | ○ |
|
|
47
|
+
| title | ドキュメント名 | ○ |
|
|
48
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
49
|
+
| part_of | 上位ドキュメントID(分割している場合) | 任意 |
|
|
50
|
+
| based_on | 根拠となる定義(用語集、外部IF、上位方針など) | 任意 |
|
|
51
|
+
| supersedes | 置き換え関係(古い図→新しい図) | 任意 |
|
|
52
|
+
|
|
53
|
+
### 3.1. `based_on` の考え方(例)
|
|
54
|
+
|
|
55
|
+
- 用語集(`gl-...`)や業務データ辞書(`bdd-...`)
|
|
56
|
+
- 外部システムIFの仕様(IF章のドキュメント)
|
|
57
|
+
- 参照する上位の方針(DEC、非機能要件など)
|
|
58
|
+
|
|
59
|
+
## 4. CNDで合意すること(スコープ)
|
|
60
|
+
|
|
61
|
+
### 4.1. 合意したいこと
|
|
62
|
+
|
|
63
|
+
- 対象システムの境界(System Boundary)と、責務の一言(何をするシステムか)
|
|
64
|
+
- 主要コンテナ(Container)の一覧と、それぞれの責務(1〜2文)
|
|
65
|
+
- 主要DB(Database)がある場合、その役割(何を永続化するか)
|
|
66
|
+
- 外部システム(External Software System)と、連携の意図(何をやり取りするか)
|
|
67
|
+
- 関係(Relationship)の向きと意味(誰が主に呼び出す/依存するか)
|
|
68
|
+
|
|
69
|
+
### 4.2. 合意しないこと(この図で扱わない)
|
|
70
|
+
|
|
71
|
+
- コンテナ内部の分解(コンポーネント/クラス、内部モジュール構成)
|
|
72
|
+
- APIエンドポイント、HTTPメソッド、リクエスト/レスポンスJSONなどのIF詳細
|
|
73
|
+
- 物理テーブル名・物理カラム名・SQL全文
|
|
74
|
+
- 実装クラス/関数名、ライブラリ名、具体的な技術選定の列挙
|
|
75
|
+
- 画面遷移やクリック手順の逐語列挙
|
|
76
|
+
|
|
77
|
+
## 5. CNDの要素定義(図と文章の両方で説明する)
|
|
78
|
+
|
|
79
|
+
この章では、図に描いた要素について **最低限の説明**を併記し、レビュー可能にします。
|
|
80
|
+
|
|
81
|
+
### 5.1. Person(人/ロール)
|
|
82
|
+
|
|
83
|
+
Personは、対象システムに対して目的をもって関わる主体(人/役割/組織)です。
|
|
84
|
+
|
|
85
|
+
- 書くこと(推奨):
|
|
86
|
+
- ロール名(例: 店員、店主、経理担当)
|
|
87
|
+
- どのコンテナを、何のために利用するか(例: Webアプリで売上登録を行う)
|
|
88
|
+
|
|
89
|
+
- 書かないこと:
|
|
90
|
+
- 個人名、UI操作手順の逐語列挙
|
|
91
|
+
|
|
92
|
+
### 5.2. System Boundary(システム境界)
|
|
93
|
+
|
|
94
|
+
境界は「対象システムが責任を持つ範囲」を表します。
|
|
95
|
+
|
|
96
|
+
- 書くこと(推奨):
|
|
97
|
+
- 境界に含めるもの
|
|
98
|
+
- 境界に含めないもの(外部システム/外部サービス等)
|
|
99
|
+
|
|
100
|
+
### 5.3. Container(コンテナ)
|
|
101
|
+
|
|
102
|
+
コンテナは、実行/配備単位(例: Webアプリ、API、バッチ)です。
|
|
103
|
+
|
|
104
|
+
- 書くこと(必須):
|
|
105
|
+
- コンテナ名
|
|
106
|
+
- 責務(1〜2文)
|
|
107
|
+
- 書くこと(推奨):
|
|
108
|
+
- 主な入出力の種類(例: 売上登録、在庫照会)
|
|
109
|
+
- 関係するデータストア(例: 販売DBを更新する)
|
|
110
|
+
- 書かないこと:
|
|
111
|
+
- 内部クラス/関数、モジュール階層の列挙
|
|
112
|
+
|
|
113
|
+
### 5.4. Database(データベース)
|
|
114
|
+
|
|
115
|
+
Database は、対象システム内の主要な永続データストアです。
|
|
116
|
+
|
|
117
|
+
- 書くこと(推奨):
|
|
118
|
+
- DBの論理名(例: 販売DB、在庫DB)
|
|
119
|
+
- 何を永続化するか(例: 売上・在庫・仕入の記録)
|
|
120
|
+
- 書かないこと:
|
|
121
|
+
- 物理テーブル名・物理カラム名・SQL
|
|
122
|
+
|
|
123
|
+
### 5.5. External Software System(外部システム)
|
|
124
|
+
|
|
125
|
+
対象システムの外側にあり、対象システムが連携する相手(既存の別システム、SaaS、決済、会計など)です。
|
|
126
|
+
|
|
127
|
+
- 書くこと(推奨):
|
|
128
|
+
- 外部システム名(一般名でよい)
|
|
129
|
+
- 連携の目的(例: 決済を依頼する、仕訳を送る)
|
|
130
|
+
- 連携の方向性(誰が主に呼び出す/依存するか)
|
|
131
|
+
- 書かないこと:
|
|
132
|
+
- API仕様の詳細、データ項目一覧(それらはIF仕様へ)
|
|
133
|
+
|
|
134
|
+
### 5.6. Relationship(関係)
|
|
135
|
+
|
|
136
|
+
関係は「やり取りの意味」を合意するための線です。CNDでは **すべての関係にラベル**を付けます。
|
|
137
|
+
|
|
138
|
+
- 書くこと(必須):
|
|
139
|
+
- 方向(誰が主に利用/依存/送信するか)
|
|
140
|
+
- ラベル(短い日本語。名詞句または短い動詞句)
|
|
141
|
+
- 書かないこと:
|
|
142
|
+
- HTTP詳細、データ項目列挙、SQL、実装条件式
|
|
143
|
+
|
|
144
|
+
## 6. 本文構成(標準テンプレ)
|
|
145
|
+
|
|
146
|
+
各 CND 成果物は、以下見出しを順番に並べます。
|
|
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 記法ルールは [cnd-mermaid-rulebook.md](cnd-mermaid-rulebook.md) に従います。
|
|
163
|
+
- 図には、少なくとも以下を含めます。
|
|
164
|
+
- Person(いる場合)
|
|
165
|
+
- 境界(System Boundary)
|
|
166
|
+
- 主要コンテナ(2〜7個程度を目安)
|
|
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
|
+
次の記述は、CNDの粒度を超えるため避けます。
|
|
191
|
+
|
|
192
|
+
| 項目 | 理由 |
|
|
193
|
+
| --------------------------------------- | -------------------------------- |
|
|
194
|
+
| 物理テーブル名・物理カラム名・SQL全文 | 図の粒度を超える(DB設計に記述) |
|
|
195
|
+
| APIエンドポイント/HTTP/JSON等の詳細 | IF仕様に記述する |
|
|
196
|
+
| 実装クラス/関数名、内部モジュールの列挙 | 変更に弱い・合意の対象がずれる |
|
|
197
|
+
| 画面遷移やクリック手順の逐語列挙 | UI変更に弱い・図の目的から逸脱 |
|
|
198
|
+
| コンポーネント/クラス等の内部構造の詳細 | コンポーネント図/実装設計で表す |
|
|
199
|
+
| 矢印ラベルなしの関係 | 何の関係か合意できない |
|
|
200
|
+
|
|
201
|
+
## 10. レビュー観点(チェックリスト)
|
|
202
|
+
|
|
203
|
+
- 対象システムは1つに絞れているか
|
|
204
|
+
- 境界の内外が説明され、責任分界が曖昧でないか
|
|
205
|
+
- 主要コンテナが多すぎず(目安: 2〜7)、過不足なく俯瞰できるか
|
|
206
|
+
- Person/外部システム/DBがある場合、必要十分に含まれているか
|
|
207
|
+
- すべての関係にラベルがあり、意味が解釈一致するか
|
|
208
|
+
- 図が「コンポーネント/実装詳細」や「IF詳細」に踏み込んでいないか
|
|
209
|
+
|
|
210
|
+
## 11. サンプル(簡易)
|
|
211
|
+
|
|
212
|
+
```yaml
|
|
213
|
+
---
|
|
214
|
+
id: cnd-candy-shop-sales-container
|
|
215
|
+
type: architecture
|
|
216
|
+
title: 駄菓子屋きぬや販売管理システムのC4コンテナ図
|
|
217
|
+
status: draft
|
|
218
|
+
part_of: []
|
|
219
|
+
based_on: []
|
|
220
|
+
---
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### 11.1. 概要
|
|
224
|
+
|
|
225
|
+
この図は「駄菓子屋きぬや販売管理システム」を主要コンテナに分割し、利用者・外部システム・DBとの関係を俯瞰します。
|
|
226
|
+
|
|
227
|
+
### 11.2. C4コンテナ図(Mermaid)
|
|
228
|
+
|
|
229
|
+
```mermaid
|
|
230
|
+
flowchart LR
|
|
231
|
+
%% Person
|
|
232
|
+
店員["👤店員"]
|
|
233
|
+
|
|
234
|
+
%% External Systems
|
|
235
|
+
会計システム["会計システム"]
|
|
236
|
+
決済サービス["決済サービス"]
|
|
237
|
+
|
|
238
|
+
%% Target System Boundary
|
|
239
|
+
subgraph 境界["対象システム"]
|
|
240
|
+
Webアプリ("Webアプリ<br>(レジ/管理画面)")
|
|
241
|
+
API("API<br>(販売/在庫)")
|
|
242
|
+
販売DB[("販売DB")]
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
%% Relationships
|
|
246
|
+
店員 -->|"売上登録"| Webアプリ
|
|
247
|
+
Webアプリ -->|"API呼び出し"| API
|
|
248
|
+
API -->|"売上データ"| 販売DB
|
|
249
|
+
|
|
250
|
+
API -->|"会計仕訳連携"| 会計システム
|
|
251
|
+
API -->|"決済依頼"| 決済サービス
|
|
252
|
+
決済サービス -->|"決済結果"| API
|
|
253
|
+
|
|
254
|
+
%% Styles
|
|
255
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
256
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
257
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
258
|
+
class 店員 person;
|
|
259
|
+
class Webアプリ,API,販売DB system;
|
|
260
|
+
class 会計システム,決済サービス external;
|
|
261
|
+
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### 11.3. 要素の説明
|
|
265
|
+
|
|
266
|
+
#### 11.3.1. 境界(System Boundary)
|
|
267
|
+
|
|
268
|
+
境界には販売管理システム本体(Webアプリ/API/販売DB)を含みます。会計や決済の処理そのものは境界の外側です。
|
|
269
|
+
|
|
270
|
+
#### 11.3.2. Person(人/ロール)
|
|
271
|
+
|
|
272
|
+
店員が売上登録などの業務のために Webアプリを利用します。
|
|
273
|
+
|
|
274
|
+
#### 11.3.3. Container(コンテナ)
|
|
275
|
+
|
|
276
|
+
Webアプリは店舗業務の入力・参照を担い、APIは販売/在庫の主要ロジックと外部連携の窓口を担います。
|
|
277
|
+
|
|
278
|
+
#### 11.3.4. Database(データベース)
|
|
279
|
+
|
|
280
|
+
販売DBは売上などの主要記録を永続化します(詳細な物理設計はDB設計に記載)。
|
|
281
|
+
|
|
282
|
+
#### 11.3.5. 外部システム(External Software System)
|
|
283
|
+
|
|
284
|
+
APIは会計システムへ仕訳相当情報を連携し、決済サービスへ決済を依頼して結果を受信します(詳細はIF仕様に記載)。
|
|
285
|
+
|
|
286
|
+
### 11.4. 補足
|
|
287
|
+
|
|
288
|
+
- 会計連携の頻度(リアルタイム/日次)を確定する。
|
|
289
|
+
|
|
290
|
+
## 12. 参照
|
|
291
|
+
|
|
292
|
+
- Mermaid 記法(CND): [cnd-mermaid-rulebook.md](../rulebooks/cnd-mermaid-rulebook.md)
|