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
|
@@ -11,32 +11,19 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Data Migration Design (DMD) Documentation Rules
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
旧→新のデータ移行を再現可能に定義し、品質(正確性・完全性)を担保するための内容を定義します。
|
|
14
|
+
対象別データ移行設計(`dmd-<term>`)で、旧→新のデータ移行を再現可能に定義し、正確性・完全性を確かめる基準を定めます。
|
|
16
15
|
|
|
17
16
|
## 1. 全体方針
|
|
18
17
|
|
|
19
|
-
`dmd-<term>`
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
- 抽出方式(フル/増分)と増分基準(基準カラム/キー/基準時刻)を明記し、同条件で再実行できるようにする
|
|
24
|
-
- 変換ルールと除外ルールは **再実行しても同じ結果** になる形で記載する
|
|
25
|
-
- 移行手順は「手動/バッチ/ツール」を明示し、入出力(形式/置き場)・ログ・再実行性を担保する
|
|
26
|
-
- 検証は **件数照合/サンプル照合/重要値照合** を最低限含め、合格基準(差分0 / 許容差ε)を明確にする
|
|
27
|
-
|
|
28
|
-
運用方針(term 運用):
|
|
29
|
-
|
|
30
|
-
- `dmd-<term>` はデータ領域(例:受注/請求/在庫)やデータセット単位で作成する
|
|
31
|
-
- `dmd-<term>` の判断体系は `dmd-index` と矛盾させない
|
|
32
|
-
- **「関連ドキュメント」セクションは必須**(最低でも `dmd-index` への導線を記載する)
|
|
18
|
+
- **目的と単位**: `dmd-<term>` は、データ領域(例: 受注・請求・在庫)またはデータセットごとの個別 SSOT とします。
|
|
19
|
+
- **上位との分担**: 抽出方式の扱い、`run_id` 規約、冪等性、検証の種類は `dmd-index` を正とし、`dmd-<term>` には対象固有の値だけを書きます。
|
|
20
|
+
- **再現性**: 「何を・どこから・どこへ・どの条件で移すか」と変換・除外ルールを、再実行しても同じ結果になる形で書き、検証は合格基準(差分0 / 許容差ε)で合否を判定できるようにします。
|
|
21
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、移行の検証に含めません。
|
|
33
22
|
|
|
34
23
|
## 2. 位置づけ
|
|
35
24
|
|
|
36
|
-
`dmd-<term>` と他ドキュメントの関係を示します。必要に応じて Mermaid による図を使用してよい。
|
|
37
|
-
|
|
38
25
|
- `mip-index`:移行の合意・判断のSSOT(成功条件・カットオーバー骨格を含む)
|
|
39
|
-
- `dmd-index
|
|
26
|
+
- `dmd-index`:データ移行の入口(共通方針、`run_id` 規約、検証の共通方針)
|
|
40
27
|
- **`dmd-<term>`:対象別データ移行の詳細設計(マッピング/変換/検証)**
|
|
41
28
|
- `mtp-index` / `mtp-<term>`:リハーサル計画・検証設計(観点/手順/証跡)
|
|
42
29
|
- `cop-index` / `cop-<term>`:当日実行の詳細手順(Runbook)
|
|
@@ -44,35 +31,20 @@ Data Migration Design (DMD) Documentation Rules
|
|
|
44
31
|
|
|
45
32
|
## 3. ファイル命名・ID規則
|
|
46
33
|
|
|
47
|
-
-
|
|
48
|
-
-
|
|
49
|
-
-
|
|
34
|
+
- **ファイル名**: `dmd-<term>.md` とし、`<term>` は用語集(GL)の論理名キー(英小文字 kebab-case。例: `order-data`)を用います。
|
|
35
|
+
- **文書 ID**: プロダクト仕様の成果物は `dmd-<term>`、プロジェクト固有の成果物は `<project-id>:dmd-<term>` とし、成果物カタログの宣言と一致させます。
|
|
36
|
+
- **文書タイトル(H1)**: `# データ移行設計: <対象名>` とし、対象名は日本語でよいものとします。
|
|
50
37
|
|
|
51
38
|
## 4. 推奨 Frontmatter 項目
|
|
52
39
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
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))。
|
|
40
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
56
41
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
| id | DMD ID(`dmd-<term>`) | ○ |
|
|
60
|
-
| type | `data` 固定 | ○ |
|
|
61
|
-
| title | データ移行設計: <対象名> | ○ |
|
|
62
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
63
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
64
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
42
|
+
- `specdojo.type` は `data`、`specdojo.rulebook` は `specdojo:dmd-rulebook` とします。
|
|
43
|
+
- `specdojo.based_on` には移行判断に直接利用した作成済みの成果物(例: `mip-index` / `br-*` / `nfr-*` / `issue-*`)の ID だけを列挙します。
|
|
65
44
|
|
|
66
|
-
|
|
45
|
+
## 5. 本文要件
|
|
67
46
|
|
|
68
|
-
|
|
69
|
-
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
|
|
70
|
-
|
|
71
|
-
## 5. 本文構成(標準テンプレ)
|
|
72
|
-
|
|
73
|
-
`dmd-<term>` は以下の見出し構成を **順序固定** で配置します。
|
|
74
|
-
|
|
75
|
-
### 5.1. `dmd-<term>`(個別SSOT)
|
|
47
|
+
本文は次の見出しを順序固定で置き、見出しは `## <番号>. <見出し>` として表の文言のまま書きます(`<term>` は対象の term に置き換えます)。
|
|
76
48
|
|
|
77
49
|
| 番号 | 見出し | 必須 |
|
|
78
50
|
| ---- | ------------------------------------------------- | ---- |
|
|
@@ -89,21 +61,17 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
89
61
|
|
|
90
62
|
## 6. 記述ガイド
|
|
91
63
|
|
|
92
|
-
|
|
64
|
+
完成例の全体像は Frontmatter の `sample` で宣言された sample を参照してください。
|
|
93
65
|
|
|
94
|
-
|
|
66
|
+
### 6.1. 概要(`<term>`)
|
|
95
67
|
|
|
96
68
|
- 対象データが何であり、どの移行範囲を扱うかを 1〜3 行で示す
|
|
97
69
|
- 依存する前提(移行方式、移行期間、上位の成功条件)を簡潔に述べる
|
|
98
70
|
|
|
99
71
|
### 6.2. 対象データ詳細(テーブル/期間/抽出条件/概算件数)
|
|
100
72
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
- 対象テーブル/コレクションを列挙する
|
|
104
|
-
- 移行期間/抽出条件を明記する
|
|
105
|
-
- 抽出方式(フル/増分)と増分基準(基準カラム/キー/基準時刻)を明記する
|
|
106
|
-
- 概算件数(見積り根拠が分かる粒度)を示す
|
|
73
|
+
- 対象テーブル/コレクション、移行期間/抽出条件、抽出方式と増分基準を明記する
|
|
74
|
+
- 概算件数は見積り根拠が分かる粒度で示す
|
|
107
75
|
|
|
108
76
|
推奨フォーマット(表):
|
|
109
77
|
|
|
@@ -112,10 +80,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
112
80
|
|
|
113
81
|
### 6.3. データマッピング
|
|
114
82
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
- 旧→新の対応を明確に示す
|
|
118
|
-
- 1対多/多対1の関係は変換ルールと合わせて記述する
|
|
83
|
+
- 旧→新の対応を明確に示し、1対多/多対1の関係は変換ルールと合わせて記述する
|
|
119
84
|
- 主キー/参照整合(FK相当)の扱い(維持/再採番/変換テーブル、投入順序の前提)を明記する
|
|
120
85
|
|
|
121
86
|
推奨フォーマット(表):
|
|
@@ -125,27 +90,17 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
125
90
|
|
|
126
91
|
### 6.4. 変換ルール
|
|
127
92
|
|
|
128
|
-
生成する `dmd-<term>` 本文の見出しは **## 4. 変換ルール**
|
|
129
|
-
|
|
130
93
|
- 変換規則(正規化、コード変換、丸め、文字種変換等)を列挙する
|
|
131
|
-
- 再実行しても同じ結果になることを前提に記述する
|
|
132
94
|
- 変換の根拠(参照表/仕様ID)がある場合はリンクする
|
|
133
95
|
|
|
134
96
|
### 6.5. 除外ルール
|
|
135
97
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
- 移行対象外となる条件を列挙する
|
|
139
|
-
- 除外理由(業務上の不要、期限切れ、品質不良等)を明記する
|
|
98
|
+
- 移行対象外となる条件と除外理由(業務上の不要、期限切れ、品質不良等)を列挙する
|
|
140
99
|
- 除外した場合の影響(参照のみ/業務に影響なし/代替手段あり)を必要に応じて追記する
|
|
141
100
|
|
|
142
101
|
### 6.6. 移行手順(手動/バッチ/ツール)
|
|
143
102
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
- 手段(手動/バッチ/ツール)を明示する
|
|
147
|
-
- 実行順序と依存関係が分かる粒度で記述する
|
|
148
|
-
- 入出力(形式/置き場)と実行単位(ジョブ名/コマンド/ツール名)が分かるように記述する(詳細はリンクでよい)
|
|
103
|
+
- 実行順序と依存関係、入出力(形式/置き場)、実行単位(ジョブ名/コマンド/ツール名)が分かるように記述する(詳細はリンクでよい)
|
|
149
104
|
|
|
150
105
|
推奨フォーマット(表):
|
|
151
106
|
|
|
@@ -154,19 +109,13 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
154
109
|
|
|
155
110
|
### 6.7. 性能/所要時間見積
|
|
156
111
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
- 所要時間見積と前提条件(件数、並列度、スループット)を示す
|
|
160
|
-
- 目標時間がある場合は明記する
|
|
112
|
+
- 所要時間見積と前提条件(件数、並列度、スループット)、目標時間がある場合はその値を示す
|
|
161
113
|
- ボトルネックが想定される場合は、暫定対策(並列化/分割/先行移行)を方針として記載してよい
|
|
162
114
|
|
|
163
115
|
### 6.8. ログ/再実行性
|
|
164
116
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
- 実行ログの保存先と識別キー(例: `run_id`)を明記する
|
|
168
|
-
- 再実行条件(再投入可能範囲、冪等性の担保方法)を示す
|
|
169
|
-
- 冪等性方式を明記する(例: `upsert` / `run_id隔離` / `再投入前truncate` / `差分適用`)
|
|
117
|
+
- 実行ログの保存先と識別キー(例: `run_id`)、再実行条件(再投入可能範囲)を示す
|
|
118
|
+
- 冪等性方式(例: `upsert` / `run_id隔離` / `再投入前truncate` / `差分適用`)を明記する
|
|
170
119
|
|
|
171
120
|
推奨フォーマット(表):
|
|
172
121
|
|
|
@@ -180,11 +129,8 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
180
129
|
|
|
181
130
|
### 6.9. 検証方法(件数照合/サンプル照合/重要値)
|
|
182
131
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
- 件数照合、サンプル照合、重要値照合の方法を明記する
|
|
186
|
-
- 合格基準は「差分0」か「許容差(ε)」かを明示する(理由も 1 行でよい)
|
|
187
|
-
- 検証結果の証跡(レポート/ログ)を示す
|
|
132
|
+
- 件数照合、サンプル照合、重要値照合の方法と証跡(レポート/ログ)を示す
|
|
133
|
+
- 合格基準は「差分0」か「許容差(ε)」かを、理由 1 行とともに明示する
|
|
188
134
|
|
|
189
135
|
推奨フォーマット(表):
|
|
190
136
|
|
|
@@ -193,20 +139,16 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
193
139
|
|
|
194
140
|
### 6.10. 関連ドキュメント(必須)
|
|
195
141
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
- `dmd-index`(入口SSOT)への導線を必ず記載する
|
|
199
|
-
- 分冊が無い場合でも `(本書のみ)` を明記する
|
|
142
|
+
- `dmd-index`(入口SSOT)への導線を必ず記載し、分冊が無い場合でも `(本書のみ)` を明記する
|
|
200
143
|
|
|
201
144
|
## 7. 禁止事項
|
|
202
145
|
|
|
203
|
-
| 禁止事項 | 理由
|
|
204
|
-
| ------------------------------------------------------------------ |
|
|
205
|
-
| 対象データの範囲(期間/抽出条件/件数/方式)を曖昧に書く | 再現性と品質担保ができないため
|
|
206
|
-
|
|
|
207
|
-
|
|
|
208
|
-
|
|
|
209
|
-
|
|
|
210
|
-
|
|
|
211
|
-
|
|
|
212
|
-
| 「関連ドキュメント」セクションを省略する | 導線が失われ、参照先が分散するため |
|
|
146
|
+
| 禁止事項 | 理由 |
|
|
147
|
+
| ------------------------------------------------------------------ | ---------------------------------------------------------------- |
|
|
148
|
+
| 対象データの範囲(期間/抽出条件/件数/方式)を曖昧に書く | 再現性と品質担保ができないため |
|
|
149
|
+
| 変換ルール・除外ルールを未記載にする | 移行結果が再現できず、意図しない欠落が発生するため |
|
|
150
|
+
| 移行手順の手段(手動/バッチ/ツール)や入出力を曖昧に書く | 実行計画が確定できないため |
|
|
151
|
+
| 検証方法を「確認する」など合格基準のない書き方にする | 合否判定できないため |
|
|
152
|
+
| 移行ツールの実装コードや長大なSQLを本文に貼り付ける | 差分管理が破綻し、更新不整合を起こすため(参照リンクに寄せる) |
|
|
153
|
+
| `dmd-index` と矛盾する共通方針(run_id/冪等性/検証種別)を記載する | ドキュメント間で判断基準が分裂するため |
|
|
154
|
+
| 文書の整形・lint の実行を移行の検証方法に含める | リポジトリの検証と移行結果の照合が混ざり、合否判定が埋もれるため |
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:dss-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
6
|
+
status: draft
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: specdojo:dss-sample
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# デザインシステム(DSS)作成ルール
|
|
16
|
+
|
|
17
|
+
Design System Specification (DSS) Authoring Rule
|
|
18
|
+
|
|
19
|
+
GUI 共通の表現を揃え、部品・レイアウトの選択と適合確認に使う設計の決まりを定めます。
|
|
20
|
+
|
|
21
|
+
## 1. 全体方針
|
|
22
|
+
|
|
23
|
+
- 対象はトークン・部品・レイアウト・状態表示・アクセシビリティです。
|
|
24
|
+
- 各決まりに適用条件・必須または禁止する内容・検証方法を示します。
|
|
25
|
+
- デザインツール、トークン定義、部品カタログに正本があれば所在・版・参照キーを示し、転載しません。正本がない範囲だけ本書で定義します。
|
|
26
|
+
- 利用者の課題と採用理由を結び、操作性目標から決まり、試作・実装の検証へ辿れるようにします。
|
|
27
|
+
- **実践の型の構成**: 章構成・判断基準・完成例が揃うため、`recipe`・`template` は `not-needed` とします。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の検証に含めません。
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけ
|
|
31
|
+
|
|
32
|
+
| 型 | 持つ内容 | DSS との境界 |
|
|
33
|
+
| ------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------- |
|
|
34
|
+
| [[specdojo:uis-rulebook\|画面仕様(UIS)]] | 画面ごとの利用目的・項目・操作・遷移・エラーの要点と回復操作 | DSS は業務上の操作や遷移を追加せず、その見せ方を定める |
|
|
35
|
+
| [[specdojo:nfr-usability-rulebook\|操作性要件]] | 完了率・誤操作率・操作時間などの測れる目標と評価条件 | 目標は NFR、目標を満たす設計の決まりは DSS に置く |
|
|
36
|
+
| [[specdojo:sysd-cross-cutting-policy-rulebook\|システム設計の横断ルール]] | エラー契約・リトライ・認可・ログなど実装の共通ルール | DSS はエラー等の表示を扱い、通信や業務処理の成立条件は扱わない |
|
|
37
|
+
| [[specdojo:sysd-index-rulebook\|システム設計の全体構成]] | 設計と実装の正本への導線 | DSS とトークン・部品の正本への入口を載せる |
|
|
38
|
+
|
|
39
|
+
画面ごとのワイヤーフレームは保守せず、UIS・DSS から作る試作をプロダクトリポジトリに置いて検証します。採用する変更は UIS・DSS・実装の該当する正本へ反映します。
|
|
40
|
+
|
|
41
|
+
## 3. ファイル命名・ID規則
|
|
42
|
+
|
|
43
|
+
- 略号は `dss`、ファイル名・ローカル ID は `dss-<term>` とし、[[specdojo:id-and-file-naming-standard|ドキュメントIDおよびファイル命名標準]] に従います。
|
|
44
|
+
- 複数系列から参照する共通定義の既定は `dss-common.md` / `dss-common` です。端末群等で適用範囲が独立する場合だけ `dss-store-gui` のように分けます。
|
|
45
|
+
- プロダクト成果物は `docs/ja/product/040-system-design/`、プロジェクト限定なら設計ドメイン配下に置き、ID は `<project-id>:dss-<term>` とします。分冊時は共通定義を参照します。
|
|
46
|
+
- 規則を個別に追跡する ID は、文書内で一意の `dss-<カテゴリ>-<連番>`(例: `dss-a11y-01`)とします。
|
|
47
|
+
|
|
48
|
+
## 4. 推奨 Frontmatter 項目
|
|
49
|
+
|
|
50
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
51
|
+
|
|
52
|
+
- `specdojo.type` は `architecture`、`specdojo.rulebook` は `specdojo:dss-rulebook` とします。
|
|
53
|
+
- `specdojo.based_on` は直接根拠とした要求・仕様の ID、`specdojo.relations.satisfies` は操作性要件等との対応に用います。
|
|
54
|
+
|
|
55
|
+
## 5. 本文要件
|
|
56
|
+
|
|
57
|
+
以下の章を番号付きで配置します。すべて必須とし、対象外の観点は理由を記載します。
|
|
58
|
+
|
|
59
|
+
| 順序 | 章 | 内容 |
|
|
60
|
+
| ---- | ------------------------ | -------------------------------------------------------------- |
|
|
61
|
+
| 1 | 目的・適用範囲 | 利用者、課題、対象 GUI・端末・表示環境、対象外、採用理由 |
|
|
62
|
+
| 2 | 正本と適用方法 | 領域ごとの正本・版・参照キー・更新責任、試作と実装への適用方法 |
|
|
63
|
+
| 3 | デザイントークン | 色・文字・余白・角丸等の用途、値または正本参照、利用制約 |
|
|
64
|
+
| 4 | 部品の使い方 | 選択条件、バリエーション、組合せ、禁止する使い方 |
|
|
65
|
+
| 5 | レイアウトの型 | 適用条件、情報の優先順位、幅・拡大時の振る舞い |
|
|
66
|
+
| 6 | 状態の見せ方 | 通常・エラー・無効・読み込み中・空・完了の表現と通知 |
|
|
67
|
+
| 7 | アクセシビリティ | キーボード、フォーカス、読み上げ、色以外の識別、視認性の決まり |
|
|
68
|
+
| 8 | 検証・変更管理と関連文書 | 要求と決まりの対応、確認方法・合格条件・担当、例外と変更影響 |
|
|
69
|
+
|
|
70
|
+
## 6. 記述ガイド
|
|
71
|
+
|
|
72
|
+
各節は「本文要件」の同名の章に対応します。
|
|
73
|
+
|
|
74
|
+
### 6.1. 目的・適用範囲
|
|
75
|
+
|
|
76
|
+
- 利用者の課題と色・文字・部品等の採用理由を結び付けます。
|
|
77
|
+
- GUI、入力手段、画面幅、テーマ、支援技術の確認範囲を表にします。物理寸法と CSS viewport 幅を区別します。
|
|
78
|
+
- 対象外を示し、画面固有の業務仕様は UIS、測れる利用結果の目標は NFR を参照します。
|
|
79
|
+
|
|
80
|
+
判断基準: 対象環境と規則の適用境界を判断できること。
|
|
81
|
+
|
|
82
|
+
- 良い例: 「店頭の読み違いを防ぐため主要金額を大きくする。ライトテーマ、CSS viewport 幅 360px 以上の販売 GUI が対象で、レシートは対象外。」
|
|
83
|
+
- 悪い例: 「全端末で使いやすく美しくする。」(利用者・環境・採用理由が不明)
|
|
84
|
+
|
|
85
|
+
### 6.2. 正本と適用方法
|
|
86
|
+
|
|
87
|
+
- 推奨列: 領域 / 正本の所在 / 版・参照キー / 更新責任。デザインツールはファイルとライブラリ、コードはリポジトリと相対パスを特定します。
|
|
88
|
+
- 正本が分かれる領域では優先順位を定めます。
|
|
89
|
+
- UIS と DSS から作る試作の置き場所、実装へ採用する際の反映先、入力文書と試作の版の記録方法を示します。
|
|
90
|
+
|
|
91
|
+
判断基準: 同じ版の定義へ到達し、値を重複保守せず試作・実装に適用できること。
|
|
92
|
+
|
|
93
|
+
- 良い例: 「色はプロダクトリポジトリの `design/tokens.json` の `color.action` を参照し、検証記録に commit を残す。」
|
|
94
|
+
- 悪い例: 「最新のデザインに合わせる。」(所在・版がなく再現不能)
|
|
95
|
+
|
|
96
|
+
### 6.3. デザイントークン
|
|
97
|
+
|
|
98
|
+
- 推奨列: 名前 / 用途 / 値・単位または参照キー / 制約。色・文字・余白・角丸・操作領域・フォーカス枠等を扱います。
|
|
99
|
+
- 色は前景と背景の許可する組合せ、文字はサイズ・行高・太さ、寸法は単位と拡大時の扱いを定めます。複数テーマには切替条件を示します。
|
|
100
|
+
- 既存の用途に合わない場合はトークンの追加を検討し、画面内で独自値を増やしません。
|
|
101
|
+
|
|
102
|
+
判断基準: 値を推測せず用途に合うトークンを選べること。
|
|
103
|
+
|
|
104
|
+
- 良い例: 「`text-caption` は補足専用。金額・エラー・操作名には使わず、寸法は相対値で拡大に追従させる。」
|
|
105
|
+
- 悪い例: 「小さい文字と青を使う。」(名前・単位・利用制約がない)
|
|
106
|
+
|
|
107
|
+
### 6.4. 部品の使い方
|
|
108
|
+
|
|
109
|
+
- 推奨列: 規則 ID・部品 / 選択条件・使い方 / 禁止・制約。ボタン・入力・表・ダイアログを含め、不使用の理由を示します。
|
|
110
|
+
- 選択条件、バリエーション、ラベル、寸法の参照先、組合せを示します。業務上の操作名・確認の要否は UIS に委ねます。
|
|
111
|
+
- 状態表示・アクセシビリティは共通規則を参照し、部品固有の条件だけ補います。
|
|
112
|
+
|
|
113
|
+
判断基準: 同じ用途に同じ部品が選ばれ、禁止する組合せも判別できること。
|
|
114
|
+
|
|
115
|
+
- 良い例: 「一つの操作群の主操作は一つ。補助操作は枠付きとし、ラベルは UIS の操作名を使う。」
|
|
116
|
+
- 悪い例: 「重要そうな操作は塗りボタンにする。」(選択条件と優先度が不明)
|
|
117
|
+
|
|
118
|
+
### 6.5. レイアウトの型
|
|
119
|
+
|
|
120
|
+
- 一覧・入力・確認等の再利用可能な型を選びます。推奨列: 規則 ID・型 / 適用条件 / 配置と幅変化の決まり。
|
|
121
|
+
- 情報の優先順位・幅の境界、列切替、折り返し、スクロール、拡大時の扱いを定めます。画面別の座標・配置図は作りません。
|
|
122
|
+
- 視覚と読み上げ・Tab の順序を揃え、長文・大量データ・最大桁の金額等が収まらない場合も操作を保つ条件を書きます。
|
|
123
|
+
|
|
124
|
+
判断基準: 境界の前後や拡大時にも情報の意味と操作順序を保てること。
|
|
125
|
+
|
|
126
|
+
- 良い例: 「入力と集計は幅 960px 以上で二列、未満で一列。入力、集計、操作の順を保ち、操作群は折り返す。」
|
|
127
|
+
- 悪い例: 「販売画面の確定ボタンは座標 (800, 600) に置く。」(画面固有で再利用できない)
|
|
128
|
+
|
|
129
|
+
### 6.6. 状態の見せ方
|
|
130
|
+
|
|
131
|
+
- 推奨列: 状態 / 視覚表現 / 通知・フォーカス / 操作上の注意。通常・エラー・無効・読み込み中・空・完了を含めます。
|
|
132
|
+
- 原因・対処・次の操作は UIS を参照し、表示位置、色以外の識別、通知時機、フォーカスと入力値の保持を定めます。
|
|
133
|
+
- 通信中・失敗を空と区別し、重複操作防止とフォーカス保持を両立させます。再送条件は横断ルールに委ねます。
|
|
134
|
+
|
|
135
|
+
判断基準: 利用者が状態と次の操作を認識でき、支援技術にも変化が伝わること。
|
|
136
|
+
|
|
137
|
+
- 良い例: 「エラーは枠と『エラー』の文字を併用する。送信時は最初の不正入力へフォーカスし、値を保持する。」
|
|
138
|
+
- 悪い例: 「失敗時は赤くし、一定時間後に消す。」(色依存で回復前に情報を失う)
|
|
139
|
+
|
|
140
|
+
### 6.7. アクセシビリティ
|
|
141
|
+
|
|
142
|
+
- キーボード操作、フォーカスの出入り、ラベルと説明の関連付け、読み上げ通知、色以外の識別を必須とします。
|
|
143
|
+
- コントラスト、操作領域、文字拡大、動きの抑制を要求・規格と評価条件に結び付け、設計値と操作性目標を区別します。
|
|
144
|
+
- 推奨列: 規則 ID / 必須の決まり / 確認条件。支援技術とブラウザの組合せ、版の記録、対象状態、手動確認する操作を特定します。
|
|
145
|
+
|
|
146
|
+
判断基準: 同じ環境・操作で合否を再現でき、一部の数値だけで規格全体への適合を宣言していないこと。
|
|
147
|
+
|
|
148
|
+
- 良い例: 「ダイアログの Tab は内部を循環し、Escape で中止して起点へ戻す。起点消失時は次の操作群へ移す。」
|
|
149
|
+
- 悪い例: 「アクセシビリティに配慮する。」(確認する操作と合否の条件がない)
|
|
150
|
+
|
|
151
|
+
### 6.8. 検証・変更管理と関連文書
|
|
152
|
+
|
|
153
|
+
- 推奨列: 対象の規則・正本キー / 対応する要求 / 確認方法 / 合格条件 / 担当。トークンの静的確認・部品表示・試作操作・利用者評価を使い分け、規則への適合と操作性目標の達成を別に確かめます。
|
|
154
|
+
- 試作確認、規則検証、利用者評価、設計採用の順と終了条件を示します。未作成の入力・試験文書は想定 ID と不足する論点・影響、未確定時に止める段階を書きます。
|
|
155
|
+
- 変更時はトークン・部品・適用画面・検証への影響を示します。例外には対象規則、理由、影響範囲、検証結果、期限、判断記録と失効時の扱いを残します。
|
|
156
|
+
- UIS、操作性要件、設計の入口・横断ルール、受入・試験への導線を置きます。
|
|
157
|
+
|
|
158
|
+
判断基準: 証跡と未解決事項を添えて採用判断へ進められ、更新後も規則から検証・判断記録へ辿れること。
|
|
159
|
+
|
|
160
|
+
- 良い例: 「試作で UIS の全操作と DSS の型を対応付け、規則検証の不適合を修正・再確認する。利用者評価を要件の目標・条件と照合し、未達の必須条件があれば採用を保留する。」
|
|
161
|
+
- 悪い例: 「試作ができたら採用する。」(要件照合と検証結果がなく採否を追えない)
|
|
162
|
+
|
|
163
|
+
## 7. 禁止事項
|
|
164
|
+
|
|
165
|
+
| 禁止事項 | 理由 |
|
|
166
|
+
| ------------------------------------------------------------ | ----------------------------------------- |
|
|
167
|
+
| 画面ごとの目的・項目・操作・遷移、業務上の判定条件を定義する | UIS と責務が重複するため |
|
|
168
|
+
| 画面ごとのワイヤーフレームを文書として保守する | UIS・DSS と試作の間に別の正本ができるため |
|
|
169
|
+
| 実装の共通ルールや操作性の達成目標を再定義する | 横断ルールや NFR と競合するため |
|
|
170
|
+
| デザインツール・トークン定義・部品カタログの内容を転載する | 正本の更新が反映されず二重管理になるため |
|
|
171
|
+
| 値・選択条件・検証方法を示さず、抽象的な形容だけで規則を書く | 実装と合否判断が揃わないため |
|