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,929 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:id-and-file-naming-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# ドキュメントIDおよびファイル命名標準
|
|
9
|
+
|
|
10
|
+
Document ID and File Naming Standard
|
|
11
|
+
|
|
12
|
+
## 1. 目的
|
|
13
|
+
|
|
14
|
+
本ルールは、SpecDojo におけるドキュメント間の参照性・可読性・機械処理性・長期運用性を確保するために、
|
|
15
|
+
|
|
16
|
+
- **ドキュメントID**
|
|
17
|
+
- **ファイル名**
|
|
18
|
+
- **ID参照**
|
|
19
|
+
- **SpecDojo Unit 内での一意性**
|
|
20
|
+
|
|
21
|
+
の命名規則と両者の関係を明確に定義することを目的とする。
|
|
22
|
+
|
|
23
|
+
本ルールにより、以下を同時に満たすことを目指す。
|
|
24
|
+
|
|
25
|
+
- 人間が見て意味を推測できること
|
|
26
|
+
- 機械(lint / CI / 生成AI)が安定して扱えること
|
|
27
|
+
- 構造変更や文書分割に耐えられること
|
|
28
|
+
- プロジェクトが複数存在してもID衝突を避けられること
|
|
29
|
+
- モノレポ構成でも、SpecDojo Unit 単位で管理できること
|
|
30
|
+
|
|
31
|
+
## 2. 基本方針
|
|
32
|
+
|
|
33
|
+
### 2.1. SpecDojo Unit と ID の一意性
|
|
34
|
+
|
|
35
|
+
SpecDojo では、1つの `docs/` ルートを **SpecDojo Unit** として扱う。
|
|
36
|
+
|
|
37
|
+
SpecDojo Unit は、原則として1つのプロダクト文脈を扱う管理単位である。
|
|
38
|
+
|
|
39
|
+
例:
|
|
40
|
+
|
|
41
|
+
```text
|
|
42
|
+
repo/docs/
|
|
43
|
+
repo/apps/product-a/docs/
|
|
44
|
+
repo/apps/product-b/docs/
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
ドキュメントIDは、原則として **SpecDojo Unit 内で一意** にする。
|
|
48
|
+
|
|
49
|
+
npm package が所有する実践体系は、利用プロジェクトの成果物と同じ Unit に展開しても所有元を識別できるよう、package ごとに定めた authority を ID の namespace として持つ。SpecDojo core の authority は `specdojo` とする。
|
|
50
|
+
|
|
51
|
+
複数の SpecDojo Unit を横断して扱う場合は、必要に応じて Unit ID とドキュメントIDの組み合わせで識別する。
|
|
52
|
+
|
|
53
|
+
```text
|
|
54
|
+
<unit-id>/<document-id>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
ただし、通常のドキュメント内では Unit ID をIDに含めない。
|
|
58
|
+
|
|
59
|
+
### 2.2. IDとファイル名の役割分離
|
|
60
|
+
|
|
61
|
+
- **ドキュメントID**
|
|
62
|
+
- 文書の意味的・論理的な識別子
|
|
63
|
+
- 参照・トレース・整合性検証の軸
|
|
64
|
+
- 原則として変更しない
|
|
65
|
+
|
|
66
|
+
- **ファイル名**
|
|
67
|
+
- 人間が扱いやすい表示・管理上の名前
|
|
68
|
+
- 配置や構成変更に応じて変更可能
|
|
69
|
+
- 原則としてドキュメントIDのローカルID部分と一致させる
|
|
70
|
+
|
|
71
|
+
機械判別・参照・トレースは ID を正とし、ファイル名そのものには依存しない。
|
|
72
|
+
|
|
73
|
+
ただし運用上の既定として、**ファイル名はドキュメントIDのローカルID部分と一致**させる。
|
|
74
|
+
|
|
75
|
+
### 2.3. IDの不変性・ファイル名の可変性
|
|
76
|
+
|
|
77
|
+
- ドキュメントIDは一意かつ原則変更不可
|
|
78
|
+
- ファイル名は表示改善・構成変更のために変更可
|
|
79
|
+
- ファイル名を変更しても、frontmatter の `id` は変更しない
|
|
80
|
+
- ID変更が必要な場合は、新IDを作成し、旧IDとの関係を `supersedes` で表現する
|
|
81
|
+
|
|
82
|
+
### 2.4. 多言語文書のID方針(言語スコープ)
|
|
83
|
+
|
|
84
|
+
多言語で同一文書を展開する場合、翻訳は同じ論理文書の言語違いであるため、ドキュメントIDは言語をまたいで同一(言語中立)とする。IDに言語を含めない。
|
|
85
|
+
|
|
86
|
+
- 同一論理IDの言語variant: `docs/ja/<path>.md` とその翻訳 `docs/en/<path>.md` は、同じ `id` を持つ。翻訳のために新しいIDを振らない。
|
|
87
|
+
- 一意性の粒度: IDは「SpecDojo Unit 内、かつ同一言語サブツリー内」で一意とする。言語をまたぐ同一IDは同一論理文書の variant として扱い、衝突とみなさない。同一言語サブツリー内での重複はエラーとする。
|
|
88
|
+
- 言語サブツリー: `docs/` 直下のロケールディレクトリ(例: `docs/ja/`、`docs/en/`)を言語スコープとする。ロケール集合は `.specdojo/index-config.yaml` の `locales` で宣言する。
|
|
89
|
+
- 言語中立文書: ロケールディレクトリに属さない配下(例: `docs/specdojo/` 配下のスキーマ)は言語中立として Unit 全体で一意とする。言語中立IDと言語別IDに同一IDを用いてはならない。
|
|
90
|
+
- 参照とID解決: 参照は言語を書かず `[[id]]` で行う。ID解決は参照元ファイルの言語と同一言語の variant を優先し、無ければ既定言語へフォールバックする。これにより翻訳時に本文中の参照を書き換える必要がない。
|
|
91
|
+
- `locales` 未宣言時: 言語スコープは無効となり、ID は Unit 全体で一意(従来動作)に扱う。
|
|
92
|
+
|
|
93
|
+
## 3. クイックサマリー(要点)
|
|
94
|
+
|
|
95
|
+
### 3.1. ドキュメントID
|
|
96
|
+
|
|
97
|
+
#### 3.1.1. プロダクト文書
|
|
98
|
+
|
|
99
|
+
プロダクト文書は、SpecDojo Unit 内で一意なローカルIDを使用する。
|
|
100
|
+
|
|
101
|
+
```text
|
|
102
|
+
<local-id>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
例:
|
|
106
|
+
|
|
107
|
+
```text
|
|
108
|
+
bdd-sales-management
|
|
109
|
+
ifx-index
|
|
110
|
+
sysd-index
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### 3.1.2. プロジェクト文書
|
|
114
|
+
|
|
115
|
+
プロジェクト文書は、同一 SpecDojo Unit 内に複数プロジェクトが存在するため、プロジェクトIDを namespace として持つ。
|
|
116
|
+
|
|
117
|
+
```text
|
|
118
|
+
<project-id>:<local-id>
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
例:
|
|
122
|
+
|
|
123
|
+
```text
|
|
124
|
+
prj-0001:prj-overview
|
|
125
|
+
prj-0001:prj-charter
|
|
126
|
+
prj-0001:sch-track-project-definition
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
#### 3.1.3. 実践体系文書
|
|
130
|
+
|
|
131
|
+
npm package が所有する philosophy / standard / rulebook / recipe / sample / template / guide / reference は、authority を namespace として持つ。
|
|
132
|
+
|
|
133
|
+
```text
|
|
134
|
+
<authority>:<local-id>
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
例:
|
|
138
|
+
|
|
139
|
+
```text
|
|
140
|
+
specdojo:document-metadata-standard
|
|
141
|
+
specdojo:prj-overview-rulebook
|
|
142
|
+
specdojo:track-design-guide
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
authority は論理的な所有元であり、ファイル名には含めない。SpecDojo core をローカルへコピーして明示的に override する場合も、同じ論理文書として同じ完全 ID を維持する。
|
|
146
|
+
|
|
147
|
+
#### 3.1.4. local-id の形式
|
|
148
|
+
|
|
149
|
+
`<local-id>` は次の形式を基本とする。
|
|
150
|
+
|
|
151
|
+
```text
|
|
152
|
+
<prefix>-<term>
|
|
153
|
+
<prefix>-<kind>-<term>
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
- `<prefix>`: ドキュメント種別
|
|
157
|
+
- `<kind>`: prefixを拡張する固定カテゴリ
|
|
158
|
+
- `<term>`: 内容を表す名詞句
|
|
159
|
+
|
|
160
|
+
例:
|
|
161
|
+
|
|
162
|
+
```text
|
|
163
|
+
bdd-sales-management
|
|
164
|
+
br-discount
|
|
165
|
+
ifx-api-inventory
|
|
166
|
+
prj-overview
|
|
167
|
+
dct-project-definition
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### 3.2. 使用可能文字
|
|
171
|
+
|
|
172
|
+
#### 3.2.1. local-id
|
|
173
|
+
|
|
174
|
+
`local-id` には以下を使用する。
|
|
175
|
+
|
|
176
|
+
- 英小文字 `a-z`
|
|
177
|
+
- 数字 `0-9`
|
|
178
|
+
- ハイフン `-`
|
|
179
|
+
|
|
180
|
+
```text
|
|
181
|
+
^[a-z0-9][a-z0-9-]*$
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
#### 3.2.2. project-id
|
|
185
|
+
|
|
186
|
+
`project-id` は以下を使用する。
|
|
187
|
+
|
|
188
|
+
```text
|
|
189
|
+
prj-<number>
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
例:
|
|
193
|
+
|
|
194
|
+
```text
|
|
195
|
+
prj-0001
|
|
196
|
+
prj-0002
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
#### 3.2.3. namespace付きID
|
|
200
|
+
|
|
201
|
+
プロジェクト文書とpackage所有の実践体系文書は、namespace と `local-id` をコロンで連結する。
|
|
202
|
+
|
|
203
|
+
```text
|
|
204
|
+
<namespace>:<local-id>
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
例:
|
|
208
|
+
|
|
209
|
+
```text
|
|
210
|
+
prj-0001:prj-overview
|
|
211
|
+
specdojo:track-design-guide
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
YAML frontmatter では、コロンを含むIDはクォートで囲む。
|
|
215
|
+
|
|
216
|
+
```yaml
|
|
217
|
+
id: "prj-0001:prj-overview"
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### 3.3. ファイル名
|
|
221
|
+
|
|
222
|
+
- 既定推奨は `ファイル名 = local-id`
|
|
223
|
+
- プロジェクト文書でも実践体系文書でも、ファイル名には namespace を含めない
|
|
224
|
+
- namespace はID上の論理的な所有元を表し、配置先ディレクトリと対応させる
|
|
225
|
+
|
|
226
|
+
例:
|
|
227
|
+
|
|
228
|
+
| 種別 | ドキュメントID | ファイル名 |
|
|
229
|
+
| ---------------- | --------------------------------------- | ----------------------------------- |
|
|
230
|
+
| プロダクト文書 | `bdd-sales-management` | `bdd-sales-management.md` |
|
|
231
|
+
| プロダクト文書 | `sysd-index` | `sysd-index.md` |
|
|
232
|
+
| プロジェクト文書 | `prj-0001:prj-overview` | `prj-overview.md` |
|
|
233
|
+
| プロジェクト文書 | `prj-0001:prj-charter` | `prj-charter.md` |
|
|
234
|
+
| プロジェクト文書 | `prj-0001:sch-track-project-definition` | `sch-track-project-definition.yaml` |
|
|
235
|
+
|
|
236
|
+
### 3.4. 参照ルール
|
|
237
|
+
|
|
238
|
+
- frontmatter の `id` は正規IDを使用する
|
|
239
|
+
- プロジェクト文書の正規IDは `<project-id>:<local-id>` とする
|
|
240
|
+
- 同一プロジェクト内の参照では、`<project-id>:` を省略したローカル参照を許可する
|
|
241
|
+
- 他プロジェクトの文書を参照する場合は、完全なIDを使用する
|
|
242
|
+
- プロダクト文書を参照する場合は、ローカルIDをそのまま使用する
|
|
243
|
+
- 生成物・検証結果では、省略参照を解決した正規IDを出力する
|
|
244
|
+
|
|
245
|
+
例:
|
|
246
|
+
|
|
247
|
+
```yaml
|
|
248
|
+
---
|
|
249
|
+
specdojo:
|
|
250
|
+
id: "prj-0001:prj-charter"
|
|
251
|
+
based_on:
|
|
252
|
+
- "prj-overview" # prj-0001:prj-overview として解決
|
|
253
|
+
- "sysd-index" # プロダクト文書ID
|
|
254
|
+
---
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
<details>
|
|
260
|
+
<summary>詳細ルール</summary>
|
|
261
|
+
|
|
262
|
+
## 4. ドキュメントIDの命名ルール
|
|
263
|
+
|
|
264
|
+
### 4.1. IDの種類
|
|
265
|
+
|
|
266
|
+
SpecDojo のドキュメントIDには、次の3種類がある。
|
|
267
|
+
|
|
268
|
+
| 種類 | 形式 | 用途 |
|
|
269
|
+
| ------------------- | ------------------------- | ------------------------------ |
|
|
270
|
+
| ローカルID | `<local-id>` | プロダクト文書 |
|
|
271
|
+
| プロジェクトID | `<project-id>:<local-id>` | プロジェクト文書 |
|
|
272
|
+
| authority付き実践ID | `<authority>:<local-id>` | package が所有する実践体系文書 |
|
|
273
|
+
|
|
274
|
+
### 4.2. プロダクト文書のID
|
|
275
|
+
|
|
276
|
+
プロダクト文書は、SpecDojo Unit 内で一意なローカルIDを使用する。
|
|
277
|
+
|
|
278
|
+
```text
|
|
279
|
+
<local-id>
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
例:
|
|
283
|
+
|
|
284
|
+
```text
|
|
285
|
+
bdd-sales-management
|
|
286
|
+
bdd-common
|
|
287
|
+
sf-product-register
|
|
288
|
+
br-discount
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
プロダクト文書には `product:` のような namespace を付けない。
|
|
292
|
+
|
|
293
|
+
理由は、SpecDojo Unit 自体が1つのプロダクト文脈を表すためである。
|
|
294
|
+
|
|
295
|
+
### 4.3. プロジェクト文書のID
|
|
296
|
+
|
|
297
|
+
プロジェクト文書は、プロジェクトIDを namespace として持つ。
|
|
298
|
+
|
|
299
|
+
```text
|
|
300
|
+
<project-id>:<local-id>
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
例:
|
|
304
|
+
|
|
305
|
+
```text
|
|
306
|
+
prj-0001:prj-overview
|
|
307
|
+
prj-0001:prj-charter
|
|
308
|
+
prj-0001:dct-index
|
|
309
|
+
prj-0001:sch-track-project-definition
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
プロジェクト文書で namespace を付ける理由は、同一 SpecDojo Unit 内に複数プロジェクトが存在し、同じローカルIDが繰り返し使われるためである。
|
|
313
|
+
|
|
314
|
+
例:
|
|
315
|
+
|
|
316
|
+
```text
|
|
317
|
+
prj-0001:prj-overview
|
|
318
|
+
prj-0002:prj-overview
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
### 4.4. 実践体系文書のID
|
|
322
|
+
|
|
323
|
+
package が所有する実践体系文書は、package ごとに定めた authority を namespace として持つ。authority と local-id は英小文字、数字、ハイフンで構成し、`prj-` で始まる authority はプロジェクトIDとの混同を避けるため使用しない。
|
|
324
|
+
|
|
325
|
+
```text
|
|
326
|
+
specdojo:<local-id>
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
ファイル名は local-id と一致させる。例えば `specdojo:track-design-guide` のファイル名は `track-design-guide.md` とする。package のバージョンは ID に含めず、npm package version と lockfile で管理する。
|
|
330
|
+
|
|
331
|
+
### 4.5. local-id の基本構造
|
|
332
|
+
|
|
333
|
+
```text
|
|
334
|
+
<prefix>-<term>
|
|
335
|
+
<prefix>-<kind>-<term>
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
- `prefix`: ドキュメント種別を表す固定語
|
|
339
|
+
- `kind`: prefixを拡張する固定カテゴリ
|
|
340
|
+
- `term`: 内容を表す名詞句
|
|
341
|
+
|
|
342
|
+
例:
|
|
343
|
+
|
|
344
|
+
```text
|
|
345
|
+
bdd-sales-management
|
|
346
|
+
br-discount
|
|
347
|
+
ifx-api-inventory
|
|
348
|
+
ifx-msg-stock-changed
|
|
349
|
+
prj-overview
|
|
350
|
+
dct-project-definition
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### 4.6. kind の命名原則
|
|
354
|
+
|
|
355
|
+
- `<kind>` は語彙を固定し、同義語の混在を禁止する
|
|
356
|
+
- 例: `api`, `msg`, `file`
|
|
357
|
+
- `message`, `messages`, `files` 等は使用しない
|
|
358
|
+
|
|
359
|
+
- `<prefix>-<kind>-<term>` 以上の多段 prefix は使用しない
|
|
360
|
+
|
|
361
|
+
OK:
|
|
362
|
+
|
|
363
|
+
```text
|
|
364
|
+
ifx-api-inventory
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
NG:
|
|
368
|
+
|
|
369
|
+
```text
|
|
370
|
+
ifx-external-api-inventory
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### 4.7. term の命名原則
|
|
374
|
+
|
|
375
|
+
- 名詞句で表現する
|
|
376
|
+
- 動詞単体で始めない
|
|
377
|
+
- 「何についての文書か」が分かることを優先する
|
|
378
|
+
- 配置ディレクトリ、表示順、状態、担当者、作業アクションなど、変更されやすい情報を入れない
|
|
379
|
+
|
|
380
|
+
OK:
|
|
381
|
+
|
|
382
|
+
```text
|
|
383
|
+
product-register
|
|
384
|
+
order-summary
|
|
385
|
+
inventory-adjustment
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
NG:
|
|
389
|
+
|
|
390
|
+
```text
|
|
391
|
+
register-product
|
|
392
|
+
edit-order
|
|
393
|
+
create-invoice
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
### 4.8. index / common の扱い(ID)
|
|
397
|
+
|
|
398
|
+
#### 4.8.1. `-index`(系列の入口・Hub)
|
|
399
|
+
|
|
400
|
+
`<prefix>-index` は、系列の入口として以下を満たす。
|
|
401
|
+
|
|
402
|
+
- 系列の要点を含む
|
|
403
|
+
- 系列内の個別ドキュメントへの導線を含む
|
|
404
|
+
- 個別が存在しない場合でも `-index` を使用し、入口IDを固定する
|
|
405
|
+
- 将来の文書分割に耐えられるようにする
|
|
406
|
+
|
|
407
|
+
`-index` は単なるリンク集ではなく、**要点(SSOT)+関連リンク**を持つ Hub とする。
|
|
408
|
+
|
|
409
|
+
#### 4.8.2. `-common`(横断的・共有定義)
|
|
410
|
+
|
|
411
|
+
`<prefix>-common` は、系列外も含めて参照される共通定義に用いる。
|
|
412
|
+
|
|
413
|
+
- 系列の親子関係を持たない
|
|
414
|
+
- 参照元が複数系列にまたがる定義を置く
|
|
415
|
+
|
|
416
|
+
### 4.9. IDに含めない情報
|
|
417
|
+
|
|
418
|
+
IDには、次の情報を含めない。
|
|
419
|
+
|
|
420
|
+
| 含めない情報 | 理由 |
|
|
421
|
+
| -------------------- | ------------------------------------------------------------------------------------------ |
|
|
422
|
+
| ディレクトリ番号 | 構成変更で変わるため |
|
|
423
|
+
| 表示順 | 並び替えで変わるため |
|
|
424
|
+
| 状態 | `draft`, `approved` などは変化するため |
|
|
425
|
+
| 担当者 | 担当変更で変わるため |
|
|
426
|
+
| 作業アクション | `create`, `modify`, `review` などは Schedule 側の責務であるため |
|
|
427
|
+
| 日付 | IDの永続性を損なうため。ただし議事録・進捗レポートなど時点そのものが識別子になる場合を除く |
|
|
428
|
+
| ディレクトリ上の所属 | 配置ディレクトリが表すため。package の論理的な所有元は authority で表す |
|
|
429
|
+
|
|
430
|
+
### 4.10. 実践体系文書のlocal-id
|
|
431
|
+
|
|
432
|
+
`docs/ja/specdojo/` 配下のフレームワーク文書(guide、standard、reference、rulebook、recipe、sample、template)は、成果物文書の `<prefix>-<term>` とは逆に、主題語の後ろへ文書種別のサフィックスを置く。
|
|
433
|
+
|
|
434
|
+
```text
|
|
435
|
+
<subject>-<type-suffix>
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
- `<subject>`: 文書の主題を表す名詞句
|
|
439
|
+
- `<type-suffix>`: `guide`、`standard`、`reference`、`philosophy`、`rulebook`、`recipe`、`sample`、`template`
|
|
440
|
+
|
|
441
|
+
- package の所有元は `specdojo:` のような authority で表し、local-id に `specdojo-` のような所属接頭辞を重ねない。
|
|
442
|
+
- ただし SpecDojo 自体を主題とする文書は、主題語として `specdojo` を用いる。
|
|
443
|
+
|
|
444
|
+
OK:
|
|
445
|
+
|
|
446
|
+
```text
|
|
447
|
+
specdojo:waza-guide
|
|
448
|
+
specdojo:exec-operation-guide
|
|
449
|
+
specdojo:guide-authoring-standard
|
|
450
|
+
specdojo:specdojo-overview-guide
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
NG:
|
|
454
|
+
|
|
455
|
+
```text
|
|
456
|
+
specdojo-waza-guide
|
|
457
|
+
specdojo-exec-operation-guide
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
## 5. ID参照ルール
|
|
461
|
+
|
|
462
|
+
### 5.1. 正規IDとローカル参照
|
|
463
|
+
|
|
464
|
+
SpecDojo では、frontmatter の `id` には正規IDを使用する。
|
|
465
|
+
|
|
466
|
+
一方、参照フィールドでは、同一プロジェクト内に限りプロジェクト文書のローカル参照を許可する。package所有の実践体系文書は、所有元を曖昧にしないため常に authority 付き完全IDで参照する。
|
|
467
|
+
|
|
468
|
+
#### 5.1.1. 正規ID
|
|
469
|
+
|
|
470
|
+
```yaml
|
|
471
|
+
id: "prj-0001:prj-charter"
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
#### 5.1.2. ローカル参照
|
|
475
|
+
|
|
476
|
+
```yaml
|
|
477
|
+
based_on:
|
|
478
|
+
- "prj-overview"
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
この場合、参照元が `prj-0001` に属していれば、次のIDとして解決する。
|
|
482
|
+
|
|
483
|
+
```text
|
|
484
|
+
prj-0001:prj-overview
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
### 5.2. 参照解決ルール
|
|
488
|
+
|
|
489
|
+
| 参照値 | 参照元 | 解決結果 |
|
|
490
|
+
| ----------------------------- | --------------- | ----------------------------- |
|
|
491
|
+
| `prj-overview` | `prj-0001` 配下 | `prj-0001:prj-overview` |
|
|
492
|
+
| `prj-0002:prj-overview` | 任意 | `prj-0002:prj-overview` |
|
|
493
|
+
| `specdojo:track-design-guide` | 任意 | `specdojo:track-design-guide` |
|
|
494
|
+
| `sysd-index` | 任意 | `sysd-index` |
|
|
495
|
+
| `bdd-common` | 任意 | `bdd-common` |
|
|
496
|
+
|
|
497
|
+
多言語文書では、解決は参照元ファイルの言語と同一言語の variant を優先し、無ければ既定言語へフォールバックする。詳細は `多言語文書のID方針(言語スコープ)` を参照する。
|
|
498
|
+
|
|
499
|
+
### 5.3. 同一プロジェクト内の参照
|
|
500
|
+
|
|
501
|
+
同一プロジェクト内の参照では、`<project-id>:` を省略してよい。
|
|
502
|
+
|
|
503
|
+
例:
|
|
504
|
+
|
|
505
|
+
```yaml
|
|
506
|
+
---
|
|
507
|
+
specdojo:
|
|
508
|
+
id: "prj-0001:prj-charter"
|
|
509
|
+
based_on:
|
|
510
|
+
- "prj-overview"
|
|
511
|
+
---
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### 5.4. 他プロジェクトへの参照
|
|
515
|
+
|
|
516
|
+
他プロジェクトの文書を参照する場合は、完全なIDを使用する。
|
|
517
|
+
|
|
518
|
+
```yaml
|
|
519
|
+
based_on:
|
|
520
|
+
- "prj-0002:prj-overview"
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
### 5.5. プロダクト文書への参照
|
|
524
|
+
|
|
525
|
+
プロダクト文書は namespace を持たないため、そのままローカルIDで参照する。
|
|
526
|
+
|
|
527
|
+
```yaml
|
|
528
|
+
based_on:
|
|
529
|
+
- "bdd-sales-management"
|
|
530
|
+
- "sysd-index"
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### 5.6. 生成物・検証結果での参照
|
|
534
|
+
|
|
535
|
+
生成物や検証結果では、省略参照を解決した正規IDを出力する。
|
|
536
|
+
|
|
537
|
+
人が記述する参照:
|
|
538
|
+
|
|
539
|
+
```yaml
|
|
540
|
+
based_on:
|
|
541
|
+
- "prj-overview"
|
|
542
|
+
```
|
|
543
|
+
|
|
544
|
+
生成物・検証結果での正規化後:
|
|
545
|
+
|
|
546
|
+
```yaml
|
|
547
|
+
based_on:
|
|
548
|
+
- "prj-0001:prj-overview"
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
## 6. ファイル命名ルール
|
|
552
|
+
|
|
553
|
+
### 6.1. 基本方針
|
|
554
|
+
|
|
555
|
+
- ファイル名は人間向けだが、既定はドキュメントIDのローカルIDと同名を推奨する
|
|
556
|
+
- 1ファイルは1ドキュメントIDと対応させる
|
|
557
|
+
- IDはfrontmatterに保持する
|
|
558
|
+
- ファイル名には namespace を含めない
|
|
559
|
+
- 日本語ファイル名を使用してよいが、例外運用とする
|
|
560
|
+
|
|
561
|
+
パスと機械識別子では `specifications` を `specs` と表記します。これは標準用語として認める限定的な短縮であり、`requirements`、`criteria`、`architecture`、`interface`、`operations` は短縮しません。文書タイトルと英語名称では `Specifications` を使用します。
|
|
562
|
+
|
|
563
|
+
```text
|
|
564
|
+
business-specs
|
|
565
|
+
external-interface-specs
|
|
566
|
+
test-specs
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
`business-specifications`、`external-if-specs`、`test-specifications` のように完全形と別の短縮を混在させません。
|
|
570
|
+
|
|
571
|
+
### 6.2. ファイル名の基本構成(推奨)
|
|
572
|
+
|
|
573
|
+
```text
|
|
574
|
+
<local-id>.md
|
|
575
|
+
<local-id>.yaml
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
例:
|
|
579
|
+
|
|
580
|
+
| 種別 | ドキュメントID | 既定のファイル名 |
|
|
581
|
+
| ---------------- | --------------------------------------- | ----------------------------------- |
|
|
582
|
+
| プロダクト文書 | `sysd-index` | `sysd-index.md` |
|
|
583
|
+
| プロダクト文書 | `bdd-common` | `bdd-common.md` |
|
|
584
|
+
| プロジェクト文書 | `prj-0001:prj-overview` | `prj-overview.md` |
|
|
585
|
+
| プロジェクト文書 | `prj-0001:prj-charter` | `prj-charter.md` |
|
|
586
|
+
| 成果物カタログ | `prj-0001:dct-index` | `generated/dct-index.md` |
|
|
587
|
+
| プロジェクト文書 | `prj-0001:sch-track-project-definition` | `sch-track-project-definition.yaml` |
|
|
588
|
+
|
|
589
|
+
### 6.3. namespace とディレクトリの関係
|
|
590
|
+
|
|
591
|
+
プロジェクト文書の namespace は、ファイル名ではなくディレクトリで表現する。
|
|
592
|
+
|
|
593
|
+
例:
|
|
594
|
+
|
|
595
|
+
```text
|
|
596
|
+
docs/ja/projects/prj-0001/prj-overview.md
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
frontmatter:
|
|
600
|
+
|
|
601
|
+
```yaml
|
|
602
|
+
---
|
|
603
|
+
specdojo:
|
|
604
|
+
id: "prj-0001:prj-overview"
|
|
605
|
+
type: project
|
|
606
|
+
status: draft
|
|
607
|
+
---
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
ファイル名に `prj-0001:` は含めない。
|
|
611
|
+
|
|
612
|
+
NG:
|
|
613
|
+
|
|
614
|
+
```text
|
|
615
|
+
prj-0001:prj-overview.md
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
### 6.4. 日本語ファイル名の例外運用
|
|
619
|
+
|
|
620
|
+
日本語ファイル名は、以下のような理由がある場合に例外として許可する。
|
|
621
|
+
|
|
622
|
+
- 対外配布
|
|
623
|
+
- 業務部門レビュー
|
|
624
|
+
- 非エンジニア向け共有
|
|
625
|
+
- 可読性を最優先する成果物
|
|
626
|
+
|
|
627
|
+
日本語ファイル名を使用する場合でも、frontmatter の `id` を正とする。
|
|
628
|
+
|
|
629
|
+
例:
|
|
630
|
+
|
|
631
|
+
```yaml
|
|
632
|
+
---
|
|
633
|
+
specdojo:
|
|
634
|
+
id: "prj-0001:prj-overview"
|
|
635
|
+
---
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
ファイル名:
|
|
639
|
+
|
|
640
|
+
```text
|
|
641
|
+
プロジェクト概要.md
|
|
642
|
+
```
|
|
643
|
+
|
|
644
|
+
### 6.5. suffix 表記ルール(ファイル名)
|
|
645
|
+
|
|
646
|
+
既定運用では、local-idをそのままファイル名として使用する。
|
|
647
|
+
|
|
648
|
+
```text
|
|
649
|
+
xxx-index.md
|
|
650
|
+
xxx-common.md
|
|
651
|
+
```
|
|
652
|
+
|
|
653
|
+
日本語ファイル名運用では、次を推奨する。
|
|
654
|
+
|
|
655
|
+
| 対象 | 推奨 |
|
|
656
|
+
| --------- | ------------------------------------------- |
|
|
657
|
+
| `-index` | suffix を付けず、自然な日本語タイトルにする |
|
|
658
|
+
| `-common` | 識別性のため `-共通` を付けてよい |
|
|
659
|
+
| 個別文書 | `<系列名>-<対象名>.md` とする |
|
|
660
|
+
|
|
661
|
+
例:
|
|
662
|
+
|
|
663
|
+
| ドキュメントID | 既定ファイル名 | 日本語ファイル名例 |
|
|
664
|
+
| ----------------------- | -------------------------- | -------------------------------------------- |
|
|
665
|
+
| `mip-index` | `mip-index.md` | `移行計画.md` |
|
|
666
|
+
| `mtp-index` | `mtp-index.md` | `移行テスト計画.md` |
|
|
667
|
+
| `mtp-cutover-rehearsal` | `mtp-cutover-rehearsal.md` | `移行テスト計画-カットオーバーリハーサル.md` |
|
|
668
|
+
| `bdd-common` | `bdd-common.md` | `業務データ辞書-共通.md` |
|
|
669
|
+
|
|
670
|
+
### 6.6. 連番プレフィックス(任意)
|
|
671
|
+
|
|
672
|
+
並び順が重要であれば、ファイル名またはディレクトリ名に `010-` 等の連番を付けてよい。
|
|
673
|
+
|
|
674
|
+
ただし、連番はIDには含めない。
|
|
675
|
+
|
|
676
|
+
OK:
|
|
677
|
+
|
|
678
|
+
```text
|
|
679
|
+
010-project-definition/prj-overview.md
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
NG:
|
|
683
|
+
|
|
684
|
+
```yaml
|
|
685
|
+
id: "prj-0001:010-prj-overview"
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
## 7. IDとファイル名の対応ルール
|
|
689
|
+
|
|
690
|
+
- すべてのドキュメントは frontmatter またはメタ情報として `id` を保持する
|
|
691
|
+
- Markdown文書は frontmatter に `id` を持つ
|
|
692
|
+
- YAML文書はトップレベルに `id` を持つ
|
|
693
|
+
- ファイル名変更時も ID は不変とする
|
|
694
|
+
- 参照・リンク・トレースは ID を正とする
|
|
695
|
+
- 機械判別は ID に基づいて行い、ファイル名には依存しない
|
|
696
|
+
- 既定としては `ファイル名 = local-id` を推奨する
|
|
697
|
+
|
|
698
|
+
## 8. 参照構造ルール
|
|
699
|
+
|
|
700
|
+
| 種別 | 構造的参照 |
|
|
701
|
+
| ------------- | ---------------------------------- |
|
|
702
|
+
| index | index ⇄ 下位(term) |
|
|
703
|
+
| common | 他 → common(構造親子なし) |
|
|
704
|
+
| project | 同一プロジェクト内はローカル参照可 |
|
|
705
|
+
| cross-project | 完全ID参照必須 |
|
|
706
|
+
|
|
707
|
+
運用ルール:
|
|
708
|
+
|
|
709
|
+
- 系列の入口は `-index` に集約する
|
|
710
|
+
- `-index` は関連ドキュメントへの導線を必ず持つ
|
|
711
|
+
- 個別文書は、必要に応じて `-index` を参照して共通方針・全体基準の重複を避ける
|
|
712
|
+
- 同一プロジェクト内の参照はローカルIDでよい
|
|
713
|
+
- 他プロジェクトへの参照は `<project-id>:<local-id>` を使用する
|
|
714
|
+
- 作成時の根拠は `based_on`、要求・仕様・テスト・実装の意味付き関係は `relations.satisfies` / `relations.verifies` / `relations.implements` を使用する
|
|
715
|
+
- トレース表はID参照から導出する派生ビューとし、独立した手編集のSSOTにしない
|
|
716
|
+
|
|
717
|
+
## 9. IDの変更・置換ルール
|
|
718
|
+
|
|
719
|
+
- IDは原則変更不可
|
|
720
|
+
- 変更が必要な場合は、新IDを作成し、旧IDとの関係を `supersedes` に記載する
|
|
721
|
+
- ID変更後も、既存参照の移行が完了するまで旧IDとの関係を追跡可能にする
|
|
722
|
+
- 呼び方や置き場所を変えたいだけか、文書を作り直したいかで 9.1(経路A)と 9.2(経路B)を使い分ける
|
|
723
|
+
|
|
724
|
+
例:
|
|
725
|
+
|
|
726
|
+
```yaml
|
|
727
|
+
supersedes:
|
|
728
|
+
- "prj-0001:api-order-get-v1"
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
### 9.1. 経路A: ファイル名のみの変更(表示改善・構成変更)
|
|
732
|
+
|
|
733
|
+
用語や置き場所を変えたいだけで、文書としての同一性が変わらない場合に使う。`id`(成果物カタログでは `local_id`)を変更しないため、Schedule のタスクIDにも影響しない、最も影響範囲が小さい経路である。
|
|
734
|
+
|
|
735
|
+
1. `id`(成果物カタログのエントリなら `local_id`)は変更しない(2.3 参照)。
|
|
736
|
+
2. ファイルは `git mv` でリネームし、履歴を保持する。
|
|
737
|
+
3. 成果物カタログ(`dct-*.yaml`)の該当エントリは `path` だけを新しいファイル名に更新し、`local_id` は変更しない。
|
|
738
|
+
4. Schedule(`sch-strategy-<track>.yaml` / `sch-track-<track>.yaml`)は変更不要(`local_id` が不変のため、タスクIDも変わらない)。
|
|
739
|
+
5. wikilink は `[[id|新しい表示名]]` の表示名部分だけを更新する(id 自体は変わらないためリンク解決は保たれる)。
|
|
740
|
+
6. sidebar 設定(`packages/docs-site/.vitepress/sidebar-config.ts` の `PRODUCT_FILE_MENU` / `PROJECTS_FILE_MENU`)のキーを新しいファイル名(拡張子なし)に更新し、表示名も合わせる。
|
|
741
|
+
7. `specdojo index build` → `specdojo catalog validate` → `npm run lint:md` → `npm run docs:build` の順で解決を確認する。
|
|
742
|
+
|
|
743
|
+
### 9.2. 経路B: 新IDへの切替(文書の再定義・分割・統合)
|
|
744
|
+
|
|
745
|
+
文書として作り直したい、または新IDを別立てしたい場合に使う。成果物カタログで Schedule によりタスク化されている deliverable の場合、タスクIDは `local_id` から生成されるため、`local_id` を変更すると生成元が変わり、既存の完了実績とは切り離された新規タスクチェーン(フルフェーズの再展開)が生成される点に注意する。
|
|
746
|
+
|
|
747
|
+
1. 旧IDの成果物カタログエントリ(`local_id` / `path` / `done_criteria` など)は削除せず維持する。すでに Schedule に焼き込まれた過去のタスクIDの参照整合性を保つため。
|
|
748
|
+
2. 新しい `local_id` で成果物カタログへ新規エントリを追加し、新しいファイルを正本にする。
|
|
749
|
+
3. 新ファイルの frontmatter に `supersedes: [<旧id>]` を設定する。
|
|
750
|
+
4. 旧ファイルは `status: deprecated` にし、新IDへの移行を示す最小限の内容(H1 と移行先への案内)へ縮小する。物理配置を `trash` ディレクトリへ移す場合は 9.3 の手順を使う。
|
|
751
|
+
5. 旧IDの実績を新 `local_id` へ引き継ぐ場合は、Schedule 戦略(`sch-strategy-<track>.yaml`)の `initial_state.completed_deliverables` に新 `local_id` を登録する。これにより新 `local_id` はフルフェーズのタスクチェーンを再生成せず、完了済みを示す単一の軽量タスクだけが生成される(フィールド定義は `sch-strategy.schema.yaml` の `initial_state`、運用の考え方は schedule-design-guide.md を参照)。
|
|
752
|
+
6. 旧IDを参照している既存の wikilink・成果物カタログの `depends_on` は、順次新IDへ更新する。旧IDのまま残しても Schedule 上は解決できるが、今後の主参照は新IDに揃えるのが望ましい。
|
|
753
|
+
7. `specdojo schedule build --track <track> --force` → `specdojo exec refresh` → `specdojo catalog validate` の順で整合性を確認する。
|
|
754
|
+
|
|
755
|
+
### 9.3. `trash` ディレクトリへの移動
|
|
756
|
+
|
|
757
|
+
`status: deprecated` にした成果物ファイルを、通常の成果物と混在させたままにすると、ディレクトリを一覧したときに現行文書と誤認されやすい。`id` は変更しない配置変更(経路A の一種)として、`trash` ディレクトリへ移す。
|
|
758
|
+
|
|
759
|
+
- 置き場所は `docs/ja/product/trash/`(プロダクト文書)または `docs/ja/projects/<project-id>/trash/`(プロジェクト文書)とする。連番プレフィックスは付けない。
|
|
760
|
+
- 移動には専用コマンド `specdojo deliverable trash --project <project-id> --local-id <local-id>` を使う。`--dry-run` で移動計画だけ確認できる。
|
|
761
|
+
- このコマンドは、成果物カタログ(`dct-*.yaml`)中の該当エントリを検出し、`git mv` でファイルを移動したうえで、そのエントリの `path` フィールドだけを新しい絶対パスへ書き換える(`local_id` は変更しないため、他のフィールドや YAML 中のコメント・整形はそのまま残る)。
|
|
762
|
+
- `status` の変更はコマンドの対象外である。`status: deprecated` への変更は 9.2 の手順(または該当文書の finalize/確定手順)で別途行う。コマンドは `specdojo.status` が `deprecated` でない場合に警告を出すのみで、値は書き換えない。
|
|
763
|
+
- 対応先が `docs/ja/product/**` でも `docs/ja/projects/<project-id>/**` でもない場合はエラーで終了する(対象外の配置)。
|
|
764
|
+
|
|
765
|
+
```sh
|
|
766
|
+
specdojo deliverable trash --project prj-0001 --local-id cdfd-register-operation --dry-run
|
|
767
|
+
specdojo deliverable trash --project prj-0001 --local-id cdfd-register-operation
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
## 10. NGパターン
|
|
771
|
+
|
|
772
|
+
| パターン | 理由 |
|
|
773
|
+
| --------------------------------------------------- | ------------------------------------------------------------------ |
|
|
774
|
+
| `Order_API_v1` | 大文字・アンダースコア・記号 |
|
|
775
|
+
| `create-order-api` | 動詞主導 |
|
|
776
|
+
| `sf-list` | 一覧・入口は `index` を使う |
|
|
777
|
+
| `bdd-main` | 役割が曖昧 |
|
|
778
|
+
| `ifx-inventory-api` | kind は prefix 直後に置く |
|
|
779
|
+
| `product:sf-index` | SpecDojo Unit がプロダクト文脈を表すため、product namespace は不要 |
|
|
780
|
+
| `prj-overview` を複数プロジェクトの正本IDとして使う | プロジェクト間で衝突する |
|
|
781
|
+
| `prj-0001-prj-overview` | project-id と local-id の境界が曖昧 |
|
|
782
|
+
| `prj-0001:010-prj-overview` | 表示順をIDに含めている |
|
|
783
|
+
| `prj-0001:prj-overview-draft` | 状態をIDに含めている |
|
|
784
|
+
| `prj-0001:prj-overview.md` | ファイル名に namespace を含めている |
|
|
785
|
+
| `specdojo-waza-guide` | authority と local-id の境界が曖昧。`specdojo:waza-guide` とする |
|
|
786
|
+
|
|
787
|
+
## 11. 運用指針
|
|
788
|
+
|
|
789
|
+
- 迷ったら「これは何についての文書か?」を名詞で考える
|
|
790
|
+
- プロダクト文書はローカルIDを使う
|
|
791
|
+
- プロジェクト文書は `<project-id>:<local-id>` を使う
|
|
792
|
+
- package 所有の実践体系文書は `<authority>:<local-id>` を使い、SpecDojo core は `specdojo:` とする
|
|
793
|
+
- 同一プロジェクト内の参照では `<project-id>:` を省略してよい
|
|
794
|
+
- 他プロジェクトへの参照では完全IDを使う
|
|
795
|
+
- 入口は `-index`、横断定義は `-common` を使う
|
|
796
|
+
- IDは設計資産、ファイル名は表示資産として扱う
|
|
797
|
+
- lint / CI / 生成AI は ID を正として扱う
|
|
798
|
+
- 新規作成時は原則として `ファイル名 = local-id` を採用する
|
|
799
|
+
- 既存文書は段階的に移行する
|
|
800
|
+
- 日本語ファイル名は例外として許可するが、frontmatter の `id` は必ず保持する
|
|
801
|
+
|
|
802
|
+
</details>
|
|
803
|
+
|
|
804
|
+
---
|
|
805
|
+
|
|
806
|
+
## 12. 用語の対応表
|
|
807
|
+
|
|
808
|
+
日本語の用語と英語の予約語・用語は以下のように対応させてください。
|
|
809
|
+
|
|
810
|
+
### 12.1. 予約語と日本語名称との対応(更新)
|
|
811
|
+
|
|
812
|
+
| 予約語 | 日本語名称 | 意味・役割 |
|
|
813
|
+
| -------------- | ---------------- | ---------------------------------- |
|
|
814
|
+
| **index** | **入口(全体)** | 系列の入口(要点SSOT+関連リンク) |
|
|
815
|
+
| **common** | **共通** | 横断的・共有定義 |
|
|
816
|
+
| **rules** | **ルール** | 強制ルール・規約(逸脱不可) |
|
|
817
|
+
| **guide** | **ガイド** | 案内・読み物・使い方 |
|
|
818
|
+
| **reference** | **リファレンス** | 一覧・比較・値の参照 |
|
|
819
|
+
| **philosophy** | **考え方** | 規約の前提となる方針・概念 |
|
|
820
|
+
|
|
821
|
+
## 13. 主要な英語用語と日本語用語との対応
|
|
822
|
+
|
|
823
|
+
| 英語用語 | 日本語用語 | 意味 |
|
|
824
|
+
| ----------------------- | ------------ | -------------------------------------------------- |
|
|
825
|
+
| **need** | **要求** | ユーザー・業務の目的・欲求・困りごと |
|
|
826
|
+
| **requirement** | **要件** | システムとして満たすべき条件 |
|
|
827
|
+
| **specification** | **仕様** | システムに守らせるルール(テストで合否判定できる) |
|
|
828
|
+
| **design** | **設計** | 構造・方式・構成としてどう実現するか |
|
|
829
|
+
| **implementation** | **実装** | コード・設定としての実現 |
|
|
830
|
+
| **definition** | **定義** | 世界の言葉・概念(正誤や合否を判定しない) |
|
|
831
|
+
| **constraint** | **制約** | 設計・実装に課される制限条件 |
|
|
832
|
+
| **acceptance criteria** | **受入条件** | 利用者視点での合格基準 |
|
|
833
|
+
|
|
834
|
+
## 14. ドキュメント種別とプレフィックスの対応表(更新)
|
|
835
|
+
|
|
836
|
+
### 14.1. プロジェクト関係ドキュメント
|
|
837
|
+
|
|
838
|
+
<!-- prettier-ignore -->
|
|
839
|
+
| 種別 | English | prefix | local-id例 | プロジェクト文書ID例 |
|
|
840
|
+
| --- | --- | --- | --- | --- |
|
|
841
|
+
| プロジェクト概要 | Project Overview | prj- | prj-overview | prj-0001:prj-overview |
|
|
842
|
+
| プロジェクト憲章 | Project Charter | prj- | prj-charter | prj-0001:prj-charter |
|
|
843
|
+
| ステークホルダー登録簿 | Stakeholder Register | prj- | prj-stakeholder-register | prj-0001:prj-stakeholder-register |
|
|
844
|
+
| プロジェクトスコープ | Project Scope | prj- | prj-scope | prj-0001:prj-scope |
|
|
845
|
+
| 成功条件・受入条件 | Success Criteria and Acceptance Criteria | prj- | prj-success-criteria-and-acceptance-criteria | prj-0001:prj-success-criteria-and-acceptance-criteria |
|
|
846
|
+
| 成果物カタログ | Deliverables Catalog | dct- | dct-index, dct-project-definition | prj-0001:dct-index, prj-0001:dct-project-definition |
|
|
847
|
+
| プロジェクト課題と解決アプローチ | Project Issues and Approach | prj- | prj-issues-and-approach | prj-0001:prj-issues-and-approach |
|
|
848
|
+
| 前提・制約・依存 | Assumptions, Constraints, and Dependencies | prj- | prj-assumptions-constraints-dependencies | prj-0001:prj-assumptions-constraints-dependencies |
|
|
849
|
+
| 代替案の比較 | Comparison of Alternatives | prj- | prj-comparison-of-alternatives | prj-0001:prj-comparison-of-alternatives |
|
|
850
|
+
| 現状定義 | Current State Definition | - | cdfd-sales | prj-0001:cdfd-sales |
|
|
851
|
+
| 影響調査 | Impact Analysis | imp- | imp-business | prj-0001:imp-business |
|
|
852
|
+
| プロジェクトマネジメント計画 | Project Management Plan | pm- | pm-plan | prj-0001:pm-plan |
|
|
853
|
+
| スケジュール | Schedule | sch- | sch-milestones, sch-defaults, sch-track-project-definition, sch-strategy-project-definition | prj-0001:sch-track-project-definition |
|
|
854
|
+
| トラック順序計画 | Timeline | tml- | tml-index | prj-0001:tml-index |
|
|
855
|
+
| エージェント実行戦略 | Exec Strategy | exec-strategy- | exec-strategy-launch | prj-0001:exec-strategy-launch |
|
|
856
|
+
| コミュニケーション計画 | Communication Plan | pm- | pm-communication-plan | prj-0001:pm-communication-plan |
|
|
857
|
+
| 品質管理計画 | Quality Management Plan | pm- | pm-quality-management-plan | prj-0001:pm-quality-management-plan |
|
|
858
|
+
| リスク登録簿 | Risk Register | pm- | pm-risk-register | prj-0001:pm-risk-register |
|
|
859
|
+
| 課題ログ | Issue Log | pm- | pm-issue-log | prj-0001:pm-issue-log |
|
|
860
|
+
| 変更要求ログ | Change Request Log | pm- | pm-change-request-log | prj-0001:pm-change-request-log |
|
|
861
|
+
| 決定ログ | Decision Log | pm- | pm-decision-log | prj-0001:pm-decision-log |
|
|
862
|
+
| プロジェクト登録簿 | Project Register | pjr- | pjr-index, pjr-0001-auth | prj-0001:pjr-index, prj-0001:pjr-0001-auth |
|
|
863
|
+
| 進捗レポート | Progress Report | pr- | pr-2026-03-01-01 | prj-0001:pr-2026-03-01-01 |
|
|
864
|
+
| 議事録 | Meeting Minutes | mm- | mm-2026-03-01-01 | prj-0001:mm-2026-03-01-01 |
|
|
865
|
+
| 体制・RACI | Organization and RACI | pm- | pm-organization | prj-0001:pm-organization |
|
|
866
|
+
|
|
867
|
+
現状定義は専用prefixを設けず、`040-current-state/` 配下に必要なプロダクト文書を同じ local-id で配置する。
|
|
868
|
+
|
|
869
|
+
### 14.2. プロダクト関係ドキュメント
|
|
870
|
+
|
|
871
|
+
<!-- prettier-ignore -->
|
|
872
|
+
| 種別 | English | prefix | 例 |
|
|
873
|
+
| --- | --- | --- | --- |
|
|
874
|
+
| 概念データフロー図 | Conceptual Data Flow Diagram | cdfd- | cdfd-overview, cdfd-sales |
|
|
875
|
+
| 概念データフロー図(ユースケース別) | Conceptual Data Flow Diagram (Use Case) | cdfd-uc- | cdfd-uc-credit-sales, cdfd-uc-replenishment |
|
|
876
|
+
| 概念クラス図 | Conceptual Class Diagram | ccd- | ccd-customer |
|
|
877
|
+
| 業務データ辞書 | Business Data Dictionary | bdd- | bdd-common, bdd-sales |
|
|
878
|
+
| 概念データストア定義 | Conceptual Data Store Definition | cdsd- | cdsd-common, cdsd-sales |
|
|
879
|
+
| 保管場所定義 | Storage Location Definition | sld- | sld-common, sld-sales |
|
|
880
|
+
| ステータス定義(状態一覧・状態遷移図) | Status Definition | stsd- | stsd-product |
|
|
881
|
+
| 分類定義 | Classification Definition | cld- | cld-product |
|
|
882
|
+
| 業務プロセス仕様 | Business Process Specification | bps- | bps-order-flow |
|
|
883
|
+
| ビジネスルール | Business Rule | br- | br-discount |
|
|
884
|
+
| 画面仕様 | UI Specification | uis- | uis-order-edit |
|
|
885
|
+
| 帳票仕様 | Business Document Specification | bds- | bds-order-summary |
|
|
886
|
+
| システム化機能 | System Function | sf- | sf-index, sf-product-register |
|
|
887
|
+
| 業務イベント仕様 | Business Event Specification | bes- | bes-index, bes-order-approved |
|
|
888
|
+
| 業務受入条件 | Business Acceptance Criteria | bac- | bac-order-approved |
|
|
889
|
+
| 用語集 / 用語 | Glossary / Term | gl- / tm- | gl-sales / tm-reorder-point |
|
|
890
|
+
| 外部システムI/F | External System Interface | ifx- | ifx-index |
|
|
891
|
+
| 外部API仕様 | External API Specification | ifx-api- | ifx-api-inventory |
|
|
892
|
+
| 外部ファイル連携仕様 | External File Exchange Specification | ifx-file- | ifx-file-order |
|
|
893
|
+
| 外部メッセージ仕様 | External Message Specification | ifx-msg- | ifx-msg-stock-changed |
|
|
894
|
+
| 外部コマンド連携仕様 | External Command Interface Specification | ifx-cmd- | ifx-cmd-supplier-order |
|
|
895
|
+
| コンテキスト図 | Context Diagram | cxd- | cxd-customer |
|
|
896
|
+
| コンテナ図 | Container Diagram | cnd- | cnd-customer |
|
|
897
|
+
| コンポーネント図 | Component Diagram | cpd- | cpd-inventory |
|
|
898
|
+
| インフラ構成図 | Infrastructure Diagram | ifd- | ifd-index |
|
|
899
|
+
| 技術スタック定義 | Technology Stack Definition | tsd- | tsd-index |
|
|
900
|
+
| システム設計-全体構成 | System Design Index | sysd- | sysd-index |
|
|
901
|
+
| システム設計-重要フロー | System Design Critical Flows | sysd- | sysd-critical-flows |
|
|
902
|
+
| システム設計-横断ルール | System Design Cross-cutting Policy | sysd- | sysd-cross-cutting-policy |
|
|
903
|
+
| 非機能要件 | Non-Functional Requirements | nfr- | nfr-performance |
|
|
904
|
+
| システム受入条件 | System Acceptance Criteria | sac- | sac-performance |
|
|
905
|
+
| テスト戦略・方針 | Test Strategy and Policy | tsp- | tsp-index |
|
|
906
|
+
| 単体テストカタログ | Unit Test Catalog | utc- | utc-index, utc-product-service |
|
|
907
|
+
| 内部結合テストカタログ | Internal Integration Test Catalog | itc- | itc-index, itc-product-service |
|
|
908
|
+
| 外部結合テストカタログ | External Integration Test Catalog | etc- | etc-index, etc-product-service |
|
|
909
|
+
| 総合テストカタログ | System Test Catalog | stc- | stc-index, stc-product-service |
|
|
910
|
+
| 受入テストカタログ | Acceptance Test Catalog | atc- | atc-index, atc-product-service |
|
|
911
|
+
|
|
912
|
+
### 14.3. 移行関係ドキュメント
|
|
913
|
+
|
|
914
|
+
<!-- prettier-ignore -->
|
|
915
|
+
| 種別 | English | prefix | 例 |
|
|
916
|
+
| --- | --- | --- | --- |
|
|
917
|
+
| 移行計画 | Migration Plan | mip- | mip-index |
|
|
918
|
+
| データ移行設計 | Data Migration Design | dmd- | dmd-index, dmd-order-data |
|
|
919
|
+
| 移行テスト計画(リハーサル計画) | Migration Test Plan | mtp- | mtp-index, mtp-cutover-rehearsal |
|
|
920
|
+
| カットオーバー計画(本番切替手順) | Cutover Plan | cop- | cop-index, cop-cutover-runbook |
|
|
921
|
+
| 運用切替計画(ハイパーケア含む) | Operations Transition Plan | otp- | otp-index |
|
|
922
|
+
|
|
923
|
+
### 14.4. 運用関係ドキュメント
|
|
924
|
+
|
|
925
|
+
<!-- prettier-ignore -->
|
|
926
|
+
| 種別 | English | prefix | 例 |
|
|
927
|
+
| --- | --- | --- | --- |
|
|
928
|
+
| 運用方針・設計 | Operations Policy and Design | opd- | opd-index, opd-monitoring |
|
|
929
|
+
| 運用手順 | Operations Runbook | opr- | opr-index, opr-incident, opr-backup-restore |
|