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,227 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:git-branching-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Git ブランチ運用標準
|
|
9
|
+
|
|
10
|
+
Git Branching Standard
|
|
11
|
+
|
|
12
|
+
SpecDojo Unit を管理するリポジトリで、プロジェクト単位の変更と task 単位の自動実行を安全に統合するためのブランチ構成、命名、統合方向、保護条件を定義します。具体的な操作は [branch-workflow-guide.md](../guides/branch-workflow-guide.md) を参照してください。
|
|
13
|
+
|
|
14
|
+
## 1. 目的・適用範囲
|
|
15
|
+
|
|
16
|
+
- 一つのリポジトリで `prj-xxxx` 単位のプロジェクトを管理し、プロジェクトごとに feature 作業または SpecDojo exec を実行する場合に適用します。
|
|
17
|
+
- `main`、プロジェクト統合ブランチ、feature ブランチ、exec ブランチの責務と統合方向を規定します。
|
|
18
|
+
- Git worktree を使わない作業にも命名と統合方向を適用し、worktree を使う場合はベースブランチの解決条件を追加で適用します。
|
|
19
|
+
|
|
20
|
+
## 2. 基本方針
|
|
21
|
+
|
|
22
|
+
- `main` はリポジトリ全体で共有する安定した統合点とし、プロジェクト進行中の未統合変更を直接蓄積しません。
|
|
23
|
+
- 各プロジェクトは `project/<project-id>/develop` を中核の統合ブランチとし、そのプロジェクトの feature と exec の分岐元・統合先を一つにします。
|
|
24
|
+
- 人が管理する feature、SpecDojo が管理する exec、対話型 agent の常設 worktree を名前空間とライフサイクルで分離します。
|
|
25
|
+
- 統合方向を固定し、task ブランチから `main` へ直接変更が流入する経路を作りません。
|
|
26
|
+
|
|
27
|
+
## 3. ブランチの種類と命名
|
|
28
|
+
|
|
29
|
+
| 種類 | 命名パターン | 必須 | 分岐元 | 統合先 | 管理主体 |
|
|
30
|
+
| ---------------- | ------------------------------ | ---- | -------------------------- | -------------------------- | ---------------- |
|
|
31
|
+
| 安定統合 | `main` | ○ | - | - | リポジトリ管理者 |
|
|
32
|
+
| プロジェクト統合 | `project/<project-id>/develop` | ○ | `main` | `main` | プロジェクト |
|
|
33
|
+
| feature | `feature/<project-id>/<topic>` | ○ | 対象 project の `develop` | 対象 project の `develop` | 人 |
|
|
34
|
+
| exec | `exec/<project-id>-<task-id>` | ○ | 実行時の project `develop` | 実行時の project `develop` | SpecDojo CLI |
|
|
35
|
+
|
|
36
|
+
- `<project-id>` は対象プロジェクトの ID と一致させます。
|
|
37
|
+
- `<topic>` は英小文字、数字、ハイフンを使い、変更の目的を識別できる名前にします。
|
|
38
|
+
- `<task-id>` は対象 schedule task の ID から機械的に導出します。
|
|
39
|
+
- 既存の `feature/<topic>` は進行中の作業が完了するまで使用できます。新規作成する feature には project ID を含めます。
|
|
40
|
+
|
|
41
|
+
### 3.1. 対話型 agent の常設 worktree
|
|
42
|
+
|
|
43
|
+
対話型オーケストレーターを隔離して起動する常設 worktree は、ブランチを `worktree/<name>`、配置を `../worktrees/<name>` とします。`<name>` は `claude-work`、`codex-work`、`copilot-work`、`qwen-work`、`gemma-work` のいずれかです。
|
|
44
|
+
|
|
45
|
+
- `worktree/` は常設の agent 作業ブランチを表す名前空間です。task ごとに作成・削除する `exec/` と区別し、`git branch --list "worktree/*"` で一括列挙できるようにします。
|
|
46
|
+
- 起動スクリプトは、既存 worktree の実際のブランチが `worktree/<name>` と一致することを確認します。不一致の場合は agent を起動せず、先に未コミット変更と独自 commit を確認して移行します。
|
|
47
|
+
- Claude Code の `--worktree` は、ブランチを `worktree-<name>`、配置を `.claude/worktrees/<name>` に固定して他の agent と揃えられないため使用しません。全 agent で `git worktree add` を使用します。
|
|
48
|
+
|
|
49
|
+
## 4. 分岐・統合の規範
|
|
50
|
+
|
|
51
|
+
標準の変更経路は次のとおりです。
|
|
52
|
+
|
|
53
|
+
```text
|
|
54
|
+
main
|
|
55
|
+
└─ project/<project-id>/develop
|
|
56
|
+
├─ feature/<project-id>/<topic>
|
|
57
|
+
└─ exec/<project-id>-<task-id>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
| 操作 | 判定基準 |
|
|
61
|
+
| ---------------------------------------- | ------------------------------------------------------------------------- |
|
|
62
|
+
| project `develop` の作成 | `main` の確認済み commit から分岐している |
|
|
63
|
+
| feature / exec の作成 | 対象 project の `develop` の commit から分岐している |
|
|
64
|
+
| feature / exec の統合 | 対象 project の `develop` に統合し、別 project や `main` へ直接統合しない |
|
|
65
|
+
| project `develop` の `main` への統合 | 必要な検証とレビューが成功し、変更範囲と未解決事項を確認している |
|
|
66
|
+
| `main` の project `develop` への取り込み | 共有中の `develop` の履歴を書き換えず、merge で取り込んでいる |
|
|
67
|
+
|
|
68
|
+
- `exec worktree merge` は実行した現在ブランチを統合先とするため、実行前に対象 project の `develop` であることを確認します。
|
|
69
|
+
- feature または exec の統合後も project の完了判断までは `develop` を保持します。
|
|
70
|
+
- project `develop` から `main` への統合は Pull Request または同等のレビュー可能な変更単位で行います。
|
|
71
|
+
|
|
72
|
+
### 4.1. developへ入る3層の変更経路
|
|
73
|
+
|
|
74
|
+
project `develop` へ入る変更は、変更の作成主体と事前レビューの要否により次の3層へ分けます。
|
|
75
|
+
|
|
76
|
+
| 層 | 変更の種類 | 作業ブランチ | `develop` への統合方法 |
|
|
77
|
+
| --- | ------------------------------------------------------------- | ------------------------------ | ----------------------------------------------------------- |
|
|
78
|
+
| 1 | SpecDojo exec が task 単位で自動実行する変更 | `exec/<project-id>-<task-id>` | 統合専用 actor が `--no-ff` で merge し、保護を bypass する |
|
|
79
|
+
| 2 | 人または対話型 agent が内容を書いた実装、設定、規範・設計文書 | `feature/<project-id>/<topic>` | Pull Request で差分の承認を得てから merge する |
|
|
80
|
+
| 3 | register の起票・close・状態遷移と、それに伴う生成物の再構築 | project `develop` | 統合専用 actor による直接 commit を許容する |
|
|
81
|
+
|
|
82
|
+
層2と層3の境界は、変更内容に事前レビューの価値があるかで判断します。実装、設定、本文、判断内容のようにレビューで誤りを発見できる変更は、コマンドで生成・記録した場合でも層2です。層3は、既に決まった実行事実を register へ記帳するだけで、内容の判断を伴わない変更に限定します。記帳と内容変更が同じ作業に含まれる場合は、全体を層2として扱います。
|
|
83
|
+
|
|
84
|
+
層3を例外にできるのは、register ID が連番ではなく乱数で採番され、index と view の生成物が `.gitignore` で Git 管理対象外になっており、Git 管理する実体が項目単位の個票と event に分かれているためです。これらの前提が成立しない register や、同じ正本ファイルを複数人が更新する記帳には例外を適用せず、層2として扱います。
|
|
85
|
+
|
|
86
|
+
exec に流す `todo` の個票と実行に必要な記帳は、実行前に project `develop` へ統合済みでなければなりません。`exec run --worktree` は project `develop` の commit を起点に worktree を作るため、feature にだけ存在する `todo` は実行対象にしません。
|
|
87
|
+
|
|
88
|
+
### 4.2. 運用規模ごとの必須条件
|
|
89
|
+
|
|
90
|
+
3層の分類、feature と exec の分岐元・統合先、および exec 対象を事前に `develop` へ入れる制約は、運用規模にかかわらず適用します。運用基盤に関する条件は次のように区別します。
|
|
91
|
+
|
|
92
|
+
| 条件 | 単独運用 | 複数人・複数 actor 運用 |
|
|
93
|
+
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
94
|
+
| 層2の統合レビュー | 作成者と独立した承認者が参加していない期間は、ローカルの差分確認と `--no-ff` merge を Pull Request の代替にできる。リモートの有無では判断しない | Pull Request を必須とし、作成者以外が参加できるレビュー単位を `develop` へ入る前に作る |
|
|
95
|
+
| project `develop` の branch protection | 省略できる | 必須。人の直接 push、force-push、削除を禁止する |
|
|
96
|
+
| 統合専用 actor | 作業者と分離できない場合は省略できる | 必須。exec の merge と層3の直接 commit だけに bypass を許可し、人の層2変更には使わない |
|
|
97
|
+
| feature を切る前の project `develop` のリモート反映 | リモートや Pull Request を使わない場合は省略できる | 必須。ローカル先端を push し、リモートの `develop` と一致することを確認してから feature を切る |
|
|
98
|
+
|
|
99
|
+
単独運用から複数人・複数 actor 運用へ移る前に、統合専用 actor と branch protection を準備します。準備できない猶予期間は単独運用の条件を複数人運用へ流用せず、対象、理由、期間、復帰条件を project register に記録します。
|
|
100
|
+
|
|
101
|
+
### 4.3. developからmainへの昇格方式
|
|
102
|
+
|
|
103
|
+
project `develop` から `main` への昇格は、`develop` の先端を第2 parent とする merge commit を必ず作ります。ローカルで再現する場合は `git merge --no-ff`、Pull Request では merge commit を作る方式を選びます。squash merge と rebase merge は使用しません。
|
|
104
|
+
|
|
105
|
+
この方式で「まとめる」対象は物理的な commit 数ではなく、`main` の first-parent 履歴です。`develop` の細かな commit は監査と `register history` のために DAG へ保持し、プロダクト変更を追うときは次の表示を正規の履歴とします。
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
git log --first-parent --oneline main
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
昇格 merge commit の subject は昇格した変更範囲を要約し、Pull Request から検証結果、承認、未解決事項を追跡できるようにします。通常の `git log` では `develop` の詳細 commit も表示されます。first-parent 表示で1昇格を1行に集約しながら、次の性質を維持することが採用理由です。
|
|
112
|
+
|
|
113
|
+
- 昇格済みの `develop` commit がすべて `main` の祖先となり、次回の昇格で再び未マージ扱いになりません。
|
|
114
|
+
- `main` の更新を共有中の `develop` へ通常の merge で取り込めます。fast-forward できる場合も履歴を書き換えません。
|
|
115
|
+
- push 済み commit の ID と到達可能性を保ち、Git 履歴へフォールバックする監査情報を失いません。
|
|
116
|
+
|
|
117
|
+
昇格後は、昇格対象だった `develop` の先端が `main` の祖先であることを `git merge-base --is-ancestor` で確認します。squash merge、一時ブランチでの rebase / cherry-pick、特定 commit の除外は元の `develop` との祖先関係を記録しないため、昇格の集約方式として使用しません。
|
|
118
|
+
|
|
119
|
+
#### 適用範囲(本方式が有効になる時点)
|
|
120
|
+
|
|
121
|
+
本方式は、**本規約の適用後に行う昇格から有効になります**。それ以前に作られた `main` の first-parent 履歴は集約されません。
|
|
122
|
+
|
|
123
|
+
`develop` を第2 parent とする merge commit を `main` 上で作らず、`main` 上へ取り込む merge を `develop` 側で実行して `main` を fast-forward した場合、`main` の first-parent 系列は `develop` の詳細 commit を辿ります。過去にこの形で昇格した区間では、`git log --first-parent main` に exec / register の遷移 commit がそのまま現れます。
|
|
124
|
+
|
|
125
|
+
既存の first-parent 系列を集約するには push 済み履歴の書き換えが必要であり、本規約は書き換えを禁止します。したがって過去区間はそのまま残します。読み手は、集約された first-parent 表示が得られるのは本規約適用後の区間である、と理解して利用します。
|
|
126
|
+
|
|
127
|
+
昇格を行う担当者は、merge の向きが逆にならないよう次を確認します。`main` を checkout した状態で `develop` を merge する、または Pull Request の base を `main`、head を `develop` として merge commit を作る方式を選びます。
|
|
128
|
+
|
|
129
|
+
## 5. 同期・履歴・保護
|
|
130
|
+
|
|
131
|
+
- `main` と共有中の project `develop` では force-push と履歴を書き換える rebase を禁止します。
|
|
132
|
+
- 公開済みで他の作業者が参照する feature では、合意なく force-push または rebase を行いません。
|
|
133
|
+
- `main` の更新は project `develop` へ定期的に mergeし、長期間の乖離を避けます。
|
|
134
|
+
- feature worktree は対象 project の `develop` を明示的なベースとして同期します。
|
|
135
|
+
- 複数プロジェクトを並行する場合、main worktree の現在ブランチによるベース自動判定だけに依存せず、対象 project の `develop` を指定します。
|
|
136
|
+
- `main` には branch protection を設定し、直接 push を禁止し、Pull Request と最低 1 名の承認、必須 CI の成功を merge 条件にします。
|
|
137
|
+
- GitHub のリポジトリ設定では merge commit だけを許可し、squash merge と rebase merge を無効にします。これは Pull Request 画面で誤った昇格方式を選べないようにするサーバ側の設定です。
|
|
138
|
+
- 複数人・複数 actor 運用の `project/<project-id>/develop` には branch protection を設定します。人または対話型 agent が内容を書いた feature は Pull Request を必須とし、exec の merge と register の記帳だけは統合専用 actor による bypass を許可します(承認ゲートの適用範囲は `承認ゲートと PR 強制条件` を参照)。
|
|
139
|
+
- 承認者は `CODEOWNERS` で宣言し、branch protection の "Require review from Code Owners" で強制します。`main` はリポジトリ管理者、各 project の承認対象は当該 project の承認権限者(PO / CCB)を owner に割り当てます。
|
|
140
|
+
|
|
141
|
+
### 5.1. mainへの直接pushを防ぐ防護柵
|
|
142
|
+
|
|
143
|
+
Lefthook の `pre-push` は、Git が標準入力へ渡す各更新の remote ref を検査し、リモート名にかかわらず `refs/heads/main` への更新を拒否します。`project/<project-id>/develop`、feature、exec など他の remote ref への push は妨げません。拒否時は base を `main`、head を project `develop` とする Pull Request を作り、merge commit で昇格するよう案内します。
|
|
144
|
+
|
|
145
|
+
このフックはローカルの誤操作を早期に止める防護柵であり、アクセス制御の境界ではありません。`--no-verify` で迂回でき、Lefthook を導入していない環境では実行されません。実際の境界は GitHub の branch protection であり、`main` への Pull Request、承認、必須 CI をサーバ側で強制します。
|
|
146
|
+
|
|
147
|
+
実際に push せず判定を確認するには、Git の `pre-push` 入力と同じ4フィールドをスクリプトへ渡します。最初のコマンドは終了コード1で拒否メッセージを表示し、2つ目は終了コード0になります。
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
printf '%s\n' 'refs/heads/local LOCAL refs/heads/main REMOTE' \
|
|
151
|
+
| node tools/protect-main-push.mjs
|
|
152
|
+
printf '%s\n' 'refs/heads/local LOCAL refs/heads/project/prj-0001/develop REMOTE' \
|
|
153
|
+
| node tools/protect-main-push.mjs
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## 6. ブランチの完了・削除
|
|
157
|
+
|
|
158
|
+
| ブランチ | 削除できる条件 | 保持する条件 |
|
|
159
|
+
| ----------------- | --------------------------------------------------------------------- | ---------------------------------------------- |
|
|
160
|
+
| feature | 変更が project `develop` に統合され、未退避の作業がない | レビュー中、競合解消中、未統合 commit がある |
|
|
161
|
+
| exec | SpecDojo の結果が project `develop` に統合され、task の記録が完了した | block 中、再実行予定、未commit変更が残っている |
|
|
162
|
+
| project `develop` | project の変更が `main` に統合され、追加対応と監査上の保持理由がない | project が進行中、リリース後対応が残っている |
|
|
163
|
+
|
|
164
|
+
- worktree に関連付いたブランチは、先に worktree の状態と未commit変更を確認してから削除します。
|
|
165
|
+
- exec ブランチは原則として SpecDojo CLI の安全確認付き削除を使用します。
|
|
166
|
+
- 統合確認のためにブランチを恒久保存せず、必要な履歴は commit、Pull Request、exec result、event に残します。
|
|
167
|
+
|
|
168
|
+
## 7. 複数プロジェクトと共通基盤
|
|
169
|
+
|
|
170
|
+
- project 固有の変更と、`src/**`、共通 template、共通 schema など複数 project に影響する変更を区別します。
|
|
171
|
+
- 共通基盤の変更を複数の project `develop` で独立に長期間保持しません。共通変更の統合順序を決め、`main` を経由して各 project `develop` へ同期します。
|
|
172
|
+
- 同一ファイルを複数 project が並行変更する場合は、統合順序、依存関係、担当を project register または同等の管理記録に残します。
|
|
173
|
+
- project 間の依存が解消されるまで、依存先の未統合 commit を別 project の正本として扱いません。
|
|
174
|
+
|
|
175
|
+
## 8. 承認ゲートと PR 強制条件
|
|
176
|
+
|
|
177
|
+
変更の承認は既定で commit(register 状態遷移+チケットの承認節)で残し、人による強制ゲート(PR 承認)は次の 3 ケースに限定します。type 別の承認フローと承認者ロールは [register-operation-guide.md](../guides/register-operation-guide.md) を正本とします。
|
|
178
|
+
|
|
179
|
+
ここでいう承認ゲートは、register 項目を承認済みとする正式な証跡です。4.1 の層2で常に行う feature Pull Request の事前レビューとは区別します。3ケース以外でも層2の変更は Pull Request でレビューしてから統合しますが、その review を register 項目の正式承認へ読み替えず、正式承認は commit とチケットの承認節に残します。
|
|
180
|
+
|
|
181
|
+
| ケース | 境界 | 承認者 | 強制手段 |
|
|
182
|
+
| --------------------------------------------- | -------------------------------- | ------------------------ | ----------------------------------------- |
|
|
183
|
+
| `develop → main` 昇格 | 変更が `main` に載る境界 | リポジトリ管理者 | `main` の branch protection + CODEOWNERS |
|
|
184
|
+
| `change-request` の承認 | 変更要求の実施承認 | 変更承認権限者(PO/CCB) | 承認対象差分の PR approve |
|
|
185
|
+
| 不可逆・高リスク・framework schema 破壊的変更 | `todo`/`issue`/`decision` の一部 | 当該 type の承認権限者 | 承認対象差分の PR approve |
|
|
186
|
+
|
|
187
|
+
- 上記以外の承認(`decision` / `risk` / `question` / `issue` / `todo` の通常運用)は commit ベースで残し、Pull Request を正式承認の証跡にすることを必須にしません。schedule 上の計画済みタスクによる成果物更新や日常の agent commit も、正式承認ゲートの対象外です。ただし、人または対話型 agent が内容を書いた層2の変更であれば、統合経路として feature Pull Request は使用します。
|
|
188
|
+
- PR 承認を強制しない理由は、可逆性(記録のみか実装を伴うか)、職務分離(自己承認の回避が platform 強制でなくても成立するか)、自動化整合(PR ゲートを自動 `exec → develop` の内側に置かない)の 3 点で判断します。
|
|
189
|
+
- 3 ケースに該当する承認は自己承認をカウントせず、作成者と承認者を分離します。承認事実(承認者・承認日・対象差分)は PR で担保し、決定内容の SSOT はチケット個票に恒久保持します。
|
|
190
|
+
|
|
191
|
+
## 9. commit メッセージ規約
|
|
192
|
+
|
|
193
|
+
- subject は `<type>(<scope>): <日本語の要約>` とし、要約を日本語で書きます。`type` は `commitlint.config.cjs` の `type-enum` に定義された値だけを使います。
|
|
194
|
+
- subject は 100 文字以内に収めます(`subject-max-length`)。日本語は情報密度が高いため、詳細は body へ回します。
|
|
195
|
+
- body には「何を変えたか」ではなく「なぜそうしたか」を日本語で書きます。判断の根拠、採らなかった選択肢、制約が該当します。1 行は 100 文字以内にします(`body-max-line-length`)。
|
|
196
|
+
- 関連する登録簿項目がある場合は、body の末尾に `Refs: PJR-XXXX` を記載します。個票が判断の SSOT であり、commit からの追跡経路を残すためです。
|
|
197
|
+
- `exec` 実行に伴う runner の自動 commit(register 状態遷移、worktree の統合など)は、既存の生成規則をそのまま用います。人が書く commit と形式を揃えるために書き換えません。
|
|
198
|
+
|
|
199
|
+
```text
|
|
200
|
+
fix(exec): 保護対象の判定を gitignore 済みファイルの除外へ変更
|
|
201
|
+
|
|
202
|
+
未追跡をすべて除外すると、agent が名簿へ mode を追加して settings ファイルを新規作成し、
|
|
203
|
+
権限プロファイルを自作できるため、ignore 済みだけを除外対象とした。
|
|
204
|
+
|
|
205
|
+
Refs: PJR-T1JW
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## 10. 禁止事項
|
|
209
|
+
|
|
210
|
+
| 禁止事項 | 理由 |
|
|
211
|
+
| -------------------------------------------------------- | -------------------------------------------------- |
|
|
212
|
+
| feature / exec を `main` へ直接統合する | project 単位の検証・レビューを迂回するため |
|
|
213
|
+
| 別 project の `develop` へ統合する | 変更の所属と追跡先が不明になるため |
|
|
214
|
+
| `main` または共有中の `develop` を force-pushする | 他の branch と worktree の比較起点を破壊するため |
|
|
215
|
+
| `develop → main` 昇格で squash / rebase merge を使う | `develop` の祖先関係と Git fallback 履歴を失うため |
|
|
216
|
+
| 統合先を確認せず `exec worktree merge` を実行する | 現在ブランチがそのまま統合先になるため |
|
|
217
|
+
| 未commit変更を確認せず worktree または branch を削除する | 成果物と result を失う可能性があるため |
|
|
218
|
+
| `feature/<project-id>` という終端ブランチを作る | 同名を親に持つ feature 階層を作成できなくなるため |
|
|
219
|
+
| 自動 `exec → develop` 統合に PR 承認ゲートを課す | 自動実行を止め、承認境界を過剰に内側へ広げるため |
|
|
220
|
+
| PR 強制 3 ケースの承認を作成者が自己承認する | 職務分離が崩れ、承認の実効性が失われるため |
|
|
221
|
+
|
|
222
|
+
## 11. 運用・見直しルール
|
|
223
|
+
|
|
224
|
+
- ブランチ命名を変更するときは、SpecDojo の branch 導出、worktree 検索、テスト、関連 guide を同時に確認します。
|
|
225
|
+
- exec の分岐元または統合先の挙動を変更するときは、[exec-worktree-guide.md](../guides/exec-worktree-guide.md) と CLI 実装の整合を確認します。
|
|
226
|
+
- 複数プロジェクト運用で競合や誤統合が繰り返される場合は、ベースブランチの明示を自動実行設定へ昇格させます。
|
|
227
|
+
- 例外運用は対象、理由、期間、復帰条件を project register または同等の管理記録に残します。
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:guide-authoring-standard
|
|
4
|
+
type: standard
|
|
5
|
+
status: draft
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Guide 記述標準
|
|
9
|
+
|
|
10
|
+
Guide Authoring Standard
|
|
11
|
+
|
|
12
|
+
`docs/ja/specdojo/guides/` 配下の各 `*-guide.md` が従うべき構成・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
13
|
+
|
|
14
|
+
## 1. 適用範囲
|
|
15
|
+
|
|
16
|
+
- 対象: `docs/ja/specdojo/guides/` 配下のすべての `*-guide.md`
|
|
17
|
+
- 目的: guide の構成・記述品質を統一し、読み手が考え方・手順・使い方を理解して実行できる説明文書を提供する
|
|
18
|
+
- 位置づけ: guide は規範(must)ではなく、理解・操作・判断を助ける説明と手順を扱う。規範事項は対応する standard / rulebook、規約の前提となる方針・概念は philosophy を正本とする
|
|
19
|
+
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
20
|
+
- 参照スキーマ: [guide-frontmatter.schema.yaml](../../../specdojo/schemas/v1/guide-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. 導入ブロック
|
|
32
|
+
|
|
33
|
+
目的・概要の直下、最初の `##` 見出しより前に、次の3ブロックをこの順で置く。各ブロックは `**ラベル**` だけの段落で始め、内容は箇条書きで書く。
|
|
34
|
+
|
|
35
|
+
| ラベル | 書く内容 |
|
|
36
|
+
| -------------------- | ------------------------------------------------------------- |
|
|
37
|
+
| 対象読者 | この guide を読む役割・立場(誰が読む文書か) |
|
|
38
|
+
| この文書で分かること | 読み終えたときに得られる知識・判断材料の範囲 |
|
|
39
|
+
| 次に読む文書 | この guide の直後に進む文書(2〜3件)。網羅的な一覧は置かない |
|
|
40
|
+
|
|
41
|
+
```markdown
|
|
42
|
+
**対象読者**
|
|
43
|
+
|
|
44
|
+
- Schedule や登録簿のタスクを人またはエージェントで実行・監視する開発者、運用者
|
|
45
|
+
|
|
46
|
+
**この文書で分かること**
|
|
47
|
+
|
|
48
|
+
- 実行経路の選び方、自動・手動実行、状態遷移、blocked 復帰
|
|
49
|
+
|
|
50
|
+
**次に読む文書**
|
|
51
|
+
|
|
52
|
+
- エージェント設定は [exec設定ガイド](exec-config-guide.md) を参照してください。
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
- 「次に読む文書」には、その guide の直接の後続だけを書く。目的別の横断一覧は [specdojo-overview-guide.md](../guides/specdojo-overview-guide.md) の `目的別の次の読み物` を唯一の正本とし、各 guide に同じ一覧を複製しない。
|
|
56
|
+
- 同じ理由で、guide の末尾に全 guide を並べる「詳細ガイド」章を置かない。特定のテーマに閉じた関連文書の列挙は妨げない。
|
|
57
|
+
- 機械検証は [guide-content.schema.yaml](../schemas/v1/guide-content.schema.yaml) を SSOT とし、`npm run lint:fm` で検証する。
|
|
58
|
+
|
|
59
|
+
## 4. Frontmatter 規約
|
|
60
|
+
|
|
61
|
+
- ファイル名は `<name>-guide.md` とする。
|
|
62
|
+
- `id` / `type` / `status` を必須とし、共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
63
|
+
- `type` は `guide` 固定とする。
|
|
64
|
+
- `id` はauthority、英小文字・数字・ハイフンで構成し、一意にする(正確な制約は参照スキーマに従う)。
|
|
65
|
+
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
66
|
+
|
|
67
|
+
| 項目 | 必須 | 説明 |
|
|
68
|
+
| ---------- | ---- | ------------------------------------- |
|
|
69
|
+
| id | ○ | `specdojo:<name>-guide` 形式の一意 ID |
|
|
70
|
+
| type | ○ | `guide` 固定 |
|
|
71
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
72
|
+
| based_on | 任意 | 根拠ドキュメント |
|
|
73
|
+
| supersedes | 任意 | 置き換え関係 |
|
|
74
|
+
|
|
75
|
+
- 機械検証は [guide-frontmatter.schema.yaml](../../../specdojo/schemas/v1/guide-frontmatter.schema.yaml) を SSOT とする。
|
|
76
|
+
|
|
77
|
+
記述例:
|
|
78
|
+
|
|
79
|
+
```yaml
|
|
80
|
+
---
|
|
81
|
+
specdojo:
|
|
82
|
+
id: specdojo:docs-structure-guide
|
|
83
|
+
type: guide
|
|
84
|
+
status: draft
|
|
85
|
+
---
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## 5. 構成の原則
|
|
89
|
+
|
|
90
|
+
- guide は固定の標準章構成を持たず、テーマ単位で章立てする。
|
|
91
|
+
- 冒頭(H1 と概要)で、目的・対象読者・前提が読み取れるようにする。
|
|
92
|
+
- 手順は番号付きリストで示し、操作・設定はコマンドや設定例などの具体物を添える。
|
|
93
|
+
- 規範事項(must)は対応する standard / rulebook へリンクし、guide 側で再定義しない。
|
|
94
|
+
- 章が長くなる場合は、テーマ単位の小見出し(`###`)で分割する。
|
|
95
|
+
|
|
96
|
+
## 6. 記述ガイド
|
|
97
|
+
|
|
98
|
+
- 文体は「です・ます」体を既定とする。standard / rulebook の規範文(「である」体)とは役割を分け、guide は読み手に語りかける説明・手順の文書として統一する。1 つの guide 内で「です・ます」と「である」を混在させない。
|
|
99
|
+
- 読み手が再現できる粒度で手順を書き、前提と結果を明示する。
|
|
100
|
+
- スクリーンショット、コマンド、設定例、画面名など、操作に必要な具体物を活用する。
|
|
101
|
+
- 用語は対応する standard / rulebook と整合させ、命名ゆれを持ち込まない。
|
|
102
|
+
- 推奨表のカラム定義(例: 操作、目的、手順、注意点)を 1 つ以上提示する。
|
|
103
|
+
- 未確定事項や仮置き情報は、本文中に次の共通ラベルで記述する。
|
|
104
|
+
- _TODO_: 後で人または生成 AI が確認・追記・修正する必要がある事項
|
|
105
|
+
- _UNDECIDED_: 情報不足ではなく、意思決定が未了で未確定の事項
|
|
106
|
+
- _ASSUMPTION_: 現時点で仮置きしている前提・仮説
|
|
107
|
+
- リンクはファイルがある場合に記載し、ない場合はバッククォートで仮置きする。
|
|
108
|
+
|
|
109
|
+
## 7. 禁止事項
|
|
110
|
+
|
|
111
|
+
- 章番号なし見出し(例: `## 基本操作`)を使用しない。
|
|
112
|
+
- 章番号末尾の `.` を省略しない。
|
|
113
|
+
- 規範(must ルール・規約)を guide で新規に定義しない。standard / rulebook を正本とする。
|
|
114
|
+
- 曖昧語(十分、適切、問題ない)を根拠なく使用しない。
|
|
115
|
+
- デッドリンクを記載しない。
|
|
116
|
+
- _TODO_: / _UNDECIDED_: / _ASSUMPTION_: 以外の独自ラベルを、共通ルール未定義のまま追加しない。
|
|
117
|
+
- `導入ブロック` の3ブロックを省略しない。ラベル名を変えない。順序を入れ替えない。
|
|
118
|
+
- 全 guide / reference を並べた目的別の横断一覧を、`specdojo:specdojo-overview-guide` 以外に置かない。
|
|
119
|
+
|
|
120
|
+
## 8. 運用ルール
|
|
121
|
+
|
|
122
|
+
- 参照先の standard / rulebook / ツール仕様が変わった場合は、guide の手順・記述を追従させる。
|
|
123
|
+
- 操作手順や画面が変わった場合は、具体物(コマンド・設定例・画面名)の整合を確認する。
|
|
124
|
+
- 表は必要に応じて SpecDojo VS Code 拡張の `SpecDojo: Format Markdown Table` コマンドで揃える。
|