specdojo 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +125 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +141 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -3,245 +3,103 @@ specdojo:
|
|
|
3
3
|
id: specdojo:sysd-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: architecture
|
|
6
|
-
status:
|
|
7
|
-
|
|
6
|
+
status: ready
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: specdojo:sysd-index-recipe
|
|
8
9
|
sample: specdojo:sysd-index-sample
|
|
10
|
+
template: specdojo:sysd-index-template
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
9
13
|
---
|
|
10
14
|
|
|
11
|
-
#
|
|
15
|
+
# システム設計索引(SYSD Index)作成ルール
|
|
12
16
|
|
|
13
|
-
System Design
|
|
17
|
+
System Design Index Documentation Rules
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
「どこに一次情報(SSOT)があるか」を迷わず辿れるようにする **System Design (SYSD) Index** の記述ルールを定義する。
|
|
19
|
+
システム設計の正本、派生物、変更時の更新先への導線を集約する索引の規約を定める。
|
|
17
20
|
|
|
18
21
|
## 1. 全体方針
|
|
19
22
|
|
|
20
|
-
|
|
23
|
+
- 合意したシステム範囲につき、設計情報の入口を一つにする。全依存ファイルの台帳にはしない。
|
|
24
|
+
- 存在しない領域も残し、非該当には理由と代替正本(または代替不要の理由)、未確認には論点と影響を示す。
|
|
25
|
+
- 正本と生成物を分け、生成物を直接編集しない。
|
|
26
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
21
27
|
|
|
22
|
-
|
|
23
|
-
- ドキュメントとコードの二重管理を避ける
|
|
24
|
-
- 変更時に追随すべき場所を明確にする
|
|
28
|
+
## 2. 位置づけ
|
|
25
29
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
Code as Spec の原則:
|
|
29
|
-
|
|
30
|
-
- SYSD Index は「一次情報」ではなく「導線」とし、仕様本文(詳細)は書かない
|
|
31
|
-
- SYSD Index は SSOT(一次情報)へのリンクと最小限の補足のみを記載する
|
|
32
|
-
- SSOT は機械可読・差分検知可能な定義を優先する(OpenAPI / migration / workflow / schema など)
|
|
33
|
-
- 補足は意図・境界・ルールに限定し、詳細は SSOT に寄せる
|
|
34
|
-
|
|
35
|
-
## 2. 位置づけと用語定義
|
|
36
|
-
|
|
37
|
-
### 2.1. 位置づけ
|
|
38
|
-
|
|
39
|
-
- `sysd-index`:システム設計情報の導線を集約する Index(本書)
|
|
40
|
-
- API仕様、DBスキーマ、ジョブ定義、設定スキーマなど:実体を持つ一次情報(SSOT)
|
|
41
|
-
- C4 / NFR / OPD / DEC:背景・方針・判断記録の関連ドキュメント
|
|
42
|
-
|
|
43
|
-
### 2.2. 用語定義
|
|
44
|
-
|
|
45
|
-
| 用語 | 定義 |
|
|
46
|
-
| ------------ | ----------------------------------------------------------------------------- |
|
|
47
|
-
| SYSD Index | System Design Index。一次情報そのものではなく、設計情報への導線をまとめる文書 |
|
|
48
|
-
| SSOT | Single Source of Truth。仕様の正本となる一次情報 |
|
|
49
|
-
| Code as Spec | コード/定義ファイルを仕様の正本として扱う運用方針 |
|
|
30
|
+
システム設計(System Design、SYSD)索引は、正本(SSOT: Single Source of Truth)の所在と変更経路をつなぐ入口である。詳細な設計判断は分冊、変更後の確認は運用・テスト仕様が担う。
|
|
50
31
|
|
|
51
32
|
## 3. ファイル命名・ID規則
|
|
52
33
|
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
- `id`(参照用の不変キー)とファイル名(可読性/並び順)は独立であり、ファイル名変更は許容する。
|
|
34
|
+
- ファイル名は `sysd-index.md` とし、対象のシステム設計文書群に置く。
|
|
35
|
+
- ID は対象範囲で一意な `sysd-index` 系とし、名前空間・配置は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] に従う。
|
|
36
|
+
- H1 にはシステム名と索引であることを示す。
|
|
57
37
|
|
|
58
38
|
## 4. 推奨 Frontmatter 項目
|
|
59
39
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
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))。
|
|
63
|
-
|
|
64
|
-
| 項目 | 説明 | 必須 |
|
|
65
|
-
| ---------- | ------------------------------------------------------ | ---- |
|
|
66
|
-
| id | SYSD ID(推奨: `sysd-index`) | ○ |
|
|
67
|
-
| type | `architecture` 固定 | ○ |
|
|
68
|
-
| title | システム設計: 全体構成(リンク集)など対象が分かる名称 | ○ |
|
|
69
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
70
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
71
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
72
|
-
|
|
73
|
-
### 4.2. 推奨ルール
|
|
40
|
+
共通の型・許可項目は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正とする。
|
|
74
41
|
|
|
75
|
-
- `
|
|
76
|
-
- `based_on`
|
|
42
|
+
- `type` は `architecture`、`rulebook` は `specdojo:sysd-index-rulebook` とする。
|
|
43
|
+
- `based_on` は直接の根拠だけを指定し、関連リンクを転記しない。
|
|
77
44
|
|
|
78
|
-
## 5.
|
|
45
|
+
## 5. 本文要件
|
|
79
46
|
|
|
80
|
-
|
|
47
|
+
見出し順・表の列は template を正本とし、本章は内容の成立条件を定める。
|
|
81
48
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
88
|
-
|
|
|
49
|
+
| 内容領域 | 必須・任意 | 成立条件 |
|
|
50
|
+
| ---------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| 対象と責任 | 必須 | 対象範囲と対象外、利用者と利用目的が分かる。略語は初出時に展開する |
|
|
52
|
+
| 設計正本 | 必須 | API・外部連携、データ契約・DB・移行、モジュール境界、設定・実行構成、Job・定期処理、監視・ログ・通知、ソース管理・CI の所在、更新責任、検証方法を示す |
|
|
53
|
+
| 派生物 | 必須 | 入力、実在する生成コマンド、生成先、閲覧先・再生成時機を対応付ける。生成しない場合は理由を記す |
|
|
54
|
+
| 変更経路 | 必須 | 変更トリガーから、最初の更新先、追従する文書・生成物、検査・ケース・期待結果へつながる |
|
|
55
|
+
| 関連仕様 | 必須 | 上位・同階層・下流の参照目的と整備状態が分かる。実在文書と未作成文書を区別する |
|
|
56
|
+
| 留保事項 | 条件付き必須 | 未決・未整備の設計事項がある場合、論点、影響、当面の扱い、解消条件と解消後の更新先を示す |
|
|
89
57
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
- 本文は「リンク集」としての導線に徹し、仕様本文の再掲はしない。
|
|
93
|
-
- `3. 自動生成物` を省略する場合は `(なし)` または `(該当なし)` を明記する。
|
|
58
|
+
- パスは基準ディレクトリを明示し、glob は集合を特定できる範囲にする。
|
|
94
59
|
|
|
95
60
|
## 6. 記述ガイド
|
|
96
61
|
|
|
97
|
-
### 6.1.
|
|
98
|
-
|
|
99
|
-
生成する本文の見出しは **## 1. 概要(対象範囲・更新責任)**
|
|
100
|
-
|
|
101
|
-
- SDI が扱う範囲(内部API、内部イベント、外部I/F、DB、ジョブ、設定、モジュール境界)を明記する。
|
|
102
|
-
- 更新責任(Owner)を role ベースで明記する。
|
|
103
|
-
|
|
104
|
-
### 6.2. SSOT 一覧(表形式)
|
|
105
|
-
|
|
106
|
-
生成する本文の見出しは **## 2. SSOT 一覧(表形式)**
|
|
107
|
-
|
|
108
|
-
SDI の中核は **SSOT 一覧表** とする。
|
|
109
|
-
|
|
110
|
-
必須列:
|
|
111
|
-
|
|
112
|
-
- 種別(Category)
|
|
113
|
-
- SSOT(一次情報の種類)
|
|
114
|
-
- 参照先(パス/場所/リンク)
|
|
115
|
-
- 更新責任(Owner:role でよい)
|
|
116
|
-
- 備考(最小補足:任意)
|
|
117
|
-
|
|
118
|
-
種別(Category)の推奨値:
|
|
62
|
+
### 6.1. 概要の書き方
|
|
119
63
|
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
- External I/F
|
|
123
|
-
- Database Schema
|
|
124
|
-
- Jobs / Batch
|
|
125
|
-
- Configurations
|
|
126
|
-
- Observability(ログ/監査/トレースの定義がある場合)
|
|
127
|
-
- Module Boundary(依存方向・構成の規約)
|
|
64
|
+
- 良い例: 「開発担当が CLI と日次処理の保存形式を変更するときに使う。店舗端末のハードウェア設計は対象外。」
|
|
65
|
+
- 悪い例: 「システム全体を扱い、担当者が適宜確認する。」利用目的と対象境界がない。
|
|
128
66
|
|
|
129
|
-
|
|
67
|
+
### 6.2. SSOT 一覧の書き方
|
|
130
68
|
|
|
131
|
-
|
|
132
|
-
- 外部URLは最小限(SaaSの画面リンク等)。可能なら repo 内に保存する
|
|
133
|
-
- 複数ある場合は代表を1つ示し、備考で派生を列挙する
|
|
69
|
+
「正本」は最初に更新する定義を記す。ログは出力ディレクトリと、形式・通知を決める設定を区別する。ソース管理・CI は統合の規約、ワークフロー・フック・検査 script の正本へ接続する。
|
|
134
70
|
|
|
135
|
-
|
|
71
|
+
- 良い例: 「DB は非該当(ファイル保存のみ)。正本は保存レコード schema と移行処理。DEV が更新し、既存形式の読込テストで検証する。」
|
|
72
|
+
- 悪い例: 「DB はなし」。理由と代替正本が分からない。
|
|
136
73
|
|
|
137
|
-
|
|
138
|
-
- バージョニング方針の入口(詳細はSCR/DECへ)
|
|
139
|
-
- 読者や利用方法の要点(1〜2行)
|
|
74
|
+
### 6.3. 自動生成物の書き方
|
|
140
75
|
|
|
141
|
-
|
|
76
|
+
対象リポジトリの script 定義と出力先を照合し、同じ出力を別の正本にしない。業務記録や実行状態は派生物と分ける。
|
|
142
77
|
|
|
143
|
-
|
|
78
|
+
- 良い例: 「API 定義から型を生成する script と出力ファイルを示し、API 変更時に再生成してビルドで整合を確かめる。」
|
|
79
|
+
- 悪い例: 「ビルドすれば更新される」。入力と出力が対応しない。
|
|
144
80
|
|
|
145
|
-
|
|
146
|
-
- AsyncAPI → HTML
|
|
147
|
-
- migration → schema dump / ERD
|
|
148
|
-
- config schema → 設定一覧ドキュメント
|
|
81
|
+
### 6.4. 変更の入口の書き方
|
|
149
82
|
|
|
150
|
-
|
|
83
|
+
正常系に加え、変更が壊しやすい失敗・境界ケースを選ぶ。これから行う検証と実行済みの証跡を混同しない。
|
|
151
84
|
|
|
152
|
-
|
|
85
|
+
- 良い例: 「保存形式変更時は schema と移行処理を更新し、移行テストで旧形式の読込成功と再実行時の重複なしを確認する。」
|
|
86
|
+
- 悪い例: 「代表実行で経路と分離を確認する」。対象と期待結果がない。
|
|
153
87
|
|
|
154
|
-
|
|
88
|
+
### 6.5. 関連ドキュメント導線の書き方
|
|
155
89
|
|
|
156
|
-
|
|
157
|
-
- SDI 更新はリンク表の差分を中心とし、仕様本文は更新対象に含めない。
|
|
158
|
-
- 典型ケース(例: API追加、テーブル追加、ジョブ追加)ごとに「どこを修正するか」を短く記述する。
|
|
90
|
+
区分は文書の役割を示す名称で統一する。C4 / NFR / OPD / DEC 等の略号だけを必須の分類にせず、対象の文書体系に合わせる。未作成文書には当面の代替参照先を示す。
|
|
159
91
|
|
|
160
|
-
|
|
92
|
+
- 良い例: 「非機能要件(NFR)」「運用方針・手順(OPD / OPR)」で分類し、未作成の運用索引は当面使う個別手順を示す。
|
|
93
|
+
- 悪い例: 同じ非機能要件を「品質」「NFR」と呼び分ける。
|
|
161
94
|
|
|
162
|
-
|
|
95
|
+
### 6.6. 留保事項の書き方
|
|
163
96
|
|
|
164
|
-
-
|
|
165
|
-
-
|
|
166
|
-
|
|
167
|
-
### 6.6. カテゴリ別の書き分け方針
|
|
168
|
-
|
|
169
|
-
Code as Spec の適用にあたり、種別(Category)ごとに何を SSOT とし、SDI 本体に何を書かないかを次のとおり判断する。
|
|
170
|
-
|
|
171
|
-
- **内部API / 内部イベント**:OpenAPI / AsyncAPI / gRPC proto 等を SSOT とし、SDI 本体にはリンクと横断ルールへの参照のみを記載する。
|
|
172
|
-
- **DB**:migration / schema 定義を SSOT とし、物理設計は「理由(意図)」のみを横断ルールまたは重要フローに残す。
|
|
173
|
-
- **UI 詳細**:画面の目的・項目は UIS を SSOT とし、実装構成(コンポーネント分割等)はコード参照とする。
|
|
174
|
-
- **Module Boundary**:クラス図は追随コストが高いため原則作らず、依存方向のルールとして横断ルールに記載する。
|
|
175
|
-
- **Jobs / Batch**:定義ファイル(workflow/cron/IaC)とコードを SSOT とし、運用上の重要事項のみ横断ルールに記載する。
|
|
176
|
-
- **Configurations**:config schema とデフォルト設定を SSOT とし、運用が触る項目のみ横断ルールまたは SDI から参照できる形で一覧化する。
|
|
97
|
+
- 良い例: 「通知先が未決で外部通知の疎通を検証できない。当面は実行ログを確認する。検知要件と通知先の決定後、設定正本と監視手順への導線を更新する。」
|
|
98
|
+
- 悪い例: 「今後検討」。影響と解消条件が分からない。
|
|
177
99
|
|
|
178
100
|
## 7. 禁止事項
|
|
179
101
|
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
| 古い/未使用/不明確なリンクを残す | Indexとしての信頼性が低下するため |
|
|
185
|
-
| Owner を未記載にする | 更新責任が不明となり形骸化するため |
|
|
186
|
-
| 備考に詳細仕様を書き始める | 本文肥大化と責務混在を招くため |
|
|
187
|
-
|
|
188
|
-
## 8. サンプル
|
|
189
|
-
|
|
190
|
-
注:以下はルール文書内の例示です。生成する `sysd-index` では `## 1...` から始まります。
|
|
191
|
-
|
|
192
|
-
```yaml
|
|
193
|
-
---
|
|
194
|
-
id: sysd-index
|
|
195
|
-
type: architecture
|
|
196
|
-
title: システム設計: 全体構成リンク集
|
|
197
|
-
status: draft
|
|
198
|
-
based_on: []
|
|
199
|
-
supersedes: []
|
|
200
|
-
---
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### 8.1. 概要(対象範囲・更新責任)
|
|
204
|
-
|
|
205
|
-
本書は、システム設計情報のSSOTを参照するための導線を一元化する。
|
|
206
|
-
更新責任: Dev Lead(構成管理)/ Ops Lead(運用系SSOT)
|
|
207
|
-
|
|
208
|
-
### 8.2. SSOT 一覧(例)
|
|
209
|
-
|
|
210
|
-
<!-- prettier-ignore -->
|
|
211
|
-
| 種別 | SSOT | 参照先 | 更新責任 | 備考 |
|
|
212
|
-
| --- | --- | --- | --- | --- |
|
|
213
|
-
| Internal API | OpenAPI | `api/openapi.yaml` | Dev | CIでlint、破壊的変更はDEC必須 |
|
|
214
|
-
| Internal Events | AsyncAPI + CloudEvents | `api/asyncapi.yaml` | Dev | schema互換性チェックを実施 |
|
|
215
|
-
| External I/F | 外部連携定義 | `spec/external-if/` | Dev | 接続先契約変更時は `dec-*` を更新 |
|
|
216
|
-
| Database Schema | migrations | `db/migrations/` | Dev | schema dumpはCI生成 |
|
|
217
|
-
| Jobs / Batch | workflow | `ops/workflows/` | Ops | 失敗時通知・リトライもここで定義 |
|
|
218
|
-
| Configurations | config schema | `config/schema.yaml` | Dev/Ops | 上書き階層はSCR参照 |
|
|
219
|
-
| Observability | ログ/監査定義 | `ops/observability/` | Ops | 監査ログ保持方針は `opd-*` 参照 |
|
|
220
|
-
| Module Boundary | package rule | `docs/architecture/module-boundary.md` | Dev | 依存方向はSCR参照 |
|
|
221
|
-
|
|
222
|
-
### 8.3. 自動生成物(例)
|
|
223
|
-
|
|
224
|
-
| 生成物 | 入力SSOT | 生成コマンド | 生成先 | 閲覧先 | 更新方式 |
|
|
225
|
-
| ------------- | ------------------- | ----------------------- | -------------------------- | ------------------------------------ | -------- |
|
|
226
|
-
| OpenAPI Docs | `api/openapi.yaml` | `npm run docs:openapi` | `docs/generated/openapi/` | `docs/generated/openapi/index.html` | CI |
|
|
227
|
-
| AsyncAPI Docs | `api/asyncapi.yaml` | `npm run docs:asyncapi` | `docs/generated/asyncapi/` | `docs/generated/asyncapi/index.html` | CI |
|
|
228
|
-
| ERD | `db/migrations/` | `npm run docs:erd` | `docs/generated/erd/` | `docs/generated/erd/index.html` | CI |
|
|
229
|
-
|
|
230
|
-
### 8.4. 変更の入口(典型ケース例)
|
|
231
|
-
|
|
232
|
-
| 変更トリガ | 最初に直す場所(SSOT) | 併せて更新する場所 | 完了条件(最低限) |
|
|
233
|
-
| --------------------- | ---------------------- | ---------------------------------------- | ------------------------- |
|
|
234
|
-
| APIエンドポイント追加 | `api/openapi.yaml` | `docs/generated/openapi/`, SDIのSSOT一覧 | API lint通過、SDI導線追加 |
|
|
235
|
-
| テーブル追加 | `db/migrations/` | `docs/generated/erd/`, SDIのSSOT一覧 | migration適用可、ERD更新 |
|
|
236
|
-
| バッチ新設 | `ops/workflows/` | 監視設定、SDIのSSOT一覧 | 実行定義・通知先が明記 |
|
|
237
|
-
| 設定項目追加 | `config/schema.yaml` | 設定一覧生成物、SDIのSSOT一覧 | 既定値・型・説明が確定 |
|
|
238
|
-
|
|
239
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
240
|
-
|
|
241
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
242
|
-
| ------ | ------------------- | ---------------------- | ---------------------- |
|
|
243
|
-
| アーキ | cpd-business-domain | 外部境界・依存先の把握 | 入口として必須 |
|
|
244
|
-
| 品質 | nfr-index | 非機能要件との整合確認 | 可用性・性能の判断基準 |
|
|
245
|
-
|
|
246
|
-
| 運用方針 | opd-index | 運用統制(監視/証跡/権限)確認 | 監査観点で参照 |
|
|
247
|
-
| 決定記録 | dec-index | 設計判断の背景追跡 | 破壊的変更時に必須 |
|
|
102
|
+
- 値、API 電文、SQL、設定キー全量、クラス構造、詳細運用手順を正本から転載し、索引を第二の仕様書にする。
|
|
103
|
+
- 非該当と未確認を同一視し、調べていない領域を無言で省略する。
|
|
104
|
+
- 未作成・廃止済みの文書や存在しないコマンドを現行の導線として示す。
|
|
105
|
+
- 対象システムの実例にある製品、ファイル配置、ロール兼務を全案件の必須構成にする。
|
|
@@ -5,6 +5,8 @@ specdojo:
|
|
|
5
5
|
deliverable_type: architecture
|
|
6
6
|
status: draft
|
|
7
7
|
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: undecided
|
|
8
10
|
template: not-needed
|
|
9
11
|
based_on:
|
|
10
12
|
- specdojo:rulebook-authoring-standard
|
|
@@ -15,53 +17,41 @@ specdojo:
|
|
|
15
17
|
|
|
16
18
|
System Design Topic Documentation Rulebook
|
|
17
19
|
|
|
18
|
-
`sysd-<term>.md`
|
|
20
|
+
`sysd-<term>.md` の構造・責務・制約・検証観点を定める。実装・検証・運用判断に使う個別設計と、子設計を束ねる hub を対象とする。
|
|
19
21
|
|
|
20
22
|
## 1. 全体方針
|
|
21
23
|
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
- 複数トピックへ適用する必須・禁止ルールは `sysd-cross-cutting-policy`、事故予防に必要な難所フローは `sysd-critical-flows` を SSOT とします。
|
|
26
|
-
- 運用判断は `opd-*`、再現可能な操作手順は `opr-*` に委ね、個別システム設計へ混在させません。
|
|
24
|
+
- 一冊は一つの設計関心事に絞る。同じ共通設計に属する複数 provider・方式は、hub と子設計に分冊できる。
|
|
25
|
+
- コード・設定全文は一次情報、運用判断は `opd-*`、操作手順は `opr-*` を参照する。
|
|
26
|
+
- **共通の運用**: 役割は適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の検証に含めない。
|
|
27
27
|
|
|
28
|
-
## 2.
|
|
28
|
+
## 2. 位置づけ
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| --------------------------- | ------------------------------------ |
|
|
32
|
-
| `sysd-index` |
|
|
33
|
-
| `sysd-cross-cutting-policy` |
|
|
34
|
-
| `sysd-critical-flows` | 最大5件の事故予防フロー |
|
|
35
|
-
| `sysd-<term>`(hub) |
|
|
36
|
-
| `sysd-<term>`(子設計) | 一つの方式・provider・機能の詳細設計 |
|
|
37
|
-
|
|
38
|
-
hub は内容の薄さを目的とするのではなく、共通事項の SSOT と子設計の選択条件を一箇所に保つための構成です。
|
|
30
|
+
| 文書 | 正本とする内容 |
|
|
31
|
+
| --------------------------- | ------------------------------------ |
|
|
32
|
+
| `sysd-index` | システム設計全体への入口 |
|
|
33
|
+
| `sysd-cross-cutting-policy` | 複数トピックの必須・禁止ルール |
|
|
34
|
+
| `sysd-critical-flows` | 最大5件の事故予防フロー |
|
|
35
|
+
| `sysd-<term>`(hub) | 共通の目的・境界、子設計の選択条件 |
|
|
36
|
+
| `sysd-<term>`(子設計) | 一つの方式・provider・機能の詳細設計 |
|
|
39
37
|
|
|
40
38
|
## 3. ファイル命名・ID規則
|
|
41
39
|
|
|
42
|
-
- ファイル名は `sysd-<term>.md`、ID は `sysd-<term>`
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
- provider 別に分冊する場合は、`sysd-<provider>-<topic>.md` のように選択軸を名前へ含めます。
|
|
46
|
-
- `sysd-index`、`sysd-critical-flows`、`sysd-cross-cutting-policy` は専用 rulebook の対象であり、本 rulebook の対象外です。
|
|
40
|
+
- ファイル名は `sysd-<term>.md`、ID は `sysd-<term>`。`<term>` は英小文字・数字・ハイフンで設計関心事を表す。
|
|
41
|
+
- hub と子設計は同じディレクトリに置く。provider 別なら `sysd-<provider>-<topic>.md` のように選択軸を含める。
|
|
42
|
+
- 索引・横断ルール・重要フローは本書の対象外とする。
|
|
47
43
|
|
|
48
44
|
## 4. 推奨 Frontmatter 項目
|
|
49
45
|
|
|
50
|
-
|
|
51
|
-
| ------------ | -------------------------------- | ----------- |
|
|
52
|
-
| `id` | `sysd-<term>` | ○ |
|
|
53
|
-
| `type` | `architecture` | ○ |
|
|
54
|
-
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
55
|
-
| `rulebook` | `specdojo:sysd-rulebook` | ○ |
|
|
56
|
-
| `part_of` | hub または `sysd-index` の ID | 子設計では○ |
|
|
57
|
-
| `based_on` | 設計判断へ直接利用した成果物 ID | 任意 |
|
|
58
|
-
| `supersedes` | 置き換える旧設計 ID | 任意 |
|
|
46
|
+
共通項目の必須性・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
59
47
|
|
|
60
|
-
|
|
48
|
+
- `type` は `architecture`、`rulebook` は `specdojo:sysd-rulebook`。
|
|
49
|
+
- 子設計の `part_of` は必須とし、hub の ID を参照して子設計一覧と一致させる。
|
|
50
|
+
- `based_on` は設計判断へ直接利用した成果物 ID を任意で示す。
|
|
61
51
|
|
|
62
|
-
## 5.
|
|
52
|
+
## 5. 本文要件
|
|
63
53
|
|
|
64
|
-
|
|
54
|
+
章構成は任意だが、次の観点を追跡可能にする。観点表と記述ガイドで作成判断ができるため、recipe・template は不要とする。
|
|
65
55
|
|
|
66
56
|
| 観点 | hub | 子設計・単独設計 | 内容 |
|
|
67
57
|
| ---------------------------- | -------- | ---------------- | -------------------------------------- |
|
|
@@ -71,50 +61,47 @@ hub の子設計一覧と `part_of` の参照は一致させます。作成途
|
|
|
71
61
|
| 全体構成・主要フロー | 推奨 | ○ | 構成要素、データ・制御の流れ、永続化点 |
|
|
72
62
|
| 設定・インターフェース | 導線のみ | 必要時○ | SSOT の所在、解決規則、互換性 |
|
|
73
63
|
| 失敗時・再実行・セキュリティ | 導線のみ | 必要時○ | 失敗境界、復旧条件、権限制約 |
|
|
74
|
-
|
|
75
|
-
|
|
|
76
|
-
|
|
77
|
-
| 検証観点・関連文書 | ○ | ○ | テスト、運用、横断ルールへの導線 |
|
|
64
|
+
| 子設計一覧 | ○ | - | 選択条件、責務、参照先 |
|
|
65
|
+
| 検証観点・関連文書 | ○ | ○ | テスト、運用、横断ルールへの導線 |
|
|
78
66
|
|
|
79
67
|
## 6. 記述ガイド
|
|
80
68
|
|
|
81
69
|
### 6.1. 目的・適用範囲
|
|
82
70
|
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
71
|
+
- 対象・対象外と利用者を1〜3段落で示す。
|
|
72
|
+
- 横断ルール・運用方針・手順への委譲先を区別する。
|
|
73
|
+
- 現行と将来構想を分け、未確定事項は共通ラベルで論点と影響を示す。
|
|
86
74
|
|
|
87
75
|
### 6.2. 設計方針・責務境界
|
|
88
76
|
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
77
|
+
- 採用理由・制約・責務外を判定可能にする。
|
|
78
|
+
- 責務表の列は構成要素、責務、責務外、参照する SSOT とする。
|
|
79
|
+
- 横断の MUST / MUST NOT は `sysd-cross-cutting-policy` の Rule ID を参照する。
|
|
92
80
|
|
|
93
81
|
### 6.3. hub と子設計
|
|
94
82
|
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
83
|
+
- 子設計一覧の列は子設計 ID、対象、固有責務、選択条件とする。
|
|
84
|
+
- provider 固有の認証・モデル・設定・制限シグナルは子設計に置く。
|
|
85
|
+
- 良い例: 「Codex 利用時は Codex 子設計を参照」。悪い例: hub に全 provider の設定全文を並べる。
|
|
98
86
|
|
|
99
87
|
### 6.4. 構成・フロー・設定
|
|
100
88
|
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
89
|
+
- 図は主要コンポーネントと境界に用い、クラス・関数単位へ展開しない。
|
|
90
|
+
- 設定は項目の意味・解決順序・検証条件を示す。
|
|
91
|
+
- 再実行性・順序・補償・監査が事故時に問題になるフローは `sysd-critical-flows` に切り出す。
|
|
104
92
|
|
|
105
93
|
### 6.5. 検証観点・関連文書
|
|
106
94
|
|
|
107
|
-
-
|
|
108
|
-
- `sysd-index
|
|
109
|
-
-
|
|
95
|
+
- 設計制約ごとに、コード・設定検証・単体/統合テスト・レビューから確認方法を選び、手順と期待結果を示す。
|
|
96
|
+
- `sysd-index`、横断ルール、必要な重要フロー、テスト設計、OPD / OPR へ導く。
|
|
97
|
+
- 参照先がなければ `(なし)` または共通の未確定ラベルを記す。
|
|
110
98
|
|
|
111
99
|
## 7. 禁止事項
|
|
112
100
|
|
|
113
|
-
| 禁止事項 | 理由
|
|
114
|
-
| --------------------------------------------- |
|
|
115
|
-
| hub に子設計の設定全文を再掲する | SSOT が分散するため
|
|
116
|
-
| 横断ルールを複数の `sysd-<term>` に複製する | 変更時に不整合となるため
|
|
117
|
-
| 運用コマンドを長い手順として記載する | OPR の責務を侵食するため
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
| 親子関係のない設計を便宜的に同じ hub へ束ねる | 選択軸と責務境界が不明になるため |
|
|
101
|
+
| 禁止事項 | 理由 |
|
|
102
|
+
| --------------------------------------------- | ------------------------------------ |
|
|
103
|
+
| hub に子設計の設定全文を再掲する | SSOT が分散するため |
|
|
104
|
+
| 横断ルールを複数の `sysd-<term>` に複製する | 変更時に不整合となるため |
|
|
105
|
+
| 運用コマンドを長い手順として記載する | OPR の責務を侵食するため |
|
|
106
|
+
| 失敗・再実行・権限・検証観点を省略する | 実装とテストの判断材料が欠落するため |
|
|
107
|
+
| 親子関係のない設計を便宜的に同じ hub へ束ねる | 選択軸と責務境界が不明になるため |
|
|
@@ -3,7 +3,7 @@ specdojo:
|
|
|
3
3
|
id: specdojo:tml-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: project
|
|
6
|
-
status:
|
|
6
|
+
status: deprecated
|
|
7
7
|
target_format: yaml
|
|
8
8
|
recipe: not-needed
|
|
9
9
|
sample: specdojo:tml-sample
|
|
@@ -16,8 +16,9 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Timeline Documentation Rules
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
本 Kata は非推奨です。全体計画は epic で管理し、`dashboard build` で生成します。移行先は [[specdojo:pjr-rulebook|プロジェクト登録簿ルール]]、手順は [[specdojo:timeline-design-guide|Timeline からの移行ガイド]] を参照してください。
|
|
20
|
+
|
|
21
|
+
以下は既存の `tml-index.yaml` を互換運用するための旧規約です。新しい計画には使いません。
|
|
21
22
|
|
|
22
23
|
本書は命名・ID 規則と schema で表現できない記述規範を定義し、構造・必須キーは schema を、トラックの標準構成と実行順序の考え方は [[specdojo:track-design-guide]] を参照します。
|
|
23
24
|
|
|
@@ -136,9 +137,3 @@ schema で機械検証できない記述規範だけを定める。トラック
|
|
|
136
137
|
- `sch-milestones.yaml` のマイルストーンを `tml-index.yaml` に複製すること。
|
|
137
138
|
- プロジェクトごとに `tml-index.yaml` を複数置くこと、またはトラック単位へ分割すること。
|
|
138
139
|
- `specdojo timeline build` の生成物を直接編集すること。
|
|
139
|
-
|
|
140
|
-
## 7. 今後の検討
|
|
141
|
-
|
|
142
|
-
- 現時点の `catalog_status` は3値の軽量フィールドであり、カタログ作成作業そのものを子カタログ(`done_criteria` 付きの成果物エントリ)として管理する「フル成果物カタログ化」は採用していない。カタログ作成の工数管理をタスク粒度で行う必要が出た場合に、フル化を再検討する。
|
|
143
|
-
- フル化する場合でも `tml-index.yaml` はトラック粒度の計画層として残し、カタログ作成タスクは Schedule 側へ展開する方針を想定する。
|
|
144
|
-
- 複数プロジェクトを横断したトラック順序計画(プログラム単位の Timeline)は現時点では扱わない。
|