specdojo 0.6.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 +193 -0
- package/README.md +2 -2
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +33 -0
- package/dist/commands/init.js +6 -1
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/orchestrator.js +10 -1
- 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/command.js +18 -0
- package/dist/devcontainer/host-script.js +21 -0
- package/dist/devcontainer/scaffold.js +22 -3
- 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/antigravity-session.js +154 -0
- 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 +160 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plan-markdownlint.js +89 -0
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +52 -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 +69 -42
- 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 +264 -43
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +12 -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 +26 -6
- package/dist/exec/run/schedule-prepare.js +228 -45
- package/dist/exec/run/schedule-task.js +132 -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 +118 -59
- package/dist/exec/worktree-ops-lifecycle.js +77 -44
- 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 +74 -32
- 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 +149 -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/provider-scaffold.js +2 -0
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -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 +48 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +61 -28
- package/docs/ja/specdojo/guides/exec-operation-guide.md +61 -13
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +4 -2
- 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 +589 -807
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -4
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +33 -4
- 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 +41 -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 +471 -74
- 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-overview-recipe.md +88 -86
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +108 -122
- 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 +146 -99
- 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-d2-rulebook.md +367 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +6 -5
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +96 -100
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +38 -47
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +132 -106
- 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-overview-sample.md +248 -140
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +130 -97
- 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-overview-template.md +161 -83
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +130 -89
- 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 +54 -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/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +1 -0
- package/package.json +6 -3
- package/templates/antigravity/README.md +19 -46
- package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
- package/templates/antigravity/orchestrator.md +3 -2
- package/templates/antigravity/settings.edit.json +73 -0
- package/templates/antigravity/settings.orchestrator.json +15 -0
- package/templates/antigravity/settings.report.json +7 -0
- package/templates/antigravity/settings.review.json +7 -0
- 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/remote-host/devcontainer-tmux.sh +217 -0
- package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -96
- package/templates/devcontainer/remote-host/ssh-config.sample +3 -1
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-agent-members.yaml +1 -0
- package/templates/init-exec-defaults.yaml +1 -1
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -4,290 +4,136 @@ specdojo:
|
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: architecture
|
|
6
6
|
status: draft
|
|
7
|
-
|
|
7
|
+
target_format: markdown
|
|
8
|
+
includes:
|
|
9
|
+
- specdojo:cnd-mermaid-rulebook
|
|
10
|
+
recipe: specdojo:cnd-recipe
|
|
8
11
|
sample: specdojo:cnd-sample
|
|
9
|
-
template:
|
|
12
|
+
template: specdojo:cnd-template
|
|
13
|
+
based_on:
|
|
14
|
+
- specdojo:rulebook-authoring-standard
|
|
10
15
|
---
|
|
11
16
|
|
|
12
|
-
# C4
|
|
17
|
+
# C4コンテナ図(CND)作成ルール
|
|
13
18
|
|
|
14
|
-
C4 Container Diagram (CND)
|
|
19
|
+
C4 Container Diagram (CND) Authoring Rule
|
|
15
20
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
この章の成果物は、次の2つをセットで扱います。
|
|
19
|
-
|
|
20
|
-
- **C4コンテナ図(Mermaid)**: 対象システムを主要コンテナ(実行/配備単位)に分割し、利用者・外部システム・データストアとの関係を俯瞰で合意する
|
|
21
|
-
- **説明(Markdown)**: 図の要素(人/境界/コンテナ/DB/外部/関係)の意味を文章で合意する
|
|
22
|
-
|
|
23
|
-
Mermaid 記法そのもののルールは [cnd-mermaid-rulebook.md](cnd-mermaid-rulebook.md) を参照してください。
|
|
21
|
+
対象システムを主要な実行・配備単位とデータストアに分け、責務、接続、配置上の前提を定義する規約です。インフラ設計と結合テストへ渡す境界を扱い、内部実装や連携構文は各正本へ委ねます。
|
|
24
22
|
|
|
25
23
|
## 1. 全体方針
|
|
26
24
|
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
|
|
32
|
-
## 2. ファイル命名・ID規則
|
|
33
|
-
|
|
34
|
-
- ファイル名: `cnd-<番号>-<短い日本語名>.md`
|
|
35
|
-
- 例: `cnd-010-駄菓子屋きぬや販売管理システム-コンテナ.md`
|
|
36
|
-
- Frontmatter:
|
|
37
|
-
- `id`: 小文字ハイフン形式(例: `cnd-candy-shop-sales-container`)
|
|
38
|
-
- `title`: 「〇〇のC4コンテナ図」のように対象が分かる表現
|
|
39
|
-
|
|
40
|
-
## 3. 推奨 Frontmatter 項目
|
|
41
|
-
|
|
42
|
-
Frontmatter の共通ルールは [document-metadata-standard.md](../standards/document-metadata-standard.md) に従います。
|
|
43
|
-
|
|
44
|
-
| 項目 | 説明 | 必須 |
|
|
45
|
-
| ---------- | ---------------------------------------------- | ---- |
|
|
46
|
-
| id | ドキュメントID(小文字ハイフン) | ○ |
|
|
47
|
-
| type | `architecture` 固定 | ○ |
|
|
48
|
-
| title | ドキュメント名 | ○ |
|
|
49
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
50
|
-
| part_of | 上位ドキュメントID(分割している場合) | 任意 |
|
|
51
|
-
| based_on | 根拠となる定義(用語集、外部IF、上位方針など) | 任意 |
|
|
52
|
-
| supersedes | 置き換え関係(古い図→新しい図) | 任意 |
|
|
53
|
-
|
|
54
|
-
### 3.1. `based_on` の考え方(例)
|
|
55
|
-
|
|
56
|
-
- 用語集(`gl-...`)や業務データ辞書(`bdd-...`)
|
|
57
|
-
- 外部システムIFの仕様(IF章のドキュメント)
|
|
58
|
-
- 参照する上位の方針(DEC、非機能要件など)
|
|
59
|
-
|
|
60
|
-
## 4. CNDで合意すること(スコープ)
|
|
61
|
-
|
|
62
|
-
### 4.1. 合意したいこと
|
|
63
|
-
|
|
64
|
-
- 対象システムの境界(System Boundary)と、責務の一言(何をするシステムか)
|
|
65
|
-
- 主要コンテナ(Container)の一覧と、それぞれの責務(1〜2文)
|
|
66
|
-
- 主要DB(Database)がある場合、その役割(何を永続化するか)
|
|
67
|
-
- 外部システム(External Software System)と、連携の意図(何をやり取りするか)
|
|
68
|
-
- 関係(Relationship)の向きと意味(誰が主に呼び出す/依存するか)
|
|
69
|
-
|
|
70
|
-
### 4.2. 合意しないこと(この図で扱わない)
|
|
71
|
-
|
|
72
|
-
- コンテナ内部の分解(コンポーネント/クラス、内部モジュール構成)
|
|
73
|
-
- APIエンドポイント、HTTPメソッド、リクエスト/レスポンスJSONなどのIF詳細
|
|
74
|
-
- 物理テーブル名・物理カラム名・SQL全文
|
|
75
|
-
- 実装クラス/関数名、ライブラリ名、具体的な技術選定の列挙
|
|
76
|
-
- 画面遷移やクリック手順の逐語列挙
|
|
77
|
-
|
|
78
|
-
## 5. CNDの要素定義(図と文章の両方で説明する)
|
|
79
|
-
|
|
80
|
-
この章では、図に描いた要素について **最低限の説明**を併記し、レビュー可能にします。
|
|
81
|
-
|
|
82
|
-
### 5.1. Person(人/ロール)
|
|
83
|
-
|
|
84
|
-
Personは、対象システムに対して目的をもって関わる主体(人/役割/組織)です。
|
|
85
|
-
|
|
86
|
-
- 書くこと(推奨):
|
|
87
|
-
- ロール名(例: 店員、店主、経理担当)
|
|
88
|
-
- どのコンテナを、何のために利用するか(例: Webアプリで売上登録を行う)
|
|
89
|
-
|
|
90
|
-
- 書かないこと:
|
|
91
|
-
- 個人名、UI操作手順の逐語列挙
|
|
92
|
-
|
|
93
|
-
### 5.2. System Boundary(システム境界)
|
|
94
|
-
|
|
95
|
-
境界は「対象システムが責任を持つ範囲」を表します。
|
|
96
|
-
|
|
97
|
-
- 書くこと(推奨):
|
|
98
|
-
- 境界に含めるもの
|
|
99
|
-
- 境界に含めないもの(外部システム/外部サービス等)
|
|
100
|
-
|
|
101
|
-
### 5.3. Container(コンテナ)
|
|
102
|
-
|
|
103
|
-
コンテナは、実行/配備単位(例: Webアプリ、API、バッチ)です。
|
|
25
|
+
- 一つの対象システムを扱い、上位の C4 コンテキスト図の利用者・外部依存・責任分界を引き継ぎます。範囲の拡張や仮定は明示します。
|
|
26
|
+
- コンテナは実行・配備単位として分け、機能名やソースディレクトリだけを理由に分割しません。データストアはファイル群やリポジトリでもよく、DB 製品の導入を前提にしません。
|
|
27
|
+
- 図は主要経路を、本文は責務・利用条件・技術制約を説明します。図の矢印を文章でなぞる説明は置きません。
|
|
28
|
+
- 記法は `includes` の [[specdojo:cnd-mermaid-rulebook|CND Mermaid 記法ルール]] に従います。形状・色・構文は本書で再定義しません。
|
|
104
29
|
|
|
105
|
-
|
|
106
|
-
- コンテナ名
|
|
107
|
-
- 責務(1〜2文)
|
|
108
|
-
- 書くこと(推奨):
|
|
109
|
-
- 主な入出力の種類(例: 売上登録、在庫照会)
|
|
110
|
-
- 関係するデータストア(例: 販売DBを更新する)
|
|
111
|
-
- 書かないこと:
|
|
112
|
-
- 内部クラス/関数、モジュール階層の列挙
|
|
30
|
+
### 1.1. 作成・合意・保守の責任
|
|
113
31
|
|
|
114
|
-
|
|
32
|
+
- ARC が作成と技術判断を担い、本 rulebook の継続更新・問い合わせ窓口となります。上位図の境界を確認した後に着手し、下位コンポーネント図・インフラ構成図の具体化と結合検証設計への引き渡し前に、利用する範囲をレビューします。
|
|
33
|
+
- BA は業務側の利用者代表と対象範囲・利用場面を、DEV は実行単位と接続方式を、QE は境界ごとの観測結果を、OPS は配備・公開・運用の前提を確認します。図に描く Person と設計の確認者は区別します。
|
|
34
|
+
- PO が対象範囲・残るリスク・公開可否を最終判断し、人間が承認または保留・差し戻しを記録します。ARC の技術確認や自動検査の成功だけでは承認完了としません。
|
|
35
|
+
- PM は作成・レビュー・課題解消をタスクへ分け、担当 Role code と判断期限を計画します。兼務と実行主体は [[specdojo:people-and-organization-definition-standard|人と組織の定義標準]] および適用先のロール・メンバー定義に従います。
|
|
115
36
|
|
|
116
|
-
|
|
37
|
+
## 2. 位置づけと用語定義
|
|
117
38
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
39
|
+
| 用語 | 本書での意味 |
|
|
40
|
+
| ------------ | -------------------------------------------------------------------------- |
|
|
41
|
+
| コンテナ | アプリケーションなどの実行・配備単位。Docker の利用を意味しない |
|
|
42
|
+
| データストア | 永続記録の保持単位。コンテナと並べて描き、生成物と正本を区別する |
|
|
43
|
+
| システム境界 | 対象が責務を持つ範囲。同一端末・同一ネットワークという物理配置とは区別する |
|
|
123
44
|
|
|
124
|
-
|
|
45
|
+
上位コンテキスト図は対象システムと外部との境界、本図はその内部構成、コンポーネント図は各コンテナ内部、インフラ構成図は物理配置・ネットワークを扱います。バージョン、コマンド構文、データ構造は技術スタック・リファレンス・schema・外部 IF 仕様を正本とします。
|
|
125
46
|
|
|
126
|
-
|
|
47
|
+
## 3. ファイル命名・ID規則
|
|
127
48
|
|
|
128
|
-
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
- 書かないこと:
|
|
133
|
-
- API仕様の詳細、データ項目一覧(それらはIF仕様へ)
|
|
49
|
+
- 共通規則は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] と [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
50
|
+
- ファイル名は `cnd-<context>.md` とし、対象を表す英小文字・数字・ハイフンで識別します。プロダクト文書は原則 `docs/<lang>/product/030-architecture/010-c4/` に置きます。
|
|
51
|
+
- プロダクト文書の ID は `cnd-<context>`、プロジェクト文書は `<project-id>:cnd-<context>` とします。H1 に対象名と C4 コンテナ図であることを示します。
|
|
52
|
+
- 関係には文書内で一意な `REL-01` 形式の ID を付け、図の端点名・ラベルと定義表を対応付けます。名称変更だけでは関係 ID を振り直しません。
|
|
134
53
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
関係は「やり取りの意味」を合意するための線です。CNDでは **すべての関係にラベル**を付けます。
|
|
138
|
-
|
|
139
|
-
- 書くこと(必須):
|
|
140
|
-
- 方向(誰が主に利用/依存/送信するか)
|
|
141
|
-
- ラベル(短い日本語。名詞句または短い動詞句)
|
|
142
|
-
- 書かないこと:
|
|
143
|
-
- HTTP詳細、データ項目列挙、SQL、実装条件式
|
|
144
|
-
|
|
145
|
-
## 6. 本文構成(標準テンプレ)
|
|
146
|
-
|
|
147
|
-
各 CND 成果物は、以下見出しを順番に並べます。
|
|
148
|
-
|
|
149
|
-
1. 概要
|
|
150
|
-
2. C4コンテナ図(Mermaid)
|
|
151
|
-
3. 要素の説明
|
|
152
|
-
4. 補足
|
|
153
|
-
|
|
154
|
-
## 7. 記述ガイド詳細
|
|
155
|
-
|
|
156
|
-
### 7.1. 概要
|
|
157
|
-
|
|
158
|
-
- 「この図が何を表すか」「対象システム」「前提」を1〜3文で書きます。
|
|
159
|
-
|
|
160
|
-
### 7.2. C4コンテナ図(Mermaid)
|
|
161
|
-
|
|
162
|
-
- Mermaid のコードブロックで図を記述します。
|
|
163
|
-
- Mermaid 記法ルールは [cnd-mermaid-rulebook.md](cnd-mermaid-rulebook.md) に従います。
|
|
164
|
-
- 図には、少なくとも以下を含めます。
|
|
165
|
-
- Person(いる場合)
|
|
166
|
-
- 境界(System Boundary)
|
|
167
|
-
- 主要コンテナ(2〜7個程度を目安)
|
|
168
|
-
- 主要DB(ある場合)
|
|
169
|
-
- 外部システム(ある場合)
|
|
170
|
-
- 関係(Relationship。全矢印にラベル)
|
|
171
|
-
|
|
172
|
-
### 7.3. 要素の説明
|
|
173
|
-
|
|
174
|
-
- 図に登場する要素を、レビューしやすい粒度で説明します。
|
|
175
|
-
- 推奨スタイル:
|
|
176
|
-
- `###` レベルの小見出しで要素名(境界/人/コンテナ/DB/外部/関係)
|
|
177
|
-
- 1〜3文で意味・前提・境界条件(含む/含まない)を説明
|
|
178
|
-
|
|
179
|
-
### 7.4. 補足
|
|
180
|
-
|
|
181
|
-
- 未確定な外部連携、境界が揺れている論点、図を分ける必要がありそうな論点を列挙します。
|
|
182
|
-
|
|
183
|
-
## 8. 命名・記述スタイル
|
|
184
|
-
|
|
185
|
-
- 用語はこの図の中で揺らさない(同じコンテナ/外部を別名で呼ばない)。
|
|
186
|
-
- ラベルは短くし、長い場合は改行(`<br>`)で読みやすくする(詳細はIF仕様へ)。
|
|
187
|
-
- コンテナは「責務が読める短い名前」を優先し、実装都合の命名(内部モジュール名など)に寄せすぎない。
|
|
188
|
-
|
|
189
|
-
## 9. 禁止事項
|
|
190
|
-
|
|
191
|
-
次の記述は、CNDの粒度を超えるため避けます。
|
|
192
|
-
|
|
193
|
-
| 項目 | 理由 |
|
|
194
|
-
| --------------------------------------- | -------------------------------- |
|
|
195
|
-
| 物理テーブル名・物理カラム名・SQL全文 | 図の粒度を超える(DB設計に記述) |
|
|
196
|
-
| APIエンドポイント/HTTP/JSON等の詳細 | IF仕様に記述する |
|
|
197
|
-
| 実装クラス/関数名、内部モジュールの列挙 | 変更に弱い・合意の対象がずれる |
|
|
198
|
-
| 画面遷移やクリック手順の逐語列挙 | UI変更に弱い・図の目的から逸脱 |
|
|
199
|
-
| コンポーネント/クラス等の内部構造の詳細 | コンポーネント図/実装設計で表す |
|
|
200
|
-
| 矢印ラベルなしの関係 | 何の関係か合意できない |
|
|
201
|
-
|
|
202
|
-
## 10. レビュー観点(チェックリスト)
|
|
203
|
-
|
|
204
|
-
- 対象システムは1つに絞れているか
|
|
205
|
-
- 境界の内外が説明され、責任分界が曖昧でないか
|
|
206
|
-
- 主要コンテナが多すぎず(目安: 2〜7)、過不足なく俯瞰できるか
|
|
207
|
-
- Person/外部システム/DBがある場合、必要十分に含まれているか
|
|
208
|
-
- すべての関係にラベルがあり、意味が解釈一致するか
|
|
209
|
-
- 図が「コンポーネント/実装詳細」や「IF詳細」に踏み込んでいないか
|
|
210
|
-
|
|
211
|
-
## 11. サンプル(簡易)
|
|
212
|
-
|
|
213
|
-
```yaml
|
|
214
|
-
---
|
|
215
|
-
id: cnd-candy-shop-sales-container
|
|
216
|
-
type: architecture
|
|
217
|
-
title: 駄菓子屋きぬや販売管理システムのC4コンテナ図
|
|
218
|
-
status: draft
|
|
219
|
-
part_of: []
|
|
220
|
-
based_on: []
|
|
221
|
-
---
|
|
222
|
-
```
|
|
54
|
+
## 4. 推奨 Frontmatter 項目
|
|
223
55
|
|
|
224
|
-
|
|
56
|
+
共通項目の配置・必須条件・型・値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
225
57
|
|
|
226
|
-
|
|
58
|
+
- SpecDojo のメタ情報は `specdojo:` 配下に置きます。文書名は本文先頭の H1 に記し、Frontmatter の `title` で代用しません。
|
|
59
|
+
- `type` は `architecture`、主 `rulebook` は `specdojo:cnd-rulebook` とします。記法部品を主 rulebook にしません。
|
|
60
|
+
- `based_on` は上位コンテキスト図など、カタログの `depends_on` の推移閉包にある直接の内容根拠に限ります。共通のプロジェクト文脈は本文で参照します。
|
|
61
|
+
- 作成・編集時は `draft` を維持します。上位文書への所属や置き換えは共通規約に従い、仮定の説明をメタ項目の追加で代用しません。
|
|
227
62
|
|
|
228
|
-
|
|
63
|
+
## 5. 本文要件
|
|
229
64
|
|
|
230
|
-
|
|
231
|
-
flowchart LR
|
|
232
|
-
%% Person
|
|
233
|
-
店員["👤店員"]
|
|
65
|
+
見出し順、表の列、記入欄の骨組みは template を正本とし、ここでは各章の意味要件を定めます。
|
|
234
66
|
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
67
|
+
| 章の役割 | 必須 | 満たす内容 |
|
|
68
|
+
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
69
|
+
| 概要 | 必須 | 対象、上位図との対応、利用目的、対象外を示す |
|
|
70
|
+
| 構成図 | 必須 | 一つのシステム境界に主要コンテナとストアを置き、直接利用者と外部依存を結ぶ。全関係にラベルを付ける |
|
|
71
|
+
| 要素・境界の定義 | 必須 | 境界内外、利用者の接点、コンテナの責務・技術区分・配置前提、ストアの正本と生成物、外部依存の利用条件・失敗影響、関係の方式と詳細の正本を説明する |
|
|
72
|
+
| 技術前提・検証対象 | 必須 | 実行時と構築時、ローカルとリモート、読み書きの境界を区別する。結合確認の対象を関係 ID または要素名で識別する |
|
|
73
|
+
| 未確定事項の引き継ぎ | 条件付き | 仮定・未確定の経路・配置がある場合、影響、担当ロール、解消条件、引き継ぎ先を残す |
|
|
238
74
|
|
|
239
|
-
|
|
240
|
-
subgraph 境界["対象システム"]
|
|
241
|
-
Webアプリ("Webアプリ<br>(レジ/管理画面)")
|
|
242
|
-
API("API<br>(販売/在庫)")
|
|
243
|
-
販売DB[("販売DB")]
|
|
244
|
-
end
|
|
75
|
+
Person・外部システム・ストアが該当しない場合は、その旨と理由を定義欄へ記載します。主要コンテナは 2〜7 個程度を目安としますが、数に合わせて未根拠の実行単位を追加しません。
|
|
245
76
|
|
|
246
|
-
|
|
247
|
-
店員 -->|"売上登録"| Webアプリ
|
|
248
|
-
Webアプリ -->|"API呼び出し"| API
|
|
249
|
-
API -->|"売上データ"| 販売DB
|
|
77
|
+
## 6. 記述ガイド
|
|
250
78
|
|
|
251
|
-
|
|
252
|
-
API -->|"決済依頼"| 決済サービス
|
|
253
|
-
決済サービス -->|"決済結果"| API
|
|
79
|
+
共通のメタ情報・用語は上位標準を参照し、本章では CND 固有の判断だけを扱います。
|
|
254
80
|
|
|
255
|
-
|
|
256
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
257
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
258
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
259
|
-
class 店員 person;
|
|
260
|
-
class Webアプリ,API,販売DB system;
|
|
261
|
-
class 会計システム,決済サービス external;
|
|
262
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
263
|
-
```
|
|
81
|
+
### 6.1. 概要
|
|
264
82
|
|
|
265
|
-
|
|
83
|
+
- 上位図のどの対象を分解するかと、読み手が配置・結合について何を判断するかを示します。
|
|
84
|
+
- 上位図が扱わない閲覧経路などを加える場合は、中核責務を変えるのか、派生した提供経路なのかを説明します。
|
|
85
|
+
- 承認対象と確認者を Role code で識別し、業務側の確認が必要な利用場面を対応付けます。実際の承認記録はプロジェクトの決定記録を参照し、図中の Person 名から承認者を推定しません。
|
|
86
|
+
- 良い例: 「販売システムを画面、処理サービス、記録ストアへ分け、店頭入力から保存までを示す」。悪い例: 「便利なシステムの全体像」。後者は対象と分割の目的を判定できません。
|
|
266
87
|
|
|
267
|
-
|
|
88
|
+
### 6.2. C4コンテナ図(Mermaid)
|
|
268
89
|
|
|
269
|
-
|
|
90
|
+
- 責務と実行・配備単位で候補を選びます。構築時だけ成立する線や任意の外部依存は、ラベルまたは注記で条件を示します。
|
|
91
|
+
- 良い例: 「サイト → 文書ストア: 公開対象文書の参照(構築時)」。悪い例: 「サイト → 文書ストア: 連携」。後者では稼働中にストアへアクセスする必要があるか判断できません。
|
|
92
|
+
- 矢印が依頼の方向か情報移動の方向かを注記し、応答を省略する場合も意味が通るようにします。
|
|
93
|
+
- 「主要経路」は上位図の各利用目的・外部依存を実現する経路とします。各経路の担当コンテナを特定し、描かない経路は対象外の理由を示します。数の目安だけで要素や関係を省きません。
|
|
270
94
|
|
|
271
|
-
|
|
95
|
+
### 6.3. 要素と境界の定義
|
|
272
96
|
|
|
273
|
-
|
|
97
|
+
- 境界、Person、Container、Data Store、External Software System、Relationship に分けて説明します。名称と関係ラベルは図と一致させます。
|
|
98
|
+
- コンテナごとに責務、実行・配備形態、既知の技術区分を示します。未確認の技術名やホストは仮定とし、内部モジュールは列挙しません。
|
|
99
|
+
- 推奨する関係表の列は「関係 ID」「起点 → 終点」「図中ラベル」「方式・条件と情報の要点」「詳細の正本」です。構文やフィールド一覧は参照先へ委ねます。
|
|
100
|
+
- 良い例: 「文書リポジトリは仕様の正本を保持し、閲覧用サイトはその生成物を配る」。悪い例: 「GitHub DB に全データを保存」。後者はファイル、版管理機構、共有サービスを混同しています。
|
|
101
|
+
- 外部依存は常時必須か、機能選択時だけ必要かを示します。ストアの直接更新者が複数ある場合、線の省略を単独書込の保証にしません。
|
|
102
|
+
- 図の全ノードに定義を、全関係に一意な関係 ID と定義行を対応付けます。図と表の起点・終点・ラベル・境界内外が一致することを合格条件とし、表だけに残った要素・関係も解消します。
|
|
274
103
|
|
|
275
|
-
|
|
104
|
+
### 6.4. 技術前提・制約と検証観点
|
|
276
105
|
|
|
277
|
-
|
|
106
|
+
- 配置設計に必要な入力と、決まっていない入力を分けます。ホスト台数・ポート・製品バージョンを埋めて合意済みと扱いません。
|
|
107
|
+
- 関係 ID を使い、保存・生成・外部呼び出しなどの結合対象と観測する結果を示します。テストケースや復旧手順の詳細までは定義しません。
|
|
108
|
+
- 下流の結合検証へ渡す各経路には正常時の結果を、外部依存・保存先には不在・失敗・結果不明時に区別する状態を記します。未確定の期待結果は検証済みの保証にせず、引き継ぐ論点にします。
|
|
109
|
+
- 良い例: 「構築時の読取不能と公開済みサイトの参照を分けて確認する」。悪い例: 「結合テストを実施する」。後者は対象と失敗の影響を識別できません。
|
|
278
110
|
|
|
279
|
-
|
|
111
|
+
### 6.5. メモ / 将来課題
|
|
280
112
|
|
|
281
|
-
|
|
113
|
+
- _ASSUMPTION_ と確定事項を分離し、影響する要素・関係、担当、解消条件を記録します。
|
|
114
|
+
- 配置・接続・公開の判断を妨げる論点は ARC が影響と対応案を PM へ報告し、PM が PJR の課題・リスク・変更要求・決定記録へ引き継ぎます。本図には転送先レコード、担当 Role code、判断期限または下流着手前などの判断時点を残し、解消後は ARC が図と参照先へ反映します。
|
|
115
|
+
- 良い例: 「配信先未確定。ARC が公開範囲と配備方式を整理し、PM が課題登録する。転送先レコードを本図へ記録し、配備設計の着手前に PO が判断する」。悪い例: 「配信は後で考える」。後者は担当と判断時点を追跡できません。
|
|
116
|
+
- 境界やコンテナを改訂・廃止したときは ARC が上位図・下位コンポーネント図・インフラ構成図の参照影響を確認し、DEV が連携実装、QE が該当する結合対象を追従させます。ライフサイクルの共通手続きはメタ情報標準を正本とします。
|
|
282
117
|
|
|
283
|
-
|
|
118
|
+
### 6.6. 検証・承認前の確認
|
|
284
119
|
|
|
285
|
-
|
|
120
|
+
このリポジトリではルートから次を実行します。`<対象.md>` は作成・変更した CND 文書の相対パスへ置き換えます。利用先では導入済みツールと検証設定に合わせ、同じ確認を行います。
|
|
286
121
|
|
|
287
|
-
|
|
122
|
+
| 確認 | コマンド | 合格条件 |
|
|
123
|
+
| ----------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
|
|
124
|
+
| Markdown | `node packages/docs-lint/bin/specdojo-docs-lint.js markdownlint <対象.md>` | 終了コード 0、記法違反なし |
|
|
125
|
+
| Frontmatter・本文 | `node packages/docs-lint/bin/specdojo-docs-lint.js remark <対象.md> --quiet --frail` | 終了コード 0、成果物 schema と主 rulebook の宣言に適合 |
|
|
126
|
+
| Mermaid 構文 | `node tools/lint-mermaid.mjs <対象.md>` | 終了コード 0、対象の全図が passed、エラー・未検査なし |
|
|
127
|
+
| Mermaid 描画 | `npm run docs:build:mermaid` | 終了コード 0、対象図の SVG が生成され、文字・矢印・境界を判読できる |
|
|
288
128
|
|
|
289
|
-
-
|
|
129
|
+
- QE は「C4コンテナ図(Mermaid)」「要素と境界の定義」「技術前提・制約と検証観点」の合格条件を照合し、コマンド結果と対象図の目視確認をレビュー記録へ残します。描画の成功だけでは内容の合格としません。失敗・未検査は原因を修正して再検査し、確認不能なら理由と次の確認者を記録して承認を保留します。
|
|
130
|
+
- ARC は必須の内容要件、上位図との対応、各確認者のレビュー結果、未解決指摘と PJR の転送先をそろえて PO へ渡します。構成・接続・公開可否を左右する未決事項は解消するか、採用する前提・影響・後続作業の制限について PO の判断を記録します。
|
|
131
|
+
- 人間の PO が承認を記録した後に、人間が `ready` への昇格を判断します。OPS は公開対象と承認対象が一致し、公開範囲の未決事項が解消していることを確認してから公開します。生成成功や `ready` の値だけを公開許可と扱いません。
|
|
290
132
|
|
|
291
|
-
##
|
|
133
|
+
## 7. 禁止事項
|
|
292
134
|
|
|
293
|
-
-
|
|
135
|
+
- 機能一覧・クラス・関数・ソース階層を、そのままコンテナとして描くこと。
|
|
136
|
+
- ストアのファイル群と、Git の履歴操作、リモート共有サービスを一つの実行単位として混同すること。
|
|
137
|
+
- IF の引数・ペイロード、schema の項目一覧、SQL、技術スタックのバージョン一覧を転載すること。
|
|
138
|
+
- 構築時だけの関係を常時接続として示すこと、または根拠のない配置・再試行・保存保証を確定事項として書くこと。
|
|
139
|
+
- 人間が担う承認や公開判断を、作成・生成・外部処理の成功だけで代替すること。
|