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
|
@@ -3,312 +3,123 @@ specdojo:
|
|
|
3
3
|
id: specdojo:sysd-cross-cutting-policy-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: architecture
|
|
6
|
-
status:
|
|
6
|
+
status: ready
|
|
7
|
+
recipe: specdojo:sysd-cross-cutting-policy-recipe
|
|
7
8
|
sample: specdojo:sysd-cross-cutting-policy-sample
|
|
9
|
+
template: specdojo:sysd-cross-cutting-policy-template
|
|
8
10
|
---
|
|
9
11
|
|
|
10
12
|
# システム設計 / 横断ルール 作成ルール
|
|
11
13
|
|
|
12
|
-
System Design Cross-cutting Policy
|
|
14
|
+
System Design Cross-cutting Policy Documentation Rules
|
|
13
15
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
実装全体に影響する共通ルールを最小限でSSOT化する **System Design Cross-cutting Policy (SYSD-CCP)** の記述ルールを定義する。
|
|
17
|
-
|
|
18
|
-
SYSD-CCP は「詳細実装の手順書」ではない。
|
|
19
|
-
**全体に共通する“前提”と“禁止事項”と“例外時の扱い”** を明確にし、実装ブレと事故を防ぐ。
|
|
16
|
+
複数の実装領域で守る制約、例外、検証条件を一つの正本にまとめるための規定である。値・構文・構造の詳細は実装・schema・リファレンスに委ね、共通の判断と適用境界を定める。
|
|
20
17
|
|
|
21
18
|
## 1. 全体方針
|
|
22
19
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
- テスト(ITS/ETS/STC)と運用(OPD/OPR)に必要な共通前提を提供する
|
|
28
|
-
- 詳細をコードへ寄せつつ、**“コードから自動生成できない意図”** を残す
|
|
29
|
-
|
|
30
|
-
基本方針:
|
|
31
|
-
|
|
32
|
-
- ルールは「最小限」かつ「強い」を原則とし、禁止・必須・例外条件を明確にする
|
|
33
|
-
- ルールは可能な限り測定可能/検証可能(CI/lint/テスト)な形で定義する
|
|
34
|
-
- 例外は SYSD-CCP 本文に散らさず、DECで理由と影響範囲を管理する
|
|
35
|
-
|
|
36
|
-
## 2. 位置づけと用語定義(必要に応じて)
|
|
37
|
-
|
|
38
|
-
### 2.1. 位置づけ
|
|
20
|
+
- 対象システムの複数モジュールに共通する必須・禁止条件を扱う。個別機能の詳細手順や一時作業の計画は持ち込まない。
|
|
21
|
+
- 対象者の課題と上位の価値・成功基準への寄与を短く示す。プロジェクト背景の全文を再掲しない。
|
|
22
|
+
- 各ルールを入力条件と観測可能な期待結果で判定できるようにする。規定の存在と実装済みの証拠を区別する。
|
|
23
|
+
- 未確定の値や業務判断を推測しない。担当、判断期限、影響、次アクションを伴う共通ラベルで残す。
|
|
39
24
|
|
|
40
|
-
|
|
41
|
-
- `sysd-index`:実体定義(OpenAPI/AsyncAPI/schema/workflow など)への導線
|
|
42
|
-
- `sysd-critical-flows`:事故予防のための重要フロー(難所)
|
|
43
|
-
- `nfr-*`:非機能要件の基準値
|
|
44
|
-
- `opd-*` / `opr-*`:運用方針・運用手順
|
|
45
|
-
- `dec-*`:例外や設計判断の根拠
|
|
25
|
+
## 2. 位置づけと用語定義
|
|
46
26
|
|
|
47
|
-
|
|
27
|
+
| 情報 | 責務 |
|
|
28
|
+
| -------------------------- | -------------------------------------------------------- |
|
|
29
|
+
| システム設計索引 | 実装・設定・schema・生成物の所在と変更の入口 |
|
|
30
|
+
| 横断ルール | 複数領域に共通する不変条件、適用範囲、例外、検証の正本 |
|
|
31
|
+
| 個別設計・非機能要件・運用 | 個別の構成、目標値、通知・保持・回復手順の詳細 |
|
|
32
|
+
| 決定記録・登録簿・Schedule | 例外承認、課題・リスク・変更、担当・期限・作業進捗の正本 |
|
|
48
33
|
|
|
49
|
-
|
|
50
|
-
| ----------- | ------------------------------------------------------------- |
|
|
51
|
-
| 横断ルール | 複数モジュール/サービスに共通して適用される実装・運用の規約 |
|
|
52
|
-
| 例外 | SYSD-CCPの通常ルールから外れる運用。理由と期限をDECで明示する |
|
|
53
|
-
| Enforcement | ルールを守らせる検証手段(CI、テスト、レビュー等) |
|
|
34
|
+
「例外」は通常規則から承認を得て外れる条件、「不適合」は未承認の逸脱、「未確認」は適合証拠が未取得の状態とする。未確認を例外や実装済みへ読み替えない。
|
|
54
35
|
|
|
55
36
|
## 3. ファイル命名・ID規則
|
|
56
37
|
|
|
57
|
-
-
|
|
58
|
-
- ルールIDは `scp-<カテゴリ>-<連番>`
|
|
59
|
-
-
|
|
60
|
-
- 1ルール=1論点を原則とし、例外条件と意図は同一ルール内で簡潔に記述する。
|
|
38
|
+
- ファイル名は `sysd-cross-cutting-policy.md` を基本とし、文書 ID の authority はプロジェクトの共通命名規約に従う。
|
|
39
|
+
- ルール ID は `scp-<カテゴリ>-<連番>` とし、同じ適用範囲内で一意かつ改訂後も追跡可能にする。
|
|
40
|
+
- カテゴリは `ERR`(エラー)、`IDM`(冪等)、`TIM`(時間制御)、`RET`(再試行)、`LOG`(ログ)、`TRC`(追跡)、`SEC`(保護)、`CFG`(設定)、`MOD`(境界)等を使う。カテゴリ追加で必須領域を隠さない。
|
|
61
41
|
|
|
62
42
|
## 4. 推奨 Frontmatter 項目
|
|
63
43
|
|
|
64
|
-
|
|
44
|
+
- 共通の型・許容値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と成果物 Frontmatter schema を正とし、ここで再定義しない。
|
|
45
|
+
- 成果物・完成例と template の生成物 Frontmatter では、`type` を本書の `deliverable_type` と同じ `architecture` に、`rulebook` を本書の完全 ID にする。template 自身の `type: template` と混同しない。設計索引へ所属する成果物は `part_of` で接続する。
|
|
46
|
+
- `based_on` は実際に判断に使った依存範囲内の文書だけにする。プロジェクト共通文脈を機械的に転記しない。
|
|
47
|
+
- `status` は agent が `ready` に変更しない。公開可否と昇格の判断責任は本文にも示す。
|
|
65
48
|
|
|
66
|
-
|
|
49
|
+
## 5. 本文要件
|
|
67
50
|
|
|
68
|
-
|
|
69
|
-
| ---------- | ------------------------------------------------ | ---- |
|
|
70
|
-
| id | SYSD-CCP ID(推奨: `sysd-cross-cutting-policy`) | ○ |
|
|
71
|
-
| type | `architecture` 固定 | ○ |
|
|
72
|
-
| title | システム設計: 横断ルール | ○ |
|
|
73
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
74
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
75
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
51
|
+
見出し順・表・記入欄の骨組みは frontmatter で宣言する template を正とし、ここでは意味要件を定める。Markdown の `##`〜`####` には階層ごとの連番と末尾の `.` を付ける。
|
|
76
52
|
|
|
77
|
-
|
|
53
|
+
| 内容 | 必須 | 意味・判定に必要な情報 |
|
|
54
|
+
| ------------------ | ---- | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
55
|
+
| 概要 | ○ | 対象・対象外、競合時の優先判断、上位価値への寄与、利用者・確認者・人間の最終承認者 |
|
|
56
|
+
| ルール一覧 | ○ | ID・カテゴリ・要約・必須度・Owner。全詳細と対応し、実装状況または確認待ち、確認時機と依存順へ接続 |
|
|
57
|
+
| 各ルール詳細 | ○ | Rule、Rationale、Scope、Enforcement、Exception、References の六要素。条件・期待結果・正本・検証コマンドを特定 |
|
|
58
|
+
| 例外 | ○ | 承認済み例外の有無、対象 Rule ID・理由・影響・期限・判断者・復帰条件・決定参照。不適合・risk・change・decision の記録と追跡責務 |
|
|
59
|
+
| 関連導線 | ○ | 設計、非機能、運用、テスト、判断記録への入口。Rule 変更から schema・生成物・互換性・移行・回帰対象への影響と担当 |
|
|
60
|
+
| 未決事項・公開条件 | ○ | 未確定の対象 ID、判断者・期限・影響・次アクション、計画登録の状況。確認完了と人間による公開・昇格の条件 |
|
|
78
61
|
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
`sysd-cross-cutting-policy` は以下の見出し構成を **順序固定** で配置する。
|
|
85
|
-
|
|
86
|
-
| 番号 | 見出し | 必須 |
|
|
87
|
-
| ---- | --------------------------------------------------------------- | ---- |
|
|
88
|
-
| 1 | 概要(適用範囲・優先順位) | ○ |
|
|
89
|
-
| 2 | ルール一覧(ID/カテゴリ/要約/必須度) | ○ |
|
|
90
|
-
| 3 | 各ルール詳細(ID単位) | ○ |
|
|
91
|
-
| 4 | 例外(DECリンク) | ○ |
|
|
92
|
-
| 5 | 関連ドキュメント導線(SDI/SYSD Critical Flows/NFR/OPD/OPR/DEC) | ○ |
|
|
93
|
-
|
|
94
|
-
補足:
|
|
95
|
-
|
|
96
|
-
- ルール一覧は「探しやすさ」を最優先し、カテゴリ単位で整理する。
|
|
97
|
-
- 例外の詳細本文は書かず、例外条件の入口とDECリンクのみを置く。
|
|
62
|
+
- 完成例にも上表の必須内容とルール詳細の六要素を適用する。架空の正本・検証コマンドは未同梱と明示し、検証計画を実行済み証跡として扱わない。
|
|
63
|
+
- 共通エラー・冪等・時間上限と打切り・retry・診断ログと監査・トレーシング・秘密と権限・設定上書き・モジュール境界を必ず検討する。非該当は構成上の理由と代替手段、または代替不要の理由を示す。
|
|
64
|
+
- HTTP API がなければ CLI 等のエラー契約を扱い、DB がなければファイル保存と途中状態の整合性を扱う。特定技術がないことを領域全体の対象外理由にしない。
|
|
65
|
+
- retry は冪等前提、signal 分類、回数の数え方、attempt・backoff 上限、fallback・上限到達時の処置を正本の値または設定キーへ接続する。未定義なら受入を保留し、判断課題を明示する。
|
|
66
|
+
- timeout は経路別の設定・単位、終了対象、部分出力・保存状態、再開条件を結ぶ。ログ・監視は相関、秘匿化、保持、検知・通知・一次対応の適用範囲を示す。
|
|
98
67
|
|
|
99
68
|
## 6. 記述ガイド
|
|
100
69
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
生成する本文の見出しは **## 1. 概要(適用範囲・優先順位)**
|
|
70
|
+
共通の値・構造・用語は上位索引または各正本へ委ねる。以下の例は局所的な判断例であり、完成例を本文へ埋め込まない。
|
|
104
71
|
|
|
105
|
-
|
|
106
|
-
- 「ルールは最小限」「検証可能性を優先」「例外はDECで管理」の原則を明記する。
|
|
107
|
-
- ルール間の優先順位(例: `SEC > ERR > RET > IDM > LOG > CFG > MOD > JOB`)を必要に応じて明示する。
|
|
72
|
+
### 6.1. 概要
|
|
108
73
|
|
|
109
|
-
|
|
74
|
+
判断基準は、読む人が対象と適用しない境界、競合時の判断、人間の承認責務を説明できることである。
|
|
110
75
|
|
|
111
|
-
|
|
76
|
+
- 良い例: 「CLI と日次処理を対象にし、無限再試行を防いで参加者の復旧負荷を減らす。DEV が実装、QE / OPS が確認し、人間の PO が公開可否を判断する」。
|
|
77
|
+
- 悪い例: 「全体に適切な規則を適用する」。対象と責任が判断できない。
|
|
112
78
|
|
|
113
|
-
|
|
114
|
-
- 一覧は「探しやすさ」を優先し、カテゴリ順または重要度順で並べる。
|
|
115
|
-
- ルール詳細本文に飛べる参照(IDの一致)を必ず担保する。
|
|
79
|
+
### 6.2. ルール一覧
|
|
116
80
|
|
|
117
|
-
|
|
81
|
+
判断基準は、一覧・詳細・適合確認の Rule ID が相互に対応し、要約と必須度の組合せで要求・禁止が同じ意味になることである。推奨列は `Rule ID / Category / Summary / Level / Owner` とする。適合状況、依存、確認時機は別の対応表へ分けてもよい。作業の進捗を本文で二重管理しない。
|
|
118
82
|
|
|
119
|
-
|
|
83
|
+
- 良い例: 「`scp-CFG-001`、不正設定で起動しない、MUST、DEV、実装未照合、起動前に V2 で確認」。
|
|
84
|
+
- 悪い例: 「設定責務を分離する、MUST NOT」。必須度を組み合わせると意図と逆になり、進捗にも展開できない。
|
|
120
85
|
|
|
121
|
-
|
|
86
|
+
### 6.3. 各ルール詳細
|
|
122
87
|
|
|
123
|
-
|
|
124
|
-
- **Rationale(意図)**:なぜ必要か(1〜3行)
|
|
125
|
-
- **Scope(適用範囲)**:どこに適用するか(API/ジョブ/イベント等)
|
|
126
|
-
- **Enforcement(検証)**:どう検証するか(CI/テスト/レビュー)
|
|
127
|
-
- **Exception(例外)**:例外条件と参照すべきDEC(ある場合)
|
|
128
|
-
- **References(参照)**:SDI/SYSD Critical Flows/NFR/OPD/OPR等への導線
|
|
88
|
+
判断基準は、条件が同じなら期待動作と合否が一意になり、検証する正本へ到達できることである。共通の検証群へ束ねる場合も Rule ID との対応を残す。
|
|
129
89
|
|
|
130
|
-
|
|
90
|
+
- 良い例: 「再送は保存済みの受付結果を照合した後だけ許可する。応答欠落では結果不明を保持し、自動再送しない。設定キーは契約正本、回帰対象と実行コマンドは検証表へ接続する」。
|
|
91
|
+
- 悪い例: 「criticality に応じて retry」。区分・signal 対応・上限の正本がなく判断不能。
|
|
92
|
+
- Rule は不変条件に絞る。検証の入口を Enforcement、低レベル手順を実装・運用正本に集約し、同じ内容を Scope に繰り返さない。
|
|
131
93
|
|
|
132
|
-
|
|
94
|
+
### 6.4. 例外
|
|
133
95
|
|
|
134
|
-
|
|
135
|
-
- 例外が恒久化しそうな場合は、SYSD-CCP本体ルールへの取り込み可否を定期レビューする。
|
|
136
|
-
- 例外未記載の実装差分は不適合として扱う。
|
|
96
|
+
判断基準は、通常ルールへ復帰でき、未承認の不適合と承認済みの逸脱を区別できることである。
|
|
137
97
|
|
|
138
|
-
|
|
98
|
+
- 良い例: 「依存の暫定許可は対象 adapter のみ、移行完了日まで、PO の decision と復帰条件を記録。違反は issue として DEV が報告、PM が追跡する」。
|
|
99
|
+
- 悪い例: 「緊急時は担当判断で無期限に解除」。影響・期限・責任が追跡できない。
|
|
139
100
|
|
|
140
|
-
|
|
101
|
+
### 6.5. 関連導線
|
|
141
102
|
|
|
142
|
-
|
|
143
|
-
- 参照先は「ID」または「リポジトリ相対パス」で一意に辿れる形にする。
|
|
144
|
-
- 分冊が無い場合でも `(本書のみ)` または `(なし)` を明記し、空欄にしない。
|
|
103
|
+
判断基準は、読み手が参照目的を理解して現行正本へ進め、変更時の追従先を選べることである。見出し・表・リンクでは参照先の文書名を基準に呼称を揃え、略号を使う場合は対応する文書名を示す。
|
|
145
104
|
|
|
146
|
-
|
|
105
|
+
- 良い例: 「保存形式変更は DEV が schema と移行を同期し、旧形式・再実行の回帰を確認。運用索引は未作成のため OPS が整備後に接続する」。
|
|
106
|
+
- 悪い例: 「provider 別設計、運用一式、旧フロー参照」。実在する ID・相対パスがなく特定できない。
|
|
107
|
+
- 呼称の良い例: 「システム設計索引」「重要フロー」を表と参照ラベルで揃える。悪い例: 同じ参照先を表では「SYSD Critical Flows」、導線では説明なく「SYSD-CF」と呼び分ける。
|
|
147
108
|
|
|
148
|
-
|
|
109
|
+
### 6.6. 未決事項と公開条件
|
|
149
110
|
|
|
150
|
-
|
|
151
|
-
- タイムアウト/リトライ(回数、バックオフ、打ち切り、冪等前提)
|
|
152
|
-
- 冪等(キー、重複排除、整合性)
|
|
153
|
-
- トランザクション/整合性(境界、最終的整合性、補償)
|
|
154
|
-
- ログ/監査ログ(必須項目、保持、PII取り扱い)
|
|
155
|
-
- トレーシング(trace_id、propagation)
|
|
156
|
-
- セキュリティ(認証・認可の実装原則、秘密情報、監査)
|
|
157
|
-
- 設定(上書き階層、変更反映、デフォルト管理)
|
|
158
|
-
- モジュール境界/依存方向(アーキ制約)
|
|
159
|
-
- ジョブ運用の共通(再実行性、run_id、失敗時通知)
|
|
111
|
+
判断基準は、PO が承認・保留・差し戻しを選べることである。未発行の作業 ID を発行済みとみなさない。
|
|
160
112
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
1. **共通エラー形式(API)**:error_code / message / detail / trace_id
|
|
164
|
-
2. **エラー分類**:再試行可否、ユーザ通知可否、監査要否
|
|
165
|
-
3. **タイムアウト既定値**:内部/外部の基準値
|
|
166
|
-
4. **リトライ規約**:回数、バックオフ、打ち切り、冪等前提
|
|
167
|
-
5. **冪等キー**:どこで必須か、重複時の挙動
|
|
168
|
-
6. **トランザクション境界**:commitの責務、跨ぎの扱い(非同期/補償)
|
|
169
|
-
7. **ログ必須項目**:trace_id / request_id / entity_id / result 等
|
|
170
|
-
8. **監査ログ**:who/when/what/before/after、保持期間、PII
|
|
171
|
-
9. **認証/認可の原則**:ポリシーの置き場、権限チェック責務
|
|
172
|
-
10. **設定上書き階層**:既定値・環境・テナント等、反映方法
|
|
173
|
-
11. **モジュール依存方向**:禁止依存、例外手続き
|
|
174
|
-
12. **ジョブ再実行性**:run_id、冪等、失敗時通知
|
|
175
|
-
|
|
176
|
-
### 6.8. SYSD-CCP に書かないもの
|
|
177
|
-
|
|
178
|
-
- OpenAPI/AsyncAPI/DB schema の本文コピー(SSOTと二重管理)
|
|
179
|
-
- 画面仕様の詳細(UISへ)
|
|
180
|
-
- 低レベル実装手順(OPR/Runbookやコードコメントへ)
|
|
181
|
-
- プロジェクト固有の一時対応の羅列(運用チケット/OPRへ)
|
|
113
|
+
- 良い例: 「通知先は未決。OPS が公開前に設計し、PM が issue と Schedule へ接続、QE が失敗注入で確認、PO が期限付き留保の可否を判断する」。
|
|
114
|
+
- 悪い例: 「NFR / OPD は後続で接続する」。誰がいつ何を判断するか分からない。
|
|
182
115
|
|
|
183
116
|
## 7. 禁止事項
|
|
184
117
|
|
|
185
|
-
| 禁止事項
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
193
|
-
## 8. サンプル
|
|
194
|
-
|
|
195
|
-
注:以下はルール文書内の例示です。生成する `sysd-cross-cutting-policy` では `## 1...` から始まります。
|
|
196
|
-
|
|
197
|
-
```yaml
|
|
198
|
-
---
|
|
199
|
-
id: sysd-cross-cutting-policy
|
|
200
|
-
type: architecture
|
|
201
|
-
title: システム設計: 横断ルール
|
|
202
|
-
status: draft
|
|
203
|
-
based_on: []
|
|
204
|
-
supersedes: []
|
|
205
|
-
---
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
### 8.1. 概要(適用範囲・優先順位)
|
|
209
|
-
|
|
210
|
-
本書は、実装全体に適用する横断ルールを統一し、レビュー判断と運用判断を一貫させるための基準である。
|
|
211
|
-
優先順位は `SEC > ERR > RET > IDM > LOG > CFG > MOD > JOB` を原則とする。
|
|
212
|
-
|
|
213
|
-
### 8.2. ルール一覧(ID/カテゴリ/要約/必須度)
|
|
214
|
-
|
|
215
|
-
<!-- prettier-ignore -->
|
|
216
|
-
| Rule ID | Category | Summary | Level | Owner |
|
|
217
|
-
| --- | --- | --- | --- | --- |
|
|
218
|
-
| scp-API-001 | API | 共通エラー応答形式を統一する | MUST | Dev |
|
|
219
|
-
| scp-RET-001 | Retry/Timeout | 外部I/Fのタイムアウトとリトライ規約 | MUST | Dev/Ops |
|
|
220
|
-
| scp-IDM-001 | Idempotency | 更新系APIは冪等キーを必須とする | MUST | Dev |
|
|
221
|
-
| scp-LOG-001 | Logging | 共通ログ項目(trace_id等) | MUST | Dev |
|
|
222
|
-
| scp-SEC-001 | Security | 認可チェック責務と境界 | MUST | Dev |
|
|
223
|
-
| scp-CFG-001 | Config | 設定上書き階層と反映方法 | MUST | Dev/Ops |
|
|
224
|
-
| scp-MOD-001 | Module | 依存方向(domain←app←interface) | MUST | Dev |
|
|
225
|
-
| scp-JOB-001 | Job | run_id と再実行性 | MUST | Ops |
|
|
226
|
-
|
|
227
|
-
### 8.3. 各ルール詳細(ID単位)
|
|
228
|
-
|
|
229
|
-
#### scp-API-001: 共通エラー応答形式
|
|
230
|
-
|
|
231
|
-
- **Rule(MUST)**
|
|
232
|
-
すべてのHTTP APIは、エラー時に共通フォーマットで応答する。
|
|
233
|
-
必須フィールド:`error_code`, `message`, `detail`, `trace_id`
|
|
234
|
-
|
|
235
|
-
- **Rationale(意図)**
|
|
236
|
-
クライアント実装の分岐を減らし、障害解析を高速化する。
|
|
237
|
-
|
|
238
|
-
- **Scope(適用範囲)**
|
|
239
|
-
内部API・外部公開API(REST)すべて。
|
|
240
|
-
|
|
241
|
-
- **Enforcement(検証)**
|
|
242
|
-
OpenAPIにエラースキーマを共通定義し、CIでlintする。
|
|
243
|
-
ITSで代表エラーケースを検証する。
|
|
244
|
-
|
|
245
|
-
- **Exception(例外)**
|
|
246
|
-
例外が必要な場合はDECを起票し、影響範囲と移行方針を明記する。
|
|
247
|
-
|
|
248
|
-
- **References(参照)**
|
|
249
|
-
SDI:OpenAPI定義(`api/openapi.yaml`)
|
|
250
|
-
テスト:ITC(エラー系) / 運用:OPD(アラート)
|
|
251
|
-
|
|
252
|
-
#### scp-RET-001: 外部I/Fのタイムアウトとリトライ
|
|
253
|
-
|
|
254
|
-
- **Rule(MUST)**
|
|
255
|
-
外部I/F呼び出しはタイムアウトを必ず設定し、最大3回まで指数バックオフでリトライする。
|
|
256
|
-
リトライは **冪等が担保できる場合のみ** 実施する。
|
|
257
|
-
|
|
258
|
-
- **Rationale(意図)**
|
|
259
|
-
ハング/遅延の波及を防ぎ、外部障害時の影響を限定する。
|
|
260
|
-
|
|
261
|
-
- **Scope(適用範囲)**
|
|
262
|
-
外部API、外部メッセージ送信、外部ファイル転送。
|
|
263
|
-
|
|
264
|
-
- **Enforcement(検証)**
|
|
265
|
-
ETSでタイムアウト/リトライ/二重送信防止を検証する。
|
|
266
|
-
リトライ回数・待機は設定で制御し、既定値をconfig schemaで固定する。
|
|
267
|
-
|
|
268
|
-
- **Exception(例外)**
|
|
269
|
-
課金など二重実行が致命的な場合は、DECで別方式(補償/確認照会)を定義する。
|
|
270
|
-
|
|
271
|
-
- **References(参照)**
|
|
272
|
-
SDI:外部I/F仕様(OpenAPI/AsyncAPI/EFES)
|
|
273
|
-
SYSD Critical Flows:外部決済フロー(存在する場合)
|
|
274
|
-
OPD:外部I/Fの監視指標(エラー率/レイテンシ)
|
|
275
|
-
|
|
276
|
-
#### scp-MOD-001: モジュール依存方向
|
|
277
|
-
|
|
278
|
-
- **Rule(MUST NOT / MUST)**
|
|
279
|
-
`domain` は `application` / `interface` に依存してはならない。
|
|
280
|
-
依存方向は **domain ← application ← interface** を守る。
|
|
281
|
-
|
|
282
|
-
- **Rationale(意図)**
|
|
283
|
-
ドメインロジックを技術詳細から分離し、変更耐性とテスト容易性を高める。
|
|
284
|
-
|
|
285
|
-
- **Scope(適用範囲)**
|
|
286
|
-
全コード(ビルド単位/パッケージ/ディレクトリ)。
|
|
287
|
-
|
|
288
|
-
- **Enforcement(検証)**
|
|
289
|
-
静的解析/アーキテクチャテスト(例:依存ルールテスト)で検証する。
|
|
290
|
-
PRレビューで違反をブロックする。
|
|
291
|
-
|
|
292
|
-
- **Exception(例外)**
|
|
293
|
-
例外は原則認めない。やむを得ない場合はDECで期限付き例外とする。
|
|
294
|
-
|
|
295
|
-
- **References(参照)**
|
|
296
|
-
SDI:モジュール境界ドキュメント/規約へのリンク
|
|
297
|
-
テスト:UTS(層別テスト方針)
|
|
298
|
-
|
|
299
|
-
### 8.4. 例外(DECリンク)
|
|
300
|
-
|
|
301
|
-
| Rule ID | 例外条件 | 影響範囲 | 期限 | DEC |
|
|
302
|
-
| ----------- | ------------------------ | ------------------- | ---------- | ----------------------------------- |
|
|
303
|
-
| scp-RET-001 | 外部課金APIで再送が不可 | 決済機能のみ | 2026-12-31 | `dec-00xx-payment-retry-exception` |
|
|
304
|
-
| scp-MOD-001 | 移行期間中の一時依存許容 | legacy adapter のみ | 2026-06-30 | `dec-00yy-legacy-dependency-waiver` |
|
|
305
|
-
|
|
306
|
-
### 8.5. 関連ドキュメント導線(SYSD/SYSD-CF/NFR/OPD/OPR/DEC)
|
|
307
|
-
|
|
308
|
-
| 種別 | ドキュメントID/参照先 | 目的 | 備考 |
|
|
309
|
-
| ---------- | ------------------------------------------------------ | ---------------------------- | ---- |
|
|
310
|
-
| SSOT | sysd-index / `api/openapi.yaml` / `config/schema.yaml` | 一次情報参照 | 必須 |
|
|
311
|
-
| 重要フロー | sysd-critical-flows | 難所フローでのルール適用確認 | 必須 |
|
|
312
|
-
| 非機能 | nfr-index | タイムアウト/SLA/SLO整合 | 必須 |
|
|
313
|
-
| 運用 | opd-index / opr-index | 監視・障害対応・証跡運用 | 必須 |
|
|
314
|
-
| 判断記録 | dec-index | 例外・設計判断の追跡 | 必須 |
|
|
118
|
+
| 禁止事項 | 理由 |
|
|
119
|
+
| -------------------------------------------------------- | ------------------------------ |
|
|
120
|
+
| 実装・schema・リファレンスの値・構文・構造を全文転載する | 二重管理になる |
|
|
121
|
+
| 確認していない上限値・設定キー・実装状況を作る | 実装・検証の前提を誤らせる |
|
|
122
|
+
| 非該当と未整備を混同し必須領域を消す | 障害・回復・観測の責務が欠ける |
|
|
123
|
+
| 検査名だけで入力・期待結果・実行経路を示さない | 合否を再現できない |
|
|
124
|
+
| 例外を散在させ、期限・判断・復帰を省く | 通常規則へ戻せない |
|
|
125
|
+
| agent に公開・昇格の最終判断を委ねる | 人間の説明責任を失う |
|