specdojo 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +82 -38
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +980 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +45 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +15 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +55 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +120 -24
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:sysd-cross-cutting-policy-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
sample: specdojo:sysd-cross-cutting-policy-sample
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# システム設計 / 横断ルール 作成ルール
|
|
10
|
+
|
|
11
|
+
System Design Cross-cutting Policy (SYSD-CCP) Documentation Rules
|
|
12
|
+
|
|
13
|
+
本ドキュメントは、システム設計情報を **コード(定義ファイル)へ寄せる運用(Code as Spec)** を前提に、
|
|
14
|
+
|
|
15
|
+
実装全体に影響する共通ルールを最小限でSSOT化する **System Design Cross-cutting Policy (SYSD-CCP)** の記述ルールを定義する。
|
|
16
|
+
|
|
17
|
+
SYSD-CCP は「詳細実装の手順書」ではない。
|
|
18
|
+
**全体に共通する“前提”と“禁止事項”と“例外時の扱い”** を明確にし、実装ブレと事故を防ぐ。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
SYSD-CCP は、以下を目的とする。
|
|
23
|
+
|
|
24
|
+
- 横断的な実装判断(エラー形式、冪等、リトライ、ログ、認証/認可、トランザクション等)を統一する
|
|
25
|
+
- チーム内の暗黙知を減らし、レビュー観点を安定させる
|
|
26
|
+
- テスト(ITS/ETS/STC)と運用(OPD/OPR)に必要な共通前提を提供する
|
|
27
|
+
- 詳細をコードへ寄せつつ、**“コードから自動生成できない意図”** を残す
|
|
28
|
+
|
|
29
|
+
基本方針:
|
|
30
|
+
|
|
31
|
+
- ルールは「最小限」かつ「強い」を原則とし、禁止・必須・例外条件を明確にする
|
|
32
|
+
- ルールは可能な限り測定可能/検証可能(CI/lint/テスト)な形で定義する
|
|
33
|
+
- 例外は SYSD-CCP 本文に散らさず、DECで理由と影響範囲を管理する
|
|
34
|
+
|
|
35
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
36
|
+
|
|
37
|
+
### 2.1. 位置づけ
|
|
38
|
+
|
|
39
|
+
- `sysd-cross-cutting-policy`:実装全体に適用する横断ルールのSSOT
|
|
40
|
+
- `sysd-index`:実体定義(OpenAPI/AsyncAPI/schema/workflow など)への導線
|
|
41
|
+
- `sysd-critical-flows`:事故予防のための重要フロー(難所)
|
|
42
|
+
- `nfr-*`:非機能要件の基準値
|
|
43
|
+
- `opd-*` / `opr-*`:運用方針・運用手順
|
|
44
|
+
- `dec-*`:例外や設計判断の根拠
|
|
45
|
+
|
|
46
|
+
### 2.2. 用語定義
|
|
47
|
+
|
|
48
|
+
| 用語 | 定義 |
|
|
49
|
+
| ----------- | ------------------------------------------------------------- |
|
|
50
|
+
| 横断ルール | 複数モジュール/サービスに共通して適用される実装・運用の規約 |
|
|
51
|
+
| 例外 | SYSD-CCPの通常ルールから外れる運用。理由と期限をDECで明示する |
|
|
52
|
+
| Enforcement | ルールを守らせる検証手段(CI、テスト、レビュー等) |
|
|
53
|
+
|
|
54
|
+
## 3. ファイル命名・ID規則
|
|
55
|
+
|
|
56
|
+
- 生成対象ドキュメントIDは `sysd-cross-cutting-policy` を推奨する。
|
|
57
|
+
- ルールIDは `scp-<カテゴリ>-<連番>` を推奨する(例: `scp-ERR-001`)。
|
|
58
|
+
- カテゴリ例:`ERR`, `API`, `RET`, `IDM`, `TXN`, `LOG`, `SEC`, `CFG`, `MOD`, `JOB`。
|
|
59
|
+
- 1ルール=1論点を原則とし、例外条件と意図は同一ルール内で簡潔に記述する。
|
|
60
|
+
|
|
61
|
+
## 4. 推奨 Frontmatter 項目
|
|
62
|
+
|
|
63
|
+
### 4.1. 設定内容
|
|
64
|
+
|
|
65
|
+
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
66
|
+
|
|
67
|
+
| 項目 | 説明 | 必須 |
|
|
68
|
+
| ---------- | ------------------------------------------------- | ---- |
|
|
69
|
+
| id | SYSD-CCP ID(推奨: `sysd-cross-cutting-policy`) | ○ |
|
|
70
|
+
| type | `architecture` など、共通スキーマで許容される種別 | ○ |
|
|
71
|
+
| title | システム設計: 横断ルール | ○ |
|
|
72
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
73
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
74
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
75
|
+
|
|
76
|
+
### 4.2. 推奨ルール
|
|
77
|
+
|
|
78
|
+
- `based_on` にはルール策定に直接利用した成果物のみ列挙する。
|
|
79
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
80
|
+
|
|
81
|
+
## 5. 本文構成(標準テンプレ)
|
|
82
|
+
|
|
83
|
+
`sysd-cross-cutting-policy` は以下の見出し構成を **順序固定** で配置する。
|
|
84
|
+
|
|
85
|
+
| 番号 | 見出し | 必須 |
|
|
86
|
+
| ---- | --------------------------------------------------------------- | ---- |
|
|
87
|
+
| 1 | 概要(適用範囲・優先順位) | ○ |
|
|
88
|
+
| 2 | ルール一覧(ID/カテゴリ/要約/必須度) | ○ |
|
|
89
|
+
| 3 | 各ルール詳細(ID単位) | ○ |
|
|
90
|
+
| 4 | 例外(DECリンク) | ○ |
|
|
91
|
+
| 5 | 関連ドキュメント導線(SDI/SYSD Critical Flows/NFR/OPD/OPR/DEC) | ○ |
|
|
92
|
+
|
|
93
|
+
補足:
|
|
94
|
+
|
|
95
|
+
- ルール一覧は「探しやすさ」を最優先し、カテゴリ単位で整理する。
|
|
96
|
+
- 例外の詳細本文は書かず、例外条件の入口とDECリンクのみを置く。
|
|
97
|
+
|
|
98
|
+
## 6. 記述ガイド
|
|
99
|
+
|
|
100
|
+
### 6.1. 概要(適用範囲・優先順位)
|
|
101
|
+
|
|
102
|
+
生成する本文の見出しは **## 1. 概要(適用範囲・優先順位)**
|
|
103
|
+
|
|
104
|
+
- SYSD-CCP が対象とする範囲(横断ルールの適用境界)を 1〜3 段落で明記する。
|
|
105
|
+
- 「ルールは最小限」「検証可能性を優先」「例外はDECで管理」の原則を明記する。
|
|
106
|
+
- ルール間の優先順位(例: `SEC > ERR > RET > IDM > LOG > CFG > MOD > JOB`)を必要に応じて明示する。
|
|
107
|
+
|
|
108
|
+
### 6.2. ルール一覧(ID/カテゴリ/要約/必須度)
|
|
109
|
+
|
|
110
|
+
生成する本文の見出しは **## 2. ルール一覧(ID/カテゴリ/要約/必須度)**
|
|
111
|
+
|
|
112
|
+
- ルールID、カテゴリ、要約、必須度(MUST/MUST NOT/SHOULD)、Owner を表形式で記載する。
|
|
113
|
+
- 一覧は「探しやすさ」を優先し、カテゴリ順または重要度順で並べる。
|
|
114
|
+
- ルール詳細本文に飛べる参照(IDの一致)を必ず担保する。
|
|
115
|
+
|
|
116
|
+
### 6.3. 各ルール詳細(ID単位)
|
|
117
|
+
|
|
118
|
+
生成する本文の見出しは **## 3. 各ルール詳細(ID単位)**
|
|
119
|
+
|
|
120
|
+
各ルールは以下を必ず含める。
|
|
121
|
+
|
|
122
|
+
- **Rule(必須/禁止)**:何を守るか(MUST / MUST NOT / SHOULD)
|
|
123
|
+
- **Rationale(意図)**:なぜ必要か(1〜3行)
|
|
124
|
+
- **Scope(適用範囲)**:どこに適用するか(API/ジョブ/イベント等)
|
|
125
|
+
- **Enforcement(検証)**:どう検証するか(CI/テスト/レビュー)
|
|
126
|
+
- **Exception(例外)**:例外条件と参照すべきDEC(ある場合)
|
|
127
|
+
- **References(参照)**:SDI/SYSD Critical Flows/NFR/OPD/OPR等への導線
|
|
128
|
+
|
|
129
|
+
### 6.4. 例外(DECリンク)
|
|
130
|
+
|
|
131
|
+
生成する本文の見出しは **## 4. 例外(DECリンク)**
|
|
132
|
+
|
|
133
|
+
- 例外の詳細本文は書かず、例外条件・影響範囲・期限・DECリンクのみを記載する。
|
|
134
|
+
- 例外が恒久化しそうな場合は、SYSD-CCP本体ルールへの取り込み可否を定期レビューする。
|
|
135
|
+
- 例外未記載の実装差分は不適合として扱う。
|
|
136
|
+
|
|
137
|
+
### 6.5. 関連ドキュメント導線
|
|
138
|
+
|
|
139
|
+
生成する本文の見出しは **## 5. 関連ドキュメント導線(SYSD/SYSD-CF/NFR/OPD/OPR/DEC)**
|
|
140
|
+
|
|
141
|
+
- ルールごとに、SYSD(一次情報)、SYSD Critical Flows(重要フロー)、NFR、OPD/OPR、DEC への導線を明記する。
|
|
142
|
+
- 参照先は「ID」または「リポジトリ相対パス」で一意に辿れる形にする。
|
|
143
|
+
- 分冊が無い場合でも `(本書のみ)` または `(なし)` を明記し、空欄にしない。
|
|
144
|
+
|
|
145
|
+
### 6.6. SYSD-CCP が扱う対象(推奨カテゴリ)
|
|
146
|
+
|
|
147
|
+
- API契約の共通ルール(バージョニング、互換性、エラー形式)
|
|
148
|
+
|
|
149
|
+
- 例外/エラー処理(分類、再試行可否、ユーザ通知)
|
|
150
|
+
- タイムアウト/リトライ(回数、バックオフ、打ち切り、冪等前提)
|
|
151
|
+
- 冪等(キー、重複排除、整合性)
|
|
152
|
+
- トランザクション/整合性(境界、最終的整合性、補償)
|
|
153
|
+
- ログ/監査ログ(必須項目、保持、PII取り扱い)
|
|
154
|
+
- トレーシング(trace_id、propagation)
|
|
155
|
+
- セキュリティ(認証・認可の実装原則、秘密情報、監査)
|
|
156
|
+
- 設定(上書き階層、変更反映、デフォルト管理)
|
|
157
|
+
- モジュール境界/依存方向(アーキ制約)
|
|
158
|
+
- ジョブ運用の共通(再実行性、run_id、失敗時通知)
|
|
159
|
+
|
|
160
|
+
### 6.7. 必須で定義すべき最小ルールセット(推奨)
|
|
161
|
+
|
|
162
|
+
1. **共通エラー形式(API)**:error_code / message / detail / trace_id
|
|
163
|
+
2. **エラー分類**:再試行可否、ユーザ通知可否、監査要否
|
|
164
|
+
3. **タイムアウト既定値**:内部/外部の基準値
|
|
165
|
+
4. **リトライ規約**:回数、バックオフ、打ち切り、冪等前提
|
|
166
|
+
5. **冪等キー**:どこで必須か、重複時の挙動
|
|
167
|
+
6. **トランザクション境界**:commitの責務、跨ぎの扱い(非同期/補償)
|
|
168
|
+
7. **ログ必須項目**:trace_id / request_id / entity_id / result 等
|
|
169
|
+
8. **監査ログ**:who/when/what/before/after、保持期間、PII
|
|
170
|
+
9. **認証/認可の原則**:ポリシーの置き場、権限チェック責務
|
|
171
|
+
10. **設定上書き階層**:既定値・環境・テナント等、反映方法
|
|
172
|
+
11. **モジュール依存方向**:禁止依存、例外手続き
|
|
173
|
+
12. **ジョブ再実行性**:run_id、冪等、失敗時通知
|
|
174
|
+
|
|
175
|
+
### 6.8. SYSD-CCP に書かないもの
|
|
176
|
+
|
|
177
|
+
- OpenAPI/AsyncAPI/DB schema の本文コピー(SSOTと二重管理)
|
|
178
|
+
- 画面仕様の詳細(UISへ)
|
|
179
|
+
- 低レベル実装手順(OPR/Runbookやコードコメントへ)
|
|
180
|
+
- プロジェクト固有の一時対応の羅列(運用チケット/OPRへ)
|
|
181
|
+
|
|
182
|
+
## 7. 禁止事項
|
|
183
|
+
|
|
184
|
+
| 禁止事項 | 理由 |
|
|
185
|
+
| --------------------------------------------- | ---------------------------- |
|
|
186
|
+
| ルールを増やし続け、インデックス管理しない | 探索性が落ちるため |
|
|
187
|
+
| 努力目標表現のみで MUST / MUST NOT を示さない | 実装判断がぶれるため |
|
|
188
|
+
| 例外をSYSD-CCP本文に散在させる | 例外管理が追跡不能になるため |
|
|
189
|
+
| SSOT本文(OpenAPI/DDL等)を貼り付ける | 二重管理で不整合を招くため |
|
|
190
|
+
| 検証方法(CI/テスト/レビュー)を書かない | ルールが形骸化するため |
|
|
191
|
+
|
|
192
|
+
## 8. サンプル
|
|
193
|
+
|
|
194
|
+
注:以下はルール文書内の例示です。生成する `sysd-cross-cutting-policy` では `## 1...` から始まります。
|
|
195
|
+
|
|
196
|
+
```yaml
|
|
197
|
+
---
|
|
198
|
+
id: sysd-cross-cutting-policy
|
|
199
|
+
type: architecture
|
|
200
|
+
title: システム設計: 横断ルール
|
|
201
|
+
status: draft
|
|
202
|
+
based_on: []
|
|
203
|
+
supersedes: []
|
|
204
|
+
---
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### 8.1. 概要(適用範囲・優先順位)
|
|
208
|
+
|
|
209
|
+
本書は、実装全体に適用する横断ルールを統一し、レビュー判断と運用判断を一貫させるための基準である。
|
|
210
|
+
優先順位は `SEC > ERR > RET > IDM > LOG > CFG > MOD > JOB` を原則とする。
|
|
211
|
+
|
|
212
|
+
### 8.2. ルール一覧(ID/カテゴリ/要約/必須度)
|
|
213
|
+
|
|
214
|
+
<!-- prettier-ignore -->
|
|
215
|
+
| Rule ID | Category | Summary | Level | Owner |
|
|
216
|
+
| --- | --- | --- | --- | --- |
|
|
217
|
+
| scp-API-001 | API | 共通エラー応答形式を統一する | MUST | Dev |
|
|
218
|
+
| scp-RET-001 | Retry/Timeout | 外部I/Fのタイムアウトとリトライ規約 | MUST | Dev/Ops |
|
|
219
|
+
| scp-IDM-001 | Idempotency | 更新系APIは冪等キーを必須とする | MUST | Dev |
|
|
220
|
+
| scp-LOG-001 | Logging | 共通ログ項目(trace_id等) | MUST | Dev |
|
|
221
|
+
| scp-SEC-001 | Security | 認可チェック責務と境界 | MUST | Dev |
|
|
222
|
+
| scp-CFG-001 | Config | 設定上書き階層と反映方法 | MUST | Dev/Ops |
|
|
223
|
+
| scp-MOD-001 | Module | 依存方向(domain←app←interface) | MUST | Dev |
|
|
224
|
+
| scp-JOB-001 | Job | run_id と再実行性 | MUST | Ops |
|
|
225
|
+
|
|
226
|
+
### 8.3. 各ルール詳細(ID単位)
|
|
227
|
+
|
|
228
|
+
#### scp-API-001: 共通エラー応答形式
|
|
229
|
+
|
|
230
|
+
- **Rule(MUST)**
|
|
231
|
+
すべてのHTTP APIは、エラー時に共通フォーマットで応答する。
|
|
232
|
+
必須フィールド:`error_code`, `message`, `detail`, `trace_id`
|
|
233
|
+
|
|
234
|
+
- **Rationale(意図)**
|
|
235
|
+
クライアント実装の分岐を減らし、障害解析を高速化する。
|
|
236
|
+
|
|
237
|
+
- **Scope(適用範囲)**
|
|
238
|
+
内部API・外部公開API(REST)すべて。
|
|
239
|
+
|
|
240
|
+
- **Enforcement(検証)**
|
|
241
|
+
OpenAPIにエラースキーマを共通定義し、CIでlintする。
|
|
242
|
+
ITSで代表エラーケースを検証する。
|
|
243
|
+
|
|
244
|
+
- **Exception(例外)**
|
|
245
|
+
例外が必要な場合はDECを起票し、影響範囲と移行方針を明記する。
|
|
246
|
+
|
|
247
|
+
- **References(参照)**
|
|
248
|
+
SDI:OpenAPI定義(`api/openapi.yaml`)
|
|
249
|
+
テスト:ITC(エラー系) / 運用:OPD(アラート)
|
|
250
|
+
|
|
251
|
+
#### scp-RET-001: 外部I/Fのタイムアウトとリトライ
|
|
252
|
+
|
|
253
|
+
- **Rule(MUST)**
|
|
254
|
+
外部I/F呼び出しはタイムアウトを必ず設定し、最大3回まで指数バックオフでリトライする。
|
|
255
|
+
リトライは **冪等が担保できる場合のみ** 実施する。
|
|
256
|
+
|
|
257
|
+
- **Rationale(意図)**
|
|
258
|
+
ハング/遅延の波及を防ぎ、外部障害時の影響を限定する。
|
|
259
|
+
|
|
260
|
+
- **Scope(適用範囲)**
|
|
261
|
+
外部API、外部メッセージ送信、外部ファイル転送。
|
|
262
|
+
|
|
263
|
+
- **Enforcement(検証)**
|
|
264
|
+
ETSでタイムアウト/リトライ/二重送信防止を検証する。
|
|
265
|
+
リトライ回数・待機は設定で制御し、既定値をconfig schemaで固定する。
|
|
266
|
+
|
|
267
|
+
- **Exception(例外)**
|
|
268
|
+
課金など二重実行が致命的な場合は、DECで別方式(補償/確認照会)を定義する。
|
|
269
|
+
|
|
270
|
+
- **References(参照)**
|
|
271
|
+
SDI:外部I/F仕様(OpenAPI/AsyncAPI/EFES)
|
|
272
|
+
SYSD Critical Flows:外部決済フロー(存在する場合)
|
|
273
|
+
OPD:外部I/Fの監視指標(エラー率/レイテンシ)
|
|
274
|
+
|
|
275
|
+
#### scp-MOD-001: モジュール依存方向
|
|
276
|
+
|
|
277
|
+
- **Rule(MUST NOT / MUST)**
|
|
278
|
+
`domain` は `application` / `interface` に依存してはならない。
|
|
279
|
+
依存方向は **domain ← application ← interface** を守る。
|
|
280
|
+
|
|
281
|
+
- **Rationale(意図)**
|
|
282
|
+
ドメインロジックを技術詳細から分離し、変更耐性とテスト容易性を高める。
|
|
283
|
+
|
|
284
|
+
- **Scope(適用範囲)**
|
|
285
|
+
全コード(ビルド単位/パッケージ/ディレクトリ)。
|
|
286
|
+
|
|
287
|
+
- **Enforcement(検証)**
|
|
288
|
+
静的解析/アーキテクチャテスト(例:依存ルールテスト)で検証する。
|
|
289
|
+
PRレビューで違反をブロックする。
|
|
290
|
+
|
|
291
|
+
- **Exception(例外)**
|
|
292
|
+
例外は原則認めない。やむを得ない場合はDECで期限付き例外とする。
|
|
293
|
+
|
|
294
|
+
- **References(参照)**
|
|
295
|
+
SDI:モジュール境界ドキュメント/規約へのリンク
|
|
296
|
+
テスト:UTS(層別テスト方針)
|
|
297
|
+
|
|
298
|
+
### 8.4. 例外(DECリンク)
|
|
299
|
+
|
|
300
|
+
| Rule ID | 例外条件 | 影響範囲 | 期限 | DEC |
|
|
301
|
+
| ----------- | ------------------------ | ------------------- | ---------- | ----------------------------------- |
|
|
302
|
+
| scp-RET-001 | 外部課金APIで再送が不可 | 決済機能のみ | 2026-12-31 | `dec-00xx-payment-retry-exception` |
|
|
303
|
+
| scp-MOD-001 | 移行期間中の一時依存許容 | legacy adapter のみ | 2026-06-30 | `dec-00yy-legacy-dependency-waiver` |
|
|
304
|
+
|
|
305
|
+
### 8.5. 関連ドキュメント導線(SYSD/SYSD-CF/NFR/OPD/OPR/DEC)
|
|
306
|
+
|
|
307
|
+
| 種別 | ドキュメントID/参照先 | 目的 | 備考 |
|
|
308
|
+
| ---------- | ------------------------------------------------------ | ---------------------------- | ---- |
|
|
309
|
+
| SSOT | sysd-index / `api/openapi.yaml` / `config/schema.yaml` | 一次情報参照 | 必須 |
|
|
310
|
+
| 重要フロー | sysd-critical-flows | 難所フローでのルール適用確認 | 必須 |
|
|
311
|
+
| 非機能 | nfr-index | タイムアウト/SLA/SLO整合 | 必須 |
|
|
312
|
+
| 運用 | opd-index / opr-index | 監視・障害対応・証跡運用 | 必須 |
|
|
313
|
+
| 判断記録 | dec-index | 例外・設計判断の追跡 | 必須 |
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:sysd-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: not-needed
|
|
7
|
+
sample: specdojo:sysd-index-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# システム設計-全体構成 作成ルール
|
|
11
|
+
|
|
12
|
+
System Design (SYSD) Index Documentation Rules
|
|
13
|
+
|
|
14
|
+
本ドキュメントは、システム設計情報を **コード(定義ファイル)へ寄せる運用(Code as Spec)** を前提に、
|
|
15
|
+
「どこに一次情報(SSOT)があるか」を迷わず辿れるようにする **System Design (SYSD) Index** の記述ルールを定義する。
|
|
16
|
+
|
|
17
|
+
## 1. 全体方針
|
|
18
|
+
|
|
19
|
+
SYSD Index は、実装・運用・テスト・レビューに必要な設計情報の **入口(Index)** を 1 箇所に集約し、
|
|
20
|
+
|
|
21
|
+
- 設計情報の迷子(どこが正か分からない)を防ぐ
|
|
22
|
+
- ドキュメントとコードの二重管理を避ける
|
|
23
|
+
- 変更時に追随すべき場所を明確にする
|
|
24
|
+
|
|
25
|
+
ことを目的とする。
|
|
26
|
+
|
|
27
|
+
Code as Spec の原則:
|
|
28
|
+
|
|
29
|
+
- SYSD Index は「一次情報」ではなく「導線」とし、仕様本文(詳細)は書かない
|
|
30
|
+
- SYSD Index は SSOT(一次情報)へのリンクと最小限の補足のみを記載する
|
|
31
|
+
- SSOT は機械可読・差分検知可能な定義を優先する(OpenAPI / migration / workflow / schema など)
|
|
32
|
+
- 補足は意図・境界・ルールに限定し、詳細は SSOT に寄せる
|
|
33
|
+
|
|
34
|
+
## 2. 位置づけと用語定義
|
|
35
|
+
|
|
36
|
+
### 2.1. 位置づけ
|
|
37
|
+
|
|
38
|
+
- `sysd-index`:システム設計情報の導線を集約する Index(本書)
|
|
39
|
+
- API仕様、DBスキーマ、ジョブ定義、設定スキーマなど:実体を持つ一次情報(SSOT)
|
|
40
|
+
- C4 / NFR / OPD / DEC:背景・方針・判断記録の関連ドキュメント
|
|
41
|
+
|
|
42
|
+
### 2.2. 用語定義
|
|
43
|
+
|
|
44
|
+
| 用語 | 定義 |
|
|
45
|
+
| ------------ | ----------------------------------------------------------------------------- |
|
|
46
|
+
| SYSD Index | System Design Index。一次情報そのものではなく、設計情報への導線をまとめる文書 |
|
|
47
|
+
| SSOT | Single Source of Truth。仕様の正本となる一次情報 |
|
|
48
|
+
| Code as Spec | コード/定義ファイルを仕様の正本として扱う運用方針 |
|
|
49
|
+
|
|
50
|
+
## 3. ファイル命名・ID規則
|
|
51
|
+
|
|
52
|
+
- SYSD本体の`id` は `sysd-index` (単一の入口文書を前提)。
|
|
53
|
+
- ファイル名はプロジェクト内で一意になるよう命名する(例: `システム設計-全体構成リンク集.md`)。
|
|
54
|
+
- 並び順が必要な場合は接頭辞の番号付与(例: `sysd-010-...`)を任意で用いてよい。
|
|
55
|
+
- `id`(参照用の不変キー)とファイル名(可読性/並び順)は独立であり、ファイル名変更は許容する。
|
|
56
|
+
|
|
57
|
+
## 4. 推奨 Frontmatter 項目
|
|
58
|
+
|
|
59
|
+
### 4.1. 設定内容
|
|
60
|
+
|
|
61
|
+
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
62
|
+
|
|
63
|
+
| 項目 | 説明 | 必須 |
|
|
64
|
+
| ---------- | ------------------------------------------------------ | ---- |
|
|
65
|
+
| id | SYSD ID(推奨: `sysd-index`) | ○ |
|
|
66
|
+
| type | `architecture` など、共通スキーマで許容される種別 | ○ |
|
|
67
|
+
| title | システム設計: 全体構成(リンク集)など対象が分かる名称 | ○ |
|
|
68
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
69
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
70
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
71
|
+
|
|
72
|
+
### 4.2. 推奨ルール
|
|
73
|
+
|
|
74
|
+
- `based_on` には導線設計の判断に直接利用した成果物のみ列挙する。
|
|
75
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
76
|
+
|
|
77
|
+
## 5. 本文構成(標準テンプレ)
|
|
78
|
+
|
|
79
|
+
`sysd-index` は以下の見出し構成を **順序固定** で配置する。
|
|
80
|
+
|
|
81
|
+
| 番号 | 見出し | 必須 |
|
|
82
|
+
| ---- | ------------------------------------------------ | ---- |
|
|
83
|
+
| 1 | 概要(対象範囲・更新責任) | ○ |
|
|
84
|
+
| 2 | SSOT 一覧(表形式) | ○ |
|
|
85
|
+
| 3 | 自動生成物(生成コマンド/生成先/閲覧先) | 任意 |
|
|
86
|
+
| 4 | 変更の入口(どこを修正すればよいか:典型ケース) | ○ |
|
|
87
|
+
| 5 | 関連ドキュメント導線(C4 / NFR / OPD / DEC 等) | ○ |
|
|
88
|
+
|
|
89
|
+
補足:
|
|
90
|
+
|
|
91
|
+
- 本文は「リンク集」としての導線に徹し、仕様本文の再掲はしない。
|
|
92
|
+
- `3. 自動生成物` を省略する場合は `(なし)` または `(該当なし)` を明記する。
|
|
93
|
+
|
|
94
|
+
## 6. 記述ガイド
|
|
95
|
+
|
|
96
|
+
### 6.1. 概要(対象範囲・更新責任)
|
|
97
|
+
|
|
98
|
+
生成する本文の見出しは **## 1. 概要(対象範囲・更新責任)**
|
|
99
|
+
|
|
100
|
+
- SDI が扱う範囲(内部API、内部イベント、外部I/F、DB、ジョブ、設定、モジュール境界)を明記する。
|
|
101
|
+
- 更新責任(Owner)を role ベースで明記する。
|
|
102
|
+
|
|
103
|
+
### 6.2. SSOT 一覧(表形式)
|
|
104
|
+
|
|
105
|
+
生成する本文の見出しは **## 2. SSOT 一覧(表形式)**
|
|
106
|
+
|
|
107
|
+
SDI の中核は **SSOT 一覧表** とする。
|
|
108
|
+
|
|
109
|
+
必須列:
|
|
110
|
+
|
|
111
|
+
- 種別(Category)
|
|
112
|
+
- SSOT(一次情報の種類)
|
|
113
|
+
- 参照先(パス/場所/リンク)
|
|
114
|
+
- 更新責任(Owner:role でよい)
|
|
115
|
+
- 備考(最小補足:任意)
|
|
116
|
+
|
|
117
|
+
種別(Category)の推奨値:
|
|
118
|
+
|
|
119
|
+
- Internal API
|
|
120
|
+
- Internal Events
|
|
121
|
+
- External I/F
|
|
122
|
+
- Database Schema
|
|
123
|
+
- Jobs / Batch
|
|
124
|
+
- Configurations
|
|
125
|
+
- Observability(ログ/監査/トレースの定義がある場合)
|
|
126
|
+
- Module Boundary(依存方向・構成の規約)
|
|
127
|
+
|
|
128
|
+
参照先の書き方:
|
|
129
|
+
|
|
130
|
+
- 原則:リポジトリ相対パス(例:`api/openapi.yaml`)
|
|
131
|
+
- 外部URLは最小限(SaaSの画面リンク等)。可能なら repo 内に保存する
|
|
132
|
+
- 複数ある場合は代表を1つ示し、備考で派生を列挙する
|
|
133
|
+
|
|
134
|
+
備考(書いてよい補足):
|
|
135
|
+
|
|
136
|
+
- CIで検証されること(lint/互換性チェック/差分検知)
|
|
137
|
+
- バージョニング方針の入口(詳細はSCR/DECへ)
|
|
138
|
+
- 読者や利用方法の要点(1〜2行)
|
|
139
|
+
|
|
140
|
+
### 6.3. 自動生成物(任意)
|
|
141
|
+
|
|
142
|
+
生成する本文の見出しは **## 3. 自動生成物(生成コマンド/生成先/閲覧先)**
|
|
143
|
+
|
|
144
|
+
- OpenAPI → HTML/Swagger UI
|
|
145
|
+
- AsyncAPI → HTML
|
|
146
|
+
- migration → schema dump / ERD
|
|
147
|
+
- config schema → 設定一覧ドキュメント
|
|
148
|
+
|
|
149
|
+
`生成コマンド` と `生成先` を記載し、CI更新であればその旨を明記する。
|
|
150
|
+
|
|
151
|
+
### 6.4. 変更の入口(典型ケース)
|
|
152
|
+
|
|
153
|
+
生成する本文の見出しは **## 4. 変更の入口(典型ケース)**
|
|
154
|
+
|
|
155
|
+
- SSOT を追加/移動/削除したら、必ず SDI を更新する。
|
|
156
|
+
- SDI 更新はリンク表の差分を中心とし、仕様本文は更新対象に含めない。
|
|
157
|
+
- 典型ケース(例: API追加、テーブル追加、ジョブ追加)ごとに「どこを修正するか」を短く記述する。
|
|
158
|
+
|
|
159
|
+
### 6.5. 関連ドキュメント導線
|
|
160
|
+
|
|
161
|
+
生成する本文の見出しは **## 5. 関連ドキュメント導線)**
|
|
162
|
+
|
|
163
|
+
- C4 / NFR / OPD / DEC など、判断・方針系ドキュメントへの導線を明記する。
|
|
164
|
+
- 分冊が無い場合でも `(なし)` または `(本書のみ)` を明記する。
|
|
165
|
+
|
|
166
|
+
### 6.6. カテゴリ別の書き分け方針
|
|
167
|
+
|
|
168
|
+
Code as Spec の適用にあたり、種別(Category)ごとに何を SSOT とし、SDI 本体に何を書かないかを次のとおり判断する。
|
|
169
|
+
|
|
170
|
+
- **内部API / 内部イベント**:OpenAPI / AsyncAPI / gRPC proto 等を SSOT とし、SDI 本体にはリンクと横断ルールへの参照のみを記載する。
|
|
171
|
+
- **DB**:migration / schema 定義を SSOT とし、物理設計は「理由(意図)」のみを横断ルールまたは重要フローに残す。
|
|
172
|
+
- **UI 詳細**:画面の目的・項目は UIS を SSOT とし、実装構成(コンポーネント分割等)はコード参照とする。
|
|
173
|
+
- **Module Boundary**:クラス図は追随コストが高いため原則作らず、依存方向のルールとして横断ルールに記載する。
|
|
174
|
+
- **Jobs / Batch**:定義ファイル(workflow/cron/IaC)とコードを SSOT とし、運用上の重要事項のみ横断ルールに記載する。
|
|
175
|
+
- **Configurations**:config schema とデフォルト設定を SSOT とし、運用が触る項目のみ横断ルールまたは SDI から参照できる形で一覧化する。
|
|
176
|
+
|
|
177
|
+
## 7. 禁止事項
|
|
178
|
+
|
|
179
|
+
| 禁止事項 | 理由 |
|
|
180
|
+
| -------------------------------------- | -------------------------------------- |
|
|
181
|
+
| SDI に API/DB の詳細仕様本文を再掲する | SSOTとの二重管理となり不整合を招くため |
|
|
182
|
+
| 実装クラス図や画面分割の詳細を列挙する | SDIの責務(導線)を逸脱するため |
|
|
183
|
+
| 古い/未使用/不明確なリンクを残す | Indexとしての信頼性が低下するため |
|
|
184
|
+
| Owner を未記載にする | 更新責任が不明となり形骸化するため |
|
|
185
|
+
| 備考に詳細仕様を書き始める | 本文肥大化と責務混在を招くため |
|
|
186
|
+
|
|
187
|
+
## 8. サンプル
|
|
188
|
+
|
|
189
|
+
注:以下はルール文書内の例示です。生成する `sysd-index` では `## 1...` から始まります。
|
|
190
|
+
|
|
191
|
+
```yaml
|
|
192
|
+
---
|
|
193
|
+
id: sysd-index
|
|
194
|
+
type: architecture
|
|
195
|
+
title: システム設計: 全体構成リンク集
|
|
196
|
+
status: draft
|
|
197
|
+
based_on: []
|
|
198
|
+
supersedes: []
|
|
199
|
+
---
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### 8.1. 概要(対象範囲・更新責任)
|
|
203
|
+
|
|
204
|
+
本書は、システム設計情報のSSOTを参照するための導線を一元化する。
|
|
205
|
+
更新責任: Dev Lead(構成管理)/ Ops Lead(運用系SSOT)
|
|
206
|
+
|
|
207
|
+
### 8.2. SSOT 一覧(例)
|
|
208
|
+
|
|
209
|
+
<!-- prettier-ignore -->
|
|
210
|
+
| 種別 | SSOT | 参照先 | 更新責任 | 備考 |
|
|
211
|
+
| --- | --- | --- | --- | --- |
|
|
212
|
+
| Internal API | OpenAPI | `api/openapi.yaml` | Dev | CIでlint、破壊的変更はDEC必須 |
|
|
213
|
+
| Internal Events | AsyncAPI + CloudEvents | `api/asyncapi.yaml` | Dev | schema互換性チェックを実施 |
|
|
214
|
+
| External I/F | 外部連携定義 | `spec/external-if/` | Dev | 接続先契約変更時は `dec-*` を更新 |
|
|
215
|
+
| Database Schema | migrations | `db/migrations/` | Dev | schema dumpはCI生成 |
|
|
216
|
+
| Jobs / Batch | workflow | `ops/workflows/` | Ops | 失敗時通知・リトライもここで定義 |
|
|
217
|
+
| Configurations | config schema | `config/schema.yaml` | Dev/Ops | 上書き階層はSCR参照 |
|
|
218
|
+
| Observability | ログ/監査定義 | `ops/observability/` | Ops | 監査ログ保持方針は `opd-*` 参照 |
|
|
219
|
+
| Module Boundary | package rule | `docs/architecture/module-boundary.md` | Dev | 依存方向はSCR参照 |
|
|
220
|
+
|
|
221
|
+
### 8.3. 自動生成物(例)
|
|
222
|
+
|
|
223
|
+
| 生成物 | 入力SSOT | 生成コマンド | 生成先 | 閲覧先 | 更新方式 |
|
|
224
|
+
| ------------- | ------------------- | ----------------------- | -------------------------- | ------------------------------------ | -------- |
|
|
225
|
+
| OpenAPI Docs | `api/openapi.yaml` | `npm run docs:openapi` | `docs/generated/openapi/` | `docs/generated/openapi/index.html` | CI |
|
|
226
|
+
| AsyncAPI Docs | `api/asyncapi.yaml` | `npm run docs:asyncapi` | `docs/generated/asyncapi/` | `docs/generated/asyncapi/index.html` | CI |
|
|
227
|
+
| ERD | `db/migrations/` | `npm run docs:erd` | `docs/generated/erd/` | `docs/generated/erd/index.html` | CI |
|
|
228
|
+
|
|
229
|
+
### 8.4. 変更の入口(典型ケース例)
|
|
230
|
+
|
|
231
|
+
| 変更トリガ | 最初に直す場所(SSOT) | 併せて更新する場所 | 完了条件(最低限) |
|
|
232
|
+
| --------------------- | ---------------------- | ---------------------------------------- | ------------------------- |
|
|
233
|
+
| APIエンドポイント追加 | `api/openapi.yaml` | `docs/generated/openapi/`, SDIのSSOT一覧 | API lint通過、SDI導線追加 |
|
|
234
|
+
| テーブル追加 | `db/migrations/` | `docs/generated/erd/`, SDIのSSOT一覧 | migration適用可、ERD更新 |
|
|
235
|
+
| バッチ新設 | `ops/workflows/` | 監視設定、SDIのSSOT一覧 | 実行定義・通知先が明記 |
|
|
236
|
+
| 設定項目追加 | `config/schema.yaml` | 設定一覧生成物、SDIのSSOT一覧 | 既定値・型・説明が確定 |
|
|
237
|
+
|
|
238
|
+
### 8.5. 関連ドキュメント導線(例)
|
|
239
|
+
|
|
240
|
+
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
241
|
+
| ------ | ------------------- | ---------------------- | ---------------------- |
|
|
242
|
+
| アーキ | cpd-business-domain | 外部境界・依存先の把握 | 入口として必須 |
|
|
243
|
+
| 品質 | nfr-index | 非機能要件との整合確認 | 可用性・性能の判断基準 |
|
|
244
|
+
|
|
245
|
+
| 運用方針 | opd-index | 運用統制(監視/証跡/権限)確認 | 監査観点で参照 |
|
|
246
|
+
| 決定記録 | dec-index | 設計判断の背景追跡 | 破壊的変更時に必須 |
|