specdojo 0.4.7 → 0.6.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 +16 -9
- package/CHANGELOG.md +106 -0
- package/dist/catalog/generate.js +144 -13
- package/dist/commands/init.js +4 -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/deliverable/deliverable.js +77 -4
- package/dist/docs/yaml-pages.js +17 -17
- package/dist/exec/core.js +3 -0
- package/dist/exec/parent-validation.js +7 -0
- package/dist/exec/pipeline-state.js +5 -2
- package/dist/exec/plans-core.js +49 -3
- package/dist/exec/plans-generation.js +48 -8
- package/dist/exec/plans-grade-findings.js +16 -0
- package/dist/exec/plans-planning.js +43 -0
- package/dist/exec/plans-storage.js +6 -2
- package/dist/exec/product-branch-records.js +105 -0
- package/dist/exec/product-branches.js +52 -0
- package/dist/exec/register-product-message.js +50 -0
- package/dist/exec/register.js +22 -1
- package/dist/exec/repo-integration-sync.js +11 -0
- package/dist/exec/repo-integration.js +58 -6
- package/dist/exec/repo-trace.js +19 -4
- package/dist/exec/results.js +11 -5
- package/dist/exec/run/register-command.js +16 -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 +33 -1
- package/dist/exec/run/register-worktree.js +52 -8
- package/dist/exec/run/schedule-prepare.js +7 -3
- package/dist/exec/strategy.js +4 -1
- package/dist/exec/task-repos.js +92 -16
- package/dist/exec/worktree-command.js +2 -2
- package/dist/exec/worktree-ops-commit.js +7 -1
- package/dist/exec/worktree.js +3 -3
- package/dist/grade/apply.js +6 -2
- package/dist/grade/markdown.js +7 -2
- package/dist/grade/plan.js +6 -4
- package/dist/register/approach.js +19 -0
- package/dist/register/catalog-status.js +49 -0
- package/dist/register/core.js +8 -0
- package/dist/register/create-commands.js +86 -4
- package/dist/register/deliverable-target.js +24 -17
- 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 +9 -2
- package/dist/register/events.js +10 -0
- package/dist/register/external-project.js +6 -0
- package/dist/register/input.js +168 -0
- package/dist/register/item.js +71 -0
- package/dist/register/maintenance-commands.js +7 -1
- package/dist/register/planning.js +37 -0
- package/dist/register/register.js +7 -3
- package/dist/register/renumber.js +16 -4
- package/dist/register/update.js +6 -0
- package/dist/register/views.js +55 -4
- package/dist/schedule/approach.js +9 -0
- 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 +22 -2
- package/dist/shared/agent-types.js +7 -1
- package/dist/shared/branch-template.js +26 -0
- package/dist/shared/commit-message-template.js +38 -0
- package/dist/shared/commit-types.js +15 -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/specdojo-config.js +42 -4
- package/dist/shared/specdojo-gitignore.js +4 -0
- package/docs/ja/specdojo/exec-templates/xep-catalog-planning-template.md +24 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +93 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +9 -2
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xep-strategy-planning-template.md +24 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xer-human-draft-template.md +23 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +7 -4
- 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 +3 -1
- package/docs/ja/specdojo/guides/exec-operation-guide.md +111 -16
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +19 -1
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +2 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +37 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +58 -16
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +1 -1
- package/docs/ja/specdojo/guides/ryu-guide.md +114 -23
- package/docs/ja/specdojo/guides/schedule-design-guide.md +31 -4
- 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/exec-human-finalize-recipe.md +1 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +206 -0
- package/docs/ja/specdojo/references/command-reference.md +86 -15
- package/docs/ja/specdojo/references/specdojo-config-reference.md +81 -8
- 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 +9 -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 +54 -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 +4 -1
- 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/dct-sample.yaml +5 -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 +44 -3
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +1 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +2 -1
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +2 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +1 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +2 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +18 -12
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +1 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +2 -1
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +1 -1
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +10 -4
- 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/ja/specdojo/templates/pjr-issue-template.md +10 -4
- package/docs/ja/specdojo/templates/pjr-question-template.md +11 -5
- package/docs/ja/specdojo/templates/pjr-risk-template.md +10 -4
- package/docs/ja/specdojo/templates/pjr-todo-template.md +10 -4
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/dct.schema.yaml +9 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +24 -16
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +1 -0
- 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/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 +21 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +75 -3
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +5 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +1 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +43 -0
- package/package.json +4 -3
- package/templates/antigravity/orchestrator.md +16 -9
- package/templates/claude/agents/specdojo-orchestrator.md +16 -9
- package/templates/codex/agents/specdojo-orchestrator.toml +16 -9
- package/templates/codex/orchestrator.md +16 -9
- package/templates/copilot/README.md +2 -1
- package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +14 -8
- package/templates/opencode/agents/specdojo-orchestrator.md +16 -9
|
@@ -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:dct-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: project
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
sample: specdojo:dct-sample
|
|
@@ -128,6 +129,7 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
128
129
|
|
|
129
130
|
| `depends_on` | 任意 | 依存する成果物の `local_id` 配列。なければ空配列 `[]` |
|
|
130
131
|
| `overview` | ○ | 成果物の目的を1文で記述 |
|
|
132
|
+
| `brief` | 任意 | 成果物の外から継続して渡す前提(技術スタックや制約など) |
|
|
131
133
|
| `path` | ○(`work`) | 成果物のファイルパス |
|
|
132
134
|
| `rulebook` | 任意 | rulebook の文書 ID、未判断なら `undecided`、不要なら `not-needed` |
|
|
133
135
|
| `evidence_refs` | 任意 | `retrofit` で読む非成果物エビデンス |
|
|
@@ -268,6 +270,13 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
268
270
|
- 既存カタログとの差分は `--dry-run` で確認する。既存ファイルは既定で保護し、内容が異なる場合の上書きには `--force` を必要とする。同一入力の再実行で内容が同じ場合は書き込まない。
|
|
269
271
|
- 生成されたカタログの `status` は template に従い `draft` のままとする。生成成功を理由に Timeline の `catalog_status` を `primary` へ変更せず、人間の内容確認後に別途更新する。
|
|
270
272
|
|
|
273
|
+
### 6.14. `brief`・`overview`・`done_criteria` の使い分けと YAML アンカー
|
|
274
|
+
|
|
275
|
+
- `overview`: 成果物の目的・責務を 1 文で記述する。カタログの表・一覧(Markdown 表示ページ)に配置され、ドメイン全体の俯瞰や成果物の責務把握に用いる。
|
|
276
|
+
- `brief`: 成果物の外から継続して渡す前提(採用する技術スタック、アーキテクチャ上の制約、設計・選定方針など)を記述する。schedule の task の plan や register 経由の plan に「前提」として展開される。未指定の場合は plan に載せない。
|
|
277
|
+
- `done_criteria`: 成果物が満たすべき完了条件・受入基準を記述する。ロールコード(`roles`)とレビュー観点(`viewpoint`)を紐づけ、客観的に検証可能な形で記載する。前提や指示そのものはここに書かず、成果物が達成した検証可能な振る舞い・状態を記載する。
|
|
278
|
+
- 複数の成果物で前提を共有する場合は、YAML のアンカー(`&anchor`)とエイリアス(`*anchor`)を利用して記述の重複を防ぐ。同一カタログファイル内で共通の前提をアンカー定義し、各成果物の `brief` から参照する。
|
|
279
|
+
|
|
271
280
|
## 7. 禁止事項
|
|
272
281
|
|
|
273
282
|
| 禁止事項 | 理由 |
|
|
@@ -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
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:ifx-api-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: api
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: not-needed
|
|
@@ -49,7 +50,7 @@ ESIL 側の `spec_ref: ifx-api-...` は、このEAPISのID(およびファイ
|
|
|
49
50
|
|
|
50
51
|
- `openapi`
|
|
51
52
|
- `info`(`title`を含む)
|
|
52
|
-
- `x-spec-meta`(`id`, `type`, `status` を含む)
|
|
53
|
+
- `x-spec-meta`(`id`, `type`, `status`, `rulebook` を含む)
|
|
53
54
|
- `servers`(少なくとも1つ)
|
|
54
55
|
- `paths`(少なくとも1つ)
|
|
55
56
|
|
|
@@ -62,6 +63,7 @@ ESIL 側の `spec_ref: ifx-api-...` は、このEAPISのID(およびファイ
|
|
|
62
63
|
|
|
63
64
|
| id | API仕様ID(`ifx-api-...`)、ESILの `spec_ref` と対応 | ○ |
|
|
64
65
|
| type | `api` 固定 | ○ |
|
|
66
|
+
| rulebook | `specdojo:ifx-api-rulebook` | ○ |
|
|
65
67
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
66
68
|
| based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
|
|
67
69
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:ifx-cmd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: api
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: specdojo:ifx-cmd-recipe
|
|
@@ -48,7 +49,7 @@ YAML の先頭に次のメタ項目を置きます。
|
|
|
48
49
|
| キー | 説明 | 必須 |
|
|
49
50
|
| -------- | ------------------------------------------------ | ---- |
|
|
50
51
|
| id | コマンド連携仕様 ID。成果物では `ifx-cmd-<term>` | ○ |
|
|
51
|
-
| type | `
|
|
52
|
+
| type | `api` 固定 | ○ |
|
|
52
53
|
| title | 対象と実行目的が分かる仕様名 | ○ |
|
|
53
54
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
54
55
|
| rulebook | `specdojo:ifx-cmd-rulebook` | ○ |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:ifx-file-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: api
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: not-needed
|
|
7
8
|
sample: specdojo:ifx-file-sample
|
|
@@ -60,7 +61,7 @@ ESIL 側の `spec_ref: ifx-file-...` は、このEFESのID(およびファイ
|
|
|
60
61
|
| キー | 説明 | 必須 |
|
|
61
62
|
| -------- | ---------------------------------------------------------- | ---- |
|
|
62
63
|
| id | ファイル仕様ID(`ifx-file-...`)、ESILの `spec_ref` と対応 | ○ |
|
|
63
|
-
| type | `
|
|
64
|
+
| type | `api` 固定 | ○ |
|
|
64
65
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
65
66
|
| based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
|
|
66
67
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:ifx-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: api
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: not-needed
|
|
@@ -40,6 +41,7 @@ ESIL は「どの外部システムと」「何を」「どの方向で」「ど
|
|
|
40
41
|
| type | `api` 固定 | ○ |
|
|
41
42
|
| title | 外部システムIF一覧名 | ○ |
|
|
42
43
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
44
|
+
| rulebook | `specdojo:ifx-index-rulebook` | ○ |
|
|
43
45
|
| interfaces | 外部連携の配列(1件以上) | ○ |
|
|
44
46
|
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
45
47
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:ifx-msg-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: api
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: not-needed
|
|
@@ -51,7 +52,7 @@ ESIL 側の `spec_ref: ifx-msg-...` は、このEMSのID(およびファイル
|
|
|
51
52
|
- `asyncapi`
|
|
52
53
|
- `info`(`title`, `version` を含む)
|
|
53
54
|
|
|
54
|
-
- `x-spec-meta`(`id`, `type`, `status` を含む)
|
|
55
|
+
- `x-spec-meta`(`id`, `type`, `status`, `rulebook` を含む)
|
|
55
56
|
- `channels`(少なくとも1つ)
|
|
56
57
|
- `components/messages`(少なくとも1つ)
|
|
57
58
|
|
|
@@ -62,7 +63,8 @@ ESIL 側の `spec_ref: ifx-msg-...` は、このEMSのID(およびファイル
|
|
|
62
63
|
| キー | 説明 | 必須 |
|
|
63
64
|
| -------- | ----------------------------------------------------------- | ---- |
|
|
64
65
|
| id | メッセージ仕様ID(`ifx-msg-...`)、ESILの `spec_ref` と対応 | ○ |
|
|
65
|
-
| type | `
|
|
66
|
+
| type | `api` 固定 | ○ |
|
|
67
|
+
| rulebook | `specdojo:ifx-msg-rulebook` | ○ |
|
|
66
68
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
67
69
|
| based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
|
|
68
70
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:mip-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: project
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:mip-index-sample
|
|
@@ -55,7 +56,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
55
56
|
| 項目 | 説明 | 必須 |
|
|
56
57
|
| ---------- | -------------------------------------------- | ---- |
|
|
57
58
|
| id | `mip-index`(固定) | ○ |
|
|
58
|
-
| type | `
|
|
59
|
+
| type | `project` 固定 | ○ |
|
|
59
60
|
| title | 移行計画: 概要(`<システム名>`) | ○ |
|
|
60
61
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
61
62
|
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:mtp-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: test
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:mtp-sample
|
|
@@ -56,7 +57,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
56
57
|
| 項目 | 説明 | 必須 |
|
|
57
58
|
| ---------- | -------------------------------------------- | ---- |
|
|
58
59
|
| id | MTP ID(`mtp-index` または `mtp-<term>`) | ○ |
|
|
59
|
-
| type | `
|
|
60
|
+
| type | `test` 固定 | ○ |
|
|
60
61
|
| title | 移行テスト計画: <対象名> | ○ |
|
|
61
62
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
62
63
|
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
@@ -203,7 +204,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
203
204
|
```yaml
|
|
204
205
|
---
|
|
205
206
|
id: mtp-index
|
|
206
|
-
type:
|
|
207
|
+
type: test
|
|
207
208
|
title: 移行テスト計画: 全体
|
|
208
209
|
status: draft
|
|
209
210
|
based_on: []
|
|
@@ -283,7 +284,7 @@ supersedes: []
|
|
|
283
284
|
```yaml
|
|
284
285
|
---
|
|
285
286
|
id: mtp-cutover-rehearsal
|
|
286
|
-
type:
|
|
287
|
+
type: test
|
|
287
288
|
title: 移行テスト計画: カットオーバーリハーサル
|
|
288
289
|
status: draft
|
|
289
290
|
based_on:
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:nfr-availability-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:nfr-availability-sample
|
|
@@ -50,13 +51,13 @@ Non-Functional Requirements Availability Documentation Rules
|
|
|
50
51
|
|
|
51
52
|
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
52
53
|
|
|
53
|
-
| 項目 | 説明
|
|
54
|
-
| ------- |
|
|
55
|
-
| id | `nfr-availability`
|
|
56
|
-
| type | `
|
|
57
|
-
| title | 非機能要件: 可用性
|
|
58
|
-
| status | `draft` / `ready` / `deprecated`
|
|
59
|
-
| part_of | `nfr-index`
|
|
54
|
+
| 項目 | 説明 | 必須 |
|
|
55
|
+
| ------- | -------------------------------- | ---- |
|
|
56
|
+
| id | `nfr-availability` | ○ |
|
|
57
|
+
| type | `requirement` 固定 | ○ |
|
|
58
|
+
| title | 非機能要件: 可用性 | ○ |
|
|
59
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
+
| part_of | `nfr-index` | 任意 |
|
|
60
61
|
|
|
61
62
|
### 4.2. 推奨ルール
|
|
62
63
|
|
|
@@ -122,7 +123,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
122
123
|
```yaml
|
|
123
124
|
---
|
|
124
125
|
id: nfr-availability
|
|
125
|
-
type:
|
|
126
|
+
type: requirement
|
|
126
127
|
title: 非機能要件: 可用性
|
|
127
128
|
status: draft
|
|
128
129
|
part_of: [nfr-index]
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:nfr-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:nfr-index-sample
|
|
@@ -53,14 +54,14 @@ Non-Functional Requirements Index Documentation Rules
|
|
|
53
54
|
|
|
54
55
|
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
55
56
|
|
|
56
|
-
| 項目 | 説明
|
|
57
|
-
| ---------- |
|
|
58
|
-
| id | NFR Index ID(推奨: `nfr-index`)
|
|
59
|
-
| type | `
|
|
60
|
-
| title | 非機能要件: インデックス
|
|
61
|
-
| status | `draft` / `ready` / `deprecated`
|
|
62
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可)
|
|
63
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可)
|
|
57
|
+
| 項目 | 説明 | 必須 |
|
|
58
|
+
| ---------- | -------------------------------------------- | ---- |
|
|
59
|
+
| id | NFR Index ID(推奨: `nfr-index`) | ○ |
|
|
60
|
+
| type | `requirement` 固定 | ○ |
|
|
61
|
+
| title | 非機能要件: インデックス | ○ |
|
|
62
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
63
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
64
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
64
65
|
|
|
65
66
|
### 4.2. 推奨ルール
|
|
66
67
|
|
|
@@ -139,7 +140,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
139
140
|
```yaml
|
|
140
141
|
---
|
|
141
142
|
id: nfr-index
|
|
142
|
-
type:
|
|
143
|
+
type: requirement
|
|
143
144
|
title: 非機能要件: インデックス
|
|
144
145
|
status: draft
|
|
145
146
|
based_on: []
|