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,113 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:philosophy-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
based_on:
|
|
7
|
+
- specdojo:document-metadata-standard
|
|
8
|
+
- specdojo:id-and-file-naming-standard
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Philosophy 記述標準
|
|
12
|
+
|
|
13
|
+
Philosophy Authoring Standard
|
|
14
|
+
|
|
15
|
+
`docs/ja/specdojo/philosophy/` 配下の各 `*-philosophy.md` が従うべき構成・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
16
|
+
|
|
17
|
+
## 1. 目的・適用範囲
|
|
18
|
+
|
|
19
|
+
- 対象: `docs/ja/specdojo/philosophy/` 配下のすべての `*-philosophy.md`
|
|
20
|
+
- 目的: SpecDojo の規約が依拠する考え方(方針・概念)を、規範や手順と混ぜずに記述する
|
|
21
|
+
- 位置づけ: philosophy は standard と rulebook の上流にあり、なぜその規約なのか、迷ったときに何を基準に判断するかを扱う。判定可能な規約は standard、成果物ごとの記述規則は rulebook、操作と手順は guide を正本とする
|
|
22
|
+
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
23
|
+
- 参照スキーマ: [philosophy-frontmatter.schema.yaml](../../../specdojo/schemas/v1/philosophy-frontmatter.schema.yaml)
|
|
24
|
+
- ファイル名・ID 規則: [id-and-file-naming-standard.md](id-and-file-naming-standard.md)
|
|
25
|
+
|
|
26
|
+
## 2. 基本方針
|
|
27
|
+
|
|
28
|
+
- philosophy は規範(must)を定義しない。読み手が自分で判断できるように、原則・概念とその理由を示す。
|
|
29
|
+
- 判定可能な条件、値、必須項目を philosophy で定義しない。定義が必要になった時点で standard、rulebook、または schema へ置き、philosophy からは参照する。
|
|
30
|
+
- 操作手順、コマンド、設定例を主目的にしない。これらは guide の責務とする。
|
|
31
|
+
- 原則・概念は、それを守らなかった場合に何が起きるかとあわせて示す。理由のない原則は判断に使えないため。
|
|
32
|
+
|
|
33
|
+
## 3. 構成の原則
|
|
34
|
+
|
|
35
|
+
- `#` はタイトルのみ。章は `##` から開始する。
|
|
36
|
+
- 章番号は 1 始まりの連番とし、末尾に `.` を付ける。章への参照は章タイトルで記載する。
|
|
37
|
+
- タイトル直下に英語名(1行)を置き、その直下に目的・概要(1〜3文)を置く。
|
|
38
|
+
- 目的・概要には、本書が規範ではないことと、判定可能な規約の正本がどこかを明示する。
|
|
39
|
+
- 定義する原則または概念の全体像を、本文の早い段階で一覧表として示す。
|
|
40
|
+
- 個々の原則・概念は、テーマ単位で章または小見出しに分ける。
|
|
41
|
+
- 固定の標準章構成は設けない。扱う対象(方針か概念か)によって適切な章立てが異なるため。
|
|
42
|
+
|
|
43
|
+
| 章の役割 | 必須 | 説明 |
|
|
44
|
+
| ------------ | ---- | ------------------------------------------------------------ |
|
|
45
|
+
| 全体一覧 | ○ | 定義する原則または概念を表で一覧する |
|
|
46
|
+
| 個別の説明 | ○ | 原則・概念ごとに、意味、目的、適用範囲を示す |
|
|
47
|
+
| 典型的な誤り | ○ | 原則・概念を取り違えた場合に起きることを示す |
|
|
48
|
+
| 正本への導線 | ○ | 判定可能な規約を持つ standard / rulebook / schema を参照する |
|
|
49
|
+
|
|
50
|
+
## 4. 導入ブロック
|
|
51
|
+
|
|
52
|
+
目的・概要の直下、最初の `##` 見出しより前に、次の3ブロックをこの順で置きます。guide と同じ3ブロックを用います。
|
|
53
|
+
|
|
54
|
+
| ラベル | 書く内容 |
|
|
55
|
+
| -------------------- | ------------------------------------------------------------------ |
|
|
56
|
+
| 対象読者 | この philosophy を読む役割・立場 |
|
|
57
|
+
| この文書で分かること | 読み終えたときに得られる判断材料の範囲 |
|
|
58
|
+
| 次に読む文書 | この philosophy の直後に進む文書(2〜3件)。網羅的な一覧は置かない |
|
|
59
|
+
|
|
60
|
+
- 目的別の横断一覧は [specdojo-overview-guide.md](../guides/specdojo-overview-guide.md) の `目的別の次の読み物` を唯一の正本とし、複製しない。
|
|
61
|
+
- `この文書が扱わないこと` は任意で追加してよい。
|
|
62
|
+
- 機械検証は [philosophy-content.schema.yaml](../schemas/v1/philosophy-content.schema.yaml) を SSOT とし、`npm run lint:fm` で検証する。
|
|
63
|
+
|
|
64
|
+
## 5. Frontmatter 規約
|
|
65
|
+
|
|
66
|
+
- ファイル名は `<subject>-philosophy.md` とする。
|
|
67
|
+
- `id` / `type` / `status` を必須とし、共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
68
|
+
- `type` は `philosophy` 固定とする。
|
|
69
|
+
- `id` は `specdojo:<subject>-philosophy` 形式とし、authority は所有元、local-id は主題と文書種別だけを表す([id-and-file-naming-standard.md](id-and-file-naming-standard.md) の `実践体系文書のlocal-id` に従う)。
|
|
70
|
+
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
71
|
+
|
|
72
|
+
| 項目 | 必須 | 説明 |
|
|
73
|
+
| ---------- | ---- | --------------------------------------------- |
|
|
74
|
+
| id | ○ | `specdojo:<subject>-philosophy` 形式の一意 ID |
|
|
75
|
+
| type | ○ | `philosophy` 固定 |
|
|
76
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
77
|
+
| based_on | 任意 | 根拠ドキュメント |
|
|
78
|
+
| supersedes | 任意 | 置き換え関係 |
|
|
79
|
+
|
|
80
|
+
記述例:
|
|
81
|
+
|
|
82
|
+
```yaml
|
|
83
|
+
---
|
|
84
|
+
specdojo:
|
|
85
|
+
id: specdojo:specdojo-philosophy
|
|
86
|
+
type: philosophy
|
|
87
|
+
status: draft
|
|
88
|
+
---
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## 6. 記述ガイド
|
|
92
|
+
|
|
93
|
+
- 文体は「です・ます」体を既定とする。standard / rulebook の規範文(「である」体)と役割を分ける。
|
|
94
|
+
- 原則・概念には、名称、短い定義、SpecDojo 上の意味を含める。
|
|
95
|
+
- 比較・対応・区別など、見比べる情報は表に置く。
|
|
96
|
+
- 例を用いる場合は、[sample-authoring-standard.md](sample-authoring-standard.md) の `共通サンプル文脈` に合わせる。
|
|
97
|
+
- 未確定事項や仮置き情報は、`_TODO_` / `_UNDECIDED_` / `_ASSUMPTION_` のラベルで記述する。
|
|
98
|
+
|
|
99
|
+
## 7. 禁止事項
|
|
100
|
+
|
|
101
|
+
- 章番号なし見出し(例: `## 基本方針`)を使用しない。
|
|
102
|
+
- 章番号末尾の `.` を省略しない。
|
|
103
|
+
- 判定可能な規約(必須項目、列挙値、しきい値、命名パターン)を philosophy で新規に定義しない。
|
|
104
|
+
- 操作手順、コマンド列、設定例を主内容にしない。
|
|
105
|
+
- 他の standard / rulebook / schema が正本とする値を複製しない。参照に留める。
|
|
106
|
+
- 曖昧語(十分、適切、問題ない)を根拠なく使用しない。
|
|
107
|
+
- `導入ブロック` の3ブロックを省略しない。ラベル名を変えない。順序を入れ替えない。
|
|
108
|
+
|
|
109
|
+
## 8. 運用ルール
|
|
110
|
+
|
|
111
|
+
- philosophy の原則を変更した場合は、その原則に依拠する standard / rulebook との整合を確認する。
|
|
112
|
+
- philosophy に判定可能な規約を書きたくなった場合は、先に対応する standard または schema を更新し、philosophy からは参照する。
|
|
113
|
+
- 同じ考え方を扱う文書が増えた場合は、文書を分けるか統合するかを、読み手が判断に使う単位で決める。
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:recipe-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: ready
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Recipe 記述標準
|
|
9
|
+
|
|
10
|
+
Recipe Authoring Standard
|
|
11
|
+
|
|
12
|
+
`docs/ja/specdojo/recipes/` 配下の各 `*-recipe.md` が従うべき章立て・記述ルール・禁止事項・運用ルールを定義します。成果物の構造・必須項目・禁止事項は対応する rulebook を正本とし、本書は「良い内容を書くための作り方」の記述方法を定義します。
|
|
13
|
+
|
|
14
|
+
## 1. 適用範囲
|
|
15
|
+
|
|
16
|
+
- 対象: `docs/ja/specdojo/recipes/` 配下のすべての `*-recipe.md`
|
|
17
|
+
- 目的: recipe の章構成・記述品質を統一し、書き手が良い内容を再現可能に作成できるようにする
|
|
18
|
+
- 成果物構造の正本: 対応する `docs/ja/specdojo/rulebooks/<prefix>-rulebook.md`
|
|
19
|
+
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
20
|
+
- 成果物 Frontmatter の構築: template の `frontmatter_template` から構築する([document-metadata-standard.md](document-metadata-standard.md) の `生成物 Frontmatter 雛形`)。この手順を recipe 本文に複製しない。
|
|
21
|
+
- 参照スキーマ: [recipe-frontmatter.schema.yaml](../../../specdojo/schemas/v1/recipe-frontmatter.schema.yaml)
|
|
22
|
+
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
23
|
+
|
|
24
|
+
## 2. 見出しレベルと章番号の原則
|
|
25
|
+
|
|
26
|
+
- `#` はタイトルのみ。章は `##` から開始する。
|
|
27
|
+
- 章番号は 1 始まりの連番。スキップしない(例: `## 1.`, 次は `## 2.`)。
|
|
28
|
+
- 章番号末尾には必ず `.` を付ける。
|
|
29
|
+
- 章への参照は章番号ではなく章タイトルで記載する(例: `各章の書き方`)。
|
|
30
|
+
- タイトル直下に **英語名(1行)** を置き、その直下に **目的・概要(1〜3文)** を置く。
|
|
31
|
+
|
|
32
|
+
## 3. Frontmatter 規約
|
|
33
|
+
|
|
34
|
+
- ファイル名は `<prefix>-recipe.md` とする。
|
|
35
|
+
- `id` / `type` / `status` を必須とし、共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
36
|
+
- `type` は `recipe` 固定とする。
|
|
37
|
+
- 対応する成果物の根拠を示すため、`rulebook` と `sample`(存在する場合)を記載する。
|
|
38
|
+
|
|
39
|
+
| 項目 | 必須 | 説明 |
|
|
40
|
+
| -------- | ---- | ---------------------------------------- |
|
|
41
|
+
| id | ○ | `specdojo:<prefix>-recipe` 形式の一意 ID |
|
|
42
|
+
| type | ○ | `recipe` 固定 |
|
|
43
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
44
|
+
| rulebook | ○ | 構造の正本となる rulebook の完全 ID |
|
|
45
|
+
| sample | 任意 | 粒度・文体の参照となる sample の完全 ID |
|
|
46
|
+
|
|
47
|
+
## 4. 標準章構成(`*-recipe.md`)
|
|
48
|
+
|
|
49
|
+
章構成は以下を原則とする。不要な章は省略可だが、省略理由を記載することを推奨する。
|
|
50
|
+
|
|
51
|
+
| 章番号 | 章タイトル | 必須 | 説明 |
|
|
52
|
+
| ------ | ------------------ | ---- | ----------------------------------------------------------- |
|
|
53
|
+
| 1 | このレシピの使い方 | ○ | このレシピを使う順序と確認の進め方を示す |
|
|
54
|
+
| 2 | 作成前に集める情報 | ○ | 着手前に短いメモで集める入力情報を表で示す |
|
|
55
|
+
| 3 | 全体の作成手順 | ○ | 完成までの手順を番号付きで示す |
|
|
56
|
+
| 4 | 各章の書き方 | ○ | 章ごとの問い・具体化のコツ・良い例/避けたい例を示す |
|
|
57
|
+
| 5 | 深掘り手順 | 任意 | 内容が浅いときに具体化を進める順序を示す |
|
|
58
|
+
| 6 | 良い例 / 悪い例 | ○ | 観点ごとに良い例と悪い例を対比する |
|
|
59
|
+
| 7 | レビュー観点 | ○ | 作成後に確認する観点を表で示す |
|
|
60
|
+
| 8 | 仕上げチェック | ○ | recipe 内の記述だけで判定できる整合・公開適性の最終確認項目 |
|
|
61
|
+
|
|
62
|
+
## 5. 記述ガイド
|
|
63
|
+
|
|
64
|
+
- recipe は「成果物が成立するか」ではなく「内容が良いか」を高める作り方を扱う。構造・必須項目・禁止事項の正本は対応 rulebook とし、その規約一覧を recipe 側で再定義しない。
|
|
65
|
+
- rulebook / sample との対応関係は frontmatter の `rulebook` / `sample` だけで示す。本文には rulebook / sample への参照(wikilink や「〜と同程度」などの照合指示)を置かない。recipe-guided 実行では recipe だけが読み込まれるため、本文中の参照は実行不能な指示になる。
|
|
66
|
+
- recipe 単体で成果物を組み立てられるよう、成果物の章立ては「全体の作成手順」と「各章の書き方」で recipe 自身の言葉で示す。
|
|
67
|
+
- 各章の書き方には、書き手が答えるべき問いを置き、抽象論で終わらせない。
|
|
68
|
+
- 良い例と悪い例は同じ観点で対比し、何が良し悪しを分けるかを判定可能にする。
|
|
69
|
+
- 推奨表のカラム(例: 観点、確認内容、良い例、悪い例)を 1 つ以上提示する。
|
|
70
|
+
- 未確定事項や仮置き情報は、本文中に次の共通ラベルで記述する。
|
|
71
|
+
- _TODO_: 後で人または生成 AI が確認・追記・修正する必要がある事項
|
|
72
|
+
- _UNDECIDED_: 情報不足ではなく、意思決定が未了で未確定の事項
|
|
73
|
+
- _ASSUMPTION_: 現時点で仮置きしている前提・仮説
|
|
74
|
+
- リンクはファイルがある場合に記載し、ない場合はバッククォートで仮置きする。
|
|
75
|
+
|
|
76
|
+
### 5.1. Why・What・How・Trace の共通原則
|
|
77
|
+
|
|
78
|
+
Why・What・How・Trace は章の固定順ではなく、成果物に含まれる主要な主張・判断を支える論理の骨格として扱う。成果物の既存の章、表、フィールドへ必要な要素を配置し、4 要素を見出しとして追加することは要求しない。
|
|
79
|
+
|
|
80
|
+
| 要素 | 意味 | 記述時の判定基準 |
|
|
81
|
+
| ----- | ------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
82
|
+
| Why | 解決する課題、守る価値、その判断が必要な理由 | 読み手が「なぜ扱うのか」と、扱わない場合の影響または目指す価値を説明できる |
|
|
83
|
+
| What | Why に応える成果、状態、条件、範囲、または決定事項 | 達成・合意・選択したかを判定でき、特定の手段を前提にしなくても意味が通る |
|
|
84
|
+
| How | What を実現・維持・判定する方針、責任分担、手順、または方式 | 対応する What が明らかで、成果物の責務を超える詳細は後続成果物へ委譲されている |
|
|
85
|
+
| Trace | Why、What、How と根拠・証跡の対応を後から確認できる識別・参照 | 主要な主張を ID、同じ行、参照、対応表、または許可されたフィールドでたどり直せる |
|
|
86
|
+
|
|
87
|
+
Why は What の必要性を説明し、What は How が満たすべき境界を定める。Trace は独立した説明を増やす要素ではなく、Why → What → How の対応と、その根拠・判断結果を検証可能にする。詳細な How から書き始めた場合も、対応する What と Why を確認し、対応先のない手段は削除する。
|
|
88
|
+
|
|
89
|
+
### 5.2. Recipe への適用方法
|
|
90
|
+
|
|
91
|
+
- 「このレシピの使い方」には、その成果物が引き継ぐ Why、定義する What、扱ってよい How、用いる Trace を成果物固有の語彙で示す。共通原則の定義は複製しない。
|
|
92
|
+
- 「作成前に集める情報」と「各章の書き方」には、主要な What がどの Why に応え、How がどの What を支えるかを具体化できる問いを置く。
|
|
93
|
+
- 「深掘り手順」は、手段の追加ではなく、孤立した What、根拠のない How、追跡できない主張を見つける順序にする。
|
|
94
|
+
- 「レビュー観点」または「仕上げチェック」には、成果物固有の対応関係と委譲境界を確認する項目を置く。
|
|
95
|
+
- 4 要素すべてを成果物内へ再掲する必要はない。上位成果物を正本とする Why などは参照で引き継ぎ、この成果物が更新責任を持つ要素だけを書く。
|
|
96
|
+
|
|
97
|
+
### 5.3. 成果物形式ごとの表し方
|
|
98
|
+
|
|
99
|
+
| 形式 | 適用方法 |
|
|
100
|
+
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
101
|
+
| Markdown 本文 | 既存の章と問いへ分散して記述する。主要な主張が離れる場合は、文書 ID、項目 ID、または短い対応表で接続する。 |
|
|
102
|
+
| 表形式の登録簿 | 1 行を一つの管理対象とし、行 ID、理由・影響、対象・条件、対応、根拠・証跡の列または参照先で接続する。同じ説明を複数行へ複製しない。 |
|
|
103
|
+
| YAML / JSON | schema で許可された ID、参照フィールド、配列要素間のキーで接続する。Why・What・How のために schema 外のキーを追加せず、詳細説明は責務を持つ上位文書へ委譲する。 |
|
|
104
|
+
| 実行結果・ログ | plan の完了条件を Why / What の根拠として引き継ぎ、実施内容、検証結果、判断、変更対象を同じ result または安定した参照で追跡できるようにする。 |
|
|
105
|
+
|
|
106
|
+
識別情報だけを定義する YAML、生成物、機械的な索引など、形式または schema が説明文を持たない成果物では、4 要素の明示を要求しない。recipe は許可された参照と下流利用の整合だけを求め、説明の正本へ委譲する。生成物は直接編集せず、その生成元で対応を維持する。
|
|
107
|
+
|
|
108
|
+
### 5.4. アンチパターン
|
|
109
|
+
|
|
110
|
+
| アンチパターン | 判定 |
|
|
111
|
+
| ----------------------------- | ------------------------------------------------------------------------------------------- |
|
|
112
|
+
| 4 要素を固定章として追加する | 既存の成果物責務や形式に関係なく `Why`、`What`、`How`、`Trace` の章を増やしている |
|
|
113
|
+
| 手段が目的化する | ツール導入、会議開催、文書作成などの How だけがあり、対応する価値・課題と成果が説明できない |
|
|
114
|
+
| 同じ Why を各成果物へ複製する | 上位成果物を参照できるのに、背景や目的を言い換えて複数の成果物で正本化している |
|
|
115
|
+
| What と How の粒度が混在する | 成果・条件と、実装クラス、詳細 API、会議の進行手順などが同じ管理単位に並んでいる |
|
|
116
|
+
| Trace のために説明を重複する | ID や参照で接続できる内容を、対応を示す目的だけで別章・別行へ再掲している |
|
|
117
|
+
| 追跡先のない主張・手段を残す | 主要な What が Why に結び付かない、または How が支える What を特定できない |
|
|
118
|
+
|
|
119
|
+
## 6. 内容充実化(薄いドキュメント防止)
|
|
120
|
+
|
|
121
|
+
- 各必須章には、最低 3 つ以上の具体項目(箇条書き・表項目・問い)を置く。
|
|
122
|
+
- 「適切に」「十分に」などの抽象語だけで終わらせず、判断可能な条件を書く。
|
|
123
|
+
- 少なくとも 1 つの章で、対応 rulebook の本文構成と章を対応付けて書き方を示す。
|
|
124
|
+
- 数値目標を扱う章では、測定方法と判定タイミングまで踏み込む。
|
|
125
|
+
- ただし、実装依存の詳細(SQL 全文、具体クラス名、詳細 API 設計)には踏み込まない。
|
|
126
|
+
|
|
127
|
+
## 7. 禁止事項
|
|
128
|
+
|
|
129
|
+
- 章番号なし見出し(例: `## このレシピの使い方`)を使用しない。
|
|
130
|
+
- 章番号末尾の `.` を省略しない。
|
|
131
|
+
- 章参照を番号のみ(例: `§4` / `第4章`)で記述しない。
|
|
132
|
+
- rulebook の構造・必須項目・禁止事項を recipe 側で再定義しない。
|
|
133
|
+
- 本文に rulebook / sample への wikilink や照合指示(「rulebook の本文構成に従っている」「sample と同程度の粒度」など)を書かない。対応関係は frontmatter で示す。
|
|
134
|
+
- rulebook / recipe / sample / template の種別ごとの役割分担表を recipe 本文に置かない(実践の型全体の役割は [kata-guide.md](../guides/kata-guide.md) が扱う)。
|
|
135
|
+
- 曖昧語(十分、適切、問題ない)を根拠なく使用しない。
|
|
136
|
+
- recipe 本文に実装詳細(SQL 全文、具体クラス名、詳細 API 設計)を書かない。
|
|
137
|
+
- _TODO_: / _UNDECIDED_: / _ASSUMPTION_: 以外の独自ラベルを、共通ルール未定義のまま追加しない。
|
|
138
|
+
|
|
139
|
+
## 8. 運用ルール
|
|
140
|
+
|
|
141
|
+
- 対応 rulebook の本文構成が変わった場合は、recipe の各章の書き方を追従させる。
|
|
142
|
+
- 大量のケース列挙や実データは recipe ではなく対象成果物側に置く。recipe では「作り方」を定義する。
|
|
143
|
+
- 表は必要に応じて `SpecDojo: Format Markdown Table` コマンドで揃える。
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:reference-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
based_on:
|
|
7
|
+
- specdojo:document-metadata-standard
|
|
8
|
+
- specdojo:id-and-file-naming-standard
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# リファレンス記述標準
|
|
12
|
+
|
|
13
|
+
Reference Authoring Standard
|
|
14
|
+
|
|
15
|
+
SpecDojo のリファレンス文書を、一貫して検索・参照できる形で作成・更新するための標準を定義します。
|
|
16
|
+
|
|
17
|
+
## 1. 目的と適用範囲
|
|
18
|
+
|
|
19
|
+
本標準は `docs/ja/specdojo/references/` 配下の `*-reference.md` に適用します。
|
|
20
|
+
|
|
21
|
+
リファレンスは、成果物、コマンド、設定項目などを一覧・比較・確認するための文書です。読者が特定の項目を素早く引けることを目的とし、背景から順に理解させる guide や、遵守事項を定める standard とは役割を分けます。
|
|
22
|
+
|
|
23
|
+
exec plan における「実践の型」は rulebook / recipe / sample / template を指します。本標準の `reference` は文書種別であり、exec plan が参照する資料種別を追加・変更するものではありません。
|
|
24
|
+
|
|
25
|
+
## 2. 基本方針
|
|
26
|
+
|
|
27
|
+
- リファレンスは、一覧、比較表、コマンド表、対応表など、目的の情報へ直接到達できる構成にする。
|
|
28
|
+
- 規約・値・仕様の正本が rulebook、standard、スキーマ、CLI 実装などにある場合は、その正本を明示してリンクする。リファレンスを重複した正本にしない。
|
|
29
|
+
- 操作の背景、判断基準、手順の説明は guide に委ね、リファレンスには必要最小限の導線を置く。
|
|
30
|
+
- 生成物の静的な複製を置く場合は、生成元または更新責任を明記する。
|
|
31
|
+
- 項目名、ID、コマンド名、ファイル名は、参照先の正本と同じ表記を使う。
|
|
32
|
+
|
|
33
|
+
## 3. Frontmatter とファイル名
|
|
34
|
+
|
|
35
|
+
Frontmatter は [ドキュメントメタ情報標準](document-metadata-standard.md) に従い、`id`、`type`、`status` を必須とします。
|
|
36
|
+
|
|
37
|
+
```yaml
|
|
38
|
+
---
|
|
39
|
+
specdojo:
|
|
40
|
+
id: specdojo:command-reference
|
|
41
|
+
type: reference
|
|
42
|
+
status: draft
|
|
43
|
+
---
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
- `type` は必ず `reference` とする。
|
|
47
|
+
- ファイル名は原則としてlocal-idと一致させ、完全IDは `specdojo:*`、local-idは `*-reference` で終える。
|
|
48
|
+
- 置換前の文書がある場合は、`supersedes` に旧IDを記録する。
|
|
49
|
+
- スキーマの正本は [reference-frontmatter.schema.yaml](../../../specdojo/schemas/v1/reference-frontmatter.schema.yaml) とする。
|
|
50
|
+
|
|
51
|
+
## 4. 導入ブロック
|
|
52
|
+
|
|
53
|
+
H1 と概要文の直下、最初の `##` 見出しより前に、次の3ブロックをこの順で置きます。各ブロックは `**ラベル**` だけの段落で始め、内容は箇条書きで書きます。guide の `対象読者` / `この文書で分かること` / `次に読む文書` と対になる構成です。
|
|
54
|
+
|
|
55
|
+
| ラベル | 書く内容 |
|
|
56
|
+
| ---------------- | ------------------------------------------------------ |
|
|
57
|
+
| 対象範囲 | このリファレンスが扱う対象の範囲(何を網羅しているか) |
|
|
58
|
+
| ここで引けるもの | 引ける項目の種類(一覧、比較軸、値、導線) |
|
|
59
|
+
| 詳細の参照先 | 背景・判断・手順を委ねる guide や、規約の正本 |
|
|
60
|
+
|
|
61
|
+
```markdown
|
|
62
|
+
**対象範囲**
|
|
63
|
+
|
|
64
|
+
- `specdojo` CLI の主要コマンド
|
|
65
|
+
|
|
66
|
+
**ここで引けるもの**
|
|
67
|
+
|
|
68
|
+
- コマンドごとの用途と実行例、共通オプション
|
|
69
|
+
|
|
70
|
+
**詳細の参照先**
|
|
71
|
+
|
|
72
|
+
- CLI 全体の流れは [遂行の技活用ガイド](../guides/waza-guide.md) を参照してください。
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
機械検証は [reference-content.schema.yaml](../schemas/v1/reference-content.schema.yaml) を SSOT とし、`npm run lint:fm` で検証します。
|
|
76
|
+
|
|
77
|
+
## 5. 本文構成
|
|
78
|
+
|
|
79
|
+
リファレンスに一律の章構成は設けません。対象を引きやすい単位で、見出しと表を構成します。
|
|
80
|
+
|
|
81
|
+
- 文体は「です・ます」体を既定とします。guide と同じ読み手向けの説明文書として統一し、1 つのリファレンス内で「である」体と混在させません。
|
|
82
|
+
- 一覧表には、少なくとも項目の識別子または名称と、その意味・用途を含める。
|
|
83
|
+
- 複数の類似項目を扱う場合は、比較に必要な観点を同じ列で示す。
|
|
84
|
+
- 参照先が多い場合は、対象領域ごとに見出しを分け、見出しだけで探せるようにする。
|
|
85
|
+
|
|
86
|
+
## 6. 更新と正本の管理
|
|
87
|
+
|
|
88
|
+
- 正本となる規約、スキーマ、CLI の公開インターフェースを変更したときは、対応するリファレンスも同じ変更で見直す。
|
|
89
|
+
- リファレンスにしか存在しない値や規則を追加しない。必要なら先に standard、rulebook、スキーマ、または実装の正本を更新する。
|
|
90
|
+
- リファレンスの追加・移動・改名時は、リンク元、VitePress サイドバー、文書インデックスを更新する。
|
|
91
|
+
- 廃止したリファレンスは削除前に `supersedes` と参照リンクを移行する。
|
|
92
|
+
|
|
93
|
+
## 7. 禁止事項
|
|
94
|
+
|
|
95
|
+
- リファレンスを、規約の唯一の正本として扱わない。
|
|
96
|
+
- 一連の作業手順や判断理由を長文で重複記述しない。
|
|
97
|
+
- 更新元が不明な静的コピーを、最新の一覧や仕様として掲載しない。
|
|
98
|
+
- `reference` を exec plan の `reference_materials` の種別として扱わない。
|
|
99
|
+
- `導入ブロック` の3ブロックを省略しない。ラベル名を変えない。順序を入れ替えない。
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:rulebook-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: ready
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Rulebook 記述標準
|
|
9
|
+
|
|
10
|
+
Rulebook Authoring Standard
|
|
11
|
+
|
|
12
|
+
`docs/ja/specdojo/rulebooks/` 配下の各 `*-rulebook.md` が従うべき章立て・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
13
|
+
|
|
14
|
+
## 1. 適用範囲
|
|
15
|
+
|
|
16
|
+
- 対象: `docs/ja/specdojo/rulebooks/` 配下のすべての `*-rulebook.md`
|
|
17
|
+
- 目的: 章構成・見出しレベル・記述品質・Frontmatter を統一し、参照・保守を容易にする
|
|
18
|
+
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
19
|
+
- 参照スキーマ: [rulebook-frontmatter.schema.yaml](../../../specdojo/schemas/v1/rulebook-frontmatter.schema.yaml)
|
|
20
|
+
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
21
|
+
|
|
22
|
+
## 2. 見出しレベルと章番号の原則
|
|
23
|
+
|
|
24
|
+
- `#` はタイトルのみ。章は `##` から開始する。
|
|
25
|
+
- 章番号は 1 始まりの連番。スキップしない(例: `## 1.`, 次は `## 2.`)。
|
|
26
|
+
- 章番号末尾には必ず `.` を付ける。
|
|
27
|
+
- 章への参照は章番号ではなく章タイトルで記載する(例: `本文構成(標準テンプレ)`)。
|
|
28
|
+
- タイトル直下に **英語名(1行)** を置き、その直下に **目的・概要(1〜3文)** を置く。
|
|
29
|
+
|
|
30
|
+
## 3. Frontmatter 規約
|
|
31
|
+
|
|
32
|
+
- ファイル名は `<prefix>-rulebook.md` とする。
|
|
33
|
+
- `id` / `type` / `status` を必須とし、共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
34
|
+
- `type` は `rulebook` 固定とする。
|
|
35
|
+
- `id` はauthority、英小文字・数字・ハイフンで構成し、一意にする(正確な制約は参照スキーマに従う)。
|
|
36
|
+
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
37
|
+
|
|
38
|
+
| 項目 | 必須 | 説明 |
|
|
39
|
+
| ------------- | ---- | -------------------------------------------------------------- |
|
|
40
|
+
| id | ○ | `specdojo:<prefix>-rulebook` 形式の一意 ID |
|
|
41
|
+
| type | ○ | `rulebook` 固定 |
|
|
42
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
43
|
+
| target_format | 任意 | 対象ドキュメントのフォーマット(`yaml` / `json` / `markdown`) |
|
|
44
|
+
| recipe | 任意 | 対応する recipe の完全 ID、`undecided`、`not-needed` |
|
|
45
|
+
| sample | 任意 | 対応する sample の完全 ID または ID 配列、上記2状態 |
|
|
46
|
+
| template | 任意 | 対応する template の完全 ID、`undecided`、`not-needed` |
|
|
47
|
+
| based_on | 任意 | 上位規約や根拠ドキュメント |
|
|
48
|
+
| supersedes | 任意 | 置き換え関係 |
|
|
49
|
+
|
|
50
|
+
- `target_format` が未記載の場合は markdown を対象とみなす。
|
|
51
|
+
- `recipe` / `sample` / `template` は要否と所在の正本であり、`undecided` は要否未判断、項目省略は必要だが未整備、完全 ID は必要かつ整備済み、`not-needed` は不要を表す。
|
|
52
|
+
- 完全 ID は `fully-guided` / `recipe-guided` の plan 生成で参照先パスの解決に使う(rulebook を参照ハブとする)。命名規約に従う場合も明示的に宣言し、宣言された参照先ファイルが存在しないと `exec validate` が警告する。`sample` の拡張子は `target_format` に従う。
|
|
53
|
+
- 同じ rulebook 系統に複数の完成例がある場合、`sample` を ID 配列で宣言する。配列の先頭を既定例として使う。
|
|
54
|
+
- 機械検証は [rulebook-frontmatter.schema.yaml](../../../specdojo/schemas/v1/rulebook-frontmatter.schema.yaml) を SSOT とする。
|
|
55
|
+
|
|
56
|
+
記述例:
|
|
57
|
+
|
|
58
|
+
```yaml
|
|
59
|
+
---
|
|
60
|
+
specdojo:
|
|
61
|
+
id: specdojo:imp-business-rulebook
|
|
62
|
+
type: rulebook
|
|
63
|
+
status: draft
|
|
64
|
+
---
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## 4. 標準章構成(`*-rulebook.md`)
|
|
68
|
+
|
|
69
|
+
章構成は以下を原則とする。不要な章は省略可だが、省略理由を記載することを推奨する。
|
|
70
|
+
|
|
71
|
+
| 章番号 | 章タイトル | 必須 | 説明 |
|
|
72
|
+
| ------ | --------------------- | ---- | ------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
+
| 1 | 全体方針 | ○ | 目的・適用範囲・記載レベルの方針をまとめる |
|
|
74
|
+
| 2 | 位置づけと用語定義 | 任意 | Mermaid などで関係を示し、複数の解釈を防ぐ必要がある用語だけを定義する。用語定義が不要な場合は章を`位置づけ`とする |
|
|
75
|
+
| 3 | ファイル命名・ID規則 | ○ | id / ファイル名 / 命名規則 |
|
|
76
|
+
| 4 | 推奨 Frontmatter 項目 | 任意 | スキーマと必須/任意の項目 |
|
|
77
|
+
| 5 | 本文要件 | ○ | 各章・キーの目的、必須・任意、記述規約。template 未整備系統では開始時の参考となる本文構成も扱う |
|
|
78
|
+
| 6 | 記述ガイド | ○ | 各章の書き方、推奨表、例など |
|
|
79
|
+
| 7 | 禁止事項 | ○ | してはいけない記述、スキーマ違反など |
|
|
80
|
+
| 8 | サンプル | 任意 | 最小例を rulebook 内にコードブロックで自己完結して埋め込む(別ファイルへのリンクにしない) |
|
|
81
|
+
|
|
82
|
+
補足:
|
|
83
|
+
|
|
84
|
+
- template を文書 ID で宣言する系統では、見出し順・表・記入欄の骨組みを template の正本とし、rulebook の本文要件には各章・キーの目的、必須・任意、記述規約を残す。同じ見出しの羅列を転載しない。
|
|
85
|
+
- `template: not-needed`、`template: undecided`、template 項目省略の系統では、成果物の内容要件を判断できるよう、本文要件に必要な章・キーと必須・任意を記載する。
|
|
86
|
+
- 記述ガイドには、章ごとの書き方と例(表・サンプル)を置き、重複を避けるため共通事項は上位(index)を SSOT とする方針を記載する。
|
|
87
|
+
- sample / recipe / template との対応関係は Frontmatter の `sample` / `recipe` / `template` だけで示す。本文にリンク章(`サンプル` / `作成レシピ` / `テンプレート`)や wikilink を置かない。fully-guided 実行では rulebook と recipe だけが読み込まれるため、sample / template への本文中のリンクは実行不能な指示になる。
|
|
88
|
+
- 用語定義は、ドメイン固有語や同じ語に複数の解釈がある場合だけ置く。本文構成(標準テンプレ)や記述ガイドで見出し・用語の意味を十分に定義できる場合は、重複を避けて用語定義を省略する。
|
|
89
|
+
|
|
90
|
+
## 5. 記述ガイド
|
|
91
|
+
|
|
92
|
+
- 各章は「何を定義する章か」が判定できる粒度で記述する。
|
|
93
|
+
- `本文要件` には、対象ドキュメントの各章・キーが担う目的と必須・任意を明示する。template 宣言済みの場合は骨組みを重複記載しない。
|
|
94
|
+
- `記述ガイド` には、章ごとの書き方、推奨表、記載例を置く。
|
|
95
|
+
- 共通事項は上位ドキュメントを SSOT とし、重複記載を避ける。
|
|
96
|
+
- 用語はファイル内で統一し、`index` / `overview` などの命名ゆれを持ち込まない。
|
|
97
|
+
- 用語定義を置く場合は、本文構成の見出し名や記述ガイドを単に言い換えて重複させない。重複になる場合は用語定義を省略する。
|
|
98
|
+
- `推奨 Frontmatter 項目` の記述は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
99
|
+
- `ファイル命名・ID規則` は [docs-structure-guide.md](../guides/docs-structure-guide.md) に従う。
|
|
100
|
+
- `target_format` がある場合は、本文ルール・記述例を対象フォーマットに合わせる。未記載の場合は markdown を対象とみなす(`Frontmatter 規約` 参照)。
|
|
101
|
+
- `target_format: yaml` / `json` の場合は、Frontmatter と同等の先頭メタ項目、ルートキー、必須キー、型制約を実装可能な粒度で定義する。
|
|
102
|
+
- 未確定事項や仮置き情報は、本文中に次の共通ラベルで記述する。
|
|
103
|
+
- _TODO_: 後で人または生成 AI が確認・追記・修正する必要がある事項
|
|
104
|
+
- _UNDECIDED_: 情報不足ではなく、意思決定が未了で未確定の事項
|
|
105
|
+
- _ASSUMPTION_: 現時点で仮置きしている前提・仮説
|
|
106
|
+
- `サンプル` 章を置く場合は、最小例をコードブロックで本文内に自己完結して埋め込む。sample ファイルの要否と所在は Frontmatter の `sample` で宣言し、本文にリンクを記載しない。
|
|
107
|
+
- template が不要な場合は Frontmatter へ `template: not-needed`、要否未判断なら `template: undecided` を宣言する。項目省略は必要だが未整備を表す。いずれも `deliverable scaffold` は最小雛形へ退避する。
|
|
108
|
+
|
|
109
|
+
## 6. 内容充実化(薄いドキュメント防止)
|
|
110
|
+
|
|
111
|
+
- 各必須章には、最低 3 つ以上の具体項目(箇条書きまたは表項目)を置く。
|
|
112
|
+
- 「適切に」「十分に」などの抽象語だけで終わらせず、判断可能な条件を書く。
|
|
113
|
+
- 少なくとも 1 つは、推奨表のカラム定義(例: ID、目的、条件、判定基準、担当)を提示する。
|
|
114
|
+
- 要求、品質特性、テスト/受入、運用/保守、トレーサビリティの欠落有無を確認する。
|
|
115
|
+
- [成果物リファレンス](../references/deliverables-reference.md) の記述が短い場合でも、類似 rulebook、一般的開発知見、PMBOK 成果物観点で必要観点を補完する。
|
|
116
|
+
- ただし、実装依存の詳細(SQL 全文、具体クラス名、詳細 API 設計)には踏み込まない。
|
|
117
|
+
|
|
118
|
+
## 7. 禁止事項
|
|
119
|
+
|
|
120
|
+
- 章番号なし見出し(例: `## 全体方針`)を使用しない。
|
|
121
|
+
- 章番号末尾の `.` を省略しない。
|
|
122
|
+
- 章参照を番号のみ(例: `§5` / `第5章`)で記述しない。
|
|
123
|
+
- 本文に sample / recipe / template への wikilink・リンク章を置かない。対応関係は Frontmatter の `sample` / `recipe` / `template` で示す。
|
|
124
|
+
- rulebook 本文に実装詳細(SQL 全文、具体クラス名、詳細 API 設計)を書かない。
|
|
125
|
+
- 曖昧語(十分、適切、問題ない)を根拠なく使用しない。
|
|
126
|
+
- _TODO_: / _UNDECIDED_: / _ASSUMPTION_: 以外の独自ラベルを、共通ルール未定義のまま追加しない。
|
|
127
|
+
- 確定済みの内容をラベル付きのまま放置したり、ラベルを本文の代替として多用したりしない。
|
|
128
|
+
|
|
129
|
+
## 8. 運用ルール
|
|
130
|
+
|
|
131
|
+
- 章構成を変更する際は、本書の表を更新し、既存の `*-rulebook.md` と整合させる。
|
|
132
|
+
- 実データや大量のケース列挙は本書ではなく対象ドキュメント側に置く。本書では「書き方・構成」を定義する。
|
|
133
|
+
- 表は必要に応じて `SpecDojo: Format Markdown Table` コマンドで揃える。
|
|
134
|
+
- `status: ready` かつ `target_format: yaml` / `json` の rulebook は、`<prefix>-rulebook.md` と
|
|
135
|
+
`docs/specdojo/schemas/v1/<prefix>.schema.yaml` がともに存在する場合、同じ成果物系統として
|
|
136
|
+
`validate:schema:rulebook-enums` の検査対象になる。
|
|
137
|
+
- 検査対象の rulebook 本文には、対応 schema の文字列 enum 値を独立した値としてすべて明記する。
|
|
138
|
+
Frontmatter と scaffold 専用の `_PLACEHOLDER_` 値は網羅判定に使用しない。
|
|
139
|
+
- 対応 schema がない rulebook、`draft` / `deprecated` の rulebook、Markdown を対象とする
|
|
140
|
+
rulebook は enum 網羅検査の対象外とする。
|