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,7 +3,7 @@ specdojo:
|
|
|
3
3
|
id: specdojo:dct-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: project
|
|
6
|
-
status:
|
|
6
|
+
status: ready
|
|
7
7
|
target_format: yaml
|
|
8
8
|
recipe: not-needed
|
|
9
9
|
sample: specdojo:dct-index-sample
|
|
@@ -16,144 +16,114 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Deliverables Catalog Index Documentation Rules
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
本ドキュメントは、成果物カタログ索引 `dct-index.yaml` に書くドメインの分類・表示順・名称・概要と、scaffold に用いるプロジェクト規模の判断基準を定めます。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
23
23
|
- `dct-index.yaml` は、プロジェクト規模とドメイン一覧の表示意図を保持する唯一の正本とする。
|
|
24
24
|
- `generated/dct-index.md` は `catalog build` が生成する表示専用ビューとし、直接編集しない。
|
|
25
25
|
- 各ドメインの成果物定義は `dct-<domain>.yaml` に置き、索引には表示名・概要・順序・グループだけを置く。
|
|
26
|
-
- 共通ルールなどの散文と生成物の外枠は `dct-index-template.md` が保持し、YAML の文字列へ複製しない。
|
|
27
26
|
- `dct-index.yaml` の宣言ドメイン集合と実在する `dct-*.yaml` の `domain` 集合を一致させる。
|
|
27
|
+
- 文書の配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正本とし、要求・品質・受入の詳細は各ドメインの成果物へ委ねて、索引へ転載しない。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。
|
|
28
29
|
|
|
29
|
-
## 2.
|
|
30
|
+
## 2. 位置づけ
|
|
30
31
|
|
|
31
|
-
|
|
32
|
-
| ------------ | --------------------------- | ---------------------------------------------------------- |
|
|
33
|
-
| 索引宣言 | `dct-index.yaml` | 規模、グループ、ドメイン順、表示名、概要を宣言する |
|
|
34
|
-
| 本文テンプレ | `dct-index-template.md` | Frontmatter 雛形、共通ルール、一覧挿入スロットを保持する |
|
|
35
|
-
| 索引ビュー | `generated/dct-index.md` | 宣言と実在カタログから生成されるプロジェクトの参照起点 |
|
|
36
|
-
| ドメイン正本 | `dct-<domain>.yaml` | ドメインに属する成果物、配置、依存関係、完了条件を定義する |
|
|
37
|
-
| ドメイン表示 | `generated/dct-<domain>.md` | 1 ドメインの成果物定義を読みやすい Markdown として表示する |
|
|
38
|
-
|
|
39
|
-
- `domain` は論理的な管理単位であり、物理ファイル名ではなく各 `dct-*.yaml` の `domain` 値で識別する。
|
|
40
|
-
- 同じ `domain` を持つ物理分割ファイルが複数あっても、索引宣言と索引ビューでは 1 ドメインとして扱う。
|
|
41
|
-
- `group` は索引ビューの分類見出しを表す。ルートのグループは `domains` または子 `groups` のどちらか一方を持つ。
|
|
42
|
-
- `subgroup` はルートグループ直下の表分割を表し、`domains` を持つ。Markdown 見出しを H4 までに収めるため、さらに子 `groups` は持てない。
|
|
43
|
-
- グループとサブグループの順序は、成果物定義の依存順や Schedule の実行順を意味しない。
|
|
32
|
+
- `domain` は論理的な管理単位であり、物理ファイル名ではなく各 `dct-*.yaml` の `domain` 値で識別する。物理分割ファイルが複数あっても、索引では 1 ドメインとして扱う。
|
|
44
33
|
|
|
45
34
|
## 3. ファイル命名・ID規則
|
|
46
35
|
|
|
47
|
-
- 索引宣言はカタログディレクトリ直下の `dct-index.yaml` とする。
|
|
48
|
-
-
|
|
49
|
-
- 索引ビューの文書 ID は `<project-id>:dct-index` とし、宣言の `project_id` と一致させる。
|
|
50
|
-
- ドメイン表示へのリンクは `./dct-<domain>.md` とし、索引ビューと同じ `generated/` ディレクトリ内で解決する。
|
|
51
|
-
- ドメイン識別子は英小文字・数字・ハイフンからなる kebab-case とする。
|
|
36
|
+
- 索引宣言はカタログディレクトリ直下の `dct-index.yaml`、索引ビューは同ディレクトリの `generated/dct-index.md` とする。
|
|
37
|
+
- 両者は `<project-id>:dct-index` を共有する。表示用の別 ID を作らず、既存の参照を維持する。
|
|
52
38
|
|
|
53
|
-
## 4.
|
|
39
|
+
## 4. 本文要件
|
|
54
40
|
|
|
55
|
-
|
|
41
|
+
構造・必須キー・型・列挙値・排他制約は `docs/specdojo/schemas/v1/dct-index.schema.yaml` を正本とし、本章は内容の判断基準を示す。独立 YAML のためメタ情報もトップレベルに置く。コマンドの構文は [[specdojo:command-reference|コマンドリファレンス]] の「catalog / deliverable」を参照する。
|
|
56
42
|
|
|
57
43
|
### 4.1. ルート項目
|
|
58
44
|
|
|
59
|
-
| 項目
|
|
60
|
-
|
|
|
61
|
-
| `id`
|
|
62
|
-
| `type`
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `project_id` | ○ | 対象プロジェクト ID |
|
|
67
|
-
| `size` | ○ | scaffold に用いる `small` / `medium` / `large` |
|
|
68
|
-
| `groups` | ○ | 索引ビューに出すグループの配列。配列順を表示順として使用する |
|
|
69
|
-
|
|
70
|
-
### 4.2. `groups[]`(ルートグループ)
|
|
45
|
+
| 項目 | 必須 | 目的・記述規約 |
|
|
46
|
+
| ------------------------------ | ---- | ------------------------------------------------------------------------------------------------------ |
|
|
47
|
+
| `id` / `project_id` | ○ | 対象プロジェクトを識別し、他プロジェクトの索引との取り違えを防ぐ |
|
|
48
|
+
| `type` / `status` / `rulebook` | ○ | 文書種別・成熟度・適用規約を示す。`status` は `draft` / `ready` / `deprecated` のいずれか |
|
|
49
|
+
| `title` | ○ | 読み手が参照起点と認識できる生成ビューの文書名 |
|
|
50
|
+
| `size` | ○ | 今後の scaffold で選択する成果物セットの規模(`small` / `medium` / `large`)。現在のドメイン数ではない |
|
|
51
|
+
| `groups` | ○ | 管理対象ドメインを、読み手が探す分類と順序でまとめる |
|
|
71
52
|
|
|
72
|
-
|
|
73
|
-
| --------- | ---- | --------------------------------------------------------------- |
|
|
74
|
-
| `name` | ○ | 索引ビューの H3 グループ見出し |
|
|
75
|
-
| `domains` | 選択 | グループ内のドメイン配列。`groups` と同時には指定できない |
|
|
76
|
-
| `groups` | 選択 | H4 で出力するサブグループ配列。`domains` と同時には指定できない |
|
|
53
|
+
### 4.2. グループとサブグループ
|
|
77
54
|
|
|
78
|
-
|
|
55
|
+
- グループはドメインを探すための分類、サブグループはその中の探索単位である。`name` と、`domains` を直接置くか子 `groups` へ分けるかは「グループ分類の決め方」に従う。
|
|
56
|
+
- 配列順は索引ビューとサイドバーの表示順であり、成果物の依存順・Schedule の実行順・優先度を表さない。
|
|
79
57
|
|
|
80
|
-
### 4.3.
|
|
58
|
+
### 4.3. ドメイン項目
|
|
81
59
|
|
|
82
|
-
| 項目
|
|
83
|
-
|
|
|
84
|
-
| `
|
|
85
|
-
| `
|
|
60
|
+
| 項目 | 必須 | 目的・記述規約 |
|
|
61
|
+
| ---------- | ---- | ------------------------------------------------------------------ |
|
|
62
|
+
| `domain` | ○ | 実在する `dct-*.yaml` の `domain` と一致する論理識別子 |
|
|
63
|
+
| `name` | ○ | 利用者向けの日本語表示名。索引ビューの表とサイドバーの表示名に使う |
|
|
64
|
+
| `overview` | ○ | ドメインが管理する成果物の関心領域を示す 1 文の概要 |
|
|
86
65
|
|
|
87
|
-
|
|
66
|
+
### 4.4. 生成ビューの確認要件
|
|
88
67
|
|
|
89
|
-
|
|
68
|
+
- 宣言した分類・順序・表示名・概要が索引ビューへ反映されていること。
|
|
69
|
+
- 各ドメインの表示から、対応するドメイン別カタログへ到達できること。
|
|
70
|
+
- サイドバーでも索引と同じドメイン名・順序で探せること。
|
|
90
71
|
|
|
91
|
-
|
|
92
|
-
| ---------- | ---- | ------------------------------------------------------ |
|
|
93
|
-
| `domain` | ○ | 実在する `dct-*.yaml` の `domain` と一致する論理識別子 |
|
|
94
|
-
| `name` | ○ | 利用者向けの日本語表示名 |
|
|
95
|
-
| `overview` | ○ | ドメインが管理する成果物の関心領域を示す 1 文の概要 |
|
|
72
|
+
## 5. 記述ガイド
|
|
96
73
|
|
|
97
|
-
|
|
74
|
+
### 5.1. メタ情報と規模の決め方
|
|
98
75
|
|
|
99
|
-
|
|
100
|
-
| --- | ------------------ | ---- | ------------------------------------------------- |
|
|
101
|
-
| 1 | 共通ルール | ○ | `dct-index-template.md` |
|
|
102
|
-
| 2 | 成果物カタログ一覧 | ○ | template のスロットへ `groups` ごとの表を生成する |
|
|
76
|
+
`size` ごとの成果物セットは、カタログ template(`docs/ja/specdojo/templates/dct-*-template.yaml`)の章と成果物の `min_size` で決まる。scaffold は `min_size` が `size` 以下(`small` < `medium` < `large`)か未指定のものを取り込む。規模は、`min_size` で増える成果物が要るかで比べて決める。
|
|
103
77
|
|
|
104
|
-
|
|
78
|
+
| 判断 | 良い例 | 悪い例 |
|
|
79
|
+
| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------- |
|
|
80
|
+
| プロジェクト識別 | 対象が prj-0001 なら、その索引 ID と `project_id` を対応させる | 別プロジェクトから複製した ID を残す |
|
|
81
|
+
| 文書名 | `成果物カタログ` のように参照起点を示す | `第3回レビュー用` のように一時的な用途だけを表す |
|
|
82
|
+
| 規模の変更 | 追加で必要な成果物セットを確認し、scaffold 方針の変更として決める | ドメインを 1 件足したことだけを理由に `size` を変更する |
|
|
105
83
|
|
|
106
|
-
|
|
107
|
-
- `groups` を持つルートグループは H3 見出しだけを生成し、各サブグループを `#### 2.<グループ番号>.<サブグループ番号>. <名称>` と表の組で生成する。
|
|
108
|
-
- グループ番号とサブグループ番号は、それぞれの配列順に 1 から採番する。
|
|
84
|
+
### 5.2. グループ分類の決め方
|
|
109
85
|
|
|
110
|
-
|
|
86
|
+
- 分類の正本は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の文書構成図とする。ルートグループはプロジェクト成果物とプロダクト成果物のような文書分類、サブグループは構成図が示す論理的なまとまり(要件〜設計、品質保証、運用など)に対応させる。
|
|
87
|
+
- 成果物リファレンスの章(rulebook 単位)と分類が食い違う場合は、構成ガイドを正とする。
|
|
88
|
+
- 複数の分類に当てはまるように見えるドメインは、構成図で置かれた枠に従い、判断理由を YAML コメントに残す。
|
|
89
|
+
- サブグループは、ルートグループ内のドメインが読み手の探索単位として 2 つ以上に分かれる場合に限る。
|
|
111
90
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
| 概要 | 宣言の `overview` |
|
|
91
|
+
| 判断 | 良い例 | 悪い例 |
|
|
92
|
+
| ------------ | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
93
|
+
| 所属の決定 | 外部I/F仕様を、構成図で置かれている業務仕様群へ 1 か所だけ宣言する | 外部I/F仕様を業務仕様群とアーキテクチャの両方へ宣言する |
|
|
94
|
+
| 階層の選択 | 業務仕様群・品質保証・運用のように探索目的で分ける。単独ドメインでも独立した探索単位なら分ける | 探索目的が同じドメインを件数だけで分割し、見出しを増やす |
|
|
95
|
+
| 分類名の付与 | `品質保証` のように、含まれるドメインの共通の関心を名前にする | `その他`・`追加分` のように、所属理由を示さない名前で受け皿を作る |
|
|
118
96
|
|
|
119
|
-
|
|
97
|
+
### 5.3. ドメインの選定と説明の書き方
|
|
120
98
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
- グループとドメインは、索引を読む人が探索しやすい順序で配列へ並べる。
|
|
124
|
-
- グループ分類の正本は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の文書構成図とする。ルートグループはプロジェクト成果物とプロダクト成果物のような文書分類、サブグループは構成図が示す論理的なまとまり(要件〜設計、品質保証、運用など)に対応させる。
|
|
125
|
-
- 成果物リファレンスは個別成果物を引くための一覧であり、章の粒度は rulebook 単位で索引のグループとは一致しない。分類が食い違う場合は構成ガイドを正として宣言する。
|
|
126
|
-
- ルートグループ内に表を直接置く場合は `domains`、サブグループへ分割する場合は `groups` を使い、両方を同じグループへ記載しない。
|
|
127
|
-
- `name` はドメインの表示名に限定し、状態や担当など変動する情報を含めない。
|
|
99
|
+
- 管理対象を物理ファイル数や今後作る予定の文書から推測しない。
|
|
100
|
+
- `name` はドメインの表示名に限定し、状態・担当・件数など変動する情報や、親ノードの「成果物カタログ」を含めない。
|
|
128
101
|
- `overview` は管理対象の関心領域を 1 文で記述し、個別成果物を列挙しない。
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
|
150
|
-
|
|
|
151
|
-
| `
|
|
152
|
-
|
|
|
153
|
-
|
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
| 実在するドメインを索引宣言から省略する | 管理対象カタログを参照起点から辿れなくなるため |
|
|
158
|
-
| `name` / `overview` に改行または `\|` を含める | Markdown 表の列構造を壊すため |
|
|
159
|
-
| 個別成果物の配置・依存・完了条件を索引宣言へ記載する | ドメイン正本との二重管理になるため |
|
|
102
|
+
|
|
103
|
+
| 項目 | 良い例 | 悪い例 |
|
|
104
|
+
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
105
|
+
| `name` | `データモデル` | `成果物カタログ(データモデル)`、`データモデル(作成中)` |
|
|
106
|
+
| `overview` | `データの概念、論理構造、分類、状態を表す成果物を管理する。` | `概念データモデル、論理データモデル、状態遷移表を管理する。` |
|
|
107
|
+
|
|
108
|
+
### 5.4. 変更時の影響確認
|
|
109
|
+
|
|
110
|
+
- ドメインの追加・削除・改名時は、索引とドメイン正本を同じ変更で整合させ、schema 検証・`catalog validate`・`catalog build` 後の「生成ビューの確認要件」で確かめる。
|
|
111
|
+
|
|
112
|
+
| 判断 | 良い例 | 悪い例 |
|
|
113
|
+
| ---------- | ------------------------------------------------------------------------ | -------------------------------------------------------- |
|
|
114
|
+
| 追加・改名 | ドメイン正本と索引を揃え、参照先へ到達できることまで確認する | 索引の表示名だけ変えて完了とする |
|
|
115
|
+
| 除去 | 同じドメインのカタログが残る間は索引から外さず、参照元の追従対象を決める | 個別成果物を非推奨にしただけでドメイン全体を索引から外す |
|
|
116
|
+
| 完了判断 | 構造・実在カタログとの整合・生成後の表示と到達をそれぞれ確かめる | schema 検証だけで完了とする |
|
|
117
|
+
|
|
118
|
+
## 6. 禁止事項
|
|
119
|
+
|
|
120
|
+
| 禁止事項 | 理由 |
|
|
121
|
+
| ---------------------------------------------------- | -------------------------------------------------- |
|
|
122
|
+
| `generated/dct-index.md` を直接編集する | 次回生成で失われ、正本と差異が生じるため |
|
|
123
|
+
| 表示順や表示名を各 `dct-*.yaml` へ分散して持たせる | ドメイン横断の編集意図が複数ファイルへ分散するため |
|
|
124
|
+
| 同じ `domain` を複数のグループへ宣言する | 索引上の所属と行が重複するため |
|
|
125
|
+
| schema で許可されないキー・値・階層を独自に追加する | 読み込み・検証・生成処理と互換性を保てないため |
|
|
126
|
+
| 実在しないドメインを宣言する | 生成リンクの参照先を作れないため |
|
|
127
|
+
| `domains[]` の要素で `name` を `domain` より前に書く | サイドバーが表示名を解決できなくなるため |
|
|
128
|
+
| 実在するドメインを索引宣言から省略する | 管理対象カタログを参照起点から辿れなくなるため |
|
|
129
|
+
| 個別成果物の配置・依存・完了条件を索引宣言へ記載する | ドメイン正本との二重管理になるため |
|