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,151 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:sample-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Sample 記述標準
|
|
9
|
+
|
|
10
|
+
Sample Authoring Standard
|
|
11
|
+
|
|
12
|
+
`docs/ja/specdojo/samples/` 配下の各 `*-sample.(md|yaml|json)` が従うべき構成・記述ルール・禁止事項・運用ルールを定義します。Frontmatter(メタ情報)の規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では扱いません。
|
|
13
|
+
|
|
14
|
+
## 1. 適用範囲
|
|
15
|
+
|
|
16
|
+
- 対象: `docs/ja/specdojo/samples/` 配下のすべての `*-sample.(md|yaml|json)`
|
|
17
|
+
- 目的: sample の構成・記述品質を統一し、粒度・文体・表の書き方を確認できる完成最小例を提供する
|
|
18
|
+
- 一次根拠: 対応する `docs/ja/specdojo/rulebooks/<prefix>-rulebook.md`
|
|
19
|
+
- Frontmatter 規約の正本: [document-metadata-standard.md](document-metadata-standard.md)
|
|
20
|
+
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
21
|
+
|
|
22
|
+
## 2. サンプル群の目的
|
|
23
|
+
|
|
24
|
+
sample は個別ドキュメントの書式例であると同時に、同じプロジェクトを題材として要求・設計・実装・テスト・運用の成果物がどうつながるかを示す一連の完成例です。
|
|
25
|
+
|
|
26
|
+
- rulebook の必須要素を満たす最小例を提示し、抽象的な規約を具体的な記述へ変換する。
|
|
27
|
+
- 複数の sample で背景、用語、登場人物、制約、数値目標を共有し、成果物間のトレーサビリティを読み取れるようにする。
|
|
28
|
+
- 小規模で理解しやすい題材を使い、ドキュメント種別ごとの役割と粒度の違いを学べるようにする。
|
|
29
|
+
- サンプルのために過度な機能や登場人物を追加せず、対象ドキュメントの説明に必要な範囲へ記述を限定する。
|
|
30
|
+
|
|
31
|
+
sample は実在プロジェクトの記録ではありません。記載値は学習・例示のための仮定を含みますが、同じ仮定を複数文書で使用する場合は値と意味を統一します。
|
|
32
|
+
|
|
33
|
+
## 3. 共通サンプル文脈
|
|
34
|
+
|
|
35
|
+
### 3.1. 物語上の背景
|
|
36
|
+
|
|
37
|
+
主人公は CoderDojo に通う小学6年生の算野創太です。祖母の算野きぬが営む「駄菓子屋きぬや」で、加齢に伴う物忘れにより販売記録や在庫確認などの問題が増えてきたため、創太は祖母と店の運営を支援するシステムを作ることを決意します。
|
|
38
|
+
|
|
39
|
+
この共通シナリオは、駄菓子屋の問題解決と、創太が周囲の助言を受けながらシステム開発を学ぶ過程を扱います。業務成果物の sample では物語表現を前面に出さず、必要な背景・関係者・判断根拠だけを業務文書として記述します。
|
|
40
|
+
|
|
41
|
+
### 3.2. プロジェクト概要
|
|
42
|
+
|
|
43
|
+
プロジェクト名は「駄菓子屋きぬや 販売管理システム構築」とします。地域の子どもたちに長年親しまれている駄菓子屋きぬやでは、販売記録、在庫管理、常連客のつけ管理をノートと店主の記憶に頼っています。
|
|
44
|
+
|
|
45
|
+
主な問題は次のとおりです。
|
|
46
|
+
|
|
47
|
+
- 人気商品の欠品が増えている。
|
|
48
|
+
- 仕入れのタイミングと数量が勘に依存し、在庫の過不足が生じている。
|
|
49
|
+
- 常連客のつけ管理が曖昧で、記録漏れや残高確認の手間が発生している。
|
|
50
|
+
- 店主以外が店番をすると、販売、在庫、つけの状況を同じ手順で確認できない。
|
|
51
|
+
|
|
52
|
+
### 3.3. 目的と必要性
|
|
53
|
+
|
|
54
|
+
- 駄菓子の販売、在庫、顧客情報、つけ残高をシンプルに一元管理する。
|
|
55
|
+
- 店主一人でも無理なく使える画面と操作フローを提供する。
|
|
56
|
+
- 家族が店番する場合も同じ手順で販売と在庫確認を行えるようにする。
|
|
57
|
+
- 店主の経験と記憶だけに依存せず、店舗運営を継続できる状態を作る。
|
|
58
|
+
- 初期リリースでは日々の記録を安定させ、後続の仕入れ改善や分析の基礎データを蓄積する。
|
|
59
|
+
|
|
60
|
+
### 3.4. 期待効果
|
|
61
|
+
|
|
62
|
+
| 観点 | 初期目標 | 測定の考え方 |
|
|
63
|
+
| ---------- | ------------------------------- | ---------------------------------------- |
|
|
64
|
+
| 欠品削減 | 人気商品の欠品回数を月間50%削減 | 対象商品を定め、欠品発生を日次で記録する |
|
|
65
|
+
| 在庫適正化 | 在庫の無駄を年間20%削減 | 廃棄、値引き、長期滞留を月次で集計する |
|
|
66
|
+
| つけ管理 | つけ残高を1分以内で確認可能 | 顧客検索から残高確認までの時間を計測する |
|
|
67
|
+
| 継続運用 | 営業日の90%以上で記録を継続 | 販売、在庫、つけの記録有無を日次確認する |
|
|
68
|
+
|
|
69
|
+
数値はサンプル群で使用する初期仮説です。成果物の目的に応じて測定期間や判定条件を具体化しますが、別の値へ変更する場合は関連 sample も同時に整合させます。
|
|
70
|
+
|
|
71
|
+
### 3.5. 前提条件
|
|
72
|
+
|
|
73
|
+
- 当面は単一店舗で運用し、複数店舗展開は対象外とする。
|
|
74
|
+
- 店頭で使用する端末は1台のタブレットを前提とする。
|
|
75
|
+
- 店舗の運用体制を大きく変えず、現行の販売手順に近い操作を優先する。
|
|
76
|
+
- 初期リリースは店頭販売、在庫、つけ管理を対象とし、EC、本格会計、仕入れ先とのシステム連携は対象外とする。
|
|
77
|
+
- 店主が最終的な業務判断を行い、システムは記録と確認を支援する。
|
|
78
|
+
- リリース日程、費用上限、オフライン時の運用など未確定の事項は、対象成果物で _UNDECIDED_: または _ASSUMPTION_: として明示する。
|
|
79
|
+
|
|
80
|
+
### 3.6. 共通登場人物
|
|
81
|
+
|
|
82
|
+
| 名前 | 年齢 | 性別 | sample 内の役割 | 役割の説明 | nickname | 人物の説明 |
|
|
83
|
+
| ---------- | ---- | ---- | -------------------- | ---------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------------------- |
|
|
84
|
+
| 算野創太 | 12 | 男 | 開発担当 | 要件を実現するための設計、実装、動作確認を担当する | `developer` | 主人公。小学6年生の天才少年。プログラミングが得意で CoderDojo に通う |
|
|
85
|
+
| 算野きぬ | 75 | 女 | 店主代表 | プロジェクトの目的、優先順位、業務要件、最終判断を担う | `shop-owner` | 創太の祖母。駄菓子屋きぬやの店主。物忘れが激しいが優しい性格 |
|
|
86
|
+
| 堂ノ前進 | 32 | 男 | 技術メンター | 設計・実装方針を助言し、技術的な判断と問題解決を支援する | `technical-mentor` | CoderDojo のメンター。創太の師匠であり、設計・開発上のアドバイザー |
|
|
87
|
+
| 踊川舞 | 12 | 女 | 利用者代表 | 店頭利用者の操作性、分かりやすさ、受入条件について意見を出す | `user-representative` | 創太の幼なじみ。ダンスが得意で、創太を支える駄菓子屋の常連 |
|
|
88
|
+
| 金田玲奈 | 12 | 女 | 顧客代表 | 顧客として期待するサービス、会計、つけ管理の観点を提供する | `customer-representative` | 創太の小学校の友人。裕福な家庭の令嬢で、実は駄菓子屋の常連 |
|
|
89
|
+
| 剛力大地 | 12 | 男 | リスク観点協力者 | 誤操作、不正利用、想定外行動などのリスク観点を提供する | `risk-reviewer` | 創太のクラスメイト。いたずら好きで乱暴に見えるが、寂しがり屋 |
|
|
90
|
+
| 風間隼人 | 12 | 男 | 同行レビュー担当 | 成果物や実装を第三者視点で確認し、改善点や競合案を提示する | `peer-reviewer` | 創太のクラスメイト。創太にライバル心を抱く一方、内心では尊敬している |
|
|
91
|
+
| 青葉菜男 | 55 | 男 | 地域店舗代表 | 小規模店舗の運営経験から、販売・在庫業務に関する意見を提供する | `local-shop-owner` | 青葉青果の店主。明るく世話好きで、算野家の活動をよく手伝う |
|
|
92
|
+
| 肉山力 | 50 | 男 | 地域協力者 | 店舗作業、導入準備、地域との調整など実務面の支援を行う | `community-supporter` | 肉山精肉店の店主。豪快で力持ち。算野家と駄菓子屋の常連 |
|
|
93
|
+
| 金森鉄子 | 60 | 女 | 店舗運営アドバイザー | 店舗運用、引継ぎ、障害時対応、継続運用の観点から助言する | `operations-advisor` | 金森金物店の店主。しっかり者で面倒見がよく、算野家を支援する |
|
|
94
|
+
| 春野さくら | 24 | 女 | 家族利用者代表 | 家族による店番や、子どもにも分かりやすい利用方法の観点を提供する | `family-user-representative` | 創太のいとこ。保育士で明るく優しい性格を持ち、子どもたちから親しまれている |
|
|
95
|
+
|
|
96
|
+
人物名はこの共通人物台帳と物語文書だけで管理し、`docs/ja/specdojo/samples/` 配下の sample には記載しません。各 sample では対象成果物に関係する人物だけを、次の識別方法で記述します。
|
|
97
|
+
|
|
98
|
+
- 本文、表の表示名、ステークホルダー名には「店主代表」「開発担当」「利用者代表」などの役割名を使用する。
|
|
99
|
+
- Member や実行主体の安定識別子が必要な項目には、表に定義した役割ベースの `nickname` を使用する。
|
|
100
|
+
- Schedule の `owner`、RACI、承認責任など責務を表す項目には、`PO` / `BA` / `ARC` / `DEV` / `QE` などの Role code を使用する。
|
|
101
|
+
- 人物名を nickname に変形した値、イニシャル、愛称は使用しない。nickname は人物が交代しても意味が変わらない役割ベースの名前とする。
|
|
102
|
+
- 役割名、nickname、Role code のどれを使うかは、[people-and-organization-definition-standard.md](people-and-organization-definition-standard.md) の Role / Member / Task owner の区分に従う。
|
|
103
|
+
|
|
104
|
+
## 4. 出力フォーマットと命名
|
|
105
|
+
|
|
106
|
+
- ファイル名は `<prefix>-sample.md` / `<prefix>-sample.yaml` / `<prefix>-sample.json` とし、対応 rulebook の `target_format` に合わせる。
|
|
107
|
+
- `target_format` が未記載の場合は markdown を対象とみなす。
|
|
108
|
+
- Markdown の場合、H1 はファイル内で 1 つだけとし、`id` / `type` / `status` / `rulebook` を含む Frontmatter を先頭に置く。
|
|
109
|
+
- YAML / JSON の場合、対応 rulebook が定める先頭メタ項目・ルートキー・必須キーを満たす。
|
|
110
|
+
|
|
111
|
+
## 5. 構成の原則
|
|
112
|
+
|
|
113
|
+
- 章構成・必須表は対応 rulebook の `本文構成(標準テンプレ)` に従い、sample 独自の章立てを作らない。
|
|
114
|
+
- Markdown の見出しは `##` から開始し、章番号は 1 始まりの連番、末尾に `.` を付ける。
|
|
115
|
+
- 必須章をすべて満たしつつ、最小の記述量で完成例として成立させる。
|
|
116
|
+
- 任意章は、完成例として理解を助ける場合に限り含める。
|
|
117
|
+
|
|
118
|
+
## 6. 記述ガイド
|
|
119
|
+
|
|
120
|
+
- sample は対応 rulebook を一次根拠とし、必須要件を満たす最小記述例に再構成する。
|
|
121
|
+
- rulebook の本文を丸写しせず、完成した記述例として書き下す。
|
|
122
|
+
- 用語は参照元の rulebook と整合させ、命名ゆれを持ち込まない。
|
|
123
|
+
- 業務文脈は `共通サンプル文脈` に統一する。前提が不足する場合は同文脈で合理的に仮定し、複数文書へ影響する仮定は本書へ反映する。
|
|
124
|
+
- 対象人物は人物名で記載せず、`共通登場人物` に定義した役割名、役割ベースの `nickname`、または Role code で記述する。
|
|
125
|
+
- 曖昧語を避け、粒度・文体・表の書き方が手本になる判定可能な記述にする。
|
|
126
|
+
- リンクはファイルがある場合に記載し、ない場合はバッククォートで仮置きする。
|
|
127
|
+
|
|
128
|
+
## 7. 内容充実化(薄いドキュメント防止)
|
|
129
|
+
|
|
130
|
+
- 各必須章に、対応 rulebook が要求する具体項目をすべて埋める。
|
|
131
|
+
- 「適切に」「十分に」などの抽象語だけで終わらせず、判断可能な記述にする。
|
|
132
|
+
- 表が要求される章では、カラムを埋めた実例を 1 行以上示す。
|
|
133
|
+
- 数値・指標を扱う章では、測定方法や判定の前提が読み取れるようにする。
|
|
134
|
+
- ただし、実装依存の詳細(SQL 全文、具体クラス名、詳細 API 設計)には踏み込まない。
|
|
135
|
+
|
|
136
|
+
## 8. 禁止事項
|
|
137
|
+
|
|
138
|
+
- 章番号なし見出し(例: `## 基本情報`)を使用しない(Markdown の場合)。
|
|
139
|
+
- 章番号末尾の `.` を省略しない。
|
|
140
|
+
- 共通の業務文脈以外の業種題材を混在させない。
|
|
141
|
+
- sample の本文、表、ID、nickname に共通登場人物の人物名、人物名由来の識別子、愛称を使用しない。
|
|
142
|
+
- rulebook の本文をそのまま複製しない。
|
|
143
|
+
- デッドリンクを記載しない。
|
|
144
|
+
- sample 本文に実装詳細(SQL 全文、具体クラス名、詳細 API 設計)を書かない。
|
|
145
|
+
- 対応 rulebook の禁止事項に抵触する記述を含めない。
|
|
146
|
+
|
|
147
|
+
## 9. 運用ルール
|
|
148
|
+
|
|
149
|
+
- 対応 rulebook の本文構成が変わった場合は、sample の章構成と必須表を追従させる。
|
|
150
|
+
- `共通サンプル文脈` が更新された場合は、関連する既存 sample、`.github/instructions/sample.instructions.md`、`upsert-sample` Skill との整合を確認する。
|
|
151
|
+
- 表は必要に応じて `SpecDojo: Format Markdown Table` コマンドで揃える。
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:standard-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Standard 記述標準
|
|
9
|
+
|
|
10
|
+
Standard Authoring Standard
|
|
11
|
+
|
|
12
|
+
`docs/ja/specdojo/standards/` 配下の各 `*-standard.md` が従うべき章立て・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
13
|
+
|
|
14
|
+
## 1. 適用範囲
|
|
15
|
+
|
|
16
|
+
- 対象: `docs/ja/specdojo/standards/` 配下のすべての `*-standard.md`
|
|
17
|
+
- 目的: standard の章構成・記述品質を統一し、判定可能な規範を定義する
|
|
18
|
+
- 位置づけ: standard は規範(must / 規約)を定義する。判断や検証に使える基準を扱い、手順や使い方は guide に委譲する
|
|
19
|
+
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
20
|
+
- 参照スキーマ: [standard-frontmatter.schema.yaml](../../../specdojo/schemas/v1/standard-frontmatter.schema.yaml)
|
|
21
|
+
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
22
|
+
|
|
23
|
+
## 2. 見出しレベルと章番号の原則
|
|
24
|
+
|
|
25
|
+
- `#` はタイトルのみ。章は `##` から開始する。
|
|
26
|
+
- 章番号は 1 始まりの連番。スキップしない(例: `## 1.`, 次は `## 2.`)。
|
|
27
|
+
- 章番号末尾には必ず `.` を付ける。
|
|
28
|
+
- 章への参照は章番号ではなく章タイトルで記載する。
|
|
29
|
+
- タイトル直下に **英語名(1行)** を置き、その直下に **目的・概要(1〜3文)** を置く。
|
|
30
|
+
|
|
31
|
+
## 3. Frontmatter 規約
|
|
32
|
+
|
|
33
|
+
- ファイル名は `<name>-standard.md` とする。
|
|
34
|
+
- `id` / `type` / `status` を必須とし、共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
35
|
+
- `type` は `standard` 固定とする。
|
|
36
|
+
- `id` はauthority、英小文字・数字・ハイフンで構成し、一意にする(正確な制約は参照スキーマに従う)。
|
|
37
|
+
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
38
|
+
|
|
39
|
+
| 項目 | 必須 | 説明 |
|
|
40
|
+
| ---------- | ---- | ---------------------------------------- |
|
|
41
|
+
| id | ○ | `specdojo:<name>-standard` 形式の一意 ID |
|
|
42
|
+
| type | ○ | `standard` 固定 |
|
|
43
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
44
|
+
| based_on | 任意 | 上位規約や根拠ドキュメント |
|
|
45
|
+
| supersedes | 任意 | 置き換え関係 |
|
|
46
|
+
|
|
47
|
+
- 機械検証は [standard-frontmatter.schema.yaml](../../../specdojo/schemas/v1/standard-frontmatter.schema.yaml) を SSOT とする。
|
|
48
|
+
|
|
49
|
+
記述例:
|
|
50
|
+
|
|
51
|
+
```yaml
|
|
52
|
+
---
|
|
53
|
+
specdojo:
|
|
54
|
+
id: specdojo:id-and-file-naming-standard
|
|
55
|
+
type: standard
|
|
56
|
+
status: draft
|
|
57
|
+
---
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## 4. 標準章構成(`*-standard.md`)
|
|
61
|
+
|
|
62
|
+
章構成は以下を原則とする。不要な章は省略可だが、省略理由を記載することを推奨する。
|
|
63
|
+
|
|
64
|
+
| 章番号 | 章タイトル | 必須 | 説明 |
|
|
65
|
+
| ------ | ------------------ | ---- | -------------------------------------------------- |
|
|
66
|
+
| 1 | 目的・適用範囲 | ○ | 何を規定する標準か、適用対象を示す |
|
|
67
|
+
| 2 | 基本方針 | ○ | 標準が依拠する原則・前提を示す |
|
|
68
|
+
| 3 | 規範本体 | ○ | 判定可能な規約・ルールを定義する(複数章に分割可) |
|
|
69
|
+
| 4 | 値制約・判定基準 | 任意 | 列挙値・パターン・しきい値など判定基準を示す |
|
|
70
|
+
| 5 | 記述例 | 任意 | 規約に沿った最小例を示す |
|
|
71
|
+
| 6 | 禁止事項 | ○ | してはいけない記述・違反パターンを列挙する |
|
|
72
|
+
| 7 | 運用・見直しルール | 任意 | 変更時の手順、見直し条件、バリデーション方法 |
|
|
73
|
+
|
|
74
|
+
## 5. 記述ガイド
|
|
75
|
+
|
|
76
|
+
- 各規範は判定可能に書く(`must` / `should` の別と条件を明確にする)。
|
|
77
|
+
- 抽象語(十分、適切)で終わらせず、満たすべき条件・基準を示す。
|
|
78
|
+
- 推奨表のカラム定義(例: 項目、必須、説明、判定基準)を 1 つ以上提示する。
|
|
79
|
+
- 機械検証できる事項は対応する schema を SSOT とし、本文では schema を二重定義せず参照に留める。
|
|
80
|
+
- 共通事項は上位の標準(ハブ)を SSOT とし、重複記載を避ける。
|
|
81
|
+
- 未確定事項や仮置き情報は、本文中に次の共通ラベルで記述する。
|
|
82
|
+
- _TODO_: 後で人または生成 AI が確認・追記・修正する必要がある事項
|
|
83
|
+
- _UNDECIDED_: 情報不足ではなく、意思決定が未了で未確定の事項
|
|
84
|
+
- _ASSUMPTION_: 現時点で仮置きしている前提・仮説
|
|
85
|
+
|
|
86
|
+
## 6. 内容充実化(薄いドキュメント防止)
|
|
87
|
+
|
|
88
|
+
- 各必須章には、最低 3 つ以上の具体項目(箇条書きまたは表項目)を置く。
|
|
89
|
+
- 規範本体には、判定基準を伴う規約を具体的に示す。
|
|
90
|
+
- 少なくとも 1 つは、判定基準を含む推奨表を提示する。
|
|
91
|
+
- 禁止事項には、違反例または理由を添えて判定可能にする。
|
|
92
|
+
- ただし、実装依存の詳細(SQL 全文、具体クラス名、詳細 API 設計)には踏み込まない。
|
|
93
|
+
|
|
94
|
+
## 7. 禁止事項
|
|
95
|
+
|
|
96
|
+
- 章番号なし見出し(例: `## 目的`)を使用しない。
|
|
97
|
+
- 章番号末尾の `.` を省略しない。
|
|
98
|
+
- 章参照を番号のみ(例: `§3` / `第3章`)で記述しない。
|
|
99
|
+
- 手順・操作・使い方など guide が担う説明を standard の主目的にしない。
|
|
100
|
+
- 曖昧語(十分、適切、問題ない)を根拠なく使用しない。
|
|
101
|
+
- schema で機械検証する制約を本文に二重定義し、両者を乖離させない。
|
|
102
|
+
- _TODO_: / _UNDECIDED_: / _ASSUMPTION_: 以外の独自ラベルを、共通ルール未定義のまま追加しない。
|
|
103
|
+
|
|
104
|
+
## 8. 運用ルール
|
|
105
|
+
|
|
106
|
+
- 章構成や規範を変更する際は、依存する rulebook / guide / schema との整合を確認する。
|
|
107
|
+
- 機械検証の根拠となる schema を変更する場合は、本文の参照と齟齬がないか確認する。
|
|
108
|
+
- 表は必要に応じて `SpecDojo: Format Markdown Table` コマンドで揃える。
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:template-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Template 記述標準
|
|
9
|
+
|
|
10
|
+
Template Authoring Standard
|
|
11
|
+
|
|
12
|
+
`docs/ja/specdojo/templates/` 配下の成果物テンプレートが従うべき構成・プレースホルダ規約・禁止事項・運用ルールを定義します。プレースホルダを埋めた結果が満たすべき Frontmatter 規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では雛形側の記述方法を定義します。
|
|
13
|
+
|
|
14
|
+
## 1. 適用範囲
|
|
15
|
+
|
|
16
|
+
- 対象: `docs/ja/specdojo/templates/` 配下のすべての成果物テンプレート `*-template.(md|yaml)`
|
|
17
|
+
- 対象外: `docs/ja/specdojo/exec-templates/` 配下の plan / result 生成用内部テンプレート。rulebook から宣言される実践の型ではなく、生成処理が消費する実行基盤の部品として [plan/result ライフサイクルガイド](../guides/plan-result-lifecycle-guide.md) に従う
|
|
18
|
+
- 目的: テンプレートの構成・プレースホルダ記法を統一し、同じ rulebook 系統の成果物へ再利用できる雛形を提供する
|
|
19
|
+
- 成果物の意味要件の正本: 対応する `docs/ja/specdojo/rulebooks/<prefix>-rulebook.md`
|
|
20
|
+
- 見出し・キー・記入欄の骨組みの正本: rulebook frontmatter が文書 ID で宣言する template
|
|
21
|
+
- 完成後の Frontmatter 規約の正本: [document-metadata-standard.md](document-metadata-standard.md)
|
|
22
|
+
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
23
|
+
|
|
24
|
+
## 2. 出力フォーマットと命名
|
|
25
|
+
|
|
26
|
+
- ファイル名は `<prefix>-template.md` / `<prefix>-template.yaml` とし、対応 rulebook の `target_format` に合わせる。
|
|
27
|
+
- Markdown テンプレートは、対応 rulebook の本文要件を満たす見出し構成を持つ。見出しの順序と記入欄は template を正本とし、rulebook 本文へ同じ骨組みを転載しない。
|
|
28
|
+
- YAML テンプレートは、対象成果物のルートキー・必須キー・型を雛形として示す。
|
|
29
|
+
- テンプレートファイル自身の Frontmatter も `specdojo:` 名前空間配下に実値で記述する(`specdojo.id: specdojo:<prefix>-template`、`specdojo.type: template`、`specdojo.status: draft`)。生成物の Frontmatter は自身 Frontmatter とは別に表現する。Markdown 成果物テンプレートは、[document-metadata-standard.md](document-metadata-standard.md) の `テンプレート自身のメタ情報と生成物 Frontmatter の分離` に従い、`specdojo:` 配下の `frontmatter_template` フィールドに `specdojo:` ラッパー込みの生成物 Frontmatter を記述する。
|
|
30
|
+
- YAML テンプレートも自身のメタ情報(`id` / `type` / `status` / `title` / `rulebook`)をトップレベルに実値で記述する。YAML catalog(`dct-*`)を除き、生成物のメタ情報はトップレベルの `metadata_template` フィールドに記述する([document-metadata-standard.md](document-metadata-standard.md) の `生成物メタ情報雛形(metadata_template)`)。
|
|
31
|
+
|
|
32
|
+
## 3. プレースホルダ規約
|
|
33
|
+
|
|
34
|
+
- プレースホルダは前後をアンダースコアで囲む大文字スネークケース(例: `_TASK_ID_`、`_DELIVERABLE_NAME_`)で記述する。
|
|
35
|
+
- 未記入や後続作業を表す箇所は共通ラベル _TODO_ を使う。
|
|
36
|
+
- プレースホルダ名は埋める内容が分かる名称にし、1 テンプレート内で意味を統一する。
|
|
37
|
+
- 固定値(変更しない記述)はプレースホルダにせず、そのまま記述する。
|
|
38
|
+
- すべてのプレースホルダは、埋めれば成果物として成立する粒度にする。
|
|
39
|
+
|
|
40
|
+
`deliverable scaffold` がカタログから確定できる次の値は予約済みの生成時プレースホルダとし、同じ rulebook 系統で template を共有するときに使用する。
|
|
41
|
+
|
|
42
|
+
| プレースホルダ | 置換元 |
|
|
43
|
+
| ------------------------ | ------------------------------------- |
|
|
44
|
+
| `_PROJECT_ID_` | 対象 project ID |
|
|
45
|
+
| `_LOCAL_ID_` | `deliverables[].local_id` |
|
|
46
|
+
| `_DELIVERABLE_NAME_` | `deliverables[].name` |
|
|
47
|
+
| `_DELIVERABLE_OVERVIEW_` | `deliverables[].overview` |
|
|
48
|
+
| `_BASED_ON_` | `depends_on` を project ID 化した配列 |
|
|
49
|
+
|
|
50
|
+
| 記法 | 用途 | 例 |
|
|
51
|
+
| ---------------------- | ------------------------------------------------------------------------- | ------------------------- |
|
|
52
|
+
| `_UPPER_SNAKE_` | 埋めるべき可変項目(記入プレースホルダ) | `_RISK_TITLE_` |
|
|
53
|
+
| _TODO_ | 後で記入・判断する箇所(記入プレースホルダ) | 担当 / 期限など |
|
|
54
|
+
| `_PROJECT_ID_` 等 | `deliverable scaffold` が置換する予約済み生成時プレースホルダ | `_PROJECT_ID_:_LOCAL_ID_` |
|
|
55
|
+
| `frontmatter_template` | 生成物 Frontmatter 雛形(Markdown 成果物テンプレート自身 Frontmatter 内) | — |
|
|
56
|
+
| `metadata_template` | 生成物メタ情報雛形(YAML テンプレートのトップレベル。`dct-*` を除く) | — |
|
|
57
|
+
|
|
58
|
+
### 3.1. 他のプレースホルダ記法との使い分け
|
|
59
|
+
|
|
60
|
+
リポジトリ内には、見た目が似た可変項目の記法が本標準の記入プレースホルダ以外に2種類ある。置換されるタイミングが異なるため、混用しない。
|
|
61
|
+
|
|
62
|
+
| 記法 | 置換タイミング | 主な使用場所 |
|
|
63
|
+
| --------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
64
|
+
| `_UPPER_SNAKE_` | 作成・生成時に一度だけ置換され、成果物には残らない | `*-template.md` / `*-template.yaml` の記入欄 |
|
|
65
|
+
| `{lower_snake}` | 実行のたびに展開され、ファイルには記法のまま残る | `.specdojo/exec-defaults.yaml` の `command_template`([exec設定ガイド](../guides/exec-config-guide.md) を参照) |
|
|
66
|
+
| `<placeholder>` | 置換されない。説明文中で任意の値を表す総称 | ドキュメント本文・コメント(例: `providers.<provider>`。必ずインラインコードで記述する) |
|
|
67
|
+
|
|
68
|
+
`_UPPER_SNAKE_` が残っている生成物は未記入を意味するが、`{lower_snake}` が残っている設定ファイルは完成状態である。この区別が読み手に伝わるよう、実行時に展開される変数を `_UPPER_SNAKE_` で書かない。
|
|
69
|
+
|
|
70
|
+
## 4. 構成の原則
|
|
71
|
+
|
|
72
|
+
- Markdown の見出しは `##` から開始し、章番号は 1 始まりの連番、末尾に `.` を付ける。
|
|
73
|
+
- 章構成は対応成果物の rulebook が定める本文要件を満たし、同じ rulebook 系統の成果物で共有できる粒度にする。
|
|
74
|
+
- 見出しの順序、表の列、記入欄の配置は template を正本とする。rulebook は章の目的、必須・任意、記述上の規約を正本とする。
|
|
75
|
+
- YAML はキー構造・必須キー・型制約を、対象成果物の schema と整合する形で示す。
|
|
76
|
+
- 埋めた結果が対象 `type` のメタ情報標準([document-metadata-standard.md](document-metadata-standard.md))を満たすようにする。
|
|
77
|
+
|
|
78
|
+
## 5. 記述ガイド
|
|
79
|
+
|
|
80
|
+
- テンプレートは「何をどこに書くか」を示す雛形であり、内容の作り方(問い・観点)は recipe に委譲する。
|
|
81
|
+
- 各セクションには、何を記入するかが分かる見出し・キー・プレースホルダを置く。
|
|
82
|
+
- 記入例が必要な場合は、プレースホルダと区別できる形(コメントや補足行)で添える。
|
|
83
|
+
- 推奨表のカラム定義(例: 項目、必須、説明)を 1 つ以上提示する。
|
|
84
|
+
- 文書へのリンクは、対象文書が存在する場合は `[[id|title]]` 形式(`id` は project 修飾 doc id)で記載する。まだ存在しない場合は `` `id` `` または `` `filename` `` のようにバッククォートで仮置きする。
|
|
85
|
+
|
|
86
|
+
## 6. 禁止事項
|
|
87
|
+
|
|
88
|
+
- 章番号なし見出し(例: `## 基本情報`)を使用しない(Markdown の場合)。
|
|
89
|
+
- 章番号末尾の `.` を省略しない。
|
|
90
|
+
- 実在のプロジェクト固有データや個人情報・機密情報を雛形に埋め込まない。
|
|
91
|
+
- 埋めずに成果物として成立しない曖昧なプレースホルダを残さない。
|
|
92
|
+
- プレースホルダ記法(`_UPPER_SNAKE_` / _TODO_ / `_PROJECT_ID_`)および `frontmatter_template` / `metadata_template` フィールド以外の独自記法を、共通ルール未定義のまま追加しない。
|
|
93
|
+
- 実行時展開変数の記法 `{lower_snake}` をテンプレートの記入プレースホルダとして使わない(`他のプレースホルダ記法との使い分け` を参照)。
|
|
94
|
+
- テンプレート本文に実装詳細(SQL 全文、具体クラス名、詳細 API 設計)を書かない。
|
|
95
|
+
|
|
96
|
+
## 7. 運用ルール
|
|
97
|
+
|
|
98
|
+
- 対応成果物の rulebook 本文要件や schema が変わった場合は、テンプレートの構成・キーを追従させる。
|
|
99
|
+
- プレースホルダ名を変更する場合は、対応する recipe / 生成処理との整合を確認する。
|
|
100
|
+
- `grade apply` はテンプレートを変更せず、評価結果と finding を `execution/grade/results/` のサイドカーに書く。テンプレート本文に評価注釈を書き込まない。
|
|
101
|
+
- 表は必要に応じて `SpecDojo: Format Markdown Table` コマンドで揃える。
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:test-document-scope-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# テストドキュメントスコープ定義標準
|
|
9
|
+
|
|
10
|
+
## 1. 目的
|
|
11
|
+
|
|
12
|
+
本ルールは、テストに関する各ドキュメント(戦略・観点/条件・テストカタログ等)について、
|
|
13
|
+
|
|
14
|
+
- **どのドキュメントに**
|
|
15
|
+
- **どこまで記述するか**
|
|
16
|
+
- **何を書いてはいけないか**
|
|
17
|
+
|
|
18
|
+
を明確にし、**重複・抜け漏れ・責務の混乱を防ぐ**ことを目的とする。
|
|
19
|
+
|
|
20
|
+
## 2. 基本原則
|
|
21
|
+
|
|
22
|
+
### 2.1. 責務分離の原則
|
|
23
|
+
|
|
24
|
+
- 上位は **方針・基準・責務境界・分配**
|
|
25
|
+
- 下位は **対象別の具体化(観点→ケース)、証跡への接続**
|
|
26
|
+
|
|
27
|
+
とする。
|
|
28
|
+
|
|
29
|
+
### 2.2. 非重複(SSOT)の原則
|
|
30
|
+
|
|
31
|
+
- **同一内容を複数成果物に重複記載しない**
|
|
32
|
+
- 重複が必要に見える場合は、原則として **参照(IDリンク)で表現**する
|
|
33
|
+
- 一次情報(SSOT)の置き場を固定する:
|
|
34
|
+
- 全体方針/品質ゲート:**TSP**
|
|
35
|
+
- ケース(観点×条件の最小表)と証跡リンク:**各レベルの対象別カタログ(`*c-<term>`)**
|
|
36
|
+
- 実行結果:**CI成果物/レポート/ログ**(Evidence)
|
|
37
|
+
|
|
38
|
+
### 2.3. 「書かない」ことも仕様である
|
|
39
|
+
|
|
40
|
+
- 対象外・除外理由・委譲先(どのレベルで担保するか)を明示する
|
|
41
|
+
- 「ここには書かない」を明示することで、下流工程の迷いを減らす
|
|
42
|
+
|
|
43
|
+
### 2.4. ドキュメント最小化の原則(カタログ方式)
|
|
44
|
+
|
|
45
|
+
- テストレベル別ドキュメントは **「概要(index)」+「対象別(term)」の2種を基本** とする
|
|
46
|
+
- `*c-index`:共通ルール(SSOT)
|
|
47
|
+
- `*c-<term>`:対象別カタログ(SSOT)
|
|
48
|
+
- 具体値・詳細手順・網羅展開は、原則として **テストコード/実行結果(CI成果物)** に寄せる
|
|
49
|
+
- 監査・外部調整・完全手動などで文書が必要な場合のみ、対象別に **最小チェックリスト** を追記してよい
|
|
50
|
+
|
|
51
|
+
## 3. ドキュメント体系と責務
|
|
52
|
+
|
|
53
|
+
本プロジェクトのテストドキュメントは、次の体系で構成する。
|
|
54
|
+
|
|
55
|
+
- テスト戦略・方針:`tsp-index`
|
|
56
|
+
- テストレベル別カタログ:
|
|
57
|
+
- 単体:`utc-index`, `utc-<term>`
|
|
58
|
+
- 内部結合:`itc-index`, `itc-<term>`
|
|
59
|
+
- 外部結合:`etc-index`, `etc-<term>`
|
|
60
|
+
- 総合:`stc-index`, `stc-<term>`
|
|
61
|
+
- 受入:`atc-index`, `atc-<term>`
|
|
62
|
+
|
|
63
|
+
注:
|
|
64
|
+
|
|
65
|
+
> - `<term>` は対象単位を表す識別子(用語集GLの論理名キー、kebab-case)とする。
|
|
66
|
+
> - 各レベルの `*c-index` は **当該レベルの共通ルールのSSOT**、`*c-<term>` は **当該レベルの対象別ケースSSOT** とする。
|
|
67
|
+
|
|
68
|
+
### 3.1. 記述内容とドキュメントの対応
|
|
69
|
+
|
|
70
|
+
| 分類 | 記述内容 | ドキュメント | ドキュメントID |
|
|
71
|
+
| ---------- | ----------------------------------------------------------- | --------------- | -------------- |
|
|
72
|
+
| 全体 | テスト全体の目的・基本方針 | TSP | `tsp-index` |
|
|
73
|
+
| 全体 | テストレベル別の責務境界(何をどこで担保するか) | TSP | `tsp-index` |
|
|
74
|
+
| 全体 | 品質ゲート(入口条件・出口条件) | TSP | `tsp-index` |
|
|
75
|
+
| 全体 | テスト運用前提(環境/データ/自動化/不具合運用の方針レベル) | TSP | `tsp-index` |
|
|
76
|
+
| 全体 | 観点/条件設計の共通原則(定義粒度・分類・判定軸) | TSP | `tsp-index` |
|
|
77
|
+
| レベル共通 | 当該レベルの対象単位の切り方/分割基準 | カタログ概要 | `*c-index` |
|
|
78
|
+
| レベル共通 | 当該レベルの対象外・除外理由(共通) | カタログ概要 | `*c-index` |
|
|
79
|
+
| レベル共通 | 当該レベルの観点/条件の立て方(共通) | カタログ概要 | `*c-index` |
|
|
80
|
+
| レベル共通 | 当該レベルの観点/条件の採用基準・分配方針 | カタログ概要 | `*c-index` |
|
|
81
|
+
| レベル共通 | 当該レベルの境界/依存の扱い(共通) | カタログ概要 | `*c-index` |
|
|
82
|
+
| レベル共通 | ケース表の共通カラム/ID規則 | カタログ概要 | `*c-index` |
|
|
83
|
+
| 対象別 | 対象の概要・責務・対象外(対象固有) | 対象別カタログ | `*c-<term>` |
|
|
84
|
+
| 対象別 | 境界/依存(対象固有、例外があれば根拠付き) | 対象別カタログ | `*c-<term>` |
|
|
85
|
+
| 対象別 | トレース(trace_keyの一次情報) | 対象別カタログ | `*c-<term>` |
|
|
86
|
+
| 対象別 | 観点→ケース表(観点×条件=ケース、証跡リンク) | 対象別カタログ | `*c-<term>` |
|
|
87
|
+
| 実行/証跡 | 全ケース実装・実行結果・ログ・レポート | コード/CI成果物 | (文書IDなし) |
|
|
88
|
+
|
|
89
|
+
※ 手動実施/監査/外部調整が必要な場合は、`*c-<term>` に **最小限の手順・観測点チェックリスト** を追加で記載してよい(別文書を増やさない)。
|
|
90
|
+
|
|
91
|
+
### 3.2. テスト戦略・方針(TSP: `tsp-index`)
|
|
92
|
+
|
|
93
|
+
- テスト全体の目的/基本方針/役割分担(レベル別の責務境界)を定義する
|
|
94
|
+
- 品質ゲート(入口条件・出口条件)を定義する
|
|
95
|
+
- 観点/条件を設計する際の共通原則(定義粒度・分類・判定軸)を定義する
|
|
96
|
+
- 環境・データ・自動化・不具合運用など、テスト運用の前提を定義する
|
|
97
|
+
※ 個別の観点・条件・ケース・具体値は記載しない
|
|
98
|
+
|
|
99
|
+
### 3.4. テストカタログ概要(`*c-index`)
|
|
100
|
+
|
|
101
|
+
- 当該テストレベルの **共通ルール(SSOT)** を定義する
|
|
102
|
+
- 対象単位の切り方(分割基準)
|
|
103
|
+
- 対象外・除外理由(共通)
|
|
104
|
+
- 観点の立て方(共通)
|
|
105
|
+
- 条件の立て方(共通)
|
|
106
|
+
- 観点/条件の採用基準と対象別への分配方針(共通)
|
|
107
|
+
- 境界/依存の扱い(共通)
|
|
108
|
+
- ケース表の共通カラム・ID規則
|
|
109
|
+
- `tsp-index` の方針を根拠として、当該レベルの「やる/やらない」を固定する
|
|
110
|
+
|
|
111
|
+
**禁止事項**
|
|
112
|
+
|
|
113
|
+
- 個別対象のケースを大量に列挙する(個別は `*c-<term>`)
|
|
114
|
+
- 他レベル/他対象の観点・条件表を再掲する(参照に留める)
|
|
115
|
+
- 実行手順や具体値を詳細に書く(証跡はCI/コードへ)
|
|
116
|
+
|
|
117
|
+
### 3.5. テストカタログ対象別(`*c-<term>`)
|
|
118
|
+
|
|
119
|
+
対象単位ごとに、以下を最小限で定義する(当該レベルのSSOT本体)
|
|
120
|
+
|
|
121
|
+
- 概要(対象の説明、粒度)
|
|
122
|
+
- 責務(このレベルで保証すること)
|
|
123
|
+
- 対象外(理由・代替レベル)
|
|
124
|
+
- 境界/依存(扱い、例外があれば根拠付き)
|
|
125
|
+
- トレース(trace_keyの一次情報)
|
|
126
|
+
- テスト観点とケース(観点→ケース表、証跡リンク)
|
|
127
|
+
|
|
128
|
+
**禁止事項**
|
|
129
|
+
|
|
130
|
+
- `*c-index` の共通方針を対象ごとに無根拠に上書きする
|
|
131
|
+
- 具体値・網羅展開・詳細手順を逐語列挙する(自動はコードへ)
|
|
132
|
+
- 根拠のない網羅主張(`tsp-index` / `*c-index` の根拠 + 証跡リンクで示す)
|
|
133
|
+
|
|
134
|
+
**補足**
|
|
135
|
+
|
|
136
|
+
- 自動テスト:具体値・詳細手順・データセットは **コード**(parameterized/table-driven等)で表現
|
|
137
|
+
- 手動テスト:必要最小限のチェックリスト/観測点のみ追記可
|
|
138
|
+
|
|
139
|
+
### 3.6. テストレベル別 責務一覧(カタログ対応)
|
|
140
|
+
|
|
141
|
+
| テストレベル | 対象(何を確認) | 境界(どこまで含める) | 重点(落とし穴) | 成果物(ID) |
|
|
142
|
+
| ------------------ | ---------------------------------------- | -------------------------------------------- | --------------------------------------- | ------------------------- |
|
|
143
|
+
| **単体(UT)** | モジュール/関数/ロジックの決定的検証 | DB・外部I/F・時刻等は原則隔離 | 境界値/例外/状態分岐/ルール整合 | `utc-index`, `utc-<term>` |
|
|
144
|
+
| **内部結合(IT)** | コンポーネント間連携(内部I/F) | 内部は実接続を増やす、外部は隔離しやすい形で | データ受け渡し/I/F整合/連携例外 | `itc-index`, `itc-<term>` |
|
|
145
|
+
| **外部結合(ET)** | 外部I/F(API/ファイル/メッセージ)の成立 | 契約/疎通/失敗系(タイムアウト等)の再現 | 契約差分、認証、冪等性、再送/リトライ | `etc-index`, `etc-<term>` |
|
|
146
|
+
| **総合(ST)** | 主要業務フローの成立(横断の整合) | 結合済み構成(内部/外部を含む前提) | E2E成立、主要例外、データ整合、運用成立 | `stc-index`, `stc-<term>` |
|
|
147
|
+
| **受入(AT)** | 受入条件(SAC/BAC等)の合否 | 実装詳細は見ない(利用者判断粒度) | 合否判定の明確さ、証跡、業務/運用観点 | `atc-index`, `atc-<term>` |
|
|
148
|
+
|
|
149
|
+
## 4. 判断に迷ったときのルール(最新版)
|
|
150
|
+
|
|
151
|
+
1. **「全体方針・品質ゲート・役割分担の話か?」**
|
|
152
|
+
- Yes → **TSP(`tsp-index`)**
|
|
153
|
+
- No → 次へ
|
|
154
|
+
|
|
155
|
+
2. **「レベル共通の切り方・共通方針・共通カラム/IDの話か?」**
|
|
156
|
+
- Yes → **`*c-index`**
|
|
157
|
+
- No → 次へ
|
|
158
|
+
|
|
159
|
+
3. **「対象別の責務・境界/依存・トレース・ケース表・証跡リンクの話か?」**
|
|
160
|
+
- Yes → **`*c-<term>`**
|
|
161
|
+
- No → 次へ
|
|
162
|
+
|
|
163
|
+
4. **「具体値・詳細手順・網羅展開・実行結果か?」**
|
|
164
|
+
- 自動 → **テストコード + CI成果物**
|
|
165
|
+
- 手動 → **`*c-<term>` に最小チェックリスト**(必要最小限)
|
|
166
|
+
|
|
167
|
+
## 5. よくあるアンチパターン(カタログ版)
|
|
168
|
+
|
|
169
|
+
| アンチパターン | 問題点 |
|
|
170
|
+
| -------------------------------------------------------- | ------------------------------ |
|
|
171
|
+
| `tsp-index` に対象別の具体値・手順・ケースが書かれている | SSOT肥大化/責務逸脱 |
|
|
172
|
+
| `*c-index` に個別ケースが大量に載っている | 役割逆転(共通SSOTが破綻) |
|
|
173
|
+
| 同じケース表が複数ドキュメントに存在する | 更新漏れの温床 |
|
|
174
|
+
| 期待値が「正常に動く」など曖昧 | 合否判定不能/証跡にならない |
|
|
175
|
+
| `case_id` や `trace_key` が頻繁に変更される | 参照崩壊/履歴追跡不能 |
|
|
176
|
+
| 手順をクリック列挙で書き続ける | 保守不能/意図不明/変更に弱い |
|