specdojo 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +82 -38
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +980 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +45 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +15 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +55 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +120 -24
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:sysd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
template: not-needed
|
|
8
|
+
based_on:
|
|
9
|
+
- specdojo:rulebook-authoring-standard
|
|
10
|
+
- specdojo:tsd-rulebook
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# 個別システム設計(SYSD)作成ルール
|
|
14
|
+
|
|
15
|
+
System Design Topic Documentation Rulebook
|
|
16
|
+
|
|
17
|
+
`sysd-<term>.md` を、システム設計の個別トピックまたは複数の子設計を束ねる hub として記述するためのルールです。`sysd-index` が設計 SSOT 全体への入口であるのに対し、本 rulebook は一つの設計関心事に絞った構造、責務、制約、検証観点を定義します。
|
|
18
|
+
|
|
19
|
+
## 1. 全体方針
|
|
20
|
+
|
|
21
|
+
- 一つの `sysd-<term>` は、一つの設計関心事、または同じ関心事に属する子設計群への導線だけを扱います。
|
|
22
|
+
- 設計判断、責務境界、構成、主要フロー、制約、検証観点を記述し、実装コードや設定ファイルの全文は一次情報への参照に留めます。
|
|
23
|
+
- 複数 provider や実装方式を同じ共通設計の下で管理する場合は、親を薄い hub、方式別の詳細を子 `sysd-<term>` として分冊できます。
|
|
24
|
+
- 複数トピックへ適用する必須・禁止ルールは `sysd-cross-cutting-policy`、事故予防に必要な難所フローは `sysd-critical-flows` を SSOT とします。
|
|
25
|
+
- 運用判断は `opd-*`、再現可能な操作手順は `opr-*` に委ね、個別システム設計へ混在させません。
|
|
26
|
+
|
|
27
|
+
## 2. 位置づけと用語定義
|
|
28
|
+
|
|
29
|
+
| ドキュメント | 役割 | 記載しないもの |
|
|
30
|
+
| --------------------------- | ------------------------------------ | ---------------------- |
|
|
31
|
+
| `sysd-index` | システム設計 SSOT の全体入口 | 個別設計の本文 |
|
|
32
|
+
| `sysd-cross-cutting-policy` | 複数トピックへ適用する横断ルール | 個別 provider の詳細 |
|
|
33
|
+
| `sysd-critical-flows` | 最大5件の事故予防フロー | 通常系の網羅的な手順 |
|
|
34
|
+
| `sysd-<term>`(hub) | 共通の目的・境界と子設計への導線 | 子設計の設定全文 |
|
|
35
|
+
| `sysd-<term>`(子設計) | 一つの方式・provider・機能の詳細設計 | 親と同じ共通方針の再掲 |
|
|
36
|
+
|
|
37
|
+
hub は内容の薄さを目的とするのではなく、共通事項の SSOT と子設計の選択条件を一箇所に保つための構成です。
|
|
38
|
+
|
|
39
|
+
## 3. ファイル命名・ID規則
|
|
40
|
+
|
|
41
|
+
- ファイル名は `sysd-<term>.md`、ID は `sysd-<term>` とします。
|
|
42
|
+
- `<term>` は英小文字・数字・ハイフンで、設計関心事を一意に表します。
|
|
43
|
+
- hub と子設計は同じディレクトリへ配置し、子設計の `part_of` から hub の ID を参照します。
|
|
44
|
+
- provider 別に分冊する場合は、`sysd-<provider>-<topic>.md` のように選択軸を名前へ含めます。
|
|
45
|
+
- `sysd-index`、`sysd-critical-flows`、`sysd-cross-cutting-policy` は専用 rulebook の対象であり、本 rulebook の対象外です。
|
|
46
|
+
|
|
47
|
+
## 4. 推奨 Frontmatter 項目
|
|
48
|
+
|
|
49
|
+
| 項目 | 説明 | 必須 |
|
|
50
|
+
| ------------ | -------------------------------- | ----------- |
|
|
51
|
+
| `id` | `sysd-<term>` | ○ |
|
|
52
|
+
| `type` | `architecture` | ○ |
|
|
53
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
54
|
+
| `rulebook` | `specdojo:sysd-rulebook` | ○ |
|
|
55
|
+
| `part_of` | hub または `sysd-index` の ID | 子設計では○ |
|
|
56
|
+
| `based_on` | 設計判断へ直接利用した成果物 ID | 任意 |
|
|
57
|
+
| `supersedes` | 置き換える旧設計 ID | 任意 |
|
|
58
|
+
|
|
59
|
+
hub の子設計一覧と `part_of` の参照は一致させます。作成途中は `status: draft` とし、実装・検証との整合を確認してから昇格します。
|
|
60
|
+
|
|
61
|
+
## 5. 本文構成(標準テンプレ)
|
|
62
|
+
|
|
63
|
+
章構成はトピックに応じて柔軟に決められます。ただし、次の観点を本文から追跡できるようにします。
|
|
64
|
+
|
|
65
|
+
| 観点 | hub | 子設計・単独設計 | 内容 |
|
|
66
|
+
| ---------------------------- | -------- | ---------------- | -------------------------------------- |
|
|
67
|
+
| 目的・適用範囲 | ○ | ○ | 対象、対象外、利用者 |
|
|
68
|
+
| 設計方針・採用理由 | ○ | ○ | 選択理由、前提、代替との境界 |
|
|
69
|
+
| 責務分担・境界 | ○ | ○ | コンポーネント、人、外部システムの責務 |
|
|
70
|
+
| 全体構成・主要フロー | 推奨 | ○ | 構成要素、データ・制御の流れ、永続化点 |
|
|
71
|
+
| 設定・インターフェース | 導線のみ | 必要時○ | SSOT の所在、解決規則、互換性 |
|
|
72
|
+
| 失敗時・再実行・セキュリティ | 導線のみ | 必要時○ | 失敗境界、復旧条件、権限制約 |
|
|
73
|
+
|
|
74
|
+
| 子設計一覧 | ○ | - | 選択条件、責務、参照先 |
|
|
75
|
+
|
|
76
|
+
| 検証観点・関連文書 | ○ | ○ | テスト、運用、横断ルールへの導線 |
|
|
77
|
+
|
|
78
|
+
## 6. 記述ガイド
|
|
79
|
+
|
|
80
|
+
### 6.1. 目的・適用範囲
|
|
81
|
+
|
|
82
|
+
- 何を設計し、誰が実装・検証・運用判断に利用するかを1〜3段落で示します。
|
|
83
|
+
- 対象外を明示し、横断ルール、運用方針、運用手順へ委譲する事項を区別します。
|
|
84
|
+
- 現在の実装境界と将来構想を混在させず、未確定事項には共通ラベルを付けます。
|
|
85
|
+
|
|
86
|
+
### 6.2. 設計方針・責務境界
|
|
87
|
+
|
|
88
|
+
- 採用理由、守るべき制約、責務外を判定可能な表現で記載します。
|
|
89
|
+
- 責務表を置く場合は、構成要素、責務、責務外、参照する SSOT を列に含めます。
|
|
90
|
+
- 複数トピック共通の MUST / MUST NOT は本文へ複製せず、Rule ID を付けて `sysd-cross-cutting-policy` を参照します。
|
|
91
|
+
|
|
92
|
+
### 6.3. hub と子設計
|
|
93
|
+
|
|
94
|
+
- hub は共通の目的、責務境界、選択軸、子設計一覧、横断ルールへの導線を保持します。
|
|
95
|
+
- 子設計一覧には、子設計 ID、対象、固有責務、選択条件を記載します。
|
|
96
|
+
- provider 固有の認証、モデル、設定、制限シグナルは子設計へ置き、hub に詳細を再掲しません。
|
|
97
|
+
|
|
98
|
+
### 6.4. 構成・フロー・設定
|
|
99
|
+
|
|
100
|
+
- 図は主要コンポーネントと境界が変わる場合に使い、クラスや関数単位へ展開しません。
|
|
101
|
+
- 設定は項目の意味、解決順序、検証条件を記述し、設定全文や秘密情報を掲載しません。
|
|
102
|
+
- 事故時に再実行性、順序、補償、監査が問題になるフローは `sysd-critical-flows` へ切り出します。
|
|
103
|
+
|
|
104
|
+
### 6.5. 検証観点・関連文書
|
|
105
|
+
|
|
106
|
+
- 設計制約ごとに、コード、設定検証、単体・統合テスト、レビューのどれで確認するかを示します。
|
|
107
|
+
- `sysd-index`、`sysd-cross-cutting-policy`、必要な `sysd-critical-flows`、テスト設計、OPD / OPR への導線を置きます。
|
|
108
|
+
- 参照先が存在しない場合は空欄にせず、`(なし)` または未確定ラベルを明記します。
|
|
109
|
+
|
|
110
|
+
## 7. 禁止事項
|
|
111
|
+
|
|
112
|
+
| 禁止事項 | 理由 |
|
|
113
|
+
| --------------------------------------------- | ------------------------------------------- |
|
|
114
|
+
| hub に子設計の設定全文を再掲する | SSOT が分散するため |
|
|
115
|
+
| 横断ルールを複数の `sysd-<term>` に複製する | 変更時に不整合となるため |
|
|
116
|
+
| 運用コマンドを長い手順として記載する | OPR の責務を侵食するため |
|
|
117
|
+
| コード、設定、schema の全文を貼り付ける | Code as Spec の一次情報と二重管理になるため |
|
|
118
|
+
| 失敗・再実行・権限・検証観点を省略する | 実装とテストの判断材料が欠落するため |
|
|
119
|
+
| 親子関係のない設計を便宜的に同じ hub へ束ねる | 選択軸と責務境界が不明になるため |
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:tml-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: not-needed
|
|
9
|
+
template: not-needed
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# タイムライン作成ルール
|
|
15
|
+
|
|
16
|
+
Timeline Documentation Rules
|
|
17
|
+
|
|
18
|
+
本ドキュメントは、Timeline(`tml-index.yaml`)を一貫した粒度と命名で作成・更新するためのルールです。
|
|
19
|
+
Timeline は「どのトラックを、どの順で、いつ着手するか」というマクロな順序を**人間が着手前に決めて記録する計画層**であり、成果物カタログ作成からトラック実行までの見通しを 1 ファイルで表します。
|
|
20
|
+
|
|
21
|
+
本書は命名・ID 規則と schema で表現できない記述規範を定義し、構造・必須キーは schema を、トラックの標準構成と実行順序の考え方は [[specdojo:track-design-guide]] を参照します。
|
|
22
|
+
|
|
23
|
+
## 1. 全体方針
|
|
24
|
+
|
|
25
|
+
- Timeline はプロジェクトごとに `tml-index.yaml` 1 ファイルとし、プロジェクト直下の `timeline/` に置く。トラック単位のファイル分割は行わない。
|
|
26
|
+
- Timeline が扱うのは**トラック粒度のマクロな順序**であり、タスク粒度の日付・依存関係は扱わない。タスク粒度は Schedule(`sch-track-<track>.yaml`)が正本とする。
|
|
27
|
+
- Timeline は人間が着手前に決める**計画**である。実行結果や実績日付を書き戻さない。
|
|
28
|
+
- Timeline はまだ成果物カタログ(`dct-<domain>.yaml`)が存在しないトラックも記載できる。カタログ未作成のトラックを計画へ載せられることが、Schedule との最大の違いである。
|
|
29
|
+
- Timeline は `specdojo timeline build` の入力であり、後続の `catalog scaffold` / `schedule build` への入力情報を生成する一方通行の流れに置く。生成物から Timeline を逆生成しない。
|
|
30
|
+
|
|
31
|
+
## 2. 位置づけと用語定義
|
|
32
|
+
|
|
33
|
+
Timeline・Schedule・成果物カタログは、決める時点と粒度が異なります。
|
|
34
|
+
|
|
35
|
+
| 用語 | 意味 |
|
|
36
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------- |
|
|
37
|
+
| track | 関連する成果物と活動をまとめた作業系列。`sch-strategy-<track>.yaml` の `<track>` と対応する |
|
|
38
|
+
| domain | 成果物カタログの管理単位。`dct-<domain>.yaml` の `domain` 値と対応する |
|
|
39
|
+
| catalog_status | 成果物カタログの作成状況。`not_started` / `draft` / `primary` の3値 |
|
|
40
|
+
| order | 逐次実行時の着手順序を表す整数。同値は並行実行の候補 |
|
|
41
|
+
| parallel_group | 並行実行してよいトラック群を表すラベル。同じ値を持つトラック同士は並行してよい |
|
|
42
|
+
| catalog_duration_estimate_days | カタログを `draft` から `primary` にするまでに要する見積り工期(稼働日) |
|
|
43
|
+
|
|
44
|
+
### 2.1. `sch-milestones.yaml` との役割分担
|
|
45
|
+
|
|
46
|
+
`tml-index.yaml` と `sch-milestones.yaml` はどちらも「節目」を扱いますが、決める時点と生成方向が逆です。両者は併存し、`sch-milestones.yaml` を Timeline で置き換えません。
|
|
47
|
+
|
|
48
|
+
| 観点 | `tml-index.yaml` | `sch-milestones.yaml` |
|
|
49
|
+
| -------- | -------------------------------------------------- | ------------------------------------------------------------ |
|
|
50
|
+
| 位置づけ | 着手前に人間が決める計画 | 実行後に集計・生成される実績 |
|
|
51
|
+
| 生成方向 | 人間が手で書く正本 | 各トラックの `phase_gates` / `group_milestones` から生成する |
|
|
52
|
+
| 粒度 | トラック粒度(着手順・並行可否・カタログ作成状況) | マイルストーン粒度(ゲート・承認・リリース地点) |
|
|
53
|
+
| 前提 | 成果物カタログが未作成のトラックも記載できる | 成果物カタログと Schedule が存在するトラックだけを対象とする |
|
|
54
|
+
| 更新契機 | 着手順の見直し、トラックの追加・除外 | `specdojo schedule build` / `specdojo exec refresh` の実行 |
|
|
55
|
+
|
|
56
|
+
## 3. ファイル命名・ID規則
|
|
57
|
+
|
|
58
|
+
### 3.1. ファイル名と配置
|
|
59
|
+
|
|
60
|
+
- プロジェクトのトラック順序計画は `tml-index.yaml` とする。プロジェクトごとに 1 ファイルだけ置く。
|
|
61
|
+
- 配置先はプロジェクト直下の横断ディレクトリ `timeline/` とする(例: `docs/ja/projects/prj-0001/timeline/tml-index.yaml`)。
|
|
62
|
+
- prefix は `tml-` を使う。`tml-` は Timeline 層の予約 prefix であり、他の用途に転用しない。
|
|
63
|
+
|
|
64
|
+
### 3.2. `id`
|
|
65
|
+
|
|
66
|
+
- 形式は `<project-id>:tml-index` とする(例: `prj-0001:tml-index`)。
|
|
67
|
+
- `project_id` にはプロジェクト識別子(例: `prj-0001`)を記載し、`id` の接頭辞と一致させる。
|
|
68
|
+
- `rulebook` には `specdojo:tml-rulebook` を宣言する。
|
|
69
|
+
|
|
70
|
+
### 3.3. `track` と `domains` の値
|
|
71
|
+
|
|
72
|
+
- `track` は `sch-strategy-<track>.yaml` / `sch-track-<track>.yaml` の `<track>` と同じ識別子を使う。まだ Schedule が存在しないトラックでも、将来使う予定の識別子を先に決めて記載する。
|
|
73
|
+
- `track` の値は [[specdojo:track-design-guide]] の標準トラック構成に定義された id を優先して使い、プロジェクト固有のトラックを足す場合だけ新しい id を定義する。
|
|
74
|
+
- `domains` には、そのトラックが対象とする `dct-<domain>.yaml` の `domain` 値を配列で記載する。1 トラックが複数ドメインを対象にしてよい。
|
|
75
|
+
- 英小文字・数字・ハイフンで構成する(パターン: `^[a-z0-9][a-z0-9-]*$`)。
|
|
76
|
+
|
|
77
|
+
## 4. 本文構成(標準テンプレ)
|
|
78
|
+
|
|
79
|
+
Timeline は Markdown の章構成を持たない YAML 成果物であり、ルートキー・必須キー・型は次の schema を正本とする。キー一覧は本書に複製しない。
|
|
80
|
+
|
|
81
|
+
| ファイル | schema |
|
|
82
|
+
| ---------------- | ------------------------------------------------ |
|
|
83
|
+
| `tml-index.yaml` | `docs/specdojo/schemas/v1/tml-index.schema.yaml` |
|
|
84
|
+
|
|
85
|
+
- ルートには `id` / `type` / `status` / `title` / `rulebook` / `version` / `project_id` / `tracks` を必須で置く。
|
|
86
|
+
- `tracks[]` の各要素には `track` / `domains` / `catalog_status` / `order` / `depends_on` を必須で置き、`catalog_duration_estimate_days` / `parallel_group` / `note` は任意とする。
|
|
87
|
+
- 互換性を壊す schema 変更(required 追加、型変更、制約強化など)を行う場合は `version` を上げ、既存の全 `tml-index.yaml` への影響を確認する。
|
|
88
|
+
|
|
89
|
+
## 5. 記述ガイド
|
|
90
|
+
|
|
91
|
+
schema で機械検証できない記述規範だけを定める。トラックの標準構成・情報の流れ・進め方別の実行順序は [[specdojo:track-design-guide]] を参照する。
|
|
92
|
+
|
|
93
|
+
### 5.1. `catalog_status` の判定基準
|
|
94
|
+
|
|
95
|
+
3値の判定は成果物カタログの実体と使われ方で決める。ファイルの `status` 値をそのまま転記しない。
|
|
96
|
+
|
|
97
|
+
| 値 | 判定基準 |
|
|
98
|
+
| ------------- | ---------------------------------------------------------------------------- |
|
|
99
|
+
| `not_started` | 対象ドメインの `dct-<domain>.yaml` がまだ存在しない |
|
|
100
|
+
| `draft` | `dct-<domain>.yaml` は存在するが、エントリ・完了条件が未確定で追加変更が続く |
|
|
101
|
+
| `primary` | カタログが SSOT として確定し、`schedule build` の入力として使える状態にある |
|
|
102
|
+
|
|
103
|
+
- `not_started` のトラックは `specdojo timeline build` が `catalog scaffold` の対象候補として扱う。
|
|
104
|
+
- `primary` へ上げる判断は人間が行う。トラックの実行開始(`sch-strategy-<track>.yaml` の作成)は `primary` 到達後を原則とする。
|
|
105
|
+
|
|
106
|
+
### 5.2. `order` と `parallel_group`
|
|
107
|
+
|
|
108
|
+
- `order` は 1 始まりの整数とし、着手順を表す。値の連番・一意性は要求しない。
|
|
109
|
+
- 同じ `order` を持つトラックは並行実行の候補である。実際に並行させてよいかを明示する場合は `parallel_group` に同じラベルを付ける。
|
|
110
|
+
- `parallel_group` のラベルには、並行させる理由が分かる名前を使う(例: `business-specs`、`design`)。トラック名をそのまま繰り返さない。
|
|
111
|
+
- `order` は依存関係と矛盾させない。`depends_on` に挙げたトラックには、自分より小さい `order` を与える。
|
|
112
|
+
|
|
113
|
+
### 5.3. `depends_on` の書き方
|
|
114
|
+
|
|
115
|
+
- 前提のないトラックも `depends_on: []` と明示する。
|
|
116
|
+
- `depends_on` には「先に着手すべきトラック」だけを書く。成果物を参照するだけの情報の流れ(入力元)は依存として書かない。入力元の一覧は [[specdojo:track-design-guide]] を正本とする。
|
|
117
|
+
- 推移的に導ける依存は重複して書かない(`a -> b`、`b -> c` のとき `a -> c` を書かない)。
|
|
118
|
+
- `depends_on` に書いた track id は、同じ `tracks[]` 内に定義されていなければならない。
|
|
119
|
+
|
|
120
|
+
### 5.4. `catalog_duration_estimate_days` と `note`
|
|
121
|
+
|
|
122
|
+
- `catalog_duration_estimate_days` は、カタログを `draft` から `primary` にするまでの稼働日見積りとし、小数可・ゼロ不可とする。トラック本体の実行工期は含めない。
|
|
123
|
+
- `catalog_status: primary` のトラックでは `catalog_duration_estimate_days` を省略してよい。
|
|
124
|
+
- `note` には、順序をそう決めた理由や保留事項など、他のフィールドで表せない判断だけを書く。フィールド値の言い換えを書かない。
|
|
125
|
+
- 未確定の順序は `note` に _UNDECIDED_ を付けて残し、ファイルの `status` を `draft` に据え置く。
|
|
126
|
+
|
|
127
|
+
## 6. 禁止事項
|
|
128
|
+
|
|
129
|
+
- タスク粒度の日付・工期・担当を `tml-index.yaml` に書くこと(タスク粒度は Schedule が正本)。
|
|
130
|
+
- 成果物パス・完了条件(`done_criteria`)を書くこと(成果物カタログが正本)。
|
|
131
|
+
- 実行実績(完了日、実際の着手日、進捗率)を書き戻すこと(実績は `sch-milestones.yaml` と `generated/` が正本)。
|
|
132
|
+
- `depends_on` を省略すること(前提なしでも `[]` と明示する)。
|
|
133
|
+
- `tracks[]` に定義されていない track id を `depends_on` に書くこと。
|
|
134
|
+
- `depends_on` の向きと `order` の大小を矛盾させること。
|
|
135
|
+
- `sch-milestones.yaml` のマイルストーンを `tml-index.yaml` に複製すること。
|
|
136
|
+
- プロジェクトごとに `tml-index.yaml` を複数置くこと、またはトラック単位へ分割すること。
|
|
137
|
+
- `specdojo timeline build` の生成物を直接編集すること。
|
|
138
|
+
|
|
139
|
+
## 7. サンプル
|
|
140
|
+
|
|
141
|
+
最小構成の例を示す。`launch` を起点に、業務仕様のドメイン別トラックを並行候補として並べている。
|
|
142
|
+
|
|
143
|
+
```yaml
|
|
144
|
+
id: prj-0001:tml-index
|
|
145
|
+
type: project
|
|
146
|
+
status: draft
|
|
147
|
+
title: トラック順序計画
|
|
148
|
+
rulebook: specdojo:tml-rulebook
|
|
149
|
+
version: 1
|
|
150
|
+
project_id: prj-0001
|
|
151
|
+
|
|
152
|
+
tracks:
|
|
153
|
+
- track: launch
|
|
154
|
+
domains: [project-definition, project-management]
|
|
155
|
+
catalog_status: primary
|
|
156
|
+
order: 1
|
|
157
|
+
depends_on: []
|
|
158
|
+
note: プロジェクト全体の前提を定義する起点トラック。
|
|
159
|
+
|
|
160
|
+
- track: data-flow
|
|
161
|
+
domains: [data-flow]
|
|
162
|
+
catalog_status: primary
|
|
163
|
+
order: 2
|
|
164
|
+
parallel_group: business-specs
|
|
165
|
+
depends_on: [launch]
|
|
166
|
+
|
|
167
|
+
- track: data-model
|
|
168
|
+
domains: [data-model]
|
|
169
|
+
catalog_status: draft
|
|
170
|
+
catalog_duration_estimate_days: 3
|
|
171
|
+
order: 2
|
|
172
|
+
parallel_group: business-specs
|
|
173
|
+
depends_on: [launch]
|
|
174
|
+
note: data-flow と同じ入力を使うため並行候補とする。
|
|
175
|
+
|
|
176
|
+
- track: architecture
|
|
177
|
+
domains: [architecture]
|
|
178
|
+
catalog_status: not_started
|
|
179
|
+
catalog_duration_estimate_days: 2
|
|
180
|
+
order: 3
|
|
181
|
+
depends_on: [data-flow, data-model]
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
## 8. 今後の検討
|
|
185
|
+
|
|
186
|
+
- 現時点の `catalog_status` は3値の軽量フィールドであり、カタログ作成作業そのものを子カタログ(`done_criteria` 付きの成果物エントリ)として管理する「フル成果物カタログ化」は採用していない。カタログ作成の工数管理をタスク粒度で行う必要が出た場合に、フル化を再検討する。
|
|
187
|
+
- フル化する場合でも `tml-index.yaml` はトラック粒度の計画層として残し、カタログ作成タスクは Schedule 側へ展開する方針を想定する。
|
|
188
|
+
- 複数プロジェクトを横断したトラック順序計画(プログラム単位の Timeline)は現時点では扱わない。
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:trc-requirements-to-specs-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
sample: specdojo:trc-requirements-to-specs-sample
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# トレーサビリティ(要求→仕様)作成ルール
|
|
10
|
+
|
|
11
|
+
Requirements Traceability (Requirements to Specs) Rulebook
|
|
12
|
+
|
|
13
|
+
本ドキュメントは、各成果物の型付きID参照から要求と仕様の対応関係を派生ビューとして表示する場合の形式を定義します。要求漏れ・仕様漏れを防ぎ、変更時の影響追跡とレビュー判断を容易にすることを目的とします。
|
|
14
|
+
|
|
15
|
+
## 1. 全体方針
|
|
16
|
+
|
|
17
|
+
- 対象は「要求と仕様の対応関係の可視化」であり、仕様本文そのものの詳細記述は扱わない。
|
|
18
|
+
- 対応関係の正本は仕様成果物の `relations.satisfies` とし、本ビューを手編集しない。
|
|
19
|
+
- 1 行は 1 つの対応命題(要求IDと対応仕様IDの関係)を原則とし、判定可能な状態で記述する。
|
|
20
|
+
- 記載の最小単位は `要求ID` とし、各要求が少なくとも 1 つ以上の仕様へトレースされる状態を維持する。
|
|
21
|
+
- 充足状況とギャップは、レビュー時に即時判定できる語彙で統一する。
|
|
22
|
+
- 本ビューは必要なプロジェクトで生成する任意の管理ビューとし、独立した成果物ドメインやトラックを持たない。
|
|
23
|
+
|
|
24
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
25
|
+
|
|
26
|
+
| 用語 | 定義 |
|
|
27
|
+
| ---------- | --------------------------------------------------------------- |
|
|
28
|
+
| 要求ID | 要求を一意に識別する ID(例: `req-` 系) |
|
|
29
|
+
| 対応仕様ID | 要求を実現する仕様を一意に識別する ID(例: `bac-` / `bes-` 系) |
|
|
30
|
+
|
|
31
|
+
| 充足状況 | 要求に対する仕様整備の達成状態(未着手 / 一部充足 / 充足) |
|
|
32
|
+
| ギャップ | 要求と仕様の間に残る不足・不整合・未確定事項 |
|
|
33
|
+
|
|
34
|
+
## 3. ファイル命名・ID規則
|
|
35
|
+
|
|
36
|
+
- 対象ドキュメント ID は `trc-requirements-to-specs` とする。
|
|
37
|
+
|
|
38
|
+
- 推奨ファイル名は `trc-requirements-to-specs.md` とする。
|
|
39
|
+
- 本 rulebook の ID は `specdojo:trc-requirements-to-specs-rulebook` とする。
|
|
40
|
+
- 追加分割が必要な場合は `trc-requirements-to-specs-<term>` 形式を用いる。
|
|
41
|
+
|
|
42
|
+
## 4. 推奨 Frontmatter 項目
|
|
43
|
+
|
|
44
|
+
[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
|
|
45
|
+
|
|
46
|
+
| 項目 | 説明 | 必須 |
|
|
47
|
+
| ---------- | --------------------------------------------- | ---- |
|
|
48
|
+
| id | `trc-requirements-to-specs` | ○ |
|
|
49
|
+
| type | `project` | ○ |
|
|
50
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
51
|
+
| rulebook | `specdojo:trc-requirements-to-specs-rulebook` | ○ |
|
|
52
|
+
| based_on | 生成元となる要求・仕様の ID 配列 | 任意 |
|
|
53
|
+
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
54
|
+
|
|
55
|
+
## 5. 本文構成(標準テンプレ)
|
|
56
|
+
|
|
57
|
+
| 章 | 見出し | 必須 | 目的 |
|
|
58
|
+
| --- | -------------------- | ---- | -------------------------------------------- |
|
|
59
|
+
| 1 | 目的と適用範囲 | ○ | トレース対象の境界と運用目的を明確化する |
|
|
60
|
+
| 2 | トレース対象の前提 | ○ | 対象要求群・対象仕様群・除外範囲を明確化する |
|
|
61
|
+
| 3 | トレースマトリクス | ○ | 要求IDと対応仕様IDの対応関係を一覧化する |
|
|
62
|
+
| 4 | 充足状況サマリ | ○ | 充足状況を集計し、優先対応領域を可視化する |
|
|
63
|
+
| 5 | ギャップと対応方針 | ○ | 不足・不整合の内容と解消方針を整理する |
|
|
64
|
+
| 6 | 変更履歴と更新ルール | 任意 | 追記・更新時の追跡可能性を担保する |
|
|
65
|
+
|
|
66
|
+
## 6. 記述ガイド
|
|
67
|
+
|
|
68
|
+
### 6.1. 目的と適用範囲
|
|
69
|
+
|
|
70
|
+
- どの要求群とどの仕様群の対応を管理するかを明記する。
|
|
71
|
+
- 対象外(例: 廃止要求、移管済み要求)がある場合は理由付きで記載する。
|
|
72
|
+
|
|
73
|
+
### 6.2. トレース対象の前提
|
|
74
|
+
|
|
75
|
+
- 要求側と仕様側の参照元(ID体系、版、作成日)を明記する。
|
|
76
|
+
- トレース単位(1:1 / 1:N / N:1)を先に定義する。
|
|
77
|
+
|
|
78
|
+
### 6.3. トレースマトリクス
|
|
79
|
+
|
|
80
|
+
- 表形式で記載し、最低限次のカラムを含める。
|
|
81
|
+
|
|
82
|
+
| カラム | 内容 |
|
|
83
|
+
| ---------- | ------------------------------ |
|
|
84
|
+
| 要求ID | 追跡対象の要求 ID |
|
|
85
|
+
| 要求要約 | 要求内容の要点(1 行) |
|
|
86
|
+
| 対応仕様ID | 対応する仕様 ID(複数可) |
|
|
87
|
+
| 充足状況 | `未着手` / `一部充足` / `充足` |
|
|
88
|
+
| ギャップ | 未対応点・不整合・要確認事項 |
|
|
89
|
+
| 備考 | 根拠、判断日、関連チケットなど |
|
|
90
|
+
|
|
91
|
+
### 6.4. 充足状況サマリ
|
|
92
|
+
|
|
93
|
+
- 充足状況は件数で集計し、未着手と一部充足を優先管理対象として明示する。
|
|
94
|
+
- 重大ギャップ(業務影響が大きい項目)は個別 ID を記載して強調する。
|
|
95
|
+
|
|
96
|
+
### 6.5. ギャップと対応方針
|
|
97
|
+
|
|
98
|
+
- ギャップごとに「解消方針」「担当」「期限」「判定条件」を記載する。
|
|
99
|
+
- 方針未確定の場合は _UNDECIDED_: ラベルで暫定状態を明示する。
|
|
100
|
+
|
|
101
|
+
### 6.6. 変更履歴と更新ルール
|
|
102
|
+
|
|
103
|
+
- 要求や仕様のID参照が更新された場合は、派生ビューを再生成する。
|
|
104
|
+
- 充足状況やギャップをビューへ直接入力せず、生成元となる成果物または検証結果へ記録する。
|
|
105
|
+
|
|
106
|
+
## 7. 禁止事項
|
|
107
|
+
|
|
108
|
+
- 要求本文・仕様本文の全文転記を行わない。
|
|
109
|
+
|
|
110
|
+
- 要求IDまたは対応仕様IDが空の行を作成しない。
|
|
111
|
+
- 充足状況に曖昧語(例: ほぼ対応、だいたい完了)を使用しない。
|
|
112
|
+
- ギャップを「なし」としながら対応仕様IDが未記載の状態を許容しない。
|
|
113
|
+
- 根拠リンクや判断履歴なしで充足状況を更新しない。
|
|
114
|
+
- 生成したトレース表を手編集し、成果物の `relations.satisfies` と異なる関係を持たせない。
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:trc-requirements-to-tests-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
sample: specdojo:trc-requirements-to-tests-sample
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# トレーサビリティ(要求→テスト)作成ルール
|
|
10
|
+
|
|
11
|
+
Requirements Traceability (Requirements to Tests) Rulebook
|
|
12
|
+
|
|
13
|
+
本ドキュメントは、各成果物の型付きID参照から要求とテストの対応関係を派生ビューとして表示する場合の形式を定義します。要求漏れ・テスト漏れを防ぎ、変更時の影響追跡と受入判断を容易にすることを目的とします。
|
|
14
|
+
|
|
15
|
+
## 1. 全体方針
|
|
16
|
+
|
|
17
|
+
- 対象は「要求とテストの対応関係の可視化」であり、テスト手順本文の詳細記述は扱わない。
|
|
18
|
+
- 対応関係の正本はテスト成果物の `relations.verifies` とし、本ビューを手編集しない。
|
|
19
|
+
- 1 行は 1 つの対応命題(要求IDと対応テストIDの関係)を原則とし、判定可能な状態で記述する。
|
|
20
|
+
- 記載の最小単位は `要求ID` とし、各要求が少なくとも 1 つ以上のテストへトレースされる状態を維持する。
|
|
21
|
+
- 充足状況とギャップは、レビュー時に即時判定できる語彙で統一する。
|
|
22
|
+
- 本ビューは必要なプロジェクトで生成する任意の管理ビューとし、独立した成果物ドメインやトラックを持たない。
|
|
23
|
+
|
|
24
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
25
|
+
|
|
26
|
+
| 用語 | 定義 |
|
|
27
|
+
| ------------ | -------------------------------------------------------------------------- |
|
|
28
|
+
| 要求ID | 要求を一意に識別する ID(例: `req-` 系) |
|
|
29
|
+
| 対応テストID | 要求を検証するテストを一意に識別する ID(例: `utc-` / `itc-` / `atc-` 系) |
|
|
30
|
+
|
|
31
|
+
| 充足状況 | 要求に対するテスト整備の達成状態(未着手 / 一部充足 / 充足) |
|
|
32
|
+
| ギャップ | 要求とテストの間に残る不足・不整合・未確定事項 |
|
|
33
|
+
|
|
34
|
+
## 3. ファイル命名・ID規則
|
|
35
|
+
|
|
36
|
+
- 対象ドキュメント ID は `trc-requirements-to-tests` とする。
|
|
37
|
+
- 推奨ファイル名は `trc-requirements-to-tests.md` とする。
|
|
38
|
+
- 本 rulebook の ID は `specdojo:trc-requirements-to-tests-rulebook` とする。
|
|
39
|
+
- 追加分割が必要な場合は `trc-requirements-to-tests-<term>` 形式を用いる。
|
|
40
|
+
|
|
41
|
+
## 4. 推奨 Frontmatter 項目
|
|
42
|
+
|
|
43
|
+
[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
|
|
44
|
+
|
|
45
|
+
| 項目 | 説明 | 必須 |
|
|
46
|
+
| -------- | --------------------------------------------- | ---- |
|
|
47
|
+
| id | `trc-requirements-to-tests` | ○ |
|
|
48
|
+
| type | `project` | ○ |
|
|
49
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
50
|
+
| rulebook | `specdojo:trc-requirements-to-tests-rulebook` | ○ |
|
|
51
|
+
|
|
52
|
+
| based_on | 生成元となる要求・テスト仕様の ID 配列 | 任意 |
|
|
53
|
+
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
54
|
+
|
|
55
|
+
## 5. 本文構成(標準テンプレ)
|
|
56
|
+
|
|
57
|
+
| 章 | 見出し | 必須 | 目的 |
|
|
58
|
+
| --- | -------------------- | ---- | ---------------------------------------------- |
|
|
59
|
+
| 1 | 目的と適用範囲 | ○ | トレース対象の境界と運用目的を明確化する |
|
|
60
|
+
| 2 | トレース対象の前提 | ○ | 対象要求群・対象テスト群・除外範囲を明確化する |
|
|
61
|
+
| 3 | トレースマトリクス | ○ | 要求IDと対応テストIDの対応関係を一覧化する |
|
|
62
|
+
| 4 | 充足状況サマリ | ○ | 充足状況を集計し、優先対応領域を可視化する |
|
|
63
|
+
| 5 | ギャップと対応方針 | ○ | 不足・不整合の内容と解消方針を整理する |
|
|
64
|
+
| 6 | 変更履歴と更新ルール | 任意 | 追記・更新時の追跡可能性を担保する |
|
|
65
|
+
|
|
66
|
+
## 6. 記述ガイド
|
|
67
|
+
|
|
68
|
+
### 6.1. 目的と適用範囲
|
|
69
|
+
|
|
70
|
+
- どの要求群とどのテスト群の対応を管理するかを明記する。
|
|
71
|
+
- 対象外(例: 廃止要求、次フェーズ対応要求)がある場合は理由付きで記載する。
|
|
72
|
+
|
|
73
|
+
### 6.2. トレース対象の前提
|
|
74
|
+
|
|
75
|
+
- 要求側とテスト側の参照元(ID体系、版、作成日)を明記する。
|
|
76
|
+
- トレース単位(1:1 / 1:N / N:1)を先に定義する。
|
|
77
|
+
|
|
78
|
+
### 6.3. トレースマトリクス
|
|
79
|
+
|
|
80
|
+
- 表形式で記載し、最低限次のカラムを含める。
|
|
81
|
+
|
|
82
|
+
| カラム | 内容 |
|
|
83
|
+
| -------- | ---------------------- |
|
|
84
|
+
| 要求ID | 追跡対象の要求 ID |
|
|
85
|
+
| 要求要約 | 要求内容の要点(1 行) |
|
|
86
|
+
|
|
87
|
+
| 対応テストID | 対応するテスト ID(複数可) |
|
|
88
|
+
|
|
89
|
+
| 充足状況 | `未着手` / `一部充足` / `充足` |
|
|
90
|
+
| ギャップ | 未対応点・不整合・要確認事項 |
|
|
91
|
+
| 備考 | 根拠、判断日、関連チケットなど |
|
|
92
|
+
|
|
93
|
+
### 6.4. 充足状況サマリ
|
|
94
|
+
|
|
95
|
+
- 充足状況は件数で集計し、未着手と一部充足を優先管理対象として明示する。
|
|
96
|
+
- 重大ギャップ(受入判定に影響する項目)は個別 ID を記載して強調する。
|
|
97
|
+
|
|
98
|
+
### 6.5. ギャップと対応方針
|
|
99
|
+
|
|
100
|
+
- ギャップごとに「解消方針」「担当」「期限」「判定条件」を記載する。
|
|
101
|
+
- 方針未確定の場合は _UNDECIDED_: ラベルで暫定状態を明示する。
|
|
102
|
+
|
|
103
|
+
### 6.6. 変更履歴と更新ルール
|
|
104
|
+
|
|
105
|
+
- 要求やテストのID参照が更新された場合は、派生ビューを再生成する。
|
|
106
|
+
|
|
107
|
+
- 充足状況やギャップをビューへ直接入力せず、生成元となる成果物または検証結果へ記録する。
|
|
108
|
+
|
|
109
|
+
## 7. 禁止事項
|
|
110
|
+
|
|
111
|
+
- 要求本文・テスト本文の全文転記を行わない。
|
|
112
|
+
|
|
113
|
+
- 要求IDまたは対応テストIDが空の行を作成しない。
|
|
114
|
+
- 充足状況に曖昧語(例: ほぼ対応、だいたい完了)を使用しない。
|
|
115
|
+
- ギャップを「なし」としながら対応テストIDが未記載の状態を許容しない。
|
|
116
|
+
- 根拠リンクや判断履歴なしで充足状況を更新しない。
|
|
117
|
+
- 生成したトレース表を手編集し、成果物の `relations.verifies` と異なる関係を持たせない。
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:tsd-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: not-needed
|
|
7
|
+
sample: specdojo:tsd-index-sample
|
|
8
|
+
template: not-needed
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 技術スタック定義(TSD Index)作成ルール
|
|
12
|
+
|
|
13
|
+
Technology Stack Definition Index (TSD Index) Documentation Rules
|
|
14
|
+
|
|
15
|
+
`tsd-index.md` は、プロダクトが採用する技術の **全体インベントリ(一覧表)** を一箇所に集約する入口ドキュメントである。採用技術の担当責務を関係者間で合意するための最小限の一覧を定義し、詳細は `tsd-<term>.md` にリンクで繋ぐ。
|
|
16
|
+
|
|
17
|
+
## 1. 全体方針
|
|
18
|
+
|
|
19
|
+
- 1プロジェクト(システム)に対して `tsd-index.md` は1つだけ作成する
|
|
20
|
+
- 採用技術の全区分を漏れなく記載し、詳細ドキュメント(`tsd-<term>.md`)への入口とする
|
|
21
|
+
- 表形式(Markdown)で管理し、機械判読用途には使わない
|
|
22
|
+
- ベンダー固有の接続情報・機密値・バージョン固定値は記載しない
|
|
23
|
+
- 採用が確定した技術のみを記載し、候補・検討中は含めない
|
|
24
|
+
|
|
25
|
+
## 2. 位置づけ
|
|
26
|
+
|
|
27
|
+
`tsd-index` と `tsd-<term>` の関係:
|
|
28
|
+
|
|
29
|
+
| ドキュメント | 役割 | 粒度 |
|
|
30
|
+
| ------------ | ---------------------------------- | ----------------------------- |
|
|
31
|
+
| `tsd-index` | 採用技術の全体インベントリ(入口) | 区分・技術名・責務を1行で表す |
|
|
32
|
+
| `tsd-<term>` | 特定技術領域の詳細設定・構成 | 複数セクションで詳述 |
|
|
33
|
+
|
|
34
|
+
`tsd-index` は全区分を俯瞰でき、必要に応じて `tsd-<term>` へリンクする。詳細設定・手順・コードブロックは `tsd-<term>` に委ねる。
|
|
35
|
+
|
|
36
|
+
## 3. ファイル命名・ID規則
|
|
37
|
+
|
|
38
|
+
- ファイル名: `tsd-index.md`(固定)
|
|
39
|
+
- `id`: `tsd-index`(固定)
|
|
40
|
+
- 配置先: プロジェクトのアーキテクチャディレクトリ(例: `030-architecture/020-infrastructure/`)
|
|
41
|
+
|
|
42
|
+
## 4. 推奨 Frontmatter 項目
|
|
43
|
+
|
|
44
|
+
| 項目 | 値 | 必須 |
|
|
45
|
+
| ---------- | -------------------------------- | ---- |
|
|
46
|
+
| `id` | `tsd-index` | ○ |
|
|
47
|
+
| `type` | `architecture` | ○ |
|
|
48
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
49
|
+
| `rulebook` | `specdojo:tsd-index-rulebook` | 推奨 |
|
|
50
|
+
| `based_on` | 根拠となる仕様 ID(配列) | 任意 |
|
|
51
|
+
|
|
52
|
+
## 5. 本文構成(標準テンプレ)
|
|
53
|
+
|
|
54
|
+
| 章番号 | 章タイトル | 必須 | 説明 |
|
|
55
|
+
| ------ | ---------------- | ---- | --------------------------------- |
|
|
56
|
+
| 1 | 技術スタック一覧 | ○ | 全区分を網羅する一覧表(表1つ) |
|
|
57
|
+
| 2 | 補足 | 任意 | `tsd-<term>` へのリンク・注意事項 |
|
|
58
|
+
|
|
59
|
+
- `技術スタック一覧` は表1つで構成する(区分ごとに複数表に分割しない)
|
|
60
|
+
- `補足` には詳細ドキュメントへのリンクを記載し、技術固有の説明は書かない
|
|
61
|
+
|
|
62
|
+
## 6. 記述ガイド
|
|
63
|
+
|
|
64
|
+
### 6.1. 技術スタック一覧表
|
|
65
|
+
|
|
66
|
+
必須列:
|
|
67
|
+
|
|
68
|
+
| 列名 | 説明 |
|
|
69
|
+
| -------- | ------------------------------------------------------------------ |
|
|
70
|
+
| 区分 | カテゴリ(例: 言語 / ランタイム / DB / ホスティング) |
|
|
71
|
+
| 採用技術 | 技術名とメジャーバージョン(例: `TypeScript 5.x`、`Node.js 24.x`) |
|
|
72
|
+
| 担当責務 | その技術を何に使うか(判定可能な粒度で1行) |
|
|
73
|
+
|
|
74
|
+
必要に応じて `補足` 列を追加してよい。
|
|
75
|
+
|
|
76
|
+
区分の推奨値:
|
|
77
|
+
|
|
78
|
+
- 言語 / ランタイム
|
|
79
|
+
- CLI フレームワーク / Web FW
|
|
80
|
+
- DB / MQ / Cache
|
|
81
|
+
- スキーマ検証 / Markdown lint / コードフォーマット
|
|
82
|
+
- ドキュメントサイト / 図解生成
|
|
83
|
+
- Git フック / コミット規約
|
|
84
|
+
- ソースコード管理 / CI/CD / パッケージ配信
|
|
85
|
+
- AI エージェント実行 / ローカル LLM
|
|
86
|
+
|
|
87
|
+
### 6.2. 補足
|
|
88
|
+
|
|
89
|
+
- 詳細ドキュメント(`tsd-<term>.md`)が存在する場合はリンクを記載する
|
|
90
|
+
- 補足に技術の設定手順・構成詳細を記述しない(`tsd-<term>` に委ねる)
|
|
91
|
+
|
|
92
|
+
## 7. 禁止事項
|
|
93
|
+
|
|
94
|
+
| 禁止事項 | 理由 |
|
|
95
|
+
| ------------------------------------------------------------------- | -------------------------------------- |
|
|
96
|
+
| 同じ技術を複数の区分に重複記載する | 一覧の見通しが悪くなるため |
|
|
97
|
+
| 担当責務を空欄にする | 合意の根拠がなくなるため |
|
|
98
|
+
| 接続情報・API キー・機密 URL を記載する | セキュリティリスクになるため |
|
|
99
|
+
| `tsd-<term>` の詳細内容(設定手順・コードブロック)を本文に展開する | インデックスの責務を逸脱するため |
|
|
100
|
+
| 採用が確定していない技術を記載する | 前提条件として誤認されるため |
|
|
101
|
+
| `tsd-index` を複数作成する | 全体インベントリの SSOT が分散するため |
|