specdojo 0.7.0 → 0.8.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 +3 -2
- package/CHANGELOG.md +153 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/init.js +5 -1
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +612 -259
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +8 -6
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +9 -4
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/yaml-pages.js +125 -3
- package/dist/exec/agent-config.js +22 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/commands.js +69 -21
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +159 -8
- package/dist/exec/evidence.js +64 -16
- 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 +153 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +48 -25
- 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/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +8 -4
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +85 -24
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +109 -0
- package/dist/exec/run/agent-pipeline.js +75 -6
- package/dist/exec/run/agent.js +20 -7
- package/dist/exec/run/in-place.js +69 -32
- package/dist/exec/run/job.js +81 -24
- package/dist/exec/run/lifecycle-commands.js +188 -36
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +6 -10
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +12 -12
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +28 -18
- package/dist/exec/run/register-state.js +10 -7
- package/dist/exec/run/register-worktree.js +60 -30
- package/dist/exec/run/schedule-mode.js +4 -4
- package/dist/exec/run/schedule-prepare.js +201 -59
- package/dist/exec/run/schedule-task.js +129 -25
- package/dist/exec/run/shared.js +4 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/strategy.js +1 -0
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +3 -2
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/worktree-command.js +29 -16
- 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 +19 -2
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-inspect.js +2 -2
- package/dist/grade/command-run.js +2 -0
- 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 +23 -3
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/job.js +31 -17
- package/dist/job/noop.js +104 -0
- 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 +4 -1
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +43 -9
- 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 +4 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +56 -32
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +1 -0
- 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 +2 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/deprecation.js +8 -0
- 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.js +142 -15
- package/dist/shared/grade-result.js +17 -1
- 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 +39 -21
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -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 +47 -16
- package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- 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 +70 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
- 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 +14 -8
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
- 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/recipes/bac-recipe.md +94 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
- package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +36 -24
- package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
- package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
- package/docs/ja/specdojo/references/command-reference.md +79 -64
- package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +56 -35
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
- 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 +100 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
- package/docs/ja/specdojo/samples/bes-sample.md +80 -21
- package/docs/ja/specdojo/samples/br-sample.md +68 -14
- package/docs/ja/specdojo/samples/ccd-sample.md +81 -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/cdsd-sample.md +89 -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 +132 -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/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-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/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
- package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
- package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
- package/docs/ja/specdojo/samples/sf-sample.md +121 -21
- package/docs/ja/specdojo/samples/sld-sample.md +107 -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 +164 -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/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/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 +3 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +53 -3
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -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/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/package.json +2 -2
- package/templates/antigravity/orchestrator.md +3 -2
- package/templates/claude/agents/specdojo-orchestrator.md +3 -2
- package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
- package/templates/codex/orchestrator.md +3 -2
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -24,8 +24,8 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
24
24
|
## 1. 全体方針
|
|
25
25
|
|
|
26
26
|
- 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID と、そのユースケースまたは系統を詳細化します。描く単位と詳細化の境界は「描き方の選択」に従います。
|
|
27
|
-
-
|
|
28
|
-
- 渡す情報・物は図の線のラベルで表します。引き渡し条件のイベントや引き渡し ID
|
|
27
|
+
- 開始から終了までの横断順序と受け渡しは「概念データフロー」の図だけを正本とします。「プロセス領域」は責務の正本であり、順序欄と章冒頭の通過順は図に一致させる対応表現です。不一致時は図を根拠に表・通過順を修正し、業務上の順序を変更するときは図を改訂してから追従させます。「データストア」は全体概要の一覧の部分集合とし、主要入力・主要出力の箇条書きや引き渡しを列挙する章は設けません。
|
|
28
|
+
- 渡す情報・物は図の線のラベルで表します。引き渡し条件のイベントや引き渡し ID は使いません。対象範囲の例外時の戻りは省略せず、線が多い場合は図を分けます。
|
|
29
29
|
- 詳細の図に Orchestrator(調整役)を置きません。調整は全体概要の「Orchestrator による PDCA の調整」などの指示の図へ委ねます。
|
|
30
30
|
- 目的はその業務が何のためにあるかを 1〜2 文、適用範囲は対象と対象外を 1 行ずつとします。人間と AI Agent の責任分担などの共通原則と凡例は、全体概要を参照し、本書で再定義しません。
|
|
31
31
|
- 状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。本書は状態の定義や遷移表を持ちません。
|
|
@@ -40,7 +40,7 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
40
40
|
| 関連データストア | 対象ケースで参照・更新する、全体概要と同じ名称・区分を持つ正本 |
|
|
41
41
|
| 例外時の戻り | 不足や不一致を、補完・再判断を担う参加単位へ返す業務上の流れ |
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
全体概要がケースの業務目的と対象範囲を選定し、本書がその流れを具体化します。領域の分割、名称、担当、起点イベントは全体概要を正本とします。構造・必須項目・禁止事項の判断は本 rulebook に従い、骨組みや作成手順と矛盾する場合もこの内容要件を優先します。
|
|
44
44
|
|
|
45
45
|
## 3. ファイル命名・ID規則
|
|
46
46
|
|
|
@@ -52,35 +52,22 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
52
52
|
|
|
53
53
|
## 4. 推奨 Frontmatter 項目
|
|
54
54
|
|
|
55
|
-
|
|
56
|
-
| ---------- | ---------------------------------------- | ---- |
|
|
57
|
-
| id | プロジェクト修飾なしの `cdfd-uc-<topic>` | ○ |
|
|
58
|
-
| type | `flow` | ○ |
|
|
59
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
-
| rulebook | `specdojo:cdfd-uc-rulebook` | ○ |
|
|
61
|
-
| `based_on` | 全体概要など、有効な直接の内容根拠の ID | 任意 |
|
|
62
|
-
| supersedes | 置き換える旧ユースケース別 CDFD の ID | 任意 |
|
|
63
|
-
|
|
55
|
+
- 共通の必須項目、値・構文・構造は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と同標準が参照するスキーマに従い、本書では再定義しません。成果物種別は本 rulebook の `deliverable_type` に従います。
|
|
64
56
|
- `based_on` に全体概要を記載する場合も product 成果物 ID を使用し、成果物カタログの `depends_on` の推移閉包に含まれる根拠だけを列挙します。
|
|
65
57
|
- status が `deprecated` の文書を `based_on` と本文の参照先にしません。有効な全体概要や後継文書へ参照を更新します。
|
|
66
58
|
- ケース ID、ユースケース名、開始・終了は本文で定義し、未定義の Frontmatter 項目を追加しません。
|
|
67
|
-
-
|
|
59
|
+
- 作成・改訂中は `status: draft` を維持します。人間による `ready` 昇格の承認者・証跡と確認手順は「完成判定」に従います。
|
|
68
60
|
|
|
69
61
|
## 5. 本文要件
|
|
70
62
|
|
|
71
|
-
見出し順・表・記入欄の骨組みは template
|
|
63
|
+
見出し順・表・記入欄の骨組みは template を正本とし、本章では重複させず、必要な判断情報を定めます。
|
|
72
64
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
| 2 | 適用範囲 | ○ | 対象と対象外を 1 行ずつ。責任分担などの共通原則は全体概要を参照 |
|
|
78
|
-
| 3 | プロセス領域 | ○ | 全体概要と同じまとまりごとの節。各節は順序と役割の表のみ |
|
|
79
|
-
| 4 | データストア | ○ | 対象ケースで参照・更新する全体概要のデータストアの部分集合 |
|
|
80
|
-
| 5 | 概念データフロー | ○ | 開始・終了のイベント、参加単位、関連データストア、情報・物の流れ。各図に業務の言葉による題と説明 1 文 |
|
|
81
|
-
| 6 | 未決事項 | 条件付き | 境界、名称、責務、判断者が未確定な論点。ある場合だけ最終章に設ける |
|
|
65
|
+
- **業務の識別と境界(必須)**: 導入文でケース ID と業務名、目的で業務の存在理由と成果、適用範囲で対象と対象外を示します。共通の責任分担は全体概要へ委ねます。
|
|
66
|
+
- **責務と正本の利用(必須)**: プロセス領域で参加単位の責務と詳細化の境界を、データストアで全体概要から選んだ正本の用途を示します。各節は役割表または利用の表とし、入出力の列挙に展開しません。
|
|
67
|
+
- **流れの合意(必須)**: 概念データフローで開始・終了、参加単位、関連データストア、情報・物の受け渡しを示します。各図に業務の言葉による題と説明 1 文を付けます。
|
|
68
|
+
- **判断待ちの可視化(条件付き)**: 境界、名称、責務、判断者に未確定の論点がある場合だけ、未決事項を最終章に置きます。
|
|
82
69
|
|
|
83
|
-
「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.`
|
|
70
|
+
「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.` の節を設けます。対象範囲に例外時の戻りがある場合は、同章内の図で漏れなく示します。戻りがない場合だけ、その図を省略します。
|
|
84
71
|
|
|
85
72
|
## 6. 記述ガイド
|
|
86
73
|
|
|
@@ -96,79 +83,113 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
96
83
|
| 詳細化の境界 | グループ内部の領域・プロセス・主要例外は有効な `cdfd-<group>` へ委ねる | 対象系統と共用領域の流れを領域単位で示し、非推奨のグループ別 CDFD へ依存しない |
|
|
97
84
|
| 入口 | ケースの開始イベントを描く | 系統の入口の起点イベントを描き、文言を全体概要の「プロセス領域」の表と一致させる |
|
|
98
85
|
|
|
86
|
+
どちらの方式でも、複数の系統(ユースケース)が共通して通るプロセス領域(領域のまとまりを含む)の内部は、全体概要またはその領域の詳細文書の 1 か所だけで描きます。ほかの詳細文書では、その領域を 1 つのノードとして置き、領域との受け渡しの線だけを描きます。領域のまとまりを 1 ノードにする場合も、全体概要の名称と含む領域 ID を併記します。内部を描く文書を役割表の「参照先」に示し、内部のプロセス・データストアの読み書き・例外時の戻りを重複して展開しません。その領域から外へ返す例外の情報は、受け渡しとして省略せず描きます。
|
|
87
|
+
|
|
88
|
+
良い例: 共用する実行・評価・完了を 1 ノードにまとめ、内部の正本を参照する。悪い例: 系統ごとに共用領域の内部を描き直す。
|
|
89
|
+
|
|
99
90
|
### 6.2. 導入文と目的
|
|
100
91
|
|
|
101
|
-
-
|
|
102
|
-
- 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2
|
|
92
|
+
- 導入文は、全体概要で選んだケース ID と業務名を一文で明示します。作成手順では、ケースを選んだ直後、目的を書く前に導入文を置きます。recipe の章別ガイドに導入文の項目がない場合も、この手順を適用します。
|
|
93
|
+
- 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2 文で記述します。
|
|
103
94
|
- BA・QE・承認者など、読み手ごとの承認・設計・確認作業を目的に書きません。
|
|
104
95
|
|
|
96
|
+
良い例: 導入文は「ケース `C-02`『欠品から補充まで』の流れを示す」、目的は「欠品した商品を補充し、売場で販売できるようにする」。悪い例: ケースを特定せず、目的を「BA が承認し、QE が検証するため」とする。
|
|
97
|
+
|
|
105
98
|
### 6.3. 適用範囲
|
|
106
99
|
|
|
107
100
|
- 対象はケース ID、参加単位、開始イベント、終了時の成果、必要な組織・システム境界を 1 行(1 文)で示します。
|
|
108
101
|
- 対象外は操作手順、補助操作、実装詳細などを 1 行(1 文)で示し、詳細化の境界は「描き方の選択」に従います。状態の定義と遷移は STSD を正本とします。
|
|
109
102
|
- 人間と AI Agent の責任分担などの共通原則は、全体概要を参照します。
|
|
110
103
|
|
|
104
|
+
良い例: 対象を「在庫の補充基準割れから販売の商品引受けまで」、対象外を「内部の発注手順・状態遷移は各正本へ委ねる」と分ける。悪い例: 「補充に関する全業務」とだけ書き、内部処理との境界を決めない。
|
|
105
|
+
|
|
111
106
|
### 6.4. プロセス領域
|
|
112
107
|
|
|
113
|
-
- 章冒頭にケース ID
|
|
108
|
+
- 章冒頭にケース ID、図に従う正常系の通過順、全体概要との正本関係を簡潔に示します。条件付きの計画連携・補完だけを担う参加単位は、常に通る主経路と区別し、順序欄に「計画連携時」「補完時」など図に対応する参加場面を示します。
|
|
114
109
|
- 全体概要と同じまとまりごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名または区分名(含む領域 ID)」とします。各節には役割の表だけを置き、入力・出力やデータストアの箇条書きは置きません。
|
|
115
110
|
- 表の列は次のとおりです。同じ参加単位が再登場する場合は別の行にして役割を区別します。
|
|
116
111
|
|
|
117
112
|
| 列 | 記載内容 |
|
|
118
113
|
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
119
|
-
| 順序 |
|
|
114
|
+
| 順序 | 図から転記する正常系の通過順または条件付きの参加場面。表の独自判断で順番を定めない |
|
|
120
115
|
| プロセスグループ・区分 | 全体概要で領域をまとめている名称 |
|
|
121
116
|
| 含む領域 | 全体概要と同じ領域 ID。領域単位の行では領域名も併記し、「プロセス領域」という列名にしてよい |
|
|
122
117
|
| PDCA(任意) | 全体概要にある Plan、Do、Check、Action、全体などの位置付け。「プロセスグループ・区分」とは別の分類軸 |
|
|
123
118
|
| 横断上の役割 | このケースで担う業務上の責務 |
|
|
124
119
|
| 参照先 | 全体概要または有効な詳細文書。未作成の文書は ID をインラインコードで仮置き |
|
|
125
120
|
|
|
121
|
+
良い例: 図の在庫→仕入→販売に合わせて順序欄を 1・2・3 とする。悪い例: 図が在庫→仕入→販売でも、表の節順だけで仕入を 1 とする。
|
|
122
|
+
|
|
126
123
|
### 6.5. データストア
|
|
127
124
|
|
|
128
125
|
- 全体概要と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、対象ケースで参照・更新する行だけを同じ名称・区分で示します。該当行がない区分は節ごと省略します。
|
|
129
126
|
- 表は「データストア」「関連する参加単位」「横断上の利用」の列とします。関連は参加単位の名称または領域 ID で示します。
|
|
130
127
|
- 各行を図の同名ノードへ対応させます。物理保管は全体概要の区分に従い、保管先の詳細や物理項目へ展開しません。
|
|
131
128
|
|
|
129
|
+
良い例: 全体概要の「商品台帳」を同じ区分で選び、「在庫が補充基準を参照する」と用途を示す。悪い例: 商品台帳の全カラムや保存パスを転載する。
|
|
130
|
+
|
|
132
131
|
### 6.6. 概念データフロー
|
|
133
132
|
|
|
134
133
|
- ノード、線種、色、絵文字は全体概要の「凡例(本プロダクト共通)」で選択された記法ルール([[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]])に従います。記法の宣言がなければ Mermaid とし、sample と template は D2 の例とします。参加単位・方向・イベントの要件が記法部品と異なる場合は本書を優先し、Mermaid も `flowchart TB` で縦に描きます。
|
|
134
|
+
- ノードのラベルに絵文字を付けるか付けないかは、全体概要の凡例の方針に合わせ、文書内の全図と系統間でそろえます。付ける場合は凡例の割り当てに従い、同じ対象には同じ絵文字を使います。詳細文書だけで追加・削除・変更しません。
|
|
135
135
|
- 正常系を上から下へ並べます。D2 は `direction: down` とし、戻りの線は上にあるノードを左辺にした `a <- b` で書きます。
|
|
136
136
|
- プロセスノードを役割表の行へ対応させ、通常の流れ全体を通して開始イベントと終了の出来事を描きます。分割図や戻りの図へ開始・終了を再掲する必要はありません。イベントは一つのノードに一つの出来事とし、発生を判定できる短い文にします。長い場合は改行し、原文を言い換えません。全体概要の起点イベントが複数の出来事を列挙している場合は、各出来事の文言を保ってノードを分けます。
|
|
137
137
|
- 参加単位どうし、または参加単位とデータストアを直接結び、渡す情報・物を名詞のラベルにします。必要な承認は「承認済みの補充依頼」のように成果の性質として表し、引き渡し条件を判定するイベントは置きません。
|
|
138
138
|
- Orchestrator とその調整要求・応答は描かず、全体概要の指示の図を参照します。対象範囲内の担当ロールを外部主体として追加しません。
|
|
139
139
|
- 図の題は「欠品から売場補充まで」「起票から完了記録まで」のように業務の言葉で付けます。説明は、その図から読み取れる流れや関係を 1 文で書きます。凡例への参照は別の短い注記にし、凡例を再定義しません。
|
|
140
|
-
-
|
|
140
|
+
- 分割の目安は、一図の受け渡しの線が 15 本を超える場合、または一ノードに入出力の線が合計 10 本以上集まる場合とし、連続する業務の段ごとに図を分けます。線は情報・物・起動・完了・戻り・再提示を各 1 本として数え、配置制御用の非表示線や凡例の線は含めません。目安以内でも線の交差やラベルの密集で接続を追いにくければ分けます。
|
|
141
|
+
- 分割後も必要な線を省略せず、接続する参加単位・データストアを同じ ID・名称で再掲します。図ごとに共有ノードと、別図・参照先へ委ねる範囲を短く注記し、開始から終了までの接続を追えるようにします。
|
|
141
142
|
|
|
142
|
-
|
|
143
|
+
良い例: 仕入から販売へ「入荷数量・受入結果」を渡す線を描き、題を「欠品から売場補充まで」とする。悪い例: 「処理フロー」とだけ題を付け、受け渡しの線に情報名を付けない。
|
|
143
144
|
|
|
144
|
-
|
|
145
|
+
### 6.7. 例外時の戻りの図
|
|
146
|
+
|
|
147
|
+
- 対象範囲に、不足や不一致を補完・再判断する参加単位へ返す流れがある場合は、「概念データフロー」に「例外時の戻り」の図を追加し、重要度で絞らずにすべて描きます。共通して通る領域の内部だけは「描き方の選択」で定めた 1 か所の正本へ委ねます。すべての受け渡しを網羅する表は作りません。
|
|
145
148
|
- 補完・再判断を担う参加単位へ戻る線に「不足項目」「記録と受入品の差異」などの戻す情報を付けます。通常の図と同じ名称・領域 ID を使います。
|
|
146
149
|
- 再提示を示す場合も「修正・承認済みの補充依頼」のような情報の線で表し、戻す条件・再開条件の列や条件イベントは設けません。内部の再試行、ログ、操作手順は描きません。
|
|
150
|
+
- 線が多い場合は「概念データフロー」の分割の目安に従い、戻り先または業務の段ごとに図を分けます。各図の題には「補充依頼の補完」のように戻す対象を示し、同じ名称・領域 ID の共有ノードで戻りと再提示を追えるようにします。読みやすさのために必要な戻りを削りません。
|
|
151
|
+
|
|
152
|
+
良い例: 仕入が不足項目を在庫へ返し、在庫が修正・再承認済みの補充依頼を再提示する。悪い例: 「エラー」を行き先なしで描く、または線が増えたので戻りを削る。
|
|
147
153
|
|
|
148
154
|
### 6.8. 未決事項
|
|
149
155
|
|
|
150
156
|
- 境界、名称、責務、判断者のいずれかが未確定な場合だけ設け、ない場合は章ごと省略します。
|
|
151
|
-
-
|
|
157
|
+
- 各論点は本文中の `_UNDECIDED_` と対応させ、影響するケース・参加単位、決定者、決定時期を示します。解決済みの論点や論点のない空表は残しません。
|
|
158
|
+
|
|
159
|
+
良い例: 「共用領域の内部の正本が未確定。`C-01`〜`C-03` に影響し、BA・ARC が系統間の整合確認時に決定」と示す。悪い例: 「詳細は後で検討」とだけ書く。
|
|
152
160
|
|
|
153
161
|
### 6.9. 完成判定
|
|
154
162
|
|
|
155
|
-
本節だけを `ready`
|
|
163
|
+
本節だけを `ready` 昇格のチェックリストの正本とします。内容の確認は次の全項目で行い、その後に人間の承認と証跡を確認します。
|
|
156
164
|
|
|
157
165
|
- ケース ID、業務名、目的、対象範囲、領域 ID・名称が全体概要と一致し、「描き方の選択」で決めた参加単位と詳細化の境界を守っています。
|
|
166
|
+
- 複数の系統が共通して通る領域の内部を描く文書が 1 か所に定まり、ほかの詳細文書ではその領域を 1 ノードと受け渡しの線で示し、内部の正本を参照しています。
|
|
158
167
|
- 「目的」が業務の存在理由・成果を 1〜2 文で示し、読み手の役割を含みません。「適用範囲」は対象と対象外が 1 行ずつで、共通原則は全体概要を参照しています。
|
|
159
168
|
- 「プロセス領域」の各節は役割表だけで構成され、全体概要のグループ・区分と一致しています。PDCA の値を示す場合は独立した任意の列にしています。
|
|
160
|
-
-
|
|
169
|
+
- 図を正本として、役割表の順序欄と章冒頭の通過順が一致しています。全参加単位の名称・領域 ID が表と図で対応し、主経路と条件付きの経路を区別して開始から終了まで上から下へ追えます。開始・終了のイベントは一ノード一出来事の短い文で、入口の文言は選んだ方式の規定に従っています。
|
|
161
170
|
- 渡す情報・物を線のラベルから読み取れ、引き渡し ID や条件のイベント、「引き渡し」「例外時の戻り先」の章がありません。
|
|
162
171
|
- Orchestrator は図に含まれず、その調整は全体概要の指示の図へ委ねられています。
|
|
163
172
|
- 図には業務の言葉による題と、読み取れることを示す説明 1 文があり、凡例は全体概要を参照しています。図を分けた場合も共有ノードと接続が追えます。
|
|
173
|
+
- ノードの絵文字の有無・割り当てが全体概要の凡例に合い、文書内の全図と系統間でそろっています。
|
|
164
174
|
- 関連データストアは全体概要と同じ名称・区分で、表の各行と図のノードが対応しています。
|
|
165
|
-
-
|
|
175
|
+
- 対象範囲の例外時の戻りを重要度で省略せず、戻す情報と補完・再判断の責任を持つ参加単位を読み取れます。戻りがない場合だけ戻りの図を省略しています。線数・集中の目安や読みやすさに応じて図を分け、分割後も必要な線を追えます。
|
|
166
176
|
- `based_on` と本文に `deprecated` の文書への参照がありません。状態定義・遷移を複製せず、有効な STSD や詳細文書を参照しています。
|
|
167
177
|
|
|
178
|
+
承認者と証跡は次の手順で確認します。
|
|
179
|
+
|
|
180
|
+
1. 対象プロジェクトの責任分担文書(RACI)の成果物確定・公開判断に対応する行から `A` の Role code を特定し、メンバー定義でそのロールを担う人間を確認します。RACI を管理しない場合は、ロール定義の承認権限とメンバー定義を参照します。対応関係は [[specdojo:people-and-organization-definition-standard|人と組織の定義標準]] に従い、承認者を特定できない場合は昇格せず未決事項へ記録します。
|
|
181
|
+
2. 対応する登録簿個票の「対応結果」または対応タスクの result に、対象文書 ID・承認対象の版(コミット等)・承認者・承認日・承認判断を記録します。同じ記録から、完成判定に用いたレビュー結果と検査証跡、承認者の根拠にした責任分担・ロール定義とメンバー定義を文書 ID または証跡の保管先で参照できるようにします。両方の記録がある場合は判断の正本を一方に定め、他方はその参照とします。
|
|
182
|
+
3. 公開前に、記録の版が昇格対象と一致し、完成判定を満たし、未解決指摘・未決事項の扱いを承認者が判断済みであることを確認します。証跡の欠落や版の不一致があれば `draft` を維持し、確認できた場合だけ人間が `ready` へ変更します。検査の成功だけで承認済みと判定しません。
|
|
183
|
+
|
|
184
|
+
改訂・廃止の影響追跡は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。BA は全体概要の詳細 CDFD 一覧、接続する系統の CDFD、状態を委ねる STSD、関連する BPS・受入条件への影響を確認し、ARC は境界と参照整合、QE は完成判定の再検証、PM は追従タスクの管理を担います。廃止・置き換えの最終判断は同標準の PO の責務に従います。
|
|
185
|
+
|
|
186
|
+
良い例: 承認記録から対象版、権限を持つ人間、レビュー結果と検査証跡をたどれる。悪い例: 「検査が通った」「承認済み」とだけ書いて `ready` にする。
|
|
187
|
+
|
|
168
188
|
## 7. 禁止事項
|
|
169
189
|
|
|
170
190
|
- プロセス領域に主要入力・主要出力・データストアの箇条書きを置く、または図をなぞる長文の注記を書く。
|
|
171
191
|
- 詳細 CDFD に独自の凡例を再掲・重複定義する。
|
|
192
|
+
- 共通して通る領域の内部を複数の詳細文書へ重複して描く、必要な例外時の戻りを重要度や線の多さを理由に省略する、または全体概要の凡例と異なる絵文字の有無・割り当てにする。
|
|
172
193
|
- 全体概要にないケースや領域分割を作る、または「描き方の選択」の粒度・詳細化の境界を越えて内部処理を再掲する。
|
|
173
194
|
- 全体概要と異なるグループ名・区分名・領域 ID・データストア名を使う、または PDCA の値をグループ・区分の列に入れる。
|
|
174
195
|
- 引き渡し ID を採番する、引き渡し条件のイベントを図に置く、引き渡し・戻す条件・再開条件の表を設ける。
|
|
@@ -4,103 +4,137 @@ specdojo:
|
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
6
|
status: draft
|
|
7
|
-
recipe:
|
|
7
|
+
recipe: not-needed
|
|
8
8
|
sample: specdojo:cdsd-sample
|
|
9
|
-
template:
|
|
9
|
+
template: not-needed
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# 概念データストア定義 作成ルール
|
|
13
13
|
|
|
14
14
|
Conceptual Data Stores Definition (CDSD) Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
業務で継続的に保持・参照する情報の集合について、管理単位・用途・更新責務を定義する基準を定めます。
|
|
17
|
+
BA が業務上の境界を合意し、ARC・DEV が設計へ接続し、QE が整合性確認の対象を識別できる一覧を作ります。
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
- **適用範囲**: 業務分析・要求定義から設計への引き渡しで利用する `cdsd-*.md` を対象とします。帳簿・台帳に加え、定義、実行記録、派生ビュー、人が確定する報告記録も業務上の管理対象なら含めます。
|
|
22
|
+
- **入力**: 成果物カタログの対象範囲・依存・受入条件、上位の目的、関連する BDD・プロセス仕様を確認します。主要な管理単位の採否と用途を、それらの根拠に対応付けます。
|
|
23
|
+
- **記載レベル**: 一覧の各行は独立した管理単位とします。ファイルが複数あることだけで分割せず、正本区分、粒度、更新責務が異なる場合は区別します。
|
|
24
|
+
- **対象外**: 全項目の型・許容値、保存形式、コマンド構文、状態遷移、復旧操作の詳細は、それぞれの schema・型定義・リファレンス・状態定義・運用手順を参照します。概念上の管理境界を判断するための説明だけを残します。
|
|
22
25
|
|
|
23
|
-
##
|
|
26
|
+
## 2. 位置づけと用語定義
|
|
24
27
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
| type | `data` 固定 | ○ |
|
|
28
|
+
- **概念データストア**: 業務上ひとまとまりとして保持・参照する情報です。物理的な保管場所や DB テーブルと一対一とは限りません。
|
|
29
|
+
- **隣接仕様との分担**: BDD は項目の業務的意味、CCD は概念間の関連、プロセス仕様・CDFD は情報の生成・利用の流れ、保管場所一覧は物理的・論理的な場所を扱います。CDSD はこれらを管理単位と更新責務でつなぎます。
|
|
30
|
+
- **共通事項の正本**: メタ情報・改訂と廃止は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]]、配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。共通方針は上位文書を参照し、各 CDSD へ再掲しません。
|
|
29
31
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
32
|
+
| Role code | 作成・確認・利用の責務 |
|
|
33
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
34
|
+
| BA | 主作成者・業務確認者として、対象者の課題、管理境界、名称、用途と上位根拠の対応を整理する。業務担当者による確認が必要な箇所を特定する |
|
|
35
|
+
| ARC | 正本・派生物の区別、生成元、外部依存と後続設計への引き渡しを確認する |
|
|
36
|
+
| DEV | 保存単位と正本の参照先、schema・型・生成処理への変更影響を確認する |
|
|
37
|
+
| QE | 対象の網羅、必須情報、検証対象と合否条件を照合する |
|
|
38
|
+
| PM | 未決事項の担当・依存順・判断時期を計画へ接続し、課題・リスク等を報告する |
|
|
39
|
+
| OPS | 公開前確認、継続更新・再生成・問い合わせの導線を確認する |
|
|
40
|
+
| PO | 管理境界と用途を最終合意し、公開範囲・確定・置き換えを人間として承認する |
|
|
33
41
|
|
|
34
|
-
|
|
42
|
+
業務担当者や「運用担当」などの呼称を使う場合は、適用先の組織定義の Role code に対応付けます。実担当者・兼務は組織・メンバー定義を参照します。
|
|
35
43
|
|
|
36
|
-
|
|
37
|
-
- `type: data` は業務ドメイン仕様であることを示す。画面やAPI仕様(`ui`/`api`)とは別ドキュメントで管理する。
|
|
44
|
+
## 3. ファイル命名・ID規則
|
|
38
45
|
|
|
39
|
-
|
|
46
|
+
- ファイル名は `cdsd-<term>.md` とし、`<term>` は対象業務領域を表す kebab-case とします。プロセス群など、読者が管理境界を合意できる単位でまとめます。
|
|
47
|
+
- プロジェクト成果物の文書 ID は `<project-id>:cdsd-<term>` とします。例は `prj-0001:cdsd-execution` です。文書内のデータストアは名称で一意に対応付け、同名で異なる管理単位を混在させません。
|
|
48
|
+
- 配置はカタログの `base_path` と成果物の `path` から解決します。業務仕様のデータモデル配下を基本とし、既存カタログのパスを推測で変更しません。
|
|
40
49
|
|
|
41
|
-
|
|
50
|
+
## 4. 推奨 Frontmatter 項目
|
|
42
51
|
|
|
43
|
-
|
|
52
|
+
許可キー・必須項目・型はドキュメントメタ情報標準と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とし、メタ情報は `specdojo:` 配下に置きます。
|
|
44
53
|
|
|
45
|
-
-
|
|
46
|
-
-
|
|
54
|
+
- `type` は `data`、`rulebook` は `specdojo:cdsd-rulebook` とします。表示名は対象領域が分かる H1 に置き、`title` を併記する場合は H1 と意味を一致させます。
|
|
55
|
+
- `based_on` には実際に読んで直接の根拠とした作成済み文書を記録します。カタログがある場合は `depends_on` の推移閉包内に限定します。単なる関連先や未作成文書を追加しません。
|
|
56
|
+
- `status` の確定判断、`supersedes` による置き換えは共通規約に従います。agent は `draft` のまま編集し、人間の PO による承認へ渡します。
|
|
47
57
|
|
|
48
|
-
|
|
58
|
+
## 5. 本文要件
|
|
49
59
|
|
|
50
|
-
|
|
60
|
+
次の構成を標準とし、見出しは `## 1.` から連番、小節も階層ごとの連番にします。表はヘッダー・区切り行・データ行を連続させ、途中に空行を入れません。
|
|
51
61
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
62
|
+
| 章 | 必須 | 内容・受入条件 |
|
|
63
|
+
| -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
64
|
+
| 概要 | 必須 | 対象者、利用場面、業務課題と放置時の影響、期待する判断結果、対象・対象外とその根拠を示す。上位文書で説明済みの内容は参照する |
|
|
65
|
+
| 概念データストア一覧 | 必須 | 対象の全管理単位を標準6列で定義し、カタログの対象範囲と照合できること |
|
|
66
|
+
| 正本区分と更新責務 | 必須 | 一覧の全行について、正本か派生・参照情報か、生成元、更新契機、利用制約、担当 Role code を識別できること |
|
|
67
|
+
| 関連仕様と検証 | 必須 | 各管理単位から、根拠となる辞書・プロセス・制約の正本、検証対象と確認手順を辿れること |
|
|
68
|
+
| 確認事項と変更影響 | 条件付き | 未決・欠落・矛盾、または改訂・廃止がある場合に、影響、担当、判断者、期限または判断時期、次アクションと追跡先を示す。なければ「なし」または省略とする |
|
|
55
69
|
|
|
56
|
-
|
|
57
|
-
| **主な内容** | 記録項目の代表例を名詞句で簡潔に |
|
|
58
|
-
| **更新タイミング** | 発生イベント・日次・月次などの処理基準 |
|
|
59
|
-
| **粒度** | データの最小記録単位(例:仕入取引毎/商品×在庫時点) |
|
|
60
|
-
| **主な用途** | 管理・分析・会計などの目的 |
|
|
70
|
+
### 5.1. 一覧の標準列
|
|
61
71
|
|
|
62
|
-
|
|
72
|
+
列順は次の順に固定します。関連仕様への参照や補足は別表・本文に置けますが、データストア名で対応付けます。
|
|
63
73
|
|
|
64
|
-
|
|
74
|
+
| 列名 | 内容・判断条件 |
|
|
75
|
+
| -------------- | --------------------------------------------------------------------------------------------- |
|
|
76
|
+
| データストア名 | BDD・用語集と対応する業務名称。日本語の単数形を基本とし、慣用名・正式名称は定義先を示して使う |
|
|
77
|
+
| 対応プロセス | 生成・更新・利用する業務プロセス。複数なら「、」で区切る |
|
|
78
|
+
| 主な内容 | 管理対象が分かる代表情報を名詞句で示す。全フィールドを列挙しない |
|
|
79
|
+
| 更新タイミング | 発生イベントまたは周期と、その適用条件を示す |
|
|
80
|
+
| 粒度 | 最小記録単位と識別の文脈。履歴と集計など複数の単位を混同しない |
|
|
81
|
+
| 主な用途 | 誰のどの業務判断・確認に使うかを示す。概要の目的に対応すること |
|
|
65
82
|
|
|
66
|
-
|
|
83
|
+
更新タイミングは「イベント(会計確定時)」「日次(閉店時)」「月次(締め)」「年次(決算)」「随時(定義変更時)」のように契機を具体化します。複数契機は併記でき、業種固有のイベントをこの例に限定しません。
|
|
67
84
|
|
|
68
|
-
|
|
69
|
-
- 必要に応じて **「イベントA・イベントB時」形式で複数指定可**
|
|
85
|
+
### 5.2. 正本区分と更新責務
|
|
70
86
|
|
|
71
|
-
-
|
|
72
|
-
-
|
|
73
|
-
-
|
|
74
|
-
- 随時:随時、変更時、追加時
|
|
87
|
+
- 正本は何を確定する情報かを示します。派生・参照情報は生成元の文書 ID または管理単位、再生成の契機と基準時点を示します。人が確定する報告記録は、その判断の範囲を明示します。
|
|
88
|
+
- 更新担当と確認担当を Role code で示し、参照だけのプロセスと更新するプロセスを区別します。直接編集・再生成・追記などの業務上の制約は、その理由または正本への参照を添えます。
|
|
89
|
+
- 保存・引き渡し単位が境界判断に必要なら、対象ファイル群や運用手順への参照を付けます。詳細なパス規則や実装内部構造は転記しません。更新失敗・不整合時の問い合わせ先と訂正・復旧手順の参照も対応付けます。
|
|
75
90
|
|
|
76
|
-
###
|
|
91
|
+
### 5.3. 関連仕様への追跡
|
|
77
92
|
|
|
78
|
-
-
|
|
79
|
-
-
|
|
93
|
+
- 関連 BDD・CCD・用語集・プロセス仕様・CDFD、該当する保管場所一覧(SLL)を文書 ID で特定します。名称・内容・粒度・入出力・管理場所のうち何を照合するかを対応付けます。関連文書がない種別を形式的に作成する必要はありません。
|
|
94
|
+
- schema・型・実装・リファレンスが正本の場合は、BDD 等の参照先を辿れるようにし、外部システムを含む入力元・出力先と更新制約を確認します。構造の詳細を CDSD 独自の定義として複製しません。
|
|
95
|
+
- 既存文書は project 修飾 ID のリンクで示します。未作成文書は ID をコード表記し、欠ける根拠、現時点で判断できる範囲、解消担当を「確認事項と変更影響」に残します。依存未整備を対象行の黙示的な除外理由にしません。
|
|
80
96
|
|
|
81
|
-
|
|
97
|
+
### 5.4. 検証と受入条件
|
|
82
98
|
|
|
83
|
-
|
|
99
|
+
BA が対象行を作成し、ARC・DEV が正本区分と依存を確認した後に QE が照合します。各データストアを作成・確認の作業単位とし、PM は依存順と確認時期を計画に記録します。
|
|
84
100
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
101
|
+
| 確認 | 合格条件・証跡 |
|
|
102
|
+
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
103
|
+
| BA: 業務範囲と用途 | カタログの対象と一覧の対応に欠落・重複がなく、標準6列が埋まり、用途が概要の課題・期待価値へつながる |
|
|
104
|
+
| ARC・DEV: 境界と依存 | 一覧と更新責務の対象集合が一致し、正本・生成元・担当・制約と、参照する BDD 等の定義が矛盾しない |
|
|
105
|
+
| QE: 整形・メタ情報 | リポジトリに導入された Prettier・Markdown lint・Frontmatter schema 検査で対象ファイルのエラーがない。コマンド・対象・結果を実行記録へ残す |
|
|
106
|
+
| QE・OPS: データと運用 | 管理単位ごとに検証対象、適用 schema または手動確認基準、確認コマンド・手順、期待結果、失敗時の対応を参照できる |
|
|
107
|
+
|
|
108
|
+
本リポジトリでは `npx prettier --write <対象.md>`、`npm run lint:md`、`npm run lint:fm` を使います。成功は終了コード 0 と対象の違反なしです。他のリポジトリでは導入済みの対応コマンドを用い、pipeline で親検証に設定されたものは runner の結果を証跡とします。
|
|
109
|
+
|
|
110
|
+
CDSD 本文は標準6列・行の網羅・参照対応を手動照合します。参照先データの schema 検証はその正本で定める手順を用い、CDSD の Frontmatter 検証とは分けます。検証対象・期待結果の詳細は正本を参照し、実行記録に対象と結果を残します。失敗時は担当へ差し戻して修正・再確認し、未解決を合格として扱いません。
|
|
111
|
+
|
|
112
|
+
### 5.5. 未決事項・変更・公開判断
|
|
113
|
+
|
|
114
|
+
- BA は確認不足・欠落・矛盾とその業務影響を整理し、PM へ報告します。計画済み作業の進捗は Schedule で追跡し、既発問題は課題、未発生の懸念はリスク、承認が必要な差分は変更要求、採用方針と理由は決定記録の PJR 転記候補として分けます。担当 Role code、報告先・判断者、判断時期、次アクション、転記先レコードを記録します。
|
|
115
|
+
- 改訂・廃止ではドキュメントメタ情報標準の変更管理に従います。BA は名称・用途・粒度の変更を BDD・CCD・用語集・プロセス仕様・SLL と照合し、ARC・DEV は schema・型・生成処理・コマンドへの影響を特定します。QE は参照元の受入条件と既存成果物を再確認し、PM は非互換変更の移行対象・順序・期限・担当を追跡します。
|
|
116
|
+
- 本 rulebook の変更時は、Frontmatter で宣言する関連 Kata と適用済み CDSD を照合し、本文要件・標準列・禁止事項の差分と同期対象を実行記録に残します。段階的な整備では未同期箇所・担当・次の作業を明記し、矛盾時は rulebook を正とします。要否判断を見直す場合も BA・ARC が理由と影響を提示し、人間の PO が合意します。
|
|
117
|
+
- 公開・`ready` 化の前に、BA・ARC・QE の受入確認と OPS の公開前確認を完了します。公開対象と閲覧範囲、個人情報・非公開情報の有無、未決事項・未解決指摘と影響を提示し、人間の PO が承認・保留・差し戻しを判断します。本 rulebook 自体の確定には関連 Kata の同期確認も必要です。公開後の問い合わせは BA、再生成・運用上の問題は OPS が受け、仕様変更が必要なら PM へつなぎます。
|
|
118
|
+
|
|
119
|
+
## 6. 記述ガイド
|
|
120
|
+
|
|
121
|
+
章ごとの判断は次の基準で行います。共通事項は上位文書を正本とし、良い例の短文は判断点だけを示すものです。
|
|
122
|
+
|
|
123
|
+
| 対象章 | 判断の基準 | 良い例 | 悪い例 |
|
|
124
|
+
| -------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- |
|
|
125
|
+
| 概要 | 対象者・放置時の影響・期待する判断と、境界の理由が分かる | 「担当交代時の更新漏れを防ぐため、BA が販売記録の更新責務を確認する。在庫は別領域の定義を参照する」 | 「データを一覧にする」のみ、または対象を根拠なく省く |
|
|
126
|
+
| 概念データストア一覧 | 代表情報・更新契機・最小単位・用途を区別できる | 「売上台帳/販売、会計/販売日・金額/イベント(会計確定時)/販売取引毎/店主の売上確認」 | 「SalesTbl/販売/全項目/随時/データ毎/管理」 |
|
|
127
|
+
| 正本区分と更新責務 | 更新元と参照先、担当と許可される扱いが分かる | 「売上集計は売上台帳から日次再生成。OPS が生成し、BA が元帳との一致を確認。集計の直接訂正はしない」 | 「システムが適切に更新する」 |
|
|
128
|
+
| 関連仕様と検証 | 参照先・比較内容・合否を辿れる | 「売上台帳に対応する BDD の文書 ID と検証手順を示し、取引粒度の一致と検証エラー0件を確認する」 | 「BDD 等と整合すること」のみ |
|
|
129
|
+
| 確認事項と変更影響 | 誰がいつ何を決め、その結果どこを直すかが分かる | 「粒度変更による集計影響を BA が課題化し PM へ報告。次回レビューで PO が範囲を判断し、ARC が生成元との対応を再確認する」 | 「詳細は後日」、未決のまま確定する |
|
|
130
|
+
|
|
131
|
+
業務名称と正式な識別子の対応が必要なら、名称の初出で短く補足するか正本を参照します。物理名を独立して示す必要がある場合だけ任意の `physicalName` 列を標準6列の後ろに追加し、既存の正本の表記を使います。CDSD のために綴りや命名規則を変換しません。
|
|
132
|
+
|
|
133
|
+
## 7. 禁止事項
|
|
134
|
+
|
|
135
|
+
- 略語・物理名だけで管理対象を表し、業務上の意味や定義先を示さないこと。
|
|
136
|
+
- カタログの対象を未記載のまま除外したり、未決の粒度・更新責務を確定済みとして扱ったりすること。
|
|
137
|
+
- 全項目・型・許容値・状態遷移・コマンド構文・詳細パスを正本から複製し、二重管理すること。
|
|
138
|
+
- 派生・参照情報を正本と混同し、生成元や更新担当の不明なまま後続設計へ渡すこと。
|
|
139
|
+
- 表を空行で分断すること、存在しない文書へのリンクや未確認の検証成功を記載すること。
|
|
140
|
+
- agent に公開可否・`ready` 昇格・置き換えの最終承認を委ねること。
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdt-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
6
|
+
status: ready
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: specdojo:cdt-sample
|
|
9
|
+
template: not-needed
|
|
10
|
+
supersedes:
|
|
11
|
+
- specdojo:cld-rulebook
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# 分類一覧 作成ルール
|
|
15
|
+
|
|
16
|
+
Code Table (CDT) Documentation Rules
|
|
17
|
+
|
|
18
|
+
業務上の分類(カテゴリ、種別、区分、コード値など)について、値を選ぶための意味・成立条件・判断境界を定義します。値・構文・構造の詳細はスキーマ・実装・リファレンスを正本として参照し、分類一覧(CDT)はそこから読み取れない業務判断を補います。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
- **目的と適用範囲**: BDD の属性、画面選択肢、集計軸などに使う分類を Markdown で記述する。分類する対象と、利用者が何を判断するための区分かを明らかにする。
|
|
23
|
+
- **正本参照**: スキーマや実装に許容値がある場合は、その定義を正とする。CDT には各値の選定条件と隣接する値との境界を記述する。実装にない業務上の分類はスタンドアロンで定義し、動的分類は値を固定せず管理規約を定義する。
|
|
24
|
+
- **完成条件**: メタデータが共通標準・schema に適合し、分類定義と業務判断が「本文要件」を満たすこと。正本参照が解決でき、関連する BDD・用語・画面・ルールと矛盾しないことを「成果物の検証」で確認する。
|
|
25
|
+
- **確定と変更**: BA・PO が意味と区分方針、ARC・DEV が正本との対応、QE が境界の検証可能性を確認する。`ready` への昇格は人間が判断する。変更時は分類を利用する仕様と実装への影響を確認し、未解消の不整合を実行結果へ記録する。
|
|
26
|
+
|
|
27
|
+
## 2. 位置づけと用語定義
|
|
28
|
+
|
|
29
|
+
- **成果物の責務**: CDT は分類の選び方を担い、BDD は属性定義、用語集は共通の語義、画面仕様は表示・操作、ビジネスルールは詳細な業務規則を担う。状態遷移や承認の詳細も対応する仕様へ委ね、選定に必要な条件だけを残す。
|
|
30
|
+
- **分類種別**: 業務分類は業務判断に基づく区分、コード表はシステムや外部連携で識別するコードの体系、動的分類は利用者が運用中に値を追加・変更する区分を指す。件数だけで種別や管理方式を決めない。
|
|
31
|
+
- **正本参照とスタンドアロン定義**: 正本参照は許容値が確定するスキーマ・型・管理元への参照を指す。スタンドアロン定義は実装に値の定義がない業務区分を CDT 自体で定義する方式であり、既存の正本を読めない場合の代替ではない。
|
|
32
|
+
|
|
33
|
+
## 3. ファイル命名・ID規則
|
|
34
|
+
|
|
35
|
+
- **ID**: プロジェクト成果物は `<project-id>:cdt-<term>`(例: `prj-0001:cdt-register-type`)とする。`<term>` は分類の主題を表す英小文字の kebab-case とし、共通の文字制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。
|
|
36
|
+
- **ファイル名と配置**: `cdt-<term>.md` とし、成果物カタログの `base_path` と `path` に従う。配置の共通方針は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正とする。
|
|
37
|
+
- **改訂と参照**: ID は同じ分類を追跡できるよう維持する。別文書で置き換える場合に限り `supersedes` で旧 ID を示す。既存の関連文書は project 修飾 ID の wikilink、未作成文書やソースコードはインラインコードで参照する。
|
|
38
|
+
|
|
39
|
+
## 4. 推奨 Frontmatter 項目
|
|
40
|
+
|
|
41
|
+
- 共通項目の必須・任意と意味は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]]、許可項目・型制約は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。CDT 固有のメタデータ項目は追加しない。
|
|
42
|
+
- `specdojo` 配下の `type` は `data`、`rulebook` は `specdojo:cdt-rulebook` とする。新規作成時の `status` は `draft` とする。
|
|
43
|
+
- 文書名は本文先頭の H1 に記載し、`specdojo.title` は追加しない。`schema_ref`・`type_ref` は本文の正本参照欄で使用する表記であり、Frontmatter の項目ではない。
|
|
44
|
+
|
|
45
|
+
最小メタデータ例:
|
|
46
|
+
|
|
47
|
+
```yaml
|
|
48
|
+
---
|
|
49
|
+
specdojo:
|
|
50
|
+
id: prj-0001:cdt-register-type
|
|
51
|
+
type: data
|
|
52
|
+
status: draft
|
|
53
|
+
rulebook: specdojo:cdt-rulebook
|
|
54
|
+
---
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 5. 本文要件
|
|
58
|
+
|
|
59
|
+
本文は次の章を基本とする。H1 は文書名だけに用い、`##`〜`####` の見出しには階層ごとの連番と末尾のピリオドを付ける(例: `### 3.1.`、`#### 3.1.1.`)。任意章を省略した場合も章番号を飛ばさない。
|
|
60
|
+
|
|
61
|
+
| 章タイトル | 必須 | 目的・内容要件 |
|
|
62
|
+
| ------------------------ | ---- | --------------------------------------------------------------------------------------------------- |
|
|
63
|
+
| 概要 | ○ | 業務目的、対象エンティティ、適用範囲、主担当・利用者とその判断を示す |
|
|
64
|
+
| 分類定義 | ○ | 対象エンティティ、分類定義名、種別、正本参照、説明を表形式で特定する |
|
|
65
|
+
| 値の業務的意味と使い分け | ○ | 正本参照あり・スタンドアロン・動的分類の方式に応じて、選定条件と境界または管理規約を示す |
|
|
66
|
+
| 関連仕様との関係 | 任意 | BDD・画面・業務ルール・状態定義などへの参照と、分類の利用先・変更影響を示す。概要等で明確なら省略可 |
|
|
67
|
+
|
|
68
|
+
### 5.1. 分類定義の要件
|
|
69
|
+
|
|
70
|
+
「定義項目」「内容」の 2 列の表に、次の項目を置く。複数の分類軸を扱う場合は、軸ごとに定義と説明の対応を識別できるようにする。
|
|
71
|
+
|
|
72
|
+
| 定義項目 | 内容 |
|
|
73
|
+
| ---------------- | -------------------------------------------------------------------------------------------------- |
|
|
74
|
+
| 対象エンティティ | 分類される業務上の対象。BDD にある場合は論理名・物理名を合わせる |
|
|
75
|
+
| 分類定義名 | 分類軸を表す論理名と属性名。エンティティ名だけで代用しない |
|
|
76
|
+
| 種別 | 業務分類・コード表・動的分類のいずれか |
|
|
77
|
+
| 正本参照(SSOT) | スキーマのパスと定義位置、型のパスと識別子、動的分類の管理元、または「なし(スタンドアロン定義)」 |
|
|
78
|
+
| 説明 | その区分で分ける業務上の判断と目的 |
|
|
79
|
+
|
|
80
|
+
### 5.2. 値の業務的意味と使い分けの要件
|
|
81
|
+
|
|
82
|
+
| 定義方式 | 必須内容 |
|
|
83
|
+
| -------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
84
|
+
| 正本参照あり | 正本に対応する識別子を行のキーとして、各値の意味・選定条件・使い分けを記す。値だけの一覧や enum・union 型の転記は置かない |
|
|
85
|
+
| スタンドアロン | 値・分類名・表示名・説明と成立条件を定義する。表示名が分類名と同じ場合は同じであると分かる形で示す |
|
|
86
|
+
| 動的分類 | 値一覧を固定せず、管理元、作成・変更権限、命名規約、削除・アーカイブ時の扱いを示す。属性や参照関係の構造は BDD に委ねる |
|
|
87
|
+
|
|
88
|
+
## 6. 記述ガイド
|
|
89
|
+
|
|
90
|
+
共通事項は上位のメタ情報標準・文書構成ガイド、共通の語義は用語集を正本とし、各章で再定義しない。以下の例は判断基準を示す部分例である。
|
|
91
|
+
|
|
92
|
+
### 6.1. 概要
|
|
93
|
+
|
|
94
|
+
- **判断基準**: 誰がどの場面で何を選ぶための分類かを示す。対象外の判断は正本となる仕様へ委ねる。
|
|
95
|
+
- **良い例**: 「起票者が、すでに起きた問題と未発生の懸念を分けて追跡するための分類を定義する。状態遷移は状態定義を参照する。」
|
|
96
|
+
- **悪い例**: 「登録項目の分類を適切に管理する。」目的・利用者・判断の境界が分からない。
|
|
97
|
+
|
|
98
|
+
### 6.2. 分類定義
|
|
99
|
+
|
|
100
|
+
正本は次の基準で選び、参照先のファイルと定義位置を確認する。スキーマと実装が併存する場合は許容値の正本を一つ指定し、他方は対応確認先として区別する。
|
|
101
|
+
|
|
102
|
+
| 参照方式 | 選定基準 | 正本参照欄の良い例 |
|
|
103
|
+
| -------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
104
|
+
| スキーマ参照 | 許容値をスキーマで管理している | `schema_ref: docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml#/$defs/ItemType` |
|
|
105
|
+
| 型参照 | スキーマがなく、ソースの型で許容値を管理している | `type_ref: <path>#<TypeName>` の形で実在するパスと型識別子を示す |
|
|
106
|
+
| スタンドアロン | 実装に定義がなく、人が業務判断に使う区分である | `なし(スタンドアロン定義)` とし、その区分を判断する主体を説明する |
|
|
107
|
+
| 動的分類 | 利用者が運用中に分類値を増減する | 管理元となる BDD のエンティティを参照し、値を確定するマスタの所在を示す |
|
|
108
|
+
|
|
109
|
+
- **判断基準**: 分類種別と参照方式は別に判断する。固定の業務分類・コード表は正本の有無で参照方式を選び、動的分類は固定 enum にせず管理元を参照する。
|
|
110
|
+
- **良い例**: 分類定義名を「分類(`item_type`)」とし、スキーマの `ItemType` を正本、CLI の検証定義を対応確認先として示す。
|
|
111
|
+
- **悪い例**: 属性を特定せず「登録項目」とだけ書く、または「ソースコード参照」とだけ書く。分類軸や参照先を解決できない。
|
|
112
|
+
|
|
113
|
+
### 6.3. 値の業務的意味と使い分け
|
|
114
|
+
|
|
115
|
+
#### 6.3.1. 正本参照あり
|
|
116
|
+
|
|
117
|
+
- **判断基準**: 正本の各値に業務上の説明が対応し、混同しやすい値を条件で区別できること。識別子は説明との対応付けに用い、許容値を独立して再定義しない。
|
|
118
|
+
- **推奨表**: `値`(正本に対応する識別子)、`分類名`(業務上の名称)、`業務上の意味と使い分け`(選定条件・隣接値との境界)。名称は関連 BDD・用語集と同じ対象を指すように合わせる。
|
|
119
|
+
- **良い例**: 「`issue` はすでに起きている問題。まだ起きていない懸念には `risk` を使う。」
|
|
120
|
+
- **悪い例**: 「`issue` は課題、`risk` はリスク。」名称の言い換えだけでは選定できない。
|
|
121
|
+
|
|
122
|
+
#### 6.3.2. スタンドアロン定義
|
|
123
|
+
|
|
124
|
+
- **判断基準**: 正本を CDT 自体が担うため、識別可能な値と判断条件を揃える。条件が重なる場合は優先順位や例外を明らかにする。
|
|
125
|
+
- **推奨表**: `値`(コード)、`分類名`(正式名称)、`表示名`(利用者向け名称)、`説明・成立条件`(選定条件)。
|
|
126
|
+
- **良い例**: 「`experimental`/試験商品/お試し: 店主が新規取扱を試す区分。入荷後30日間の売れ行きで定番化を判断する。」
|
|
127
|
+
- **悪い例**: 「`experimental`/その他/その他: 適宜使用する。」適用条件と判断主体を特定できない。
|
|
128
|
+
|
|
129
|
+
#### 6.3.3. 動的分類
|
|
130
|
+
|
|
131
|
+
- **判断基準**: 利用者が値を追加・変更できることを前提に、作成権限と既存参照の扱いを判断できる規約にする。件数の大小で固定 enum 化しない。
|
|
132
|
+
- **良い例**: 「店主がタグを追加する。使用済みタグは削除せずアーカイブし、新規付与だけを停止する。」管理元の属性定義は BDD を参照する。
|
|
133
|
+
- **悪い例**: 現在のタグを BDD の enum として列挙する。運用中に追加される値を表現できない。
|
|
134
|
+
|
|
135
|
+
### 6.4. 関連仕様との関係
|
|
136
|
+
|
|
137
|
+
- **判断基準**: 参照する文書と、どの属性・判断に分類を使うかを対にする。税率・状態遷移・承認・コマンド構文などの詳細は各正本へ委ねる。
|
|
138
|
+
- **良い例**: 「業務データ辞書の `item_type` に対応する。分類別の終端・承認者は状態定義を参照する。」文書名は実在する文書の wikilink として記述する。
|
|
139
|
+
- **悪い例**: 関連文書名だけを並べる、または状態遷移表や CLI オプション一覧を転記する。利用関係を示せないか、正本との二重管理になる。
|
|
140
|
+
|
|
141
|
+
### 6.5. 成果物の検証
|
|
142
|
+
|
|
143
|
+
1. **構造とメタデータ**: リポジトリの検査設定に従い Markdown・Frontmatter を検証する。期待結果は見出し・表の違反や未定義メタデータがないこと。カタログ管理下では ID・パス・rulebook 宣言との一致も確認する。
|
|
144
|
+
2. **参照と対応**: 正本のファイル・定義位置を解決し、各許容値に業務上の説明があり、正本にない値を許容していないことを照合する。CLI 等の検証値を併記する場合は正本と同じ集合か確認し、不一致は実行結果へ残す。
|
|
145
|
+
3. **業務判断と影響**: 混同しやすい値の条件、スタンドアロン分類の重複・漏れ、動的分類の権限・参照保持を確認する。変更時は BDD・画面・業務ルール・関連実装の利用箇所を辿り、意味や表示との不整合がないことを確認する。
|
|
146
|
+
|
|
147
|
+
## 7. 禁止事項
|
|
148
|
+
|
|
149
|
+
- **正本の再掲**: 値だけの一覧、enum・union 型、型制約、コマンド構文、状態遷移表の転記を置かない。説明表の識別子は「値の業務的意味と使い分けの要件」に従う。
|
|
150
|
+
- **判断できない説明**: 名称の直訳や「適切に選ぶ」だけで条件を済ませない。根拠のない値数の目安を分類種別・管理方式の必須条件にしない。
|
|
151
|
+
- **責務の混同**: 動的分類を固定 enum 化しない。分類の業務判断に寄与しない DDL・SQL・内部関数の詳細を混入しない。
|
|
152
|
+
- **共通規約違反**: 未定義の Frontmatter 項目、番号なし見出し、章番号末尾のピリオド欠落を使用しない。
|