specdojo 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +142 -35
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +990 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +54 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +33 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +56 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +472 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +163 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +121 -24
- package/templates/antigravity/README.md +35 -0
- package/templates/antigravity/exec-defaults-snippet.yaml +38 -0
- package/templates/antigravity/orchestrator.md +146 -0
- package/templates/antigravity/pm-members-snippet.yaml +55 -0
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/agents/specdojo-orchestrator.md +153 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/codex/agents/specdojo-orchestrator.toml +154 -0
- package/templates/codex/orchestrator.md +146 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +193 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:dct-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
sample: specdojo:dct-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 成果物カタログ(ドメイン別)作成ルール
|
|
11
|
+
|
|
12
|
+
Deliverables Catalog (Domain) Documentation Rulebook
|
|
13
|
+
|
|
14
|
+
本ドキュメントは、ドメイン別成果物カタログ(`dct-<domain>.yaml`)を統一構造で作成・更新するためのルールを定義する。
|
|
15
|
+
各ドメインが管理する成果物の `local_id`・`kind`・`depends_on`・配置先・`done_criteria` を machine-readable な YAML として一覧化し、スケジュール展開・レビュー計画生成・トレーサビリティの基礎とする。
|
|
16
|
+
構造の詳細仕様は `docs/specdojo/schemas/v1/dct.schema.yaml` を SSOT とし、本ルールはその運用方針を補う。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- `dct-<domain>.yaml` は、特定ドメインに属する成果物の machine-readable な台帳として機能する。
|
|
21
|
+
- 個別成果物の本文内容は各成果物ファイルを正とし、カタログはメタ情報(ID・種別・依存・配置先・概要・完了条件)の管理に専念する。
|
|
22
|
+
- 成果物の漏れ・重複・所在不明を防ぐため、プロジェクト内で発生するすべての成果物をいずれかのドメインカタログに記載する。
|
|
23
|
+
- `kind`(`work` / `control` / `generated`)を明示し、スケジュール展開対象(`work`)を他と区別する。
|
|
24
|
+
- 構造・必須キー・型制約は `dct.schema.yaml` に従う。本ルールでスキーマ定義を再掲・上書きしない。
|
|
25
|
+
- `dct-index` の「共通ルール」を SSOT として参照し、重複定義を避ける。
|
|
26
|
+
|
|
27
|
+
## 2. 位置づけと用語定義
|
|
28
|
+
|
|
29
|
+
`dct-<domain>.yaml` と関連ドキュメントの関係を示す。
|
|
30
|
+
|
|
31
|
+
```mermaid
|
|
32
|
+
flowchart LR
|
|
33
|
+
DCT_IDX["dct-index<br>成果物カタログ索引"]
|
|
34
|
+
DCT_DOM["dct-<domain>.yaml<br>ドメイン別成果物カタログ"]
|
|
35
|
+
ART["成果物本体<br><local_id>.md 等"]
|
|
36
|
+
|
|
37
|
+
DCT_IDX --> DCT_DOM --> ART
|
|
38
|
+
|
|
39
|
+
classDef target stroke-width:4px
|
|
40
|
+
class DCT_DOM target
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
| 用語 | 定義 |
|
|
44
|
+
| ----------- | --------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| `group` | カタログ内の章に対応する区分。`deliverables` を持つ葉グループと、子 `groups` を持つ親グループがある |
|
|
46
|
+
| `local_id` | 成果物の論理名。プロジェクト内で一意とし、`depends_on` の参照キーとして使う |
|
|
47
|
+
| `kind` | 成果物の種別。`work` / `control` / `generated` の3値 |
|
|
48
|
+
| `base_path` | グループまたはドメインの配置先ディレクトリ。先頭スラッシュの有無で解決方法が変わる |
|
|
49
|
+
|
|
50
|
+
- `dct-index` の索引エントリから各 `dct-<domain>.yaml` へ参照される。
|
|
51
|
+
- 成果物本体(`<local_id>.md` 等)への参照は、`base_path` と各成果物の `path` から解決する。
|
|
52
|
+
|
|
53
|
+
## 3. ファイル命名・ID規則
|
|
54
|
+
|
|
55
|
+
### 3.1. ファイル命名規約
|
|
56
|
+
|
|
57
|
+
- ファイル名は `dct-<domain>.yaml` とする(例: `dct-project-definition.yaml`、`dct-project-management.yaml`)。
|
|
58
|
+
- `<domain>` は `domain` キーの値と一致させる。
|
|
59
|
+
- 1 ドメインを複数ファイルに物理分割する場合は `dct-<domain>-<part>.yaml` とし、各ファイルの `domain` キーは分割前と同じ `<domain>` を保つ。`<part>` は分割軸を表す kebab-case とし、成果物種別で分割する場合は成果物 ID の接頭辞を用いる(例: `dct-data-model-bdd.yaml`・`dct-data-model-cdsd.yaml` はいずれも `domain: data-model`)。分割の判断基準は `物理分割(1 ドメイン複数ファイル)` を参照する。
|
|
60
|
+
- テンプレートは `dct-<domain>-template.yaml` とし、`type: template` で記述する。
|
|
61
|
+
- テンプレートを物理分割する場合は `dct-<domain>-<part>-template.yaml` とし、各ファイルの `domain` キーは分割前と同じ `<domain>` を保つ(例: `dct-data-model-bdd-template.yaml`・`dct-data-model-cdsd-template.yaml` はいずれも `domain: data-model`)。scaffold で `dct-<domain>-<part>.yaml` に展開され、`catalog build` で同一 `domain` としてマージされる。
|
|
62
|
+
|
|
63
|
+
### 3.2. ID・識別子規約
|
|
64
|
+
|
|
65
|
+
- ドキュメントの `id` は、`type: project` では `<project-id>:dct-<domain>` 形式とする(例: `prj-0001:dct-project-definition`)。テンプレートでは `dct-<domain>-template` 形式とする。物理分割する場合は、`type: project` では `<project-id>:dct-<domain>-<part>`、テンプレートでは `dct-<domain>-<part>-template` 形式とし、`domain` キーは分割前と同じ `<domain>` を保つ(例: `prj-0001:dct-data-model-bdd`、`specdojo:dct-data-model-bdd-template`)。
|
|
66
|
+
- `domain` は英小文字・数字・ハイフン(kebab-case)で、先頭は英小文字または数字、最大 63 文字とする。
|
|
67
|
+
- `project_id` は `prj-` + 4 桁以上の数字とし、`type: project` では必須とする。配置先プロジェクト ID と一致させる。
|
|
68
|
+
- 各成果物の `local_id` は、`type: project` では英小文字・数字・ハイフンのみとし、プロジェクト内で一意にする。
|
|
69
|
+
- 反復作成する成果物は、成果物ファミリーを表す固定 `local_id` と、実体IDの命名規則を表す `instance_id_pattern` を分離する。
|
|
70
|
+
|
|
71
|
+
## 4. 推奨メタ項目
|
|
72
|
+
|
|
73
|
+
YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭のトップレベルキーとして記載する。
|
|
74
|
+
|
|
75
|
+
| キー | 説明 | 必須 |
|
|
76
|
+
| ------------ | -------------------------------------------------------------------- | -------------- |
|
|
77
|
+
| `id` | 成果物 ID(例: `prj-0001:dct-project-definition`) | ○ |
|
|
78
|
+
| `type` | `project` / `template` のいずれか | ○ |
|
|
79
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
80
|
+
| `title` | ドキュメント名。表示ページの見出しになる | ○ |
|
|
81
|
+
| `rulebook` | 参照する rulebook ID(`specdojo:dct-rulebook`) | ○ |
|
|
82
|
+
| `part_of` | 親となる `dct-index` の `id`(配列形式) | 任意 |
|
|
83
|
+
| `project_id` | プロジェクト ID(例: `prj-0001`) | ○(`project`) |
|
|
84
|
+
| `domain` | ドメイン識別子。ファイル名 `dct-<domain>.yaml` と一致させる | ○ |
|
|
85
|
+
| `base_path` | ドメインの既定ディレクトリ。リポジトリルートからの絶対パスで記載する | 任意 |
|
|
86
|
+
|
|
87
|
+
## 5. 本文構成(標準テンプレ)
|
|
88
|
+
|
|
89
|
+
### 5.1. ルート構造
|
|
90
|
+
|
|
91
|
+
`dct-<domain>.yaml` は次のルート構造を標準とする。
|
|
92
|
+
|
|
93
|
+
| キー | 必須 | 内容 |
|
|
94
|
+
| ---------- | ---- | --------------------------- |
|
|
95
|
+
| `id` | ○ | 成果物 ID |
|
|
96
|
+
| `type` | ○ | `project` / `template` |
|
|
97
|
+
| `status` | ○ | 状態 |
|
|
98
|
+
| `title` | ○ | ドキュメント名 |
|
|
99
|
+
| `rulebook` | ○ | 参照する rulebook ID |
|
|
100
|
+
| `part_of` | 任意 | 親 `dct-index` の `id` 配列 |
|
|
101
|
+
|
|
102
|
+
| `project_id` | ○(`project`) | プロジェクト ID |
|
|
103
|
+
|
|
104
|
+
| `domain` | ○ | ドメイン識別子 |
|
|
105
|
+
| `base_path` | 任意 | ドメインの既定ディレクトリ |
|
|
106
|
+
| `groups` | ○ | グループ(章)の配列 |
|
|
107
|
+
|
|
108
|
+
### 5.2. `groups[]`(グループ)
|
|
109
|
+
|
|
110
|
+
各グループは Markdown カタログの章に対応する。葉グループは `deliverables` を、親グループは子 `groups` を持つ(どちらか一方が必須)。
|
|
111
|
+
|
|
112
|
+
| フィールド | 必須 | 内容 |
|
|
113
|
+
| -------------- | ---- | ------------------------------------------------- |
|
|
114
|
+
| `name` | 任意 | 章タイトル(例: `管理計画`、`組織体制`) |
|
|
115
|
+
| `base_path` | 任意 | グループの配置先ディレクトリ |
|
|
116
|
+
| `note` | 任意 | グループへの補足(例: `WBSへの落とし込み対象外`) |
|
|
117
|
+
| `groups` | 任意 | 子グループの配列(入れ子。親グループで使用) |
|
|
118
|
+
| `deliverables` | 任意 | 成果物エントリの配列(葉グループで使用) |
|
|
119
|
+
|
|
120
|
+
### 5.3. `deliverables[]`(成果物エントリ)
|
|
121
|
+
|
|
122
|
+
| フィールド | 必須 | 内容 |
|
|
123
|
+
| --------------------- | ---- | ----------------------------------------------------- |
|
|
124
|
+
| `local_id` | ○ | 成果物の論理名(例: `prj-overview`) |
|
|
125
|
+
| `instance_id_pattern` | 任意 | 反復成果物の実体ID規則(例: `pjr-{sequence}-{term}`) |
|
|
126
|
+
| `name` | ○ | 業務ユーザーが理解可能な日本語名 |
|
|
127
|
+
| `kind` | ○ | `work` / `control` / `generated` |
|
|
128
|
+
|
|
129
|
+
| `depends_on` | 任意 | 依存する成果物の `local_id` 配列。なければ空配列 `[]` |
|
|
130
|
+
| `overview` | ○ | 成果物の目的を1文で記述 |
|
|
131
|
+
| `path` | ○(`work`) | 成果物のファイルパス |
|
|
132
|
+
| `rulebook` | 任意 | rulebook の文書 ID、未判断なら `undecided`、不要なら `not-needed` |
|
|
133
|
+
| `evidence_refs` | 任意 | `retrofit` で読む非成果物エビデンス |
|
|
134
|
+
| `done_criteria` | ○(`work`) | 完了条件の配列 |
|
|
135
|
+
| `note` | 任意 | 構造化フィールドで表せない補足 |
|
|
136
|
+
|
|
137
|
+
### 5.4. `evidence_refs[]`(非成果物エビデンス)
|
|
138
|
+
|
|
139
|
+
| フィールド | 必須 | 内容 |
|
|
140
|
+
| ---------- | ---- | ---------------------------------------------------------- |
|
|
141
|
+
| `kind` | ○ | エビデンス種別。現在は `implementation` のみ |
|
|
142
|
+
| `path` | ○ | リポジトリルート相対のファイルまたは限定されたディレクトリ |
|
|
143
|
+
| `purpose` | ○ | この参照から確認する現在動作・制約 |
|
|
144
|
+
|
|
145
|
+
### 5.5. `done_criteria[]`(完了条件)
|
|
146
|
+
|
|
147
|
+
| フィールド | 必須 | 内容 |
|
|
148
|
+
| ----------- | ---- | ------------------------------------------------------------------------------------------ |
|
|
149
|
+
| `text` | ○ | 成果物が満たすべき検証可能な条件 |
|
|
150
|
+
| `roles` | ○ | 条件を確認するロールコード配列(`PO` / `PM` / `BA` / `ARC` / `DEV` / `QE` / `UX` / `OPS`) |
|
|
151
|
+
| `viewpoint` | ○ | 主たるレビュー観点 ID(`vp-*`。`pm-review-viewpoints.yaml` で定義) |
|
|
152
|
+
|
|
153
|
+
## 6. 記述ガイド
|
|
154
|
+
|
|
155
|
+
### 6.1. グループ構成
|
|
156
|
+
|
|
157
|
+
- サブドメインに分かれない場合は、単一の葉グループに `deliverables` を並べる(平坦型)。
|
|
158
|
+
- サブドメインが2つ以上に分かれる場合は、親グループの `groups` 配下に子グループを並べ、各子グループに `name`・`base_path`・`deliverables` を記載する(章分割型)。
|
|
159
|
+
- 親グループは `deliverables` を直接持たず、子 `groups` で表現する。
|
|
160
|
+
|
|
161
|
+
### 6.2. `kind`(種別)
|
|
162
|
+
|
|
163
|
+
- `work`: スケジュール展開対象。成果物を実際に作成する作業に対応する。`path` と `done_criteria` が必須。
|
|
164
|
+
- `control`: プロジェクト管理・統制文書。スケジュール展開対象外。
|
|
165
|
+
- `generated`: 自動生成・派生成果物。スケジュール展開対象外。
|
|
166
|
+
- 3値以外に拡張しない。
|
|
167
|
+
- `generated` には実践の型を適用しない。`rulebook` が記載されていても、実行時は `kind` から非適用を導出する。
|
|
168
|
+
|
|
169
|
+
計画成果物をカタログへ登録する場合も、生成方法ではなくライフサイクルで区別する。
|
|
170
|
+
|
|
171
|
+
- 人または agent が判断して更新する `tml-index`、`dct-index`、`dct-plan-<domain>`、`sch-strategy-<track>`、`sch-defaults` は `work` とする。
|
|
172
|
+
- `sch-track-<track>` と `sch-milestones` は strategy から再生成できるため `generated` とし、対応する `sch-strategy-<track>` を `depends_on` に宣言する。
|
|
173
|
+
|
|
174
|
+
- 計画成果物を所有するトラック自身の `sch-strategy` は、自己生成の循環を避けるため `control` とするか、そのトラックの scope 外へ置く。
|
|
175
|
+
- `dct-<domain>.yaml` 自身と `generated/` 配下の表示用生成物は、カタログ定義との二重管理を避けるため登録しない。
|
|
176
|
+
- トラック別の strategy、track は、Timeline で当該トラックが `catalog_status: primary` になった時点で具体的な `local_id` を追加し、未着手トラックの分を先行登録しない。
|
|
177
|
+
|
|
178
|
+
### 6.3. `depends_on`
|
|
179
|
+
|
|
180
|
+
- 直接依存する成果物の `local_id` を配列で記載する。依存がない場合は空配列 `[]` とする。
|
|
181
|
+
- 参照先は同一カタログまたは他ドメインカタログに存在する `local_id` とし、ファイルパスや URL を混在させない。
|
|
182
|
+
- 反復成果物を参照する場合は、`instance_id_pattern` ではなく固定の `local_id` を参照する。
|
|
183
|
+
|
|
184
|
+
### 6.4. 実践の型の要否宣言
|
|
185
|
+
|
|
186
|
+
- 成果物カタログは成果物と rulebook の対応だけを `rulebook` に宣言する。recipe / sample / template の要否と所在は、参照先 rulebook の frontmatter を正本とする。
|
|
187
|
+
|
|
188
|
+
- `rulebook` には、必要と判断して実在する rulebook の完全 ID を記載する。要否未判断は `undecided`、不要は `not-needed`、項目省略は必要だが未整備を表す。`catalog validate` は完全 ID に対応する文書の実在を検証する。
|
|
189
|
+
- `rulebook: none` は成果物本体のメタ情報で「準拠 rulebook なし」を表す値であり、カタログの要否宣言には使わない。カタログで不要と判断した場合は `rulebook: not-needed` を使う。
|
|
190
|
+
- `kind: generated` では `rulebook` 宣言の有無にかかわらず4種すべてを適用しない。成果物ごとの型宣言を追加せず、`kind` から導出する。
|
|
191
|
+
- recipe / sample / template の `undecided` は利用可能性判定で未整備として扱い、`not-needed` は欠落とみなさず対応する `*-maintenance` の対象にも含めない。要否を再検討する場合は、先に rulebook frontmatter の宣言を更新する。
|
|
192
|
+
|
|
193
|
+
### 6.5. `evidence_refs`
|
|
194
|
+
|
|
195
|
+
- `evidence_refs` は成果物ごとの安定した調査入力であり、`approach: retrofit` の edit / review plan に「実装エビデンス」として展開される。
|
|
196
|
+
- `depends_on` のような成果物間の根拠・実行順序を作らず、`based_on` のような文書 ID 参照にも使わない。
|
|
197
|
+
- `path` は先頭スラッシュなしのリポジトリルート相対パスとし、絶対パス、`..`、`.`、バックスラッシュ、重複区切りを含めない。宣言先の存在と同一成果物内の重複を `catalog validate` で検証する。
|
|
198
|
+
- `path` はコマンドの入口(例: `src/<command>.ts`)または責務単位のディレクトリを調査の起点として指定し、入口から到達する内部実装は import などをたどって確認する。rename・分割されやすい内部ヘルパーファイルを直接指定すると refactor のたびに参照が陳腐化するため、指定しない。
|
|
199
|
+
- ディレクトリを指定する場合は責務単位に限定し、`src`、`tools`、`docs`、リポジトリルートのような過度に広い範囲を指定しない。
|
|
200
|
+
- `purpose` はファイル名の言い換えではなく、入出力、状態遷移、例外など、その参照から何を確認するかを記載する。
|
|
201
|
+
- 実装エビデンスは読み取り専用であり、plan frontmatter の `targets`、worktree の変更許可範囲、commit 許可リストへ追加しない。
|
|
202
|
+
|
|
203
|
+
### 6.6. `base_path` と `path` の解決
|
|
204
|
+
|
|
205
|
+
- 先頭が `/` のパスはリポジトリルートからの絶対パスとして解決する。
|
|
206
|
+
- 先頭が `/` でないパスは相対パスとし、最も近い祖先(グループまたはドメイン)の解決済み `base_path` に連結する。
|
|
207
|
+
- ドメインの `base_path` は絶対パス(先頭 `/`)で記載することを推奨する。
|
|
208
|
+
- 解決結果はリポジトリルートからの相対パスを正準形とし、先頭スラッシュなし・POSIX 区切り(`/`)で正規化する。`base_path` 先頭の `/` はルートを起点とする記法上の目印であり、生成される dct ビュー・exec plan・doc-index など下流の参照表記には残さない。
|
|
209
|
+
|
|
210
|
+
### 6.7. `done_criteria`
|
|
211
|
+
|
|
212
|
+
- `work` 成果物には最低 1 件の完了条件を記載する。
|
|
213
|
+
- `text` は「確認できること」「識別できること」など、検証可能な形で記述する。
|
|
214
|
+
- `roles` には条件を確認する責務を持つロールコードのみを記載する。
|
|
215
|
+
- `viewpoint` には `pm-review-viewpoints.yaml` で定義された `vp-*` の ID を 1 つ記載する。
|
|
216
|
+
|
|
217
|
+
### 6.8. 反復成果物
|
|
218
|
+
|
|
219
|
+
- 反復成果物の `local_id` には成果物ファミリーを表す固定の kebab-case を使用する。
|
|
220
|
+
- 実体IDの命名規則は `instance_id_pattern` に分離する(例: `pjr-{sequence}-{term}`、`pr-{yyyy}-{mm}-{dd}`)。
|
|
221
|
+
- プレースホルダは小文字を波括弧で囲んで記述し、固定語はハイフンで連結する。
|
|
222
|
+
|
|
223
|
+
### 6.9. テンプレート固有項目
|
|
224
|
+
|
|
225
|
+
- `type: template` のファイルでのみ `min_size`(`small` / `medium` / `large`)を使用できる。
|
|
226
|
+
|
|
227
|
+
- `min_size` は規模に応じた取捨選択のための項目であり、scaffold 時に除去される。
|
|
228
|
+
- テンプレートでは `local_id` や `part_of` にアンダースコアで囲んだプレースホルダ(例: `_PROJECT_ID_:dct-index`)を使用できる。
|
|
229
|
+
|
|
230
|
+
### 6.10. 業務領域テンプレートの反復方針(`_TERM_` の使い分け)
|
|
231
|
+
|
|
232
|
+
- `local_id` に `_TERM_` を含むテンプレート項目(例: `cdfd-_TERM_`、`bdd-_TERM_`)は、パターンA(複数業務領域)を既定とする。業務領域が複数ある場合(例: 販売/調達/会計)に、業務領域ごとへ項目を複製し、`_TERM_` を各業務領域の略称へ置き換える。
|
|
233
|
+
- 対象業務が単一で、成果物を業務の局面・処理内容ごとに複数項目へ分割する場合はパターンB(単一領域・複数項目)を用いる。このときは `_TERM_` を使わず、項目ごとに固定の `local_id` と `done_criteria` を個別に記載する。
|
|
234
|
+
- どちらのパターンでも `groups[]` と `deliverables[]` の項目数に上限はない。テンプレートの1件は書式サンプルであり、実際に必要な数だけ記載する。
|
|
235
|
+
- パターンBの実例は `prj-0001:dct-data-flow`(`domain: data-flow`。単一業務(SpecDojo運用)を、初期化・課題整理・タスク実行・例外対応・定期実行など複数のデータフロー(`cdfd`)に分割している)を参照する。
|
|
236
|
+
|
|
237
|
+
### 6.11. 物理分割(1 ドメイン複数ファイル)
|
|
238
|
+
|
|
239
|
+
- 反復要素が多く単一ファイルが肥大化するドメイン(例: `data-model` を成果物種別ごとに分ける場合)は、論理ドメインを保ったまま複数ファイルへ物理分割してよい。
|
|
240
|
+
- 分割ファイルは `dct-<domain>-<part>.yaml` とし、すべて同一の `domain` キーを持たせる。`catalog build` は同一 `domain` のファイルをファイル名の昇順でマージし、`dct-<domain>.md` を 1 つ生成する。
|
|
241
|
+
- 同一階層にある名前付き group は `name` の完全一致をキーに1章へ結合する。章の位置と `base_path`・`note`・`min_size` は最初に現れた group の値を採用し、`deliverables` はファイル名昇順、各ファイル内の定義順で追記する。同名の子 `groups` にもこの規則を再帰的に適用する。
|
|
242
|
+
- group の `base_path` 等は同名 group 間で一致させる。後続 group の成果物と子 group は、結合先となる最初の group の `base_path` を継承する。
|
|
243
|
+
- 名前が異なる group は別章として保持する。無名 group は結合キーを持たないため、従来どおりファイル名昇順で見出しなしの内容として連結する。単一ファイル内の group 構造は変更しない。
|
|
244
|
+
- マージ順序はファイル名の昇順で決定的に定まる。最初に現れる章の並びを制御したい場合は `<part>` の命名で順序を表現する。
|
|
245
|
+
- 同一 `domain` の各ファイルは `project_id` と `base_path` を一致させる。`base_path` はマージ後の配置先解決の起点となるため、部分ファイルごとに変えない。
|
|
246
|
+
- `local_id` はプロジェクト内で一意という制約を維持する。同一ドメインの分割ファイル間で `local_id` が重複するとマージがエラーになる。
|
|
247
|
+
- ドキュメントの `id`・`title` 等のメタ情報は、マージ後カタログではファイル名昇順で先頭となるファイルの値を採用する。分割してもメタ情報が一貫するよう記載する。
|
|
248
|
+
|
|
249
|
+
### 6.12. 成果物カタログ判定計画(`dct-plan-<domain>.yaml`)
|
|
250
|
+
|
|
251
|
+
- data-flow 等の上流成果物からどの成果物インスタンスが必要かを agent が判定した結果は、`dct-plan-<domain>.yaml` へ機械可読な形で保存する。構造の SSOT は `docs/specdojo/schemas/v1/dct-plan.schema.yaml` とする。
|
|
252
|
+
- 配置先は成果物カタログディレクトリ配下の `plans/` とする(例: `docs/ja/projects/prj-0001/010-deliverables-catalog/plans/dct-plan-data-flow.yaml`)。`dct-*.yaml` と同じ階層に置かない。`catalog validate` / `catalog build` の対象と混同させないためである。
|
|
253
|
+
- 判定計画はバージョン管理対象の正本であり、`generated/` 配下の派生ビューとは区別する。
|
|
254
|
+
- 判定計画に書くのは、必要な成果物インスタンス・placeholder 値・採用しない候補・未確定事項・判定根拠・確度に限る。`groups`・`base_path`・`done_criteria` などのカタログ構造はテンプレートとジェネレーターの責務であり、判定計画へ複製しない。
|
|
255
|
+
- `iteration_pattern` は `業務領域テンプレートの反復方針(_TERM_ の使い分け)` のパターンAを `pattern-a`、パターンBを `pattern-b` として記載する。`pattern-a` では placeholder ごとに値と根拠を `variables` へ書き、`local_id` は展開結果と一致させる。`pattern-b` では `variables` を使わず、処理単位ごとの固定 `local_id` を記載する。
|
|
256
|
+
- 上流成果物から根拠を得られない placeholder・成果物の要否・名称・依存関係は確定させず、`open_questions` に理由と次のアクションを残す。根拠のない項目を推測で確定しない。
|
|
257
|
+
- 入力は Timeline が示す着手対象ドメインの上流成果物とし、少なくとも 1 件の data-flow 成果物を根拠にする。data-flow が存在しないドメインでは明示的に入力文書を指定する。data-flow が複数あるドメインでは、対象ドメインに関係するものをすべて入力に含める。
|
|
258
|
+
- 既に `dct-<domain>.yaml` があるドメインでは、既存カタログを基準線として入力に含め、既存 `local_id` を落とす場合は `exclusions` に理由を残す。
|
|
259
|
+
- 既存の判定計画は無条件に上書きしない。再判定時は差分をレビューし、上書きは明示的な `--force` 操作で行う。
|
|
260
|
+
- 判定計画の存在はカタログの `primary` 確定を意味しない。判定計画は draft 作成支援であり、`catalog_status` の更新は人間の確認を経て行う。
|
|
261
|
+
|
|
262
|
+
### 6.13. 判定計画からの決定論的生成
|
|
263
|
+
|
|
264
|
+
- 保存済みの判定計画からカタログを生成する場合は、`catalog scaffold --plan --domain <domain>` を使用する。`--var` は併用せず、placeholder 値は根拠付きの `variables` を正本とする。
|
|
265
|
+
- ジェネレーターは template の `min_size`、placeholder 展開、`part_of`、`domain`、`base_path`、group 構造を scaffold と共通の処理で適用する。物理分割された template は、同じ `domain` を持つ全ファイルをファイル名順に処理し、対応する `dct-<domain>-<part>.yaml` を生成する。
|
|
266
|
+
- blocking な `open_questions`、未解決 placeholder、重複 `local_id`、存在しない `depends_on`、schema 違反が一件でもあれば、その domain のファイルを一件も書き込まない。
|
|
267
|
+
- 既存カタログとの差分は `--dry-run` で確認する。既存ファイルは既定で保護し、内容が異なる場合の上書きには `--force` を必要とする。同一入力の再実行で内容が同じ場合は書き込まない。
|
|
268
|
+
- 生成されたカタログの `status` は template に従い `draft` のままとする。生成成功を理由に Timeline の `catalog_status` を `primary` へ変更せず、人間の内容確認後に別途更新する。
|
|
269
|
+
|
|
270
|
+
## 7. 禁止事項
|
|
271
|
+
|
|
272
|
+
| 禁止事項 | 理由 |
|
|
273
|
+
| ----------------------------------------------------------------- | -------------------------------------------------------- |
|
|
274
|
+
| `local_id` に日本語・空白・大文字を使用する(`project` の場合) | スキーマの kebab-case 制約に反するため |
|
|
275
|
+
| 成果物の詳細本文(仕様・手順・構成図など)をカタログに記載する | 詳細は成果物本体に集約するため |
|
|
276
|
+
| `kind` を `work` / `control` / `generated` 以外に拡張する | スケジュール展開・レビュー生成の前提が崩れるため |
|
|
277
|
+
| 同一 `local_id` を複数ドメインのカタログに重複して記載する | トレーサビリティとスケジュール展開が破綻するため |
|
|
278
|
+
| `depends_on` に `local_id` 以外(ファイルパス・URL)を混在させる | 依存解決が機械的に行えなくなるため |
|
|
279
|
+
| `evidence_refs.path` に絶対パス・親参照・存在しないパスを記載する | 再現可能で安全な調査範囲を確定できないため |
|
|
280
|
+
| `evidence_refs.path` にリポジトリ全体など広すぎる範囲を指定する | 調査範囲と判断根拠を限定できないため |
|
|
281
|
+
| `evidence_refs.path` に入口から到達できる内部ヘルパーを指定する | refactor 時の rename・分割で参照が陳腐化しやすいため |
|
|
282
|
+
| `work` 成果物で `path` または `done_criteria` を省略する | スケジュール展開とレビュー計画生成に必須のため |
|
|
283
|
+
| 実在しない実践の型 ID、またはカタログで `rulebook: none` を使う | 未判断・未整備・不要・参照切れを機械的に区別できないため |
|
|
284
|
+
| `dct-plan-<domain>.yaml` にカタログ構造や自由文の判断メモを書く | ジェネレーターが機械的に扱えず責務境界が崩れるため |
|
|
285
|
+
| 根拠のない placeholder 値や成果物を判定計画で確定させる | 推測がそのままカタログへ流れ込むため |
|
|
286
|
+
| 判定計画がある domain を `--var` 付きの通常 scaffold で再生成する | 根拠付きの判定結果と生成入力が分岐するため |
|
|
287
|
+
| 本ルールや成果物ファイルでスキーマ定義を再掲・上書きする | `dct.schema.yaml` を SSOT とするため |
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:dec-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
sample: specdojo:dec-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 決定記録 作成ルール
|
|
11
|
+
|
|
12
|
+
Decision Log Documentation Rulebook
|
|
13
|
+
|
|
14
|
+
本ドキュメントは、決定記録(`dec-<NNNN>-<topic>`)を統一形式で記述するためのルールを定義する。
|
|
15
|
+
|
|
16
|
+
## 1. 全体方針
|
|
17
|
+
|
|
18
|
+
- 重要な判断の背景、選択肢、採択理由を追跡可能に残す。
|
|
19
|
+
- 決定後の影響範囲とフォローアップを明示する。
|
|
20
|
+
- 結論だけでなく判断根拠を残す。
|
|
21
|
+
|
|
22
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
23
|
+
|
|
24
|
+
- 決定記録はプロジェクト運営・設計判断の証跡である。
|
|
25
|
+
- 課題ログ、変更要求ログと相互参照する。
|
|
26
|
+
|
|
27
|
+
## 3. ファイル命名・ID規則
|
|
28
|
+
|
|
29
|
+
- 推奨: `dec-<NNNN>-<topic>.md`
|
|
30
|
+
- 連番は4桁ゼロ埋めとする(例: `dec-0001-auth`)。
|
|
31
|
+
|
|
32
|
+
## 4. 推奨 Frontmatter 項目
|
|
33
|
+
|
|
34
|
+
| 項目 | 説明 | 必須 |
|
|
35
|
+
| ---- | ---- | ---- |
|
|
36
|
+
|
|
37
|
+
| id | `dec-<NNNN>-<topic>` | ○ |
|
|
38
|
+
| type | `project` | ○ |
|
|
39
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
40
|
+
|
|
41
|
+
## 5. 本文構成(標準テンプレ)
|
|
42
|
+
|
|
43
|
+
| 番号 | 見出し | 必須 |
|
|
44
|
+
| ---- | -------------- | ---- |
|
|
45
|
+
| 1 | 背景 | ○ |
|
|
46
|
+
| 2 | 検討した選択肢 | ○ |
|
|
47
|
+
| 3 | 決定内容 | ○ |
|
|
48
|
+
| 4 | 採択理由 | ○ |
|
|
49
|
+
| 5 | 影響範囲 | ○ |
|
|
50
|
+
|
|
51
|
+
## 6. 記述ガイド
|
|
52
|
+
|
|
53
|
+
- 選択肢は少なくとも2案以上を記載する。
|
|
54
|
+
|
|
55
|
+
- 採択理由は判断軸とともに記載する。
|
|
56
|
+
- 影響範囲は仕様・実装・運用の観点で示す。
|
|
57
|
+
|
|
58
|
+
## 7. 禁止事項
|
|
59
|
+
|
|
60
|
+
- 根拠なしで結論のみを記載しない。
|
|
61
|
+
- 実装断片の貼り付けで説明を代替しない。
|
|
62
|
+
- 影響範囲未記載のまま確定しない。
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:dmd-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:dmd-index-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# データ移行設計 作成ルール
|
|
12
|
+
|
|
13
|
+
Data Migration Design Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、`dmd-index`(データ移行設計の入口・共通SSOT)を一貫した粒度で作成するためのルールを定義する。
|
|
16
|
+
|
|
17
|
+
## 1. 全体方針
|
|
18
|
+
|
|
19
|
+
- `dmd-index` はデータ移行設計の入口(共通SSOT)として、抽出/変換/除外/冪等性/検証の共通方針を定義する。
|
|
20
|
+
- 個別データ領域の詳細は `dmd-<term>` に委譲し、`dmd-index` では共通判断軸と導線を定義する。
|
|
21
|
+
- 曖昧表現を避け、再実行条件と合否判定が可能な記述にする。
|
|
22
|
+
|
|
23
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
24
|
+
|
|
25
|
+
- `mip-index`: 移行計画・成功条件・停止許容時間の合意
|
|
26
|
+
- `dmd-index`: データ移行の共通設計(本書)
|
|
27
|
+
- `dmd-<term>`: 対象別の詳細設計(抽出条件/マッピング/手順/検証)
|
|
28
|
+
- `mtp-index` / `mtp-<term>`: リハーサル計画と証跡設計
|
|
29
|
+
- `cop-index` / `cop-<term>`: 当日実行の詳細手順(Runbook)
|
|
30
|
+
|
|
31
|
+
## 3. ファイル命名・ID規則
|
|
32
|
+
|
|
33
|
+
- `id` は `dmd-index` を使用する。
|
|
34
|
+
- ファイル名は `dmd-index-データ移行設計.md` など、プロジェクト内で一意になるように命名する。
|
|
35
|
+
|
|
36
|
+
## 4. 推奨 Frontmatter 項目
|
|
37
|
+
|
|
38
|
+
| 項目 | 説明 | 必須 |
|
|
39
|
+
| ----- | ---------------------- | ---- |
|
|
40
|
+
| id | `dmd-index` | ○ |
|
|
41
|
+
| type | `migration` 固定 | ○ |
|
|
42
|
+
| title | `データ移行設計: 全体` | ○ |
|
|
43
|
+
|
|
44
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
45
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
46
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
47
|
+
|
|
48
|
+
## 5. 本文構成(標準テンプレ)
|
|
49
|
+
|
|
50
|
+
| 番号 | 見出し | 必須 |
|
|
51
|
+
|
|
52
|
+
| ---- | ------------------------------------------------- | ---- |
|
|
53
|
+
| 1 | 概要(index) | ○ |
|
|
54
|
+
| 2 | 共通方針(抽出/変換/除外/冪等性/ログ) | ○ |
|
|
55
|
+
| 3 | run_id 規約(命名/採番/記録/参照方法) | ○ |
|
|
56
|
+
| 4 | 検証の共通方針(種別/基準/証跡/保管) | ○ |
|
|
57
|
+
| 5 | 対象一覧(スコープ/非対象/担当/対応ドキュメント) | ○ |
|
|
58
|
+
| 6 | 関連ドキュメント(必須) | ○ |
|
|
59
|
+
|
|
60
|
+
## 6. 記述ガイド
|
|
61
|
+
|
|
62
|
+
### 6.1. 概要(index)
|
|
63
|
+
|
|
64
|
+
- データ移行設計の目的(再現性・品質担保)と範囲を 1〜3 行で示す。
|
|
65
|
+
- 本書が入口(SSOT)であり、詳細は `dmd-<term>` にあることを明記する。
|
|
66
|
+
|
|
67
|
+
### 6.2. 共通方針(抽出/変換/除外/冪等性/ログ)
|
|
68
|
+
|
|
69
|
+
- 抽出(フル/増分)の採用方針と増分基準を定義する。
|
|
70
|
+
- 変換/除外の原則(再実行で同一結果)と根拠リンクの方針を定義する。
|
|
71
|
+
- 冪等性とログ要件(最低限残す項目)を定義する。
|
|
72
|
+
|
|
73
|
+
### 6.3. run_id 規約(命名/採番/記録/参照方法)
|
|
74
|
+
|
|
75
|
+
- 命名規則(例: `DMD-YYYYMMDD-<term>-NN`)と採番方法を定義する。
|
|
76
|
+
|
|
77
|
+
- run_id をログ/投入データ/照合レポートに紐づける。
|
|
78
|
+
|
|
79
|
+
### 6.4. 検証の共通方針(種別/基準/証跡/保管)
|
|
80
|
+
|
|
81
|
+
- 最低限の検証種別(件数/サンプル/重要値)を定義する。
|
|
82
|
+
- 合格基準(差分0 / 許容差ε)の記述方法を定義する。
|
|
83
|
+
- 証跡の保管場所と命名規約を定義する。
|
|
84
|
+
|
|
85
|
+
### 6.5. 対象一覧(スコープ/非対象/担当/対応ドキュメント)
|
|
86
|
+
|
|
87
|
+
- 対象/非対象/担当/対応 `dmd-<term>` を一覧化する。
|
|
88
|
+
- `mip-index` の移行対象と整合し、導線を明記する。
|
|
89
|
+
|
|
90
|
+
### 6.6. 関連ドキュメント(必須)
|
|
91
|
+
|
|
92
|
+
- 各 `dmd-<term>` への導線を必ず記載する。
|
|
93
|
+
- 分冊が無い場合でも `(本書のみ)` を明記する。
|
|
94
|
+
|
|
95
|
+
## 7. 禁止事項
|
|
96
|
+
|
|
97
|
+
- `dmd-<term>` に記載すべき個別の変換仕様や実行手順を `dmd-index` に重複記載しない。
|
|
98
|
+
- 対象一覧に対象/非対象や対応DMDの導線を欠落させない。
|
|
99
|
+
- run_id 規約や検証共通方針を未定義のままにしない。
|
|
100
|
+
- 実装依存の長大なSQLやコードを本文に記載しない。
|