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,194 +3,19 @@ specdojo:
|
|
|
3
3
|
id: specdojo:cld-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
|
-
status:
|
|
7
|
-
recipe:
|
|
6
|
+
status: deprecated
|
|
7
|
+
recipe: not-needed
|
|
8
8
|
sample: specdojo:cld-sample
|
|
9
|
-
template:
|
|
9
|
+
template: not-needed
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
-
# 分類一覧(
|
|
12
|
+
# 分類一覧(CLD)ドキュメント作成ルール(非推奨)
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
分類は業務目的に応じて **業務分類(固定)/コード表(システム分類)/動的分類(ユーザー定義)** の3種類に分けて管理します。
|
|
14
|
+
Deprecated Classification Definition Rulebook
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
この rulebook は非推奨です。略号 `cld` は概念クラス図(`ccd`)と紛れるため、後継の [[specdojo:cdt-rulebook|分類一覧(CDT)作成ルール]] へ移行しました。
|
|
18
17
|
|
|
19
|
-
##
|
|
18
|
+
## 1. 移行方針
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
分類は以下の 3 種類に分類される:
|
|
24
|
-
|
|
25
|
-
### 1. **業務分類(Business Classification)**
|
|
26
|
-
|
|
27
|
-
- 業務ロジックに基づいて固定的に存在する分類
|
|
28
|
-
- 例:商品区分、顧客種別、売上種別
|
|
29
|
-
- 値は少数で変動しないことが多い
|
|
30
|
-
- システム依存性は低い
|
|
31
|
-
|
|
32
|
-
### 2. **コード表(Code List / System Code List)**
|
|
33
|
-
|
|
34
|
-
- システムで使用されるコード値の一覧
|
|
35
|
-
- 都道府県コード、支払方法コード、税種別コードなど
|
|
36
|
-
- 多くの場合 **マスターテーブルとして保持する**
|
|
37
|
-
- BDD の enum と密接に対応
|
|
38
|
-
|
|
39
|
-
### 3. **動的分類(Dynamic Classification)**
|
|
40
|
-
|
|
41
|
-
- ユーザーが自由に作成・編集・削除できる分類
|
|
42
|
-
- タグ、ラベル、フォルダ分類など
|
|
43
|
-
- **BDD の enum にしてはいけない**
|
|
44
|
-
- システムテーブルで管理し、BDD では string または reference とする
|
|
45
|
-
|
|
46
|
-
## 1. メタデータ
|
|
47
|
-
|
|
48
|
-
分類一覧を1つの YAML ドキュメントとして管理する場合、以下のメタデータを用いる。
|
|
49
|
-
|
|
50
|
-
| 項目 | 説明 | 必須 |
|
|
51
|
-
| ---- | ------------------------------ | ---- |
|
|
52
|
-
| id | 分類一覧ID(例:cll-xxx-xxxx) | ○ |
|
|
53
|
-
|
|
54
|
-
| type | `data` 固定 | ○ |
|
|
55
|
-
| title | 分類一覧名 | ○ |
|
|
56
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
57
|
-
| supersedes | 置き換え関係(旧仕様→新仕様) | 任意 |
|
|
58
|
-
|
|
59
|
-
### 1.1 ID規約
|
|
60
|
-
|
|
61
|
-
- 分類一覧IDは正規表現 **`^cll-[a-z0-9-]+$`** に合致すること
|
|
62
|
-
- `type: data` は画面やAPI仕様と切り離して管理することを示す
|
|
63
|
-
|
|
64
|
-
## 2. 記述ルール(共通)
|
|
65
|
-
|
|
66
|
-
- 日本語の単数形で記載する(例:商品区分、顧客種別)
|
|
67
|
-
- 分類を 分類定義 と 値の説明(値一覧) の二つの表で整理する。
|
|
68
|
-
- 値はシステム上の識別子として lower-kebab-case を使用する。
|
|
69
|
-
- 略語のみの記述や曖昧な説明は避ける。
|
|
70
|
-
- システム内部名称のみにしない
|
|
71
|
-
|
|
72
|
-
### 2.1 分類定義の説明
|
|
73
|
-
|
|
74
|
-
分類定義は、**「定義項目 / 内容」** の 2 列の表で記述します。
|
|
75
|
-
|
|
76
|
-
| 列名 | 説明 |
|
|
77
|
-
| ---------------- | -------------------------------------------------- |
|
|
78
|
-
| 対象エンティティ | 分類が属する業務上の主要対象(例:商品、顧客など) |
|
|
79
|
-
| 分類定義名 | 分類を表す項目(フィールド)名 |
|
|
80
|
-
| 種別 | 「業務分類」「コード表」「動的分類」のいずれか |
|
|
81
|
-
| 説明 | 分類が何を意味するか |
|
|
82
|
-
|
|
83
|
-
### 2.2 値一覧
|
|
84
|
-
|
|
85
|
-
値を持つ分類では、以下の列を基本とする。
|
|
86
|
-
|
|
87
|
-
| 列名 | 説明 |
|
|
88
|
-
| ------ | ------------------------------------------- |
|
|
89
|
-
| 値 | システム上の識別子。`lower-kebab-case` 推奨 |
|
|
90
|
-
| 分類名 | 正式名称。BDD/用語集と整合させる |
|
|
91
|
-
| 表示名 | UI や現場で使用される表示用名称 |
|
|
92
|
-
| 説明 | 値の意味・成立条件など |
|
|
93
|
-
|
|
94
|
-
## 3. 分類の種類別のルール
|
|
95
|
-
|
|
96
|
-
### 3.1 業務分類(Business Classification)
|
|
97
|
-
|
|
98
|
-
#### 特徴
|
|
99
|
-
|
|
100
|
-
- 業務ロジック上必然的に存在する分類
|
|
101
|
-
- 値は少数で固定的
|
|
102
|
-
- システム実装に強く依存しない
|
|
103
|
-
|
|
104
|
-
#### BDD での扱い
|
|
105
|
-
|
|
106
|
-
- 値が少ない場合は BDD の `type: enum` として記載してよい。
|
|
107
|
-
|
|
108
|
-
---
|
|
109
|
-
|
|
110
|
-
### 3.2 コード表(System Code List)
|
|
111
|
-
|
|
112
|
-
#### 特徴
|
|
113
|
-
|
|
114
|
-
- システム内で使用される **コード値の一覧**
|
|
115
|
-
- 多くの場合 **マスターテーブルとして管理すべき**
|
|
116
|
-
- 外部連携や識別子として利用される
|
|
117
|
-
|
|
118
|
-
#### マスターテーブル化すべき条件
|
|
119
|
-
|
|
120
|
-
以下のいずれかを満たす:
|
|
121
|
-
|
|
122
|
-
- 値が多い(10以上)
|
|
123
|
-
- 追加・変更・廃止の可能性がある
|
|
124
|
-
- 外部システム連携や帳票に必要
|
|
125
|
-
- 多言語化が必要
|
|
126
|
-
- BDD enum では収まらないメタ情報がある(例:税率、期間)
|
|
127
|
-
|
|
128
|
-
#### BDD enum で良いケース
|
|
129
|
-
|
|
130
|
-
- 値が3〜5個以下
|
|
131
|
-
- 業務ルールで固定されている
|
|
132
|
-
- ラベル変更の可能性が低い
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
### 3.3 動的分類(Dynamic Classification)
|
|
137
|
-
|
|
138
|
-
#### 特徴
|
|
139
|
-
|
|
140
|
-
- ユーザーが自由に追加・編集・削除可能
|
|
141
|
-
- タグ、ラベル、フォルダ分類などに用いられる
|
|
142
|
-
|
|
143
|
-
#### BDD の enum にしてはいけない
|
|
144
|
-
|
|
145
|
-
- 値の増減に対応できず仕様が破綻するため
|
|
146
|
-
|
|
147
|
-
#### BDD での扱い
|
|
148
|
-
|
|
149
|
-
- type: `string` または `reference` とする
|
|
150
|
-
|
|
151
|
-
#### 標準列
|
|
152
|
-
|
|
153
|
-
| 値 | 作成者 | 説明 |
|
|
154
|
-
|
|
155
|
-
---
|
|
156
|
-
|
|
157
|
-
## 4. BDD との関係(重要)
|
|
158
|
-
|
|
159
|
-
| 分類種類 | BDD の扱い |
|
|
160
|
-
| -------- | ---------------------------- |
|
|
161
|
-
| 業務分類 | enum 可能 |
|
|
162
|
-
| コード表 | enum または マスターテーブル |
|
|
163
|
-
| 動的分類 | enum 禁止、別テーブルで管理 |
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
|
|
167
|
-
## 5. サンプル(商品区分)
|
|
168
|
-
|
|
169
|
-
### 5.1 メタデータ
|
|
170
|
-
|
|
171
|
-
```yaml
|
|
172
|
-
---
|
|
173
|
-
id: cll-product-type
|
|
174
|
-
type: data
|
|
175
|
-
title: 商品区分
|
|
176
|
-
status: draft
|
|
177
|
-
supersedes: []
|
|
178
|
-
---
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
### 5.2 分類定義
|
|
182
|
-
|
|
183
|
-
| 定義項目 | 内容 |
|
|
184
|
-
| ---------------- | ---------------------- |
|
|
185
|
-
| 対象エンティティ | 商品 |
|
|
186
|
-
| 分類定義名 | 商品区分 |
|
|
187
|
-
| 種別 | 業務分類 |
|
|
188
|
-
| 説明 | 商品の業務上の上位分類 |
|
|
189
|
-
|
|
190
|
-
### 5.3 値一覧
|
|
191
|
-
|
|
192
|
-
| 値 | 分類名 | 表示名 | 説明 |
|
|
193
|
-
| ----- | ------ | -------- | ---------- |
|
|
194
|
-
| snack | お菓子 | おやつ | 食品系商品 |
|
|
195
|
-
| toy | 玩具 | おもちゃ | 玩具類 |
|
|
196
|
-
| drink | 飲料 | ドリンク | 飲み物類 |
|
|
20
|
+
- 新しい成果物は `cld-<term>` ではなく `cdt-<term>` として作成し、[[specdojo:cdt-rulebook|分類一覧作成ルール]] を参照します。
|
|
21
|
+
- 既存の `cld-*` 成果物やカタログ定義は、[[specdojo:id-and-file-naming-standard|ドキュメントIDおよびファイル命名標準]] の経路 B に従って `cdt-*` へ切り替えます。
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:clis-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: ui
|
|
6
|
+
status: draft
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: specdojo:clis-sample
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# CLI仕様(CLIS)作成ルール
|
|
16
|
+
|
|
17
|
+
Command Line Interface Specification (CLIS) Authoring Rule
|
|
18
|
+
|
|
19
|
+
システム自身が提供する CLI コマンド群について、利用目的、操作の流れ、入出力の要点、終了時の判断と回復を定義する基準を定めます。
|
|
20
|
+
|
|
21
|
+
## 1. 全体方針
|
|
22
|
+
|
|
23
|
+
- 1 ファイルは一つの業務目的または機能領域のコマンド群とし、利用者の課題と達成結果を対応付けます。
|
|
24
|
+
- 人の直接操作と自動実行の設定・監視について、対象者、開始条件、結果の確認方法を記述します。
|
|
25
|
+
- CLIS は利用者側の操作仕様として `ui`、システムが外部コマンドを呼ぶ契約は `ifx-cmd` として `api` に分類します。
|
|
26
|
+
- 構文・引数・既定値はコマンドリファレンス、データの値・構造はファイル仕様・schema・連携契約を正本とし、操作の選択と結果の判断に必要な要点を残します。
|
|
27
|
+
- 共通事項は上位の索引、個別仕様は差分と参照先を示します。索引が未作成なら、その旨と作成後の照合対象を記録します。
|
|
28
|
+
- 推奨表の列は必須情報を保って統合できます。
|
|
29
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
30
|
+
|
|
31
|
+
## 2. 位置づけ
|
|
32
|
+
|
|
33
|
+
CLIS は業務プロセス仕様やシステム化機能を受け、利用者とシステムの操作境界を定めます。
|
|
34
|
+
|
|
35
|
+
```mermaid
|
|
36
|
+
graph TD
|
|
37
|
+
SF["システム化機能 (sf)"] --> CLIS["CLI仕様 (clis)<br/>利用者視点の操作フロー・入力情報と出力情報・次の手"]
|
|
38
|
+
CLIS -.->|"構文・引数の正本参照"| CMDREF["コマンドリファレンス (command-reference)<br/>コマンド構文・オプション詳細の正本"]
|
|
39
|
+
CLIS -.->|"中身の正本参照"| IN["入力情報の仕様<br/>ファイル・API・外部コマンド等の正本"]
|
|
40
|
+
CLIS -.->|"中身の正本参照"| OUT["出力情報の仕様<br/>ファイル・API・外部コマンド等の正本"]
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## 3. ファイル命名・ID規則
|
|
44
|
+
|
|
45
|
+
命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
46
|
+
|
|
47
|
+
- ファイル名は `clis-<機能名またはコマンド群名>.md` とします。例: `clis-exec-commands.md`。
|
|
48
|
+
- ID はプロダクト文書が `clis-<kebab-case>`、プロジェクト文書が `<project-id>:clis-<kebab-case>`、同梱の完成例が `specdojo:` 付きとします。
|
|
49
|
+
- H1 はコマンド名だけでなく、対象の機能領域を識別できる名前にします。
|
|
50
|
+
|
|
51
|
+
## 4. 推奨 Frontmatter 項目
|
|
52
|
+
|
|
53
|
+
共通項目と制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。
|
|
54
|
+
|
|
55
|
+
- `type` は本 rulebook の `deliverable_type` に対応する `ui`、`rulebook` は `specdojo:clis-rulebook` とします。
|
|
56
|
+
- `part_of` は所属する索引、`based_on` は根拠とした業務プロセス・システム化機能等を示し、カタログの依存関係と照合します。
|
|
57
|
+
- 未作成の依存先や根拠を接続できない理由は「メモ / 将来課題」へ記録します。
|
|
58
|
+
|
|
59
|
+
## 5. 本文要件
|
|
60
|
+
|
|
61
|
+
次の順に構成し、「入力と出力の要点」は「入力情報」「出力情報」に分けます。
|
|
62
|
+
|
|
63
|
+
| 章 | 必須・任意 | 目的と内容要件 |
|
|
64
|
+
| -------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------ |
|
|
65
|
+
| 概要 | 必須 | コマンド群で達成する結果と対象範囲を 1〜2 文で示す |
|
|
66
|
+
| 利用目的と対象ユーザー | 必須 | 対象者の課題、対象外の操作と引き渡し先、手順・完了判断の確認者を示す |
|
|
67
|
+
| 操作の流れ | 必須 | 開始条件、標準経路、分岐、中断・再開、完了時の確認結果を示す |
|
|
68
|
+
| 操作とコマンド参照 | 必須 | 操作・コマンドと構文の正本を対応付ける。フローで意味が分かれば説明列は任意 |
|
|
69
|
+
| 入力と出力の要点 | 必須 | 受け取るものと送り出すものを分離し、対象・役割・正本と入力失敗時の扱いを示す |
|
|
70
|
+
| 終了コードとエラー表示・利用者の次の手 | 必須 | 正常・警告・異常の判断、表示要点、回復条件と操作。対象なし・スキップも扱う |
|
|
71
|
+
| メモ / 将来課題 | 任意 | 未作成の参照先、未確認の動作、未決事項の論点と影響・当面の扱いを示す。該当事項があれば省略しない |
|
|
72
|
+
|
|
73
|
+
## 6. 記述ガイド
|
|
74
|
+
|
|
75
|
+
完成例は frontmatter の `sample` を参照します。
|
|
76
|
+
|
|
77
|
+
### 6.1. 概要
|
|
78
|
+
|
|
79
|
+
- 判断基準: 達成結果と引き継ぐものが分かること。内部処理は含めません。
|
|
80
|
+
- 良い例: 「作業指示の準備から実行・進捗確認・再開をつなぎ、結果と判断を次の担当者へ引き継ぐコマンド群。」
|
|
81
|
+
- 悪い例: 「引数を解析し、内部関数を呼び出す CLI。」利用者が得る結果を判断できません。
|
|
82
|
+
|
|
83
|
+
### 6.2. 利用目的と対象ユーザー
|
|
84
|
+
|
|
85
|
+
- 判断基準: 対象者と達成結果が対応し、操作・結果確認・合意の役割が分かること。自動実行は設定・監視する人も示します。
|
|
86
|
+
- 良い例: 「運用者は停止した作業の状態と残存成果を確認して再開する。レビュー担当は記録から完了条件の充足を確認する。」
|
|
87
|
+
- 悪い例: 「対象は全ユーザー。目的はコマンドの実行。」課題、達成結果、確認者が特定できません。
|
|
88
|
+
|
|
89
|
+
### 6.3. 操作の流れ
|
|
90
|
+
|
|
91
|
+
- 判断基準: 開始前から結果確認まで進め、分岐を選べること。中断時は同じ試行の再開と新規のやり直しを区別し、保持成果と再開先を示します。
|
|
92
|
+
- 順序付きリストまたは Mermaid を使い、併用時は分岐と選択条件などを分担します。状態や実行主体の固有語は初出で定義または正本へ案内します。
|
|
93
|
+
- 良い例: 「状況確認 → 対象を選んで実行 → 記録と差分で結果を確認。中断時は保存済みの試行と成果を確認して該当段から再開する。」
|
|
94
|
+
- 悪い例: 「実行後は常に完了。失敗したら最初から実行。」業務上の完了確認と既存成果の扱いが欠けます。
|
|
95
|
+
|
|
96
|
+
### 6.4. 操作とコマンド参照
|
|
97
|
+
|
|
98
|
+
- 判断基準: 操作からコマンドと構文の正本を特定できること。該当する小節があればそこへ、なければ章へ接続します。
|
|
99
|
+
- 推奨列は「操作」「対象コマンド」「正本リファレンス」。用途を選べなくなるコマンドは行を分け、フローにない操作の意味はここで補います。
|
|
100
|
+
- 良い例: 「状況確認 → `exec status` → [[specdojo:command-reference#7-exec|CLIコマンドリファレンス: exec]]」。
|
|
101
|
+
- 悪い例: 全フラグの型・既定値・組合せを表へ転載する。構文の変更を二重管理することになります。
|
|
102
|
+
|
|
103
|
+
### 6.5. 入力と出力の要点
|
|
104
|
+
|
|
105
|
+
判断基準は、情報の方向、利用する操作、目的、中身の正本を追えることです。入力・出力を表に分け、操作は専用列か対象欄で識別します。同じ扱いの操作はまとめ、該当なし行は作りません。
|
|
106
|
+
|
|
107
|
+
#### 6.5.1. 入力情報
|
|
108
|
+
|
|
109
|
+
- 入力は CLI が受け取るもの。必須情報は「種類」「対象」「役割」「正本の参照」「ない/壊れている/届かないときの扱い」。ファイル、標準入力、対話、環境変数、API 応答、外部処理の結果を確認します。
|
|
110
|
+
- 失敗時は停止・代替・再入力・警告継続を区別し、対応する事象名または参照でエラー章につなげます。欠落と破損で扱いが異なれば分けて示します。
|
|
111
|
+
- 良い例: 「設定ファイルを実行条件の解決に使う。中身は schema を参照し、欠落時は既定設定、破損時は『設定不正』として停止する。」
|
|
112
|
+
- 悪い例: 「設定を読む。なければ適切に処理する。」停止するか続行するかを判断できません。
|
|
113
|
+
|
|
114
|
+
#### 6.5.2. 出力情報
|
|
115
|
+
|
|
116
|
+
- 出力は CLI が外へ送り出すもの。必須情報は「種類」「対象」「役割」「正本の参照」。標準出力・標準エラー、ファイルの作成・更新、外部への送信・起動を扱います。
|
|
117
|
+
- 表示先は契約に合わせ、標準出力に診断が出る場合も区別します。表示要点は利用者が確認する内容に絞ります。
|
|
118
|
+
- 良い例: 「実行記録を保存し、次の担当が結果と再開段を確認する。項目と形式は記録の schema を参照する。」
|
|
119
|
+
- 悪い例: 保存する JSON の全フィールドや API のペイロードを列挙する。中身の正本と重複します。
|
|
120
|
+
|
|
121
|
+
#### 6.5.3. 正本の選び方と参照の境界
|
|
122
|
+
|
|
123
|
+
| 対象 | 中身を委ねる正本 | CLIS に残す判断情報 |
|
|
124
|
+
| -------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
|
125
|
+
| ファイル | 対象の rulebook または schema | どの操作で読み書きするか、用途、欠落・破損時の扱い |
|
|
126
|
+
| 外部 API | [[specdojo:ifx-api-rulebook\|外部API仕様作成ルール]] に従う契約 | 呼ぶ目的、送信と応答の方向、接続不能・時間切れ・拒否時の扱い |
|
|
127
|
+
| 自システム API | [[specdojo:sysd-index-rulebook\|システム設計索引作成ルール]] に従う索引が案内する内部 API 定義 | 名前と用途。定義が未作成なら詳細を仮定しない |
|
|
128
|
+
| 外部コマンド | [[specdojo:ifx-cmd-rulebook\|外部コマンド連携仕様作成ルール]] に従う契約 | 起動する目的、渡すもの、受け取る結果、失敗時の扱い |
|
|
129
|
+
|
|
130
|
+
- API への送信は出力、応答は入力です。取得と更新を兼ねる呼出しは両方に挙げます。外部コマンドも起動を出力、実行結果を入力に挙げます。
|
|
131
|
+
- 未作成の正本は ID かファイル名をインラインコードで示し、その旨と影響を記録します。独立した正本が不要な対話表示などは、理由を添えて参照なしとします。
|
|
132
|
+
- 成果物本文では別の型の sample を契約例として参照できます。学習例と実案件を区別し、対象操作と用途を示します。本型の sample・recipe・template の対応宣言とは別です。
|
|
133
|
+
|
|
134
|
+
### 6.6. 終了コードとエラー表示・利用者の次の手
|
|
135
|
+
|
|
136
|
+
- 判断基準: 発生条件、終了コードの意味、表示要点、次の確認・操作から完了・回復を判定できること。表示から分からない原因は補います。
|
|
137
|
+
- 終了コードの値と伝播は対象コマンドの正本に従い、外部処理のコードを CLI 全体へ一律に当てはめません。警告継続・対象なし・スキップは、正常終了でも未実施・未完了になり得るかを示します。
|
|
138
|
+
- 再試行の前に確認する状態・保持成果・担当を示します。再実行で二重処理や成果の消失が起こり得る場合は、回避条件を記述します。
|
|
139
|
+
- 良い例: 「対象なしの正常終了は新規作業の完了を意味しない。運用者は依存関係と対象条件を確認してから選択をやり直す。」
|
|
140
|
+
- 悪い例: 「非ゼロなら再実行する。」原因の解消、残存成果、再開先が判断できません。
|
|
141
|
+
|
|
142
|
+
入出力章は表示先・役割、次の推奨表は事象ごとの判断と回復を扱います。
|
|
143
|
+
|
|
144
|
+
| 列 | 記述する内容 |
|
|
145
|
+
| -------------- | ---------------------------------------------------------------------- |
|
|
146
|
+
| 事象・条件 | 正常、警告、異常を分ける条件。入力章の事象名と対応させる |
|
|
147
|
+
| 終了コード | 正本で定義された値または参照。経路で異なる場合は適用条件を付ける |
|
|
148
|
+
| 表示要点 | 利用者が事象を識別する情報。出力先が分かれる場合はその区別 |
|
|
149
|
+
| 利用者の次の手 | 担当者、確認対象、再開・再入力・引き継ぎ等の操作と回復を確認できる結果 |
|
|
150
|
+
|
|
151
|
+
### 6.7. メモ / 将来課題
|
|
152
|
+
|
|
153
|
+
- 判断基準: 確定仕様と未確定事項を区別し、影響する操作・回復経路と当面の扱いが分かること。
|
|
154
|
+
- 良い例: 「外部 agent 契約は未作成。終了状態と再開条件が決まるまで、当該経路の受入判断を保留する。」
|
|
155
|
+
- 悪い例: 「今後検討する。」論点と影響する経路が分かりません。
|
|
156
|
+
|
|
157
|
+
## 7. 禁止事項
|
|
158
|
+
|
|
159
|
+
| 禁止する記述 | 理由 |
|
|
160
|
+
| -------------------------------------------- | -------------------------------------------------------- |
|
|
161
|
+
| 構文・値・構造・実装詳細の正本の再掲 | 引数表、ペイロード、内部クラス、SQL 等の二重管理を避ける |
|
|
162
|
+
| 外部コマンド連携契約や GUI レイアウトの混入 | 利用者の CLI 操作という責務を保つ |
|
|
163
|
+
| 入力と出力の混同、正本未作成を隠したリンク | 情報の方向と仕様の確定範囲を誤認させる |
|
|
164
|
+
| 次の手を伴わないエラー列挙、一律の再実行指示 | 回復条件を判断できず、二重処理や成果消失につながる |
|
|
165
|
+
|
|
166
|
+
## 8. 運用ルール
|
|
167
|
+
|
|
168
|
+
- コマンド構文だけの変更は正本へ反映し、参照先を確認します。利用目的、操作の流れ、入出力の要点、終了時の判断、回復条件が変わる場合は CLIS も改訂します。
|
|
169
|
+
- 受入確認では標準経路・分岐と入力失敗・警告・異常をたどり、表示・終了コード・保持成果・次の操作を正本と照合します。
|
|
170
|
+
- 完了・回復が期待結果と一致し、二重処理・成果消失を避ける再試行条件を確認できれば合格とします。
|
|
@@ -16,75 +16,57 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
C4 Container Diagram (CND) Documentation Rules using Mermaid
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
C4 コンテナ図は「対象システム」を、**実行/配備単位(コンテナ)** に分割して俯瞰し、利用者(人)・外部システム・データストアとの関係(やり取り)を、概念レベルで合意するために用います。
|
|
22
|
-
|
|
23
|
-
---
|
|
19
|
+
C4 コンテナ図を Mermaid の `flowchart` で表す記法を定めます。文書の命名・メタ情報・本文要件と要素の選定は [[specdojo:cnd-rulebook|C4コンテナ図作成ルール]] に従います。
|
|
24
20
|
|
|
25
21
|
## 1. 全体方針
|
|
26
22
|
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
- 1つの図には **対象システムを1つ**だけ置く(複数対象は図を分ける)。
|
|
31
|
-
|
|
32
|
-
---
|
|
23
|
+
- 一つの図には一つの対象システムを置き、コンポーネント・クラスなどの内部構造は描きません。
|
|
24
|
+
- 図は詳細の量より、境界・接続の解釈が割れないことを優先します。
|
|
25
|
+
- **共通の運用**: 役割は適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱います。
|
|
33
26
|
|
|
34
27
|
## 2. C4要素と Mermaid 記号の対応
|
|
35
28
|
|
|
36
|
-
C4
|
|
29
|
+
| C4要素 | Mermaid での表現例 |
|
|
30
|
+
| ---------------------------------------- | --------------------------------------- |
|
|
31
|
+
| Person(人/ロール) | `店員["店員"]` |
|
|
32
|
+
| Container(コンテナ) | `Webアプリ("Webアプリ<br>(React)")` |
|
|
33
|
+
| Database(データベース) | `販売DB[("販売DB")]` |
|
|
34
|
+
| External Software System(外部システム) | `会計システム["会計システム"]` |
|
|
35
|
+
| System Boundary(境界) | `subgraph 境界["対象システム"] ... end` |
|
|
36
|
+
| Relationship(関係) | `店員 -->\|"売上登録"\| Webアプリ` |
|
|
37
37
|
|
|
38
|
-
|
|
39
|
-
| ---------------------------------------- | ---------------------------------- | -------------------------------------------------------------------- |
|
|
40
|
-
| Person(人/ロール) | 利用者・関係者 | `店員["店員"]` |
|
|
41
|
-
| Container(コンテナ) | 実行/配備単位(Web/API/バッチ等) | `Webアプリ("Webアプリ<br>(React)")` |
|
|
42
|
-
| Database(データベース) | 永続データストア | `販売DB[("販売DB")]` |
|
|
43
|
-
| External Software System(外部システム) | 連携先システム | `会計システム["会計システム"]` |
|
|
44
|
-
| System Boundary(境界) | 対象システムの範囲 | `subgraph 境界["対象システム"] ... end` |
|
|
45
|
-
| Relationship(関係) | 利用・連携・参照・データ入出力概念 | `店員 -->\|"売上登録"\| Webアプリ`/`API --> \|"売上データ"\| 販売DB` |
|
|
38
|
+
### 2.1. 標準の色分け(推奨)
|
|
46
39
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
## 2.1 標準の色分け(推奨)
|
|
50
|
-
|
|
51
|
-
C4コンテナ図は色が必須ではありませんが、読み手が「人 / 対象システム内の要素 / 外部システム」を一目で区別できるよう、以下の色分けを推奨します。
|
|
40
|
+
色は任意で、次の区分を推奨します。
|
|
52
41
|
|
|
53
42
|
- Person(人/ロール): 暖色系
|
|
54
43
|
- 対象システム内(Container / Database): 寒色系(主役)
|
|
55
44
|
- 外部システム(External System): 無彩色系(脇役)
|
|
56
45
|
- 境界(System Boundary): 破線枠
|
|
57
46
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### 2.1.1 標準スタイル定義(コピーして利用)
|
|
61
|
-
|
|
62
|
-
※ 既存の C4 コンテキスト図(CXD)と同じ色指定を利用します。
|
|
47
|
+
#### 2.1.1. 標準スタイル定義(コピーして利用)
|
|
63
48
|
|
|
64
49
|
```mermaid
|
|
65
50
|
flowchart LR
|
|
66
|
-
%% --- Standard styles (recommended) ---
|
|
67
51
|
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
68
52
|
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
69
53
|
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
70
54
|
|
|
71
|
-
%% System boundary style (subgraph)
|
|
72
|
-
%% NOTE: '境界' は subgraph のID(名前)に合わせる
|
|
73
55
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
74
56
|
```
|
|
75
57
|
|
|
76
|
-
|
|
58
|
+
#### 2.1.2. 適用ルール
|
|
77
59
|
|
|
78
60
|
- Personノードには `person` クラスを付ける
|
|
79
61
|
- 対象システム内の Container / Database には `system` クラスを付ける
|
|
80
62
|
- 外部システムノードには `external` クラスを付ける
|
|
81
|
-
- 境界は `subgraph 境界[...]` として、`style 境界 ...`
|
|
82
|
-
|
|
83
|
-
---
|
|
63
|
+
- 境界は `subgraph 境界[...]` として、`style 境界 ...` で枠線を指定する。`境界` は実際のサブグラフ ID に合わせる
|
|
84
64
|
|
|
85
65
|
## 3. ノードのルール
|
|
86
66
|
|
|
87
|
-
|
|
67
|
+
以下の例は形状とラベルを示します。色の適用は「標準の色分け(推奨)」に従います。
|
|
68
|
+
|
|
69
|
+
### 3.1. Person(人/ロール)
|
|
88
70
|
|
|
89
71
|
- **四角 `[]`** を使用する。
|
|
90
72
|
- 表示ラベルは業務ロール/主体を短い日本語で表す。
|
|
@@ -95,12 +77,9 @@ flowchart LR
|
|
|
95
77
|
flowchart LR
|
|
96
78
|
店員["👤店員"]
|
|
97
79
|
店主["👤店主"]
|
|
98
|
-
|
|
99
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
100
|
-
class 店員,店主 person;
|
|
101
80
|
```
|
|
102
81
|
|
|
103
|
-
### 3.2 Container(コンテナ)
|
|
82
|
+
### 3.2. Container(コンテナ)
|
|
104
83
|
|
|
105
84
|
- **角丸長方形 `()`** を使用する。
|
|
106
85
|
- 表示ラベルは「コンテナ名(+必要なら技術/役割の短い補足)」とする。
|
|
@@ -112,30 +91,24 @@ flowchart LR
|
|
|
112
91
|
flowchart LR
|
|
113
92
|
Webアプリ("Webアプリ<br>(レジ/管理画面)")
|
|
114
93
|
API("API<br>(販売/在庫)")
|
|
115
|
-
|
|
116
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
117
|
-
class Webアプリ,API system;
|
|
118
94
|
```
|
|
119
95
|
|
|
120
|
-
### 3.3 Database(データベース)
|
|
96
|
+
### 3.3. Database(データベース)
|
|
121
97
|
|
|
122
98
|
- **円柱ノード `[(...)]`** を使用する。
|
|
123
|
-
- DB
|
|
99
|
+
- DBの論理名を短く書く。
|
|
124
100
|
|
|
125
101
|
例:
|
|
126
102
|
|
|
127
103
|
```mermaid
|
|
128
104
|
flowchart LR
|
|
129
105
|
販売DB[("販売DB")]
|
|
130
|
-
|
|
131
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
132
|
-
class 販売DB system;
|
|
133
106
|
```
|
|
134
107
|
|
|
135
|
-
### 3.4 External Software System(外部システム)
|
|
108
|
+
### 3.4. External Software System(外部システム)
|
|
136
109
|
|
|
137
110
|
- **四角 `[]`** を使用する。
|
|
138
|
-
-
|
|
111
|
+
- 表示ラベルは外部システムの一般名とする。
|
|
139
112
|
|
|
140
113
|
例:
|
|
141
114
|
|
|
@@ -143,16 +116,12 @@ flowchart LR
|
|
|
143
116
|
flowchart LR
|
|
144
117
|
会計システム["会計システム"]
|
|
145
118
|
決済サービス["決済サービス"]
|
|
146
|
-
|
|
147
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
148
|
-
class 会計システム,決済サービス external;
|
|
149
119
|
```
|
|
150
120
|
|
|
151
|
-
### 3.5 System Boundary(境界)
|
|
121
|
+
### 3.5. System Boundary(境界)
|
|
152
122
|
|
|
153
123
|
- 対象システムは **サブグラフ `subgraph ... end`** で囲う。
|
|
154
|
-
-
|
|
155
|
-
- 境界内の要素を増やしすぎない(詳細化はコンポーネント図へ)。
|
|
124
|
+
- 境界内に置く要素の選定基準は主 rulebook に従う。
|
|
156
125
|
|
|
157
126
|
例:
|
|
158
127
|
|
|
@@ -163,17 +132,11 @@ flowchart LR
|
|
|
163
132
|
API("API")
|
|
164
133
|
販売DB[("販売DB")]
|
|
165
134
|
end
|
|
166
|
-
|
|
167
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
168
|
-
class Webアプリ,API,販売DB system;
|
|
169
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
170
135
|
```
|
|
171
136
|
|
|
172
|
-
---
|
|
173
|
-
|
|
174
137
|
## 4. エッジ(関係)のルール
|
|
175
138
|
|
|
176
|
-
### 4.1 方向
|
|
139
|
+
### 4.1. 方向
|
|
177
140
|
|
|
178
141
|
- `A --> B` を基本とする。
|
|
179
142
|
- 方向は「主たる依存/利用/送信の向き」が分かるように統一する。
|
|
@@ -181,23 +144,19 @@ flowchart LR
|
|
|
181
144
|
- 例: コンテナ間の呼び出し: `Webアプリ -->|"API呼び出し"| API`
|
|
182
145
|
- 例: DBへの入出力: `API -->|"売上データ"| 販売DB`
|
|
183
146
|
|
|
184
|
-
### 4.2 ラベル
|
|
147
|
+
### 4.2. ラベル
|
|
185
148
|
|
|
186
|
-
-
|
|
149
|
+
- すべてのエッジにラベルを付ける。
|
|
187
150
|
- ラベルは **短い名詞句**または **短い動詞句**で書く。
|
|
188
151
|
- 例: `売上登録` / `在庫照会` / `会計仕訳連携` / `決済結果を受信`
|
|
189
152
|
- 長い場合は `<br>` で改行してよい。
|
|
190
153
|
|
|
191
|
-
---
|
|
192
|
-
|
|
193
154
|
## 5. 命名・表記ルール
|
|
194
155
|
|
|
195
|
-
- ノードID
|
|
196
|
-
- 表示ラベルは `"..."`
|
|
156
|
+
- ノードIDは日本語でもよいが、記号や空白は避け、短い識別子にする。
|
|
157
|
+
- 表示ラベルは `"..."` で囲ってよい。
|
|
197
158
|
- 同じ主体/システム/コンテナ/DBは、図の中で名称を揺らさない。
|
|
198
159
|
|
|
199
|
-
---
|
|
200
|
-
|
|
201
160
|
## 6. 禁止事項
|
|
202
161
|
|
|
203
162
|
| 項目 | 理由 |
|
|
@@ -209,27 +168,21 @@ flowchart LR
|
|
|
209
168
|
| コンポーネント/クラス等の内部構造の詳細 | コンポーネント図/実装設計で表す |
|
|
210
169
|
| 矢印ラベルなしの関係 | 合意が取れない |
|
|
211
170
|
|
|
212
|
-
---
|
|
213
|
-
|
|
214
171
|
## 7. サンプル(最小)
|
|
215
172
|
|
|
216
173
|
```mermaid
|
|
217
174
|
flowchart LR
|
|
218
|
-
%% Person
|
|
219
175
|
店員["👤店員"]
|
|
220
176
|
|
|
221
|
-
%% External Systems
|
|
222
177
|
会計システム["会計システム"]
|
|
223
178
|
決済サービス["決済サービス"]
|
|
224
179
|
|
|
225
|
-
%% Target System Boundary
|
|
226
180
|
subgraph 境界["対象システム"]
|
|
227
181
|
Webアプリ("Webアプリ<br>(レジ/管理画面)")
|
|
228
182
|
API("API<br>(販売/在庫)")
|
|
229
183
|
販売DB[("販売DB")]
|
|
230
184
|
end
|
|
231
185
|
|
|
232
|
-
%% Relationships
|
|
233
186
|
店員 -->|"売上登録"| Webアプリ
|
|
234
187
|
Webアプリ -->|"API呼び出し"| API
|
|
235
188
|
API -->|"売上データ"| 販売DB
|
|
@@ -238,7 +191,6 @@ flowchart LR
|
|
|
238
191
|
API -->|"決済依頼"| 決済サービス
|
|
239
192
|
決済サービス -->|"決済結果"| API
|
|
240
193
|
|
|
241
|
-
%% Styles
|
|
242
194
|
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
243
195
|
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
244
196
|
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
@@ -248,11 +200,9 @@ flowchart LR
|
|
|
248
200
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
249
201
|
```
|
|
250
202
|
|
|
251
|
-
---
|
|
252
|
-
|
|
253
203
|
## 8. 凡例(推奨)
|
|
254
204
|
|
|
255
|
-
|
|
205
|
+
必要な場合に置きます。
|
|
256
206
|
|
|
257
207
|
```mermaid
|
|
258
208
|
flowchart LR
|
|
@@ -273,7 +223,6 @@ flowchart LR
|
|
|
273
223
|
Web -->|"Relationship(関係)"| 外部
|
|
274
224
|
end
|
|
275
225
|
|
|
276
|
-
%% Styles
|
|
277
226
|
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
278
227
|
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
279
228
|
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
@@ -282,5 +231,3 @@ flowchart LR
|
|
|
282
231
|
class 外部 external;
|
|
283
232
|
style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
284
233
|
```
|
|
285
|
-
|
|
286
|
-
---
|