specdojo 0.4.6 → 0.5.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/.github/agents/specdojo-orchestrator.md +14 -9
- package/CHANGELOG.md +62 -0
- package/dist/catalog/document-target.js +75 -0
- package/dist/commands/agent.js +2 -80
- package/dist/commands/init.js +3 -0
- package/dist/commands/night-orchestrator.js +33 -4
- package/dist/dashboard/dashboard.js +5 -6
- package/dist/dashboard/timeline-build.js +5 -1
- package/dist/dashboard/timeline.js +6 -3
- package/dist/docs/yaml-pages.js +17 -17
- package/dist/exec/agent-config.js +28 -16
- package/dist/exec/agent-plan.js +108 -0
- package/dist/exec/commands.js +3 -3
- package/dist/exec/core.js +2 -0
- package/dist/exec/grade-checkpoint.js +12 -0
- package/dist/exec/pipeline-state.js +5 -2
- package/dist/exec/plans-core.js +7 -67
- package/dist/exec/plans-generation.js +28 -7
- package/dist/exec/plans-grade-findings.js +16 -0
- package/dist/exec/plans-planning.js +43 -0
- package/dist/exec/plans-storage.js +5 -2
- package/dist/exec/project.js +4 -1
- package/dist/exec/register.js +82 -6
- package/dist/exec/repo-integration-sync.js +9 -0
- package/dist/exec/repo-integration.js +17 -2
- package/dist/exec/repo-trace.js +17 -4
- package/dist/exec/results.js +2 -0
- package/dist/exec/run/lifecycle-commands.js +2 -0
- package/dist/exec/run/register-core.js +11 -0
- package/dist/exec/run/register-mode.js +19 -1
- package/dist/exec/run/register-resume.js +23 -0
- package/dist/exec/run/register-state.js +4 -1
- package/dist/exec/run/register-worktree.js +28 -1
- package/dist/exec/run/schedule-prepare.js +7 -1
- package/dist/exec/strategy.js +2 -0
- package/dist/exec/task-repos.js +18 -4
- package/dist/exec/worktree-command.js +8 -1
- package/dist/exec/worktree-ops-commit.js +7 -1
- package/dist/exec/worktree-ops-merge.js +40 -1
- package/dist/grade/apply.js +13 -7
- package/dist/grade/command-inspect.js +2 -1
- package/dist/grade/command-run.js +39 -0
- package/dist/grade/grade.js +3 -1
- package/dist/grade/markdown.js +11 -6
- package/dist/grade/pipeline-state.js +8 -6
- package/dist/grade/plan.js +14 -10
- package/dist/grade/run.js +307 -0
- package/dist/grade/target-discovery.js +1 -1
- package/dist/grade/targets.js +44 -22
- package/dist/register/approach.js +35 -0
- package/dist/register/catalog-status.js +49 -0
- package/dist/register/core.js +5 -0
- package/dist/register/create-commands.js +83 -5
- package/dist/register/deliverable-target.js +215 -0
- package/dist/register/dependency.js +123 -0
- package/dist/register/derivation.js +2 -2
- package/dist/register/epic.js +42 -0
- package/dist/register/event-merge.js +5 -2
- package/dist/register/events.js +8 -0
- package/dist/register/external-project.js +4 -0
- package/dist/register/item.js +18 -0
- package/dist/register/maintenance-commands.js +7 -1
- package/dist/register/planning.js +37 -0
- package/dist/register/register.js +5 -1
- package/dist/register/renumber.js +12 -4
- package/dist/register/views.js +55 -4
- package/dist/review/grade.js +19 -17
- package/dist/schedule/schedule.js +3 -1
- package/dist/schedule/strategy-generate-scope.js +5 -1
- package/dist/schedule/strategy-generate.js +1 -0
- package/dist/schedule/strategy-profiles.js +1 -1
- package/dist/shared/agent-plan.js +1 -0
- package/dist/shared/agent-types.js +3 -0
- package/dist/shared/grade-result.js +23 -5
- package/dist/shared/markdownlint-config.js +38 -0
- package/dist/shared/markdownlint-scaffold.js +2 -9
- package/dist/shared/provider-scaffold.js +5 -3
- package/dist/shared/specdojo-config.js +10 -3
- package/dist/shared/specdojo-gitignore.js +4 -0
- package/dist/specdojo.js +5 -1
- package/docs/ja/specdojo/exec-templates/xep-catalog-planning-template.md +24 -0
- package/docs/ja/specdojo/exec-templates/xep-strategy-planning-template.md +24 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-template.md +2 -2
- package/docs/ja/specdojo/guides/docs-editing-guide.md +14 -1
- package/docs/ja/specdojo/guides/docs-structure-guide.md +10 -8
- package/docs/ja/specdojo/guides/exec-config-guide.md +44 -12
- package/docs/ja/specdojo/guides/exec-operation-guide.md +20 -15
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +19 -1
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +3 -1
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +2 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +59 -16
- package/docs/ja/specdojo/guides/register-operation-guide.md +44 -15
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +15 -1
- package/docs/ja/specdojo/guides/review-guide.md +2 -2
- package/docs/ja/specdojo/guides/ryu-guide.md +12 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +16 -16
- package/docs/ja/specdojo/guides/timeline-design-guide.md +37 -33
- package/docs/ja/specdojo/recipes/tsd-recipe.md +198 -0
- package/docs/ja/specdojo/references/command-reference.md +92 -29
- package/docs/ja/specdojo/references/specdojo-config-reference.md +49 -16
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +5 -4
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +8 -7
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +9 -6
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +3 -1
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +2 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +4 -2
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +10 -9
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +10 -9
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +7 -6
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +56 -36
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +7 -6
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +80 -61
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +111 -63
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +1 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/atc-sample.md +1 -1
- package/docs/ja/specdojo/samples/bac-sample.md +1 -1
- package/docs/ja/specdojo/samples/bdd-sample.yaml +1 -1
- package/docs/ja/specdojo/samples/bds-sample.md +1 -1
- package/docs/ja/specdojo/samples/bes-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/bes-sample.md +1 -1
- package/docs/ja/specdojo/samples/ccd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cdfd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +1 -1
- package/docs/ja/specdojo/samples/cdsd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cld-sample.md +1 -1
- package/docs/ja/specdojo/samples/cnd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cop-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/cop-sample.md +1 -1
- package/docs/ja/specdojo/samples/cpd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cstd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cxd-sample.md +1 -1
- package/docs/ja/specdojo/samples/dmd-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/dmd-sample.md +1 -1
- package/docs/ja/specdojo/samples/etc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/etc-sample.md +1 -1
- package/docs/ja/specdojo/samples/gl-sample.yaml +2 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +1 -1
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +1 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +1 -1
- package/docs/ja/specdojo/samples/ifx-file-sample.md +1 -1
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +1 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +2 -1
- package/docs/ja/specdojo/samples/itc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/itc-sample.md +1 -1
- package/docs/ja/specdojo/samples/mtp-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +1 -1
- package/docs/ja/specdojo/samples/ntp-sample.md +1 -1
- package/docs/ja/specdojo/samples/opd-sample.md +1 -1
- package/docs/ja/specdojo/samples/opr-sample.md +1 -1
- package/docs/ja/specdojo/samples/otp-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/otp-sample.md +1 -1
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +1 -1
- package/docs/ja/specdojo/samples/sac-sample.md +1 -1
- package/docs/ja/specdojo/samples/sf-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/sf-sample.md +1 -1
- package/docs/ja/specdojo/samples/sld-sample.md +1 -1
- package/docs/ja/specdojo/samples/stc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/stc-sample.md +1 -1
- package/docs/ja/specdojo/samples/stsd-sample.md +1 -1
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +1 -1
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +1 -1
- package/docs/ja/specdojo/samples/sysd-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/tsd-index-sample.md +22 -16
- package/docs/ja/specdojo/samples/tsd-sample.md +241 -21
- package/docs/ja/specdojo/samples/tsp-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/uis-sample.md +1 -1
- package/docs/ja/specdojo/samples/utc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/utc-sample.md +1 -1
- package/docs/ja/specdojo/standards/document-metadata-standard.md +28 -3
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +2 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +16 -11
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +1 -1
- package/docs/ja/specdojo/templates/pjr-dependent-items-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-epic-items-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-epic-template.md +44 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +4 -2
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +24 -16
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +4 -1
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/gl.schema.yaml +8 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +20 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +73 -4
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +5 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +21 -3
- package/package.json +2 -2
- package/templates/antigravity/orchestrator.md +14 -9
- package/templates/claude/agents/specdojo-orchestrator.md +14 -9
- package/templates/codex/agents/specdojo-orchestrator.toml +14 -9
- package/templates/codex/orchestrator.md +14 -9
- package/templates/copilot/README.md +2 -1
- package/templates/devcontainer/devcontainer.json +1 -0
- package/templates/init-agent-members.yaml +46 -3
- package/templates/opencode/README.md +118 -14
- package/templates/opencode/agents/specdojo-orchestrator.md +15 -10
- package/templates/opencode/opencode.json +25 -0
|
@@ -29,6 +29,12 @@ SpecDojo Configuration Reference
|
|
|
29
29
|
|
|
30
30
|
`npx specdojo config init` は、register を開始できる次の最小構成を生成します。catalog や schedule の未使用キーは生成しません。
|
|
31
31
|
|
|
32
|
+
あわせて、markdownlint の設定がなければリポジトリ直下に `.markdownlint.yaml` を生成します。
|
|
33
|
+
MD013・MD024・MD033・MD036・MD041・MD060 を無効にし、日本語の長い行や SpecDojo の文書構成を許容します。
|
|
34
|
+
既存設定は上書きしません。既存リポジトリでは `config init --dry-run` で確認してから再実行すると追加できます。
|
|
35
|
+
exec の result の commit 前検査にも、利用リポジトリに設定がないときは同じ基本規則が適用されます。
|
|
36
|
+
設定の優先順位と hook / CLI2 の配置は [[specdojo:command-reference|CLIコマンドリファレンス]] を参照してください。
|
|
37
|
+
|
|
32
38
|
```json
|
|
33
39
|
{
|
|
34
40
|
"version": 1,
|
|
@@ -124,13 +130,14 @@ project の `integration_branch` は、`repos[].integration_branch` とは別の
|
|
|
124
130
|
|
|
125
131
|
`projects.<project-id>.run` に指定します。これらのパスは `base_path` の影響を受けず、リポジトリルート基準です。
|
|
126
132
|
|
|
127
|
-
| キー
|
|
128
|
-
|
|
|
129
|
-
| `exec_defaults`
|
|
130
|
-
| `agent_config`
|
|
131
|
-
| `parent_validations`
|
|
132
|
-
| `
|
|
133
|
-
| `
|
|
133
|
+
| キー | 既定値 | 役割・利用箇所 |
|
|
134
|
+
| ---------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
135
|
+
| `exec_defaults` | なし | provider、権限、リトライなどを定義する exec defaults ファイルです。agent を起動する `exec run` が参照します。 |
|
|
136
|
+
| `agent_config` | なし | `exec_defaults` の旧キーです。互換目的でのみ利用し、新しい設定では `exec_defaults` を使います。 |
|
|
137
|
+
| `parent_validations` | `[]` | この project だけで追加する親 runner の検証です。`exec_defaults` の `pipeline.parent_validations` の後ろへ指定順に加えます。 |
|
|
138
|
+
| `parent_validations_exclude` | `[]` | 共有の `pipeline.parent_validations` から除外する ID と実行先の組です。除外後に `parent_validations` を追記します。 |
|
|
139
|
+
| `worktree_base` | `../worktrees` | `exec run --worktree` / `--auto` と `exec trial` が作る worktree の親です。リポジトリ外を指定します。 |
|
|
140
|
+
| `register_date_timezone` | `UTC` | 登録簿の「登録日」「完了日」を日時から暦日へ変換する IANA タイムゾーン名です。例は `Asia/Tokyo` です。 |
|
|
134
141
|
|
|
135
142
|
`parent_validations` の要素は、共有 defaults と同じく検証 ID、または `{ "id": "<id>", "repo": "<repo>" }` です。共有 defaults を複製せず、プロダクトリポジトリを持つ project だけに検証を追加できます。たとえば `prj-0002` だけで `specdojo-lp` の型と lint を検査する設定は次のとおりです。
|
|
136
143
|
|
|
@@ -151,7 +158,27 @@ project の `integration_branch` は、`repos[].integration_branch` とは別の
|
|
|
151
158
|
}
|
|
152
159
|
```
|
|
153
160
|
|
|
154
|
-
|
|
161
|
+
除外を指定しない場合、有効な一覧は「共有 defaults の `pipeline.parent_validations` → project の `run.parent_validations`」の順です。同じ ID と実行先の組が両方にある場合は重複として agent 起動前にエラーになります。追加も除外も省略した project には共有 defaults だけが適用されるため、`repos` を持たない別 project はプロダクトリポジトリ向けの追加検証に影響されません。許可される ID と実行結果の記録は [[specdojo:exec-config-guide|exec設定ガイド]] を参照してください。
|
|
162
|
+
|
|
163
|
+
共有検証を減らす場合は `run.parent_validations_exclude` を指定します。要素の形式は `parent_validations` と同じです。有効な一覧は「共有の `pipeline.parent_validations` から除外 → `run.parent_validations` を追記」の順になり、共有一覧の残りと追記分の順序を保ちます。除外を省略するか `[]` にした project は従来どおりです。共有 defaults のほかの設定や、別 project の検証は変わりません。
|
|
164
|
+
|
|
165
|
+
たとえば共有一覧が `lint-fm`・`lint-md`・`lint-ts`・`typecheck`・`test-unit`・`test-integration`・`validate-schema` の場合、`prj-0002` の `run` を次のようにすると、`lint-fm`・`lint-md` と `specdojo-lp` の `typecheck` だけが有効になります。`repos` は上の例と同じ宣言を使います。
|
|
166
|
+
|
|
167
|
+
```json
|
|
168
|
+
{
|
|
169
|
+
"exec_defaults": ".specdojo/exec-defaults.yaml",
|
|
170
|
+
"parent_validations_exclude": [
|
|
171
|
+
"lint-ts",
|
|
172
|
+
"typecheck",
|
|
173
|
+
"test-unit",
|
|
174
|
+
"test-integration",
|
|
175
|
+
"validate-schema"
|
|
176
|
+
],
|
|
177
|
+
"parent_validations": [{ "id": "typecheck", "repo": "specdojo-lp" }]
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
除外の ID だけの指定は `{ "id": "<id>", "repo": "project" }` と同じで、同じ ID の別リポジトリ向け検証には一致しません。未知の ID、不正な要素、共有一覧に存在しない ID と実行先の組の除外、除外一覧内または最終一覧内の組の重複は agent 起動前に設定エラーになります。除外前の共有一覧自体も検証します。除外は project の追加分には適用せず、除外した組を `parent_validations` で末尾に戻すことはできます。共有 defaults に新しく追加された検証は、除外に指定しない限り継承します。
|
|
155
182
|
|
|
156
183
|
`config init` は一般既定の `../worktrees` ではなく、実行したリポジトリのディレクトリ名から作る `../<リポジトリ名>-worktrees` を `worktree_base` へ明示します。例えば `app1-specdojo/` で実行した場合は `../app1-specdojo-worktrees` です。
|
|
157
184
|
|
|
@@ -161,15 +188,20 @@ project の `integration_branch` は、`repos[].integration_branch` とは別の
|
|
|
161
188
|
|
|
162
189
|
`projects.<project-id>.repos` は、プロジェクトリポジトリとは別のプロダクトリポジトリを配列で宣言します。プロジェクトリポジトリ自身は宣言しません。キーを省略した project(または空配列)は、従来どおりプロジェクトリポジトリ 1 つだけを扱います。
|
|
163
190
|
|
|
164
|
-
| キー
|
|
165
|
-
|
|
|
166
|
-
| `name`
|
|
167
|
-
| `path`
|
|
168
|
-
| `integration_branch`
|
|
169
|
-
| `
|
|
191
|
+
| キー | 必須 | 既定値 | 役割・利用箇所 |
|
|
192
|
+
| ---------------------- | ---- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
193
|
+
| `name` | 必須 | なし | `targets`・`paths` の接頭辞に使うリポジトリ名です。`[a-z0-9-]` だけを使い、project 内で一意です。`project` は予約名で使えません。 |
|
|
194
|
+
| `path` | 必須 | なし | リポジトリのルートです。SpecDojo ルートからの相対パスで書き、実在するディレクトリを指します。 |
|
|
195
|
+
| `integration_branch` | 任意 | そのリポジトリの現在のブランチ | exec が変更を統合する先のブランチです。exec branch もこのブランチの先端から作ります。 |
|
|
196
|
+
| `integration_strategy` | 任意 | `merge` | `merge` はローカルの merge commit で統合します。`branch-only` は exec branch に commit して保持し、プロダクト側の PR レビューに渡します。 |
|
|
197
|
+
| `setup` | 任意 | 両方 `true` | worktree 作成時の準備の有無です。`install`(依存導入)と `build`(生成物の build)を真偽値で指定します。 |
|
|
170
198
|
|
|
171
199
|
register の worktree 実行では、`exec run --integration-branch <repo>=<branch>` により `integration_branch` を run ごとに上書きできます。統合先の優先順位は「run の指定 → `repos[].integration_branch` → そのリポジトリの現在のブランチ」です。指定方法、ローカルブランチの検査、並列実行と再開時の扱いは [[specdojo:command-reference]] を参照してください。
|
|
172
200
|
|
|
201
|
+
GitHub flow などで PR レビューを必須にするリポジトリには、`"integration_strategy": "branch-only"` を指定します。`integration_branch` は exec branch の作成元と、プロダクト側で PR を作る際の統合先の目安です。runner は統合先へ merge せず、push・PR 作成(`gh` を含む)も行いません。プロダクトの commit とプロジェクトの記帳が成功すると、プロジェクト側は通常どおり `review` へ進み、result に `branch-only`(未統合)、exec branch 名、trace key を残します。プロダクト側のレビューやリリースが完了したことは意味しません。
|
|
202
|
+
|
|
203
|
+
成功後は全 worktree を撤去し、`branch-only` の exec branch だけを残します。利用者はその branch を必要な承認のもと push し、プロダクト側の手順で PR を作成します。squash merge でも追跡できるよう、commit メッセージの `Refs: <project-id>:<item-id>` を保持してください。失敗時は worktree と branch を残して `--resume` で再開し、`branch-only` の worktree へ統合先を自動で取り込みません。同じ項目を新規実行する際に保持済み branch があると停止するため、既存 run を再開するか、プロダクト側の作業を終えて branch を退避・削除してから実行します。`exec worktree prune` は未統合の branch を削除しません。
|
|
204
|
+
|
|
173
205
|
```json
|
|
174
206
|
{
|
|
175
207
|
"base_path": "docs/ja/projects/prj-0001",
|
|
@@ -179,6 +211,7 @@ register の worktree 実行では、`exec run --integration-branch <repo>=<bran
|
|
|
179
211
|
"name": "app1",
|
|
180
212
|
"path": "../app1",
|
|
181
213
|
"integration_branch": "main",
|
|
214
|
+
"integration_strategy": "branch-only",
|
|
182
215
|
"setup": { "install": true, "build": false }
|
|
183
216
|
}
|
|
184
217
|
]
|
|
@@ -220,7 +253,7 @@ agent の起動コマンドには、provider ごとにプロダクト worktree
|
|
|
220
253
|
|
|
221
254
|
agent 実行の前後で行う保護設定(`package.json`、CI 設定など)と Git 状態(HEAD・ローカル設定)の検査は、プロダクト worktree にも同じ一覧で行います。evidence の変更ファイルは、プロダクト側を `<name>:<path>` で記録します。
|
|
222
255
|
|
|
223
|
-
プロダクトリポジトリの変更は、`exec run --worktree` の統合段で runner がリポジトリごとに commit
|
|
256
|
+
プロダクトリポジトリの変更は、`exec run --worktree` の統合段で runner がリポジトリごとに commit し、宣言順にプロダクトの設定方式を処理し、最後にプロジェクトを統合します。統合の順序、失敗時の部分状態、再開は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の「複数リポジトリの worktree と統合順序」と「複数リポジトリの統合の失敗と再開」を参照してください。`exec worktree commit` はプロダクト側を統合しないため、プロダクト worktree に未 commit の変更か exec branch の commit が残るタスクは、プロジェクト側の commit の前に停止します。撤去は、全リポジトリの worktree が撤去できることを確かめてからまとめて行います。
|
|
224
257
|
|
|
225
258
|
exec worktree の中で設定を読む場合(agent が worktree で `specdojo` を実行する場合など)、`path` の代わりに同じタスクの `<worktree_base>/<task-id>/<name>/` へ解決します。
|
|
226
259
|
|
|
@@ -232,7 +265,7 @@ exec worktree の中で設定を読む場合(agent が worktree で `specdojo`
|
|
|
232
265
|
- `name` がいずれかの project ID と同じである。`<name>:<...>` が doc id とリポジトリのパスのどちらか区別できなくなるためです。
|
|
233
266
|
- `name` が予約名 `project` である。プロジェクトリポジトリの worktree のディレクトリ名と重なるためです。
|
|
234
267
|
- `path` が空、絶対パス、存在しない、またはディレクトリでない。
|
|
235
|
-
- 宣言に無いキーがある、`integration_branch` が空文字、`setup` の値が真偽値でない。
|
|
268
|
+
- 宣言に無いキーがある、`integration_branch` が空文字、`integration_strategy` が `merge` / `branch-only` 以外、`setup` の値が真偽値でない。
|
|
236
269
|
|
|
237
270
|
設定の形は `docs/specdojo/schemas/v1/specdojo-config.schema.yaml` でも検証できます。リポジトリ名と project ID の重複と `path` の実在は schema で表せないため、CLI の読み込み時の検証が正本です。
|
|
238
271
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bac-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:bac-sample
|
|
@@ -49,7 +50,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
49
50
|
| ---- | ---- | ---- |
|
|
50
51
|
|
|
51
52
|
| id | 受入条件ID(`bac-...`) | ○ |
|
|
52
|
-
| type | `
|
|
53
|
+
| type | `requirement` 固定 | ○ |
|
|
53
54
|
| title | 受入条件名(例: 業務受入条件: 商品販売) | ○ |
|
|
54
55
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
55
56
|
| part_of | 上位BAC ID(分割している場合) | 任意 |
|
|
@@ -149,7 +150,7 @@ Markdown で「受入対象」と「シナリオ」を記述します。
|
|
|
149
150
|
```markdown
|
|
150
151
|
---
|
|
151
152
|
id: bac-sale-checkout
|
|
152
|
-
type:
|
|
153
|
+
type: requirement
|
|
153
154
|
title: 業務受入条件: 商品販売
|
|
154
155
|
status: draft
|
|
155
156
|
part_of: []
|
|
@@ -196,7 +197,7 @@ supersedes: []
|
|
|
196
197
|
```markdown
|
|
197
198
|
---
|
|
198
199
|
id: bac-procurement-order-to-payment
|
|
199
|
-
type:
|
|
200
|
+
type: requirement
|
|
200
201
|
title: 業務受入条件: 仕入(発注〜入荷〜支払)
|
|
201
202
|
status: draft
|
|
202
203
|
part_of: []
|
|
@@ -285,7 +286,7 @@ supersedes: []
|
|
|
285
286
|
```markdown
|
|
286
287
|
---
|
|
287
288
|
id: bac-sale-payment-method
|
|
288
|
-
type:
|
|
289
|
+
type: requirement
|
|
289
290
|
title: 業務受入条件: 会計確定(支払方法の記録)
|
|
290
291
|
status: draft
|
|
291
292
|
part_of: []
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bdd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: not-needed
|
|
@@ -34,7 +35,7 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
34
35
|
### 3.1. ID規約
|
|
35
36
|
|
|
36
37
|
- `id` は正規表現 `^bdd-[a-z0-9-]+$` に合致する一意IDを用いる。
|
|
37
|
-
- `type` は `
|
|
38
|
+
- `type` は `data` 固定とする。
|
|
38
39
|
- 置き換えがある場合は `supersedes` に旧IDを列挙する。
|
|
39
40
|
|
|
40
41
|
### 3.2. ファイル命名規約
|
|
@@ -50,7 +51,7 @@ Frontmatter と同等の以下の項目をYAMLドキュメントの先頭に必
|
|
|
50
51
|
| 項目 | 説明 | 必須 |
|
|
51
52
|
| ---------- | ---------------------------------------- | ---- |
|
|
52
53
|
| id | データ辞書ID(`bdd-...`) | ○ |
|
|
53
|
-
| type | `
|
|
54
|
+
| type | `data` 固定 | ○ |
|
|
54
55
|
| title | ドキュメント名。表示ページの見出しになる | ○ |
|
|
55
56
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
56
57
|
| rulebook | `specdojo:bdd-rulebook` 固定 | ○ |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bds-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: ui
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:bds-sample
|
|
@@ -48,7 +49,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
48
49
|
| ---- | ------------------- | ---- |
|
|
49
50
|
| id | 帳票ID(`bds-...`) | ○ |
|
|
50
51
|
|
|
51
|
-
| type | `
|
|
52
|
+
| type | `ui` 固定 | ○ |
|
|
52
53
|
| title | 帳票名 | ○ |
|
|
53
54
|
|
|
54
55
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
@@ -58,7 +59,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
58
59
|
### 4.1 ID規約
|
|
59
60
|
|
|
60
61
|
- BDS の `id` は正規表現 `^bds-[a-z0-9-]+$` に合致する一意IDを使用します。
|
|
61
|
-
- `type:
|
|
62
|
+
- `type: ui` は帳票の利用者向け仕様であることを示します。
|
|
62
63
|
|
|
63
64
|
## 5. 本文構成(標準テンプレ)
|
|
64
65
|
|
|
@@ -153,7 +154,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
153
154
|
```markdown
|
|
154
155
|
---
|
|
155
156
|
id: bds-daily-sales-summary
|
|
156
|
-
type:
|
|
157
|
+
type: ui
|
|
157
158
|
title: 日次売上サマリ
|
|
158
159
|
status: draft
|
|
159
160
|
part_of: []
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bes-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: markdown
|
|
7
8
|
recipe: undecided
|
|
@@ -43,13 +44,13 @@ Business Event Specification Index (BES Index) Documentation Rules
|
|
|
43
44
|
|
|
44
45
|
## 4. 推奨 Frontmatter 項目
|
|
45
46
|
|
|
46
|
-
| 項目 | 説明
|
|
47
|
-
| ------------ |
|
|
48
|
-
| `id` | ドキュメントID(例: `bes-index`)
|
|
49
|
-
| `type` | `
|
|
50
|
-
| `status` | `draft` / `ready` / `deprecated`
|
|
51
|
-
| `rulebook` | `specdojo:bes-index-rulebook`
|
|
52
|
-
| `supersedes` | 置き換え関係(古仕様→新仕様)
|
|
47
|
+
| 項目 | 説明 | 必須 |
|
|
48
|
+
| ------------ | --------------------------------- | ---- |
|
|
49
|
+
| `id` | ドキュメントID(例: `bes-index`) | ○ |
|
|
50
|
+
| `type` | `requirement` 固定 | ○ |
|
|
51
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
52
|
+
| `rulebook` | `specdojo:bes-index-rulebook` | 任意 |
|
|
53
|
+
| `supersedes` | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
53
54
|
|
|
54
55
|
## 5. 本文構成(標準テンプレ)
|
|
55
56
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bes-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:bes-sample
|
|
@@ -56,7 +57,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
56
57
|
| ---- | --------------------------------- | ---- |
|
|
57
58
|
| id | BES ID(例: `bes-sale-checkout`) | ○ |
|
|
58
59
|
|
|
59
|
-
| type | `
|
|
60
|
+
| type | `requirement` 固定 | ○ |
|
|
60
61
|
| title | 業務イベント名(例: 業務イベント: 会計確定(販売)) | ○ |
|
|
61
62
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
62
63
|
| based_on | 根拠となる仕様ID(BEL/UIS/BPS 等) | 任意 |
|
|
@@ -65,7 +66,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
65
66
|
### 3.1 ID規約
|
|
66
67
|
|
|
67
68
|
- BES ID は `bes-...` の形式を推奨します(例: `bes-sale-checkout`)。
|
|
68
|
-
- `type:
|
|
69
|
+
- `type: requirement` は機能・業務イベントの要件であることを示します。
|
|
69
70
|
|
|
70
71
|
## 4. 本文テンプレ(最小)
|
|
71
72
|
|
|
@@ -97,7 +98,7 @@ BES の責務は次に **限定** し、各項目を見出しとしてこの順
|
|
|
97
98
|
---
|
|
98
99
|
|
|
99
100
|
id: bes-sale-checkout
|
|
100
|
-
type:
|
|
101
|
+
type: requirement
|
|
101
102
|
title: 業務イベント: 会計確定(販売)
|
|
102
103
|
status: draft
|
|
103
104
|
part_of: []
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:cdsd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:cdsd-sample
|
|
@@ -24,7 +25,7 @@ Conceptual Data Stores Definition (CDSD) Documentation Rules
|
|
|
24
25
|
| 項目 | 説明 | 必須 |
|
|
25
26
|
| ---- | -------------------------------------- | ---- |
|
|
26
27
|
| id | 概念データストア一覧ID (cdsl-xxx-xxxx) | ○ |
|
|
27
|
-
| type | `
|
|
28
|
+
| type | `data` 固定 | ○ |
|
|
28
29
|
|
|
29
30
|
| title | 概念データストア一覧名 | ○ |
|
|
30
31
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
@@ -33,7 +34,7 @@ Conceptual Data Stores Definition (CDSD) Documentation Rules
|
|
|
33
34
|
### 1.1 ID規約
|
|
34
35
|
|
|
35
36
|
- 概念データストア一覧IDは正規表現 `^cdsl-[a-z0-9-]+$` に合致する一意IDを用いる。
|
|
36
|
-
- `type: data` は業務ドメイン仕様であることを示す。画面やAPI仕様(`
|
|
37
|
+
- `type: data` は業務ドメイン仕様であることを示す。画面やAPI仕様(`ui`/`api`)とは別ドキュメントで管理する。
|
|
37
38
|
|
|
38
39
|
## 2. 記述ルール
|
|
39
40
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:cld-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:cld-sample
|
|
@@ -50,7 +51,7 @@ specdojo:
|
|
|
50
51
|
| ---- | ------------------------------ | ---- |
|
|
51
52
|
| id | 分類一覧ID(例:cll-xxx-xxxx) | ○ |
|
|
52
53
|
|
|
53
|
-
| type | `
|
|
54
|
+
| type | `data` 固定 | ○ |
|
|
54
55
|
| title | 分類一覧名 | ○ |
|
|
55
56
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
56
57
|
| supersedes | 置き換え関係(旧仕様→新仕様) | 任意 |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:cop-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: operations
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:cop-index-sample
|
|
@@ -56,7 +57,7 @@ Frontmatter は共通スキーマに従う。
|
|
|
56
57
|
| 項目 | 説明 | 必須 |
|
|
57
58
|
| ---------- | -------------------------------- | ---- |
|
|
58
59
|
| id | `cop-index` | ○ |
|
|
59
|
-
| type | `
|
|
60
|
+
| type | `operations` 固定 | ○ |
|
|
60
61
|
| title | カットオーバー計画: 全体 | ○ |
|
|
61
62
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
62
63
|
| based_on | 根拠となる仕様ID(配列) | 任意 |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:cop-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: operations
|
|
5
6
|
status: draft
|
|
6
7
|
sample: specdojo:cop-sample
|
|
7
8
|
---
|
|
@@ -56,7 +57,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
56
57
|
| 項目 | 説明 | 必須 |
|
|
57
58
|
| ---------- | -------------------------------------------- | ---- |
|
|
58
59
|
| id | COP ID(`cop-<term>`) | ○ |
|
|
59
|
-
| type | `
|
|
60
|
+
| type | `operations` 固定 | ○ |
|
|
60
61
|
| title | カットオーバー計画: `<対象名>` | ○ |
|
|
61
62
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
62
63
|
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
@@ -207,7 +208,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
207
208
|
```yaml
|
|
208
209
|
---
|
|
209
210
|
id: cop-cutover-day
|
|
210
|
-
type:
|
|
211
|
+
type: operations
|
|
211
212
|
title: カットオーバー計画: 本番切替当日
|
|
212
213
|
status: draft
|
|
213
214
|
based_on:
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:dmd-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:dmd-index-sample
|
|
@@ -38,7 +39,7 @@ Data Migration Design Documentation Rules
|
|
|
38
39
|
| 項目 | 説明 | 必須 |
|
|
39
40
|
| ----- | ---------------------- | ---- |
|
|
40
41
|
| id | `dmd-index` | ○ |
|
|
41
|
-
| type | `
|
|
42
|
+
| type | `data` 固定 | ○ |
|
|
42
43
|
| title | `データ移行設計: 全体` | ○ |
|
|
43
44
|
|
|
44
45
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:dmd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
sample: specdojo:dmd-sample
|
|
7
8
|
---
|
|
@@ -56,7 +57,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
56
57
|
| 項目 | 説明 | 必須 |
|
|
57
58
|
| ---------- | -------------------------------------------- | ---- |
|
|
58
59
|
| id | DMD ID(`dmd-<term>`) | ○ |
|
|
59
|
-
| type | `
|
|
60
|
+
| type | `data` 固定 | ○ |
|
|
60
61
|
| title | データ移行設計: <対象名> | ○ |
|
|
61
62
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
62
63
|
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
@@ -3,6 +3,7 @@ schema: docs/specdojo/schemas/v1/gl.schema.yaml
|
|
|
3
3
|
specdojo:
|
|
4
4
|
id: specdojo:gl-rulebook
|
|
5
5
|
type: rulebook
|
|
6
|
+
deliverable_type: glossary
|
|
6
7
|
status: draft
|
|
7
8
|
target_format: yaml
|
|
8
9
|
recipe: undecided
|
|
@@ -47,12 +48,14 @@ Glossary Documentation Rules
|
|
|
47
48
|
|
|
48
49
|
YAML ファイルの先頭に、以下のメタデータ(ルートキー)を持たせることを推奨する。
|
|
49
50
|
|
|
50
|
-
| 項目
|
|
51
|
-
|
|
|
52
|
-
| id
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
51
|
+
| 項目 | 説明 | 必須 |
|
|
52
|
+
| -------- | ---------------------------------- | ---- |
|
|
53
|
+
| id | 用語集ID(`gl-...`) | ○ |
|
|
54
|
+
| type | `glossary` 固定 | ○ |
|
|
55
|
+
| rulebook | `specdojo:gl-rulebook` | ○ |
|
|
56
|
+
| title | 用語集名(例: 用語集: 在庫・調達) | ○ |
|
|
57
|
+
| locale | 言語(例: `ja` / `en`) | ○ |
|
|
58
|
+
| status | `draft` / `ready` / `deprecated` | 任意 |
|
|
56
59
|
|
|
57
60
|
## 5. 本文要件
|
|
58
61
|
|