specdojo 0.6.0 → 0.8.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 +3 -2
- package/CHANGELOG.md +193 -0
- package/README.md +2 -2
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +33 -0
- package/dist/commands/init.js +6 -1
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/orchestrator.js +10 -1
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +612 -259
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +8 -6
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +9 -4
- package/dist/devcontainer/command.js +18 -0
- package/dist/devcontainer/host-script.js +21 -0
- package/dist/devcontainer/scaffold.js +22 -3
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/yaml-pages.js +125 -3
- package/dist/exec/agent-config.js +22 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/antigravity-session.js +154 -0
- package/dist/exec/commands.js +69 -21
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +159 -8
- package/dist/exec/evidence.js +64 -16
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +160 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plan-markdownlint.js +89 -0
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +52 -25
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/register-resume.js +69 -42
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +8 -4
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +85 -24
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +109 -0
- package/dist/exec/run/agent-pipeline.js +75 -6
- package/dist/exec/run/agent.js +20 -7
- package/dist/exec/run/in-place.js +69 -32
- package/dist/exec/run/job.js +81 -24
- package/dist/exec/run/lifecycle-commands.js +264 -43
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +12 -10
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +12 -12
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +28 -18
- package/dist/exec/run/register-state.js +10 -7
- package/dist/exec/run/register-worktree.js +60 -30
- package/dist/exec/run/schedule-mode.js +26 -6
- package/dist/exec/run/schedule-prepare.js +228 -45
- package/dist/exec/run/schedule-task.js +132 -25
- package/dist/exec/run/shared.js +4 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/strategy.js +1 -0
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +3 -2
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/worktree-command.js +29 -16
- package/dist/exec/worktree-ops-commit.js +118 -59
- package/dist/exec/worktree-ops-lifecycle.js +77 -44
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +19 -2
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-inspect.js +2 -2
- package/dist/grade/command-run.js +2 -0
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +23 -3
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/job.js +31 -17
- package/dist/job/noop.js +104 -0
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +4 -1
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -32
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +4 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +56 -32
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +1 -0
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +2 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git.js +149 -15
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/provider-scaffold.js +2 -0
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +48 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +61 -28
- package/docs/ja/specdojo/guides/exec-operation-guide.md +61 -13
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +4 -2
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +589 -807
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -4
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +33 -4
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +41 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +471 -74
- package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
- package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +88 -86
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +108 -122
- package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
- package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
- package/docs/ja/specdojo/references/command-reference.md +146 -99
- package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +367 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +6 -5
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +96 -100
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +38 -47
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +132 -106
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +100 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
- package/docs/ja/specdojo/samples/bes-sample.md +80 -21
- package/docs/ja/specdojo/samples/br-sample.md +68 -14
- package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +248 -140
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +130 -97
- package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +132 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
- package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
- package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
- package/docs/ja/specdojo/samples/sf-sample.md +121 -21
- package/docs/ja/specdojo/samples/sld-sample.md +107 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +164 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +161 -83
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +130 -89
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +54 -3
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +1 -0
- package/package.json +6 -3
- package/templates/antigravity/README.md +19 -46
- package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
- package/templates/antigravity/orchestrator.md +3 -2
- package/templates/antigravity/settings.edit.json +73 -0
- package/templates/antigravity/settings.orchestrator.json +15 -0
- package/templates/antigravity/settings.report.json +7 -0
- package/templates/antigravity/settings.review.json +7 -0
- package/templates/claude/agents/specdojo-orchestrator.md +3 -2
- package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
- package/templates/codex/orchestrator.md +3 -2
- package/templates/devcontainer/remote-host/devcontainer-tmux.sh +217 -0
- package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -96
- package/templates/devcontainer/remote-host/ssh-config.sample +3 -1
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-agent-members.yaml +1 -0
- package/templates/init-exec-defaults.yaml +1 -1
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -3,7 +3,7 @@ specdojo:
|
|
|
3
3
|
id: specdojo:dct-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: project
|
|
6
|
-
status:
|
|
6
|
+
status: ready
|
|
7
7
|
target_format: yaml
|
|
8
8
|
recipe: not-needed
|
|
9
9
|
sample: specdojo:dct-index-sample
|
|
@@ -16,144 +16,133 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Deliverables Catalog Index Documentation Rules
|
|
18
18
|
|
|
19
|
-
本ドキュメントは、成果物カタログ索引の正本 `dct-index.yaml`
|
|
19
|
+
本ドキュメントは、成果物カタログ索引の正本 `dct-index.yaml` の記述ルールです。ドメインを探すための分類・表示順・名称・概要と、scaffold に用いるプロジェクト規模の判断基準を定めます。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
23
23
|
- `dct-index.yaml` は、プロジェクト規模とドメイン一覧の表示意図を保持する唯一の正本とする。
|
|
24
24
|
- `generated/dct-index.md` は `catalog build` が生成する表示専用ビューとし、直接編集しない。
|
|
25
25
|
- 各ドメインの成果物定義は `dct-<domain>.yaml` に置き、索引には表示名・概要・順序・グループだけを置く。
|
|
26
|
-
- 共通ルールなどの散文と生成物の外枠は `dct-index-template.md` が保持し、YAML の文字列へ複製しない。
|
|
27
26
|
- `dct-index.yaml` の宣言ドメイン集合と実在する `dct-*.yaml` の `domain` 集合を一致させる。
|
|
27
|
+
- 共通事項は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正本とし、索引へ転載しない。要求・品質・受入・運用の詳細も、各ドメインの成果物へ委ねる。
|
|
28
28
|
|
|
29
29
|
## 2. 位置づけと用語定義
|
|
30
30
|
|
|
31
31
|
| 用語 | 正本・生成物 | 役割 |
|
|
32
32
|
| ------------ | --------------------------- | ---------------------------------------------------------- |
|
|
33
33
|
| 索引宣言 | `dct-index.yaml` | 規模、グループ、ドメイン順、表示名、概要を宣言する |
|
|
34
|
-
| 本文テンプレ | `dct-index-template.md` | Frontmatter 雛形、共通ルール、一覧挿入スロットを保持する |
|
|
35
34
|
| 索引ビュー | `generated/dct-index.md` | 宣言と実在カタログから生成されるプロジェクトの参照起点 |
|
|
36
35
|
| ドメイン正本 | `dct-<domain>.yaml` | ドメインに属する成果物、配置、依存関係、完了条件を定義する |
|
|
37
36
|
| ドメイン表示 | `generated/dct-<domain>.md` | 1 ドメインの成果物定義を読みやすい Markdown として表示する |
|
|
38
37
|
|
|
39
38
|
- `domain` は論理的な管理単位であり、物理ファイル名ではなく各 `dct-*.yaml` の `domain` 値で識別する。
|
|
40
39
|
- 同じ `domain` を持つ物理分割ファイルが複数あっても、索引宣言と索引ビューでは 1 ドメインとして扱う。
|
|
41
|
-
-
|
|
42
|
-
- `subgroup` はルートグループ直下の表分割を表し、`domains` を持つ。Markdown 見出しを H4 までに収めるため、さらに子 `groups` は持てない。
|
|
40
|
+
- グループはドメインを探すための分類、サブグループはその中の探索単位を表す。宣言できる階層は schema に従う。
|
|
43
41
|
- グループとサブグループの順序は、成果物定義の依存順や Schedule の実行順を意味しない。
|
|
44
42
|
|
|
45
43
|
## 3. ファイル命名・ID規則
|
|
46
44
|
|
|
47
45
|
- 索引宣言はカタログディレクトリ直下の `dct-index.yaml` とする。
|
|
48
46
|
- 索引ビューは同ディレクトリの `generated/dct-index.md` に生成する。
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
- ドメイン識別子は英小文字・数字・ハイフンからなる kebab-case とする。
|
|
47
|
+
- 索引宣言と索引ビューは `<project-id>:dct-index` を共有する。表示用の別 ID を作らず、既存の参照を維持する。
|
|
48
|
+
- ドメイン識別子や ID の文字種・形式は `docs/specdojo/schemas/v1/dct-index.schema.yaml` に従う。
|
|
52
49
|
|
|
53
|
-
## 4.
|
|
50
|
+
## 4. 本文要件
|
|
54
51
|
|
|
55
|
-
|
|
52
|
+
構造・必須キー・型・列挙値・排他制約は `docs/specdojo/schemas/v1/dct-index.schema.yaml` を正本とし、本章は内容を判断するための目的を示す。独立 YAML のためメタ情報もトップレベルに置き、Frontmatter 専用章は設けない。コマンドの構文は [[specdojo:command-reference|コマンドリファレンス]] の「catalog / deliverable」、生成処理の詳細は `src/catalog/build.ts` を参照する。
|
|
56
53
|
|
|
57
54
|
### 4.1. ルート項目
|
|
58
55
|
|
|
59
|
-
| 項目
|
|
60
|
-
|
|
|
61
|
-
| `id`
|
|
62
|
-
| `type`
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `project_id` | ○ | 対象プロジェクト ID |
|
|
67
|
-
| `size` | ○ | scaffold に用いる `small` / `medium` / `large` |
|
|
68
|
-
| `groups` | ○ | 索引ビューに出すグループの配列。配列順を表示順として使用する |
|
|
56
|
+
| 項目 | 必須 | 目的・記述規約 |
|
|
57
|
+
| ------------------------------ | ---- | --------------------------------------------------------------------------------------------------------------------- |
|
|
58
|
+
| `id` / `project_id` | ○ | 対象プロジェクトを識別し、他プロジェクトの索引との取り違えを防ぐ |
|
|
59
|
+
| `type` / `status` / `rulebook` | ○ | 文書種別・成熟度・適用規約を示す。`status` は `draft` / `ready` / `deprecated` のいずれかで、意味はメタ情報標準に従う |
|
|
60
|
+
| `title` | ○ | 読み手が参照起点と認識できる生成ビューの文書名 |
|
|
61
|
+
| `size` | ○ | 今後の scaffold で選択する成果物セットの規模(`small` / `medium` / `large`)。現在のドメイン数ではない |
|
|
62
|
+
| `groups` | ○ | 管理対象ドメインを、読み手が探す分類と順序でまとめる |
|
|
69
63
|
|
|
70
|
-
### 4.2.
|
|
64
|
+
### 4.2. グループとサブグループ
|
|
71
65
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
| `domains` | 選択 | グループ内のドメイン配列。`groups` と同時には指定できない |
|
|
76
|
-
| `groups` | 選択 | H4 で出力するサブグループ配列。`domains` と同時には指定できない |
|
|
66
|
+
- 各グループの `name` は必須とし、含めるドメインの共通の関心を示す。
|
|
67
|
+
- `domains` を直接置くか、子 `groups` へ分けるかは探索単位で判断する。サブグループは任意であり、ドメイン数だけで追加しない。
|
|
68
|
+
- 配列順を索引ビューとサイドバーの表示順として扱う。優先度・着手順・担当者順の管理には用いない。
|
|
77
69
|
|
|
78
|
-
|
|
70
|
+
### 4.3. ドメイン項目
|
|
79
71
|
|
|
80
|
-
|
|
72
|
+
| 項目 | 必須 | 目的・記述規約 |
|
|
73
|
+
| ---------- | ---- | ------------------------------------------------------------------ |
|
|
74
|
+
| `domain` | ○ | 実在する `dct-*.yaml` の `domain` と一致する論理識別子 |
|
|
75
|
+
| `name` | ○ | 利用者向けの日本語表示名。索引ビューの表とサイドバーの表示名に使う |
|
|
76
|
+
| `overview` | ○ | ドメインが管理する成果物の関心領域を示す 1 文の概要 |
|
|
81
77
|
|
|
82
|
-
|
|
83
|
-
| --------- | ---- | ------------------------------------------------------------ |
|
|
84
|
-
| `name` | ○ | 索引ビューの H4 サブグループ見出し |
|
|
85
|
-
| `domains` | ○ | サブグループ内のドメイン配列。配列順を表の行順として使用する |
|
|
78
|
+
- 各要素のキーは `domain`、`name`、`overview` の順に書く。文書サイトのサイドバーは `domain` の直後の `name` を表示名として読むため、順序を入れ替えると表示名を解決できない。
|
|
86
79
|
|
|
87
|
-
|
|
80
|
+
### 4.4. 生成ビューの確認要件
|
|
88
81
|
|
|
89
|
-
|
|
82
|
+
- 宣言した分類・順序・表示名・概要が、読み手の参照起点となる索引ビューへ反映されていること。
|
|
83
|
+
- 各ドメインの表示から、対応するドメイン別カタログへ到達できること。物理分割されていても論理ドメイン単位で辿れること。
|
|
84
|
+
- サイドバーでも索引と同じドメイン名・順序で探せること。生成ビューの見出し・表・リンクを YAML に手書きで保持しない。
|
|
90
85
|
|
|
91
|
-
|
|
92
|
-
| ---------- | ---- | ------------------------------------------------------ |
|
|
93
|
-
| `domain` | ○ | 実在する `dct-*.yaml` の `domain` と一致する論理識別子 |
|
|
94
|
-
| `name` | ○ | 利用者向けの日本語表示名 |
|
|
95
|
-
| `overview` | ○ | ドメインが管理する成果物の関心領域を示す 1 文の概要 |
|
|
86
|
+
## 5. 記述ガイド
|
|
96
87
|
|
|
97
|
-
|
|
88
|
+
### 5.1. メタ情報と規模の決め方
|
|
98
89
|
|
|
99
|
-
|
|
100
|
-
| --- | ------------------ | ---- | ------------------------------------------------- |
|
|
101
|
-
| 1 | 共通ルール | ○ | `dct-index-template.md` |
|
|
102
|
-
| 2 | 成果物カタログ一覧 | ○ | template のスロットへ `groups` ごとの表を生成する |
|
|
90
|
+
対象プロジェクトと予定する成果物セットを確認してからメタ情報を記入する。`size` を変える場合は scaffold の対象範囲を見直す判断として扱い、変更理由を実行記録へ残す。
|
|
103
91
|
|
|
104
|
-
|
|
92
|
+
| 判断 | 良い例 | 悪い例 |
|
|
93
|
+
| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------- |
|
|
94
|
+
| プロジェクト識別 | 対象が prj-0001 なら、その索引 ID と `project_id` を対応させる | 別プロジェクトから複製した ID を残す |
|
|
95
|
+
| 文書名 | `成果物カタログ` のように参照起点を示す | `第3回レビュー用` のように一時的な用途だけを表す |
|
|
96
|
+
| 規模の変更 | 追加で必要な成果物セットを確認し、scaffold 方針の変更として決める | ドメインを 1 件足したことだけを理由に `size` を変更する |
|
|
105
97
|
|
|
106
|
-
|
|
107
|
-
- `groups` を持つルートグループは H3 見出しだけを生成し、各サブグループを `#### 2.<グループ番号>.<サブグループ番号>. <名称>` と表の組で生成する。
|
|
108
|
-
- グループ番号とサブグループ番号は、それぞれの配列順に 1 から採番する。
|
|
98
|
+
### 5.2. グループ分類の決め方
|
|
109
99
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
| 列名 | 生成内容 |
|
|
113
|
-
| -------------- | ------------------------------------------------ |
|
|
114
|
-
| ドメイン | `domain` をバッククォートで囲んだ値 |
|
|
115
|
-
| 名称 | 宣言の `name` |
|
|
116
|
-
| 成果物カタログ | `generated/dct-<domain>.md` へ解決する相対リンク |
|
|
117
|
-
| 概要 | 宣言の `overview` |
|
|
118
|
-
|
|
119
|
-
## 6. 記述・生成・検証ガイド
|
|
120
|
-
|
|
121
|
-
### 6.1. 宣言の書き方
|
|
122
|
-
|
|
123
|
-
- グループとドメインは、索引を読む人が探索しやすい順序で配列へ並べる。
|
|
124
|
-
- グループ分類の正本は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の文書構成図とする。ルートグループはプロジェクト成果物とプロダクト成果物のような文書分類、サブグループは構成図が示す論理的なまとまり(要件〜設計、品質保証、運用など)に対応させる。
|
|
100
|
+
- 分類の正本は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の文書構成図とする。ルートグループはプロジェクト成果物とプロダクト成果物のような文書分類、サブグループは構成図が示す論理的なまとまり(要件〜設計、品質保証、運用など)に対応させる。
|
|
125
101
|
- 成果物リファレンスは個別成果物を引くための一覧であり、章の粒度は rulebook 単位で索引のグループとは一致しない。分類が食い違う場合は構成ガイドを正として宣言する。
|
|
126
|
-
-
|
|
127
|
-
- `
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
159
|
-
|
|
102
|
+
- 1 つのドメインが複数の分類に当てはまるように見える場合は、構成図でそのドメインが置かれた枠に従って 1 か所だけへ置き、判断理由を YAML コメントに残す。
|
|
103
|
+
- サブグループに分けるのは、ルートグループ内のドメインが読み手の探索単位として 2 つ以上のまとまりに分かれる場合に限る。探索単位が 1 つなら `domains` を直接置く。
|
|
104
|
+
|
|
105
|
+
| 判断 | 良い例 | 悪い例 |
|
|
106
|
+
| ------------ | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
107
|
+
| 所属の決定 | 外部I/F仕様を、構成図で置かれている業務仕様群へ 1 か所だけ宣言する | 外部I/F仕様を業務仕様群とアーキテクチャの両方へ宣言する |
|
|
108
|
+
| 階層の選択 | 業務仕様群・品質保証・運用のように探索目的で分ける。単独ドメインでも独立した探索単位なら分ける | 探索目的が同じドメインを件数だけで分割し、見出しを増やす |
|
|
109
|
+
| 分類名の付与 | `品質保証` のように、含まれるドメインの共通の関心を名前にする | `その他`・`追加分` のように、所属理由を示さない名前で受け皿を作る |
|
|
110
|
+
|
|
111
|
+
### 5.3. ドメインの選定と説明の書き方
|
|
112
|
+
|
|
113
|
+
- 管理対象は実在カタログの `domain` で判断し、物理ファイル数や今後作る予定の文書から推測しない。
|
|
114
|
+
- `name` はドメインの表示名に限定し、状態・担当・件数など変動する情報を含めない。サイドバーにも出るため、親ノードの「成果物カタログ」を繰り返さない。
|
|
115
|
+
- `overview` は管理対象の関心領域を 1 文で記述し、個別成果物を列挙しない。個別成果物はドメイン表示が正本である。
|
|
116
|
+
|
|
117
|
+
| 項目 | 良い例 | 悪い例 |
|
|
118
|
+
| ---------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
119
|
+
| `name` | `データモデル` | `成果物カタログ(データモデル)`、`データモデル(作成中)` |
|
|
120
|
+
| `overview` | `データの概念、論理構造、分類、状態を表す成果物を管理する。` | `概念データモデル、論理データモデル、状態遷移表を管理する。` |
|
|
121
|
+
| 管理単位 | データモデルのカタログが物理分割されていても同じ `domain` として 1 件だけ宣言する | 分割ファイルごとに別ドメインを作る、または同じドメインを複数回宣言する |
|
|
122
|
+
|
|
123
|
+
### 5.4. 変更時の影響確認
|
|
124
|
+
|
|
125
|
+
- ドメインの追加・削除・改名時は、索引とドメイン正本を同じ変更で整合させる。構造の適合は schema 検証、実在カタログとの整合は `catalog validate` で確認し、`catalog build` 後に「生成ビューの確認要件」を満たすことを確かめる。
|
|
126
|
+
- 改訂・廃止の共通原則は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従う。個別成果物の非推奨化とドメインの除去は分けて判断し、同じドメインのカタログが残る間は索引から外さない。
|
|
127
|
+
- ARC は分類と参照先の構造整合、QE は索引ビュー・サイドバーからの到達と表示、PM は残る追従作業の担当・実行順を確認する。プロジェクト固有の役割分担がある場合は、その定義に従う。
|
|
128
|
+
|
|
129
|
+
| 判断 | 良い例 | 悪い例 |
|
|
130
|
+
| ---------- | ---------------------------------------------------------------- | --------------------------------------------------------- |
|
|
131
|
+
| 追加・改名 | ドメイン正本と索引を揃え、参照先へ到達できることまで確認する | 索引の表示名だけ変えて完了とする |
|
|
132
|
+
| 除去 | 同じドメインの残存カタログと参照元を調べ、追従対象を決める | 個別成果物を非推奨にしただけでドメイン全体を索引から外す |
|
|
133
|
+
| 完了判断 | 構造・実在ドメインとの整合・生成後の表示と到達をそれぞれ確かめる | YAML が読み込めること、または schema 検証だけで完了とする |
|
|
134
|
+
|
|
135
|
+
影響確認の記録は、`変更対象`(ドメインまたは項目)、`理由`(分類・規模を変える根拠)、`影響先`(参照元・生成表示・scaffold)、`担当 Role code`、`確認結果` の列で整理すると、未解消の追従作業を引き継げる。
|
|
136
|
+
|
|
137
|
+
## 6. 禁止事項
|
|
138
|
+
|
|
139
|
+
| 禁止事項 | 理由 |
|
|
140
|
+
| ---------------------------------------------------- | -------------------------------------------------- |
|
|
141
|
+
| `generated/dct-index.md` を直接編集する | 次回生成で失われ、正本と差異が生じるため |
|
|
142
|
+
| 表示順や表示名を各 `dct-*.yaml` へ分散して持たせる | ドメイン横断の編集意図が複数ファイルへ分散するため |
|
|
143
|
+
| 同じ `domain` を複数のグループへ宣言する | 索引上の所属と行が重複するため |
|
|
144
|
+
| schema で許可されないキー・値・階層を独自に追加する | 読み込み・検証・生成処理と互換性を保てないため |
|
|
145
|
+
| 実在しないドメインを宣言する | 生成リンクの参照先を作れないため |
|
|
146
|
+
| `domains[]` の要素で `name` を `domain` より前に書く | サイドバーが表示名を解決できなくなるため |
|
|
147
|
+
| 実在するドメインを索引宣言から省略する | 管理対象カタログを参照起点から辿れなくなるため |
|
|
148
|
+
| 個別成果物の配置・依存・完了条件を索引宣言へ記載する | ドメイン正本との二重管理になるため |
|
|
@@ -171,12 +171,13 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
171
171
|
|
|
172
172
|
計画成果物をカタログへ登録する場合も、生成方法ではなくライフサイクルで区別する。
|
|
173
173
|
|
|
174
|
-
- 人または agent が判断して更新する `
|
|
174
|
+
- 人または agent が判断して更新する `dct-index`、`dct-plan-<domain>`、`sch-strategy-<track>`、`sch-defaults` は `work` とする。
|
|
175
|
+
- 全体計画は登録簿の epic を正本とし、順序は `depends_on`、範囲は `domains`、期間は着手・完了の記録と `due_on` で管理する。運用は [[specdojo:register-operation-guide|登録簿運用ガイド]] を参照する。非推奨の `tml-index` は新しいカタログへ登録せず、移行時に旧エントリと不要な依存を外す。
|
|
175
176
|
- `sch-track-<track>` と `sch-milestones` は strategy から再生成できるため `generated` とし、対応する `sch-strategy-<track>` を `depends_on` に宣言する。
|
|
176
177
|
|
|
177
178
|
- 計画成果物を所有するトラック自身の `sch-strategy` は、自己生成の循環を避けるため `control` とするか、そのトラックの scope 外へ置く。
|
|
178
179
|
- `dct-<domain>.yaml` 自身と `generated/` 配下の表示用生成物は、カタログ定義との二重管理を避けるため登録しない。
|
|
179
|
-
- トラック別の strategy、track
|
|
180
|
+
- トラック別の strategy、track は、対象 epic の範囲にあるカタログを人間が確認し、`catalog-planning` の子 todo を完了させてから具体的な `local_id` を追加する。strategy 作成は対象 track を担う epic のもとで進め、未着手トラックの分を先行登録しない。
|
|
180
181
|
|
|
181
182
|
### 6.3. `depends_on`
|
|
182
183
|
|
|
@@ -198,7 +199,8 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
198
199
|
- `evidence_refs` は成果物ごとの安定した調査入力であり、`approach: retrofit` の edit / review plan に「実装エビデンス」として展開される。
|
|
199
200
|
- `depends_on` のような成果物間の根拠・実行順序を作らず、`based_on` のような文書 ID 参照にも使わない。
|
|
200
201
|
- `path` は先頭スラッシュなしのリポジトリルート相対パスとし、絶対パス、`..`、`.`、バックスラッシュ、重複区切りを含めない。宣言先の存在と同一成果物内の重複を `catalog validate` で検証する。
|
|
201
|
-
- `path`
|
|
202
|
+
- `path` は責務単位の調査範囲を指定し、状態遷移・判定・検証の本体を含むファイルが参照にあることを確認する。入口が re-export だけなら転送先をたどり、本体の参照を補う。re-export だけのファイルを根拠にしない。
|
|
203
|
+
- `catalog validate` は JavaScript / TypeScript の re-export(型の re-export を含む)だけのファイルへの参照を警告する。警告は終了コードを変えず、存在しないパス・広すぎる範囲・重複のエラーは維持する。
|
|
202
204
|
- ディレクトリを指定する場合は責務単位に限定し、`src`、`tools`、`docs`、リポジトリルートのような過度に広い範囲を指定しない。
|
|
203
205
|
- `purpose` はファイル名の言い換えではなく、入出力、状態遷移、例外など、その参照から何を確認するかを記載する。
|
|
204
206
|
- 実装エビデンスは読み取り専用であり、plan frontmatter の `targets`、worktree の変更許可範囲、commit 許可リストへ追加しない。
|
|
@@ -257,10 +259,10 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
257
259
|
- 判定計画に書くのは、必要な成果物インスタンス・placeholder 値・採用しない候補・未確定事項・判定根拠・確度に限る。`groups`・`base_path`・`done_criteria` などのカタログ構造はテンプレートとジェネレーターの責務であり、判定計画へ複製しない。
|
|
258
260
|
- `iteration_pattern` は `業務領域テンプレートの反復方針(_TERM_ の使い分け)` のパターンAを `pattern-a`、パターンBを `pattern-b` として記載する。`pattern-a` では placeholder ごとに値と根拠を `variables` へ書き、`local_id` は展開結果と一致させる。`pattern-b` では `variables` を使わず、処理単位ごとの固定 `local_id` を記載する。
|
|
259
261
|
- 上流成果物から根拠を得られない placeholder・成果物の要否・名称・依存関係は確定させず、`open_questions` に理由と次のアクションを残す。根拠のない項目を推測で確定しない。
|
|
260
|
-
- 入力は
|
|
262
|
+
- 入力は epic の `domains` が示す対象ドメインの上流成果物とし、少なくとも 1 件の data-flow 成果物を根拠にする。data-flow が存在しないドメインでは明示的に入力文書を指定する。data-flow が複数あるドメインでは、対象ドメインに関係するものをすべて入力に含める。
|
|
261
263
|
- 既に `dct-<domain>.yaml` があるドメインでは、既存カタログを基準線として入力に含め、既存 `local_id` を落とす場合は `exclusions` に理由を残す。
|
|
262
264
|
- 既存の判定計画は無条件に上書きしない。再判定時は差分をレビューし、上書きは明示的な `--force` 操作で行う。
|
|
263
|
-
-
|
|
265
|
+
- 判定計画は draft 作成支援であり、その存在だけでカタログの内容確認や `catalog-planning` の完了を代替しない。
|
|
264
266
|
|
|
265
267
|
### 6.13. 判定計画からの決定論的生成
|
|
266
268
|
|
|
@@ -268,7 +270,7 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
268
270
|
- ジェネレーターは template の `min_size`、placeholder 展開、`part_of`、`domain`、`base_path`、group 構造を scaffold と共通の処理で適用する。物理分割された template は、同じ `domain` を持つ全ファイルをファイル名順に処理し、対応する `dct-<domain>-<part>.yaml` を生成する。
|
|
269
271
|
- blocking な `open_questions`、未解決 placeholder、重複 `local_id`、存在しない `depends_on`、schema 違反が一件でもあれば、その domain のファイルを一件も書き込まない。
|
|
270
272
|
- 既存カタログとの差分は `--dry-run` で確認する。既存ファイルは既定で保護し、内容が異なる場合の上書きには `--force` を必要とする。同一入力の再実行で内容が同じ場合は書き込まない。
|
|
271
|
-
- 生成されたカタログの `status` は template に従い `draft`
|
|
273
|
+
- 生成されたカタログの `status` は template に従い `draft` のままとする。生成成功だけで確定とせず、人間の内容確認を経て `catalog-planning` の完了を記録する。
|
|
272
274
|
|
|
273
275
|
### 6.14. `brief`・`overview`・`done_criteria` の使い分けと YAML アンカー
|
|
274
276
|
|
|
@@ -288,7 +290,7 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
288
290
|
| `depends_on` に `local_id` 以外(ファイルパス・URL)を混在させる | 依存解決が機械的に行えなくなるため |
|
|
289
291
|
| `evidence_refs.path` に絶対パス・親参照・存在しないパスを記載する | 再現可能で安全な調査範囲を確定できないため |
|
|
290
292
|
| `evidence_refs.path` にリポジトリ全体など広すぎる範囲を指定する | 調査範囲と判断根拠を限定できないため |
|
|
291
|
-
| `evidence_refs
|
|
293
|
+
| `evidence_refs` の根拠を re-export だけのファイルで済ませる | 状態遷移・判定・検証の本体が参照から漏れるため |
|
|
292
294
|
| `work` 成果物で `path` または `done_criteria` を省略する | スケジュール展開とレビュー計画生成に必須のため |
|
|
293
295
|
| 実在しない実践の型 ID、またはカタログで `rulebook: none` を使う | 未判断・未整備・不要・参照切れを機械的に区別できないため |
|
|
294
296
|
| `dct-plan-<domain>.yaml` にカタログ構造や自由文の判断メモを書く | ジェネレーターが機械的に扱えず責務境界が崩れるため |
|
|
@@ -29,13 +29,14 @@ Decision Log Documentation Rulebook
|
|
|
29
29
|
|
|
30
30
|
- 推奨: `dec-<NNNN>-<topic>.md`
|
|
31
31
|
- 連番は4桁ゼロ埋めとする(例: `dec-0001-auth`)。
|
|
32
|
+
- 文書 ID は `<project-id>:dec-<NNNN>-<topic>` 形式とする(例: `prj-0001:dec-0001-auth`)。
|
|
32
33
|
|
|
33
34
|
## 4. 推奨 Frontmatter 項目
|
|
34
35
|
|
|
35
36
|
| 項目 | 説明 | 必須 |
|
|
36
37
|
| ---- | ---- | ---- |
|
|
37
38
|
|
|
38
|
-
| id |
|
|
39
|
+
| id | `<project-id>:dec-<NNNN>-<topic>` | ○ |
|
|
39
40
|
| type | `project` | ○ |
|
|
40
41
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
41
42
|
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:dss-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
6
|
+
status: draft
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: specdojo:dss-sample
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# デザインシステム(DSS)作成ルール
|
|
16
|
+
|
|
17
|
+
Design System Specification (DSS) Authoring Rule
|
|
18
|
+
|
|
19
|
+
GUI の画面をまたいで見た目と操作時の表現を揃える、デザインシステムの記述ルールです。実装者・生成 agent が部品とレイアウトの型を選び、品質保証担当者が適合を確認できる設計の決まりを定めます。
|
|
20
|
+
|
|
21
|
+
## 1. 全体方針
|
|
22
|
+
|
|
23
|
+
- 基本の値(デザイントークン)、部品の使い方、レイアウトの型、状態表示、アクセシビリティを対象にします。
|
|
24
|
+
- 各決まりには適用条件・必須または禁止する内容・検証方法を記載し、「見やすくする」だけで終わらせません。
|
|
25
|
+
- デザインツール、トークン定義、部品カタログに正本がある場合は、所在・対象の版・参照キーを示し、その値や仕様を転載しません。正本がない範囲だけ本書で定義します。
|
|
26
|
+
- 利用者の課題と設計の採用理由を結び、操作性の目標から決まり、試作・実装の検証へ辿れるようにします。
|
|
27
|
+
|
|
28
|
+
## 2. 位置づけと用語定義
|
|
29
|
+
|
|
30
|
+
### 2.1. 他の型との分担
|
|
31
|
+
|
|
32
|
+
| 型 | 持つ内容 | DSS との境界 |
|
|
33
|
+
| ------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------- |
|
|
34
|
+
| [[specdojo:uis-rulebook\|画面仕様(UIS)]] | 画面ごとの利用目的・項目・操作・遷移・エラーの要点と回復操作 | DSS は業務上の操作や遷移を追加せず、その見せ方を定める |
|
|
35
|
+
| [[specdojo:nfr-usability-rulebook\|操作性要件]] | 完了率・誤操作率・操作時間などの測れる目標と評価条件 | 目標は NFR、目標を満たす設計の決まりは DSS に置く |
|
|
36
|
+
| [[specdojo:sysd-cross-cutting-policy-rulebook\|システム設計の横断ルール]] | エラー契約・リトライ・認可・ログなど実装の共通ルール | DSS はエラー等の表示を扱い、通信や業務処理の成立条件は扱わない |
|
|
37
|
+
| [[specdojo:sysd-index-rulebook\|システム設計の全体構成]] | 設計と実装の正本への導線 | DSS とトークン・部品の正本への入口を載せる |
|
|
38
|
+
|
|
39
|
+
画面ごとのワイヤーフレームは文書として保守しません。UIS と DSS を入力として agent 等が試作を作り、プロダクトのリポジトリに置きます。試作は決まりの検証に使い、変更を採用するときは UIS・DSS・実装の該当する正本へ反映します。
|
|
40
|
+
|
|
41
|
+
### 2.2. 用語
|
|
42
|
+
|
|
43
|
+
| 用語 | 定義 |
|
|
44
|
+
| ---------------- | ------------------------------------------------------------------------------ |
|
|
45
|
+
| デザイントークン | 色・文字・余白・角丸等の再利用する値に、用途が分かる名前を付けたもの |
|
|
46
|
+
| 部品 | ボタン・入力・表・ダイアログなど、複数画面で共通の表現・操作を担う単位 |
|
|
47
|
+
| レイアウトの型 | 特定画面の配置図ではなく、情報や操作を組み立てる再利用可能な配置・幅変化の規則 |
|
|
48
|
+
|
|
49
|
+
## 3. ファイル命名・ID規則
|
|
50
|
+
|
|
51
|
+
- 略号は `dss`、ファイル名とローカル ID は `dss-<term>` とします。命名の共通規則は [[specdojo:id-and-file-naming-standard|ドキュメントIDおよびファイル命名標準]] に従います。
|
|
52
|
+
- 既定は `dss-common.md` / `dss-common` です。画面仕様など複数系列から参照する共通定義として `common` を用い、端末群等で適用範囲が独立する場合だけ `dss-store-gui` のように分けます。
|
|
53
|
+
- プロダクト成果物は `docs/ja/product/040-system-design/` へ置きます。プロジェクト限定の成果物はプロジェクトの設計ドメイン配下に置き、ID を `<project-id>:dss-<term>` とします。分冊時は共通定義への参照を示し、値を複製しません。
|
|
54
|
+
- 成果物の規則を個別に追跡する場合は `dss-<カテゴリ>-<連番>`(例: `dss-a11y-01`)を文書内で一意に付けます。
|
|
55
|
+
|
|
56
|
+
## 4. 推奨 Frontmatter 項目
|
|
57
|
+
|
|
58
|
+
[[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と共通の成果物 Frontmatter スキーマに従い、`specdojo` 配下に記載します。
|
|
59
|
+
|
|
60
|
+
| 項目 | 必須 | 内容 |
|
|
61
|
+
| ----------- | ---- | ------------------------------------------------------------------------ |
|
|
62
|
+
| `id` | ○ | `dss-<term>`。プロジェクト限定なら project 修飾 ID |
|
|
63
|
+
| `type` | ○ | `architecture` 固定。要求を表す `ui` や `requirement` と区別する |
|
|
64
|
+
| `status` | ○ | 作成時は `draft`。昇格は人が判断する |
|
|
65
|
+
| `rulebook` | ○ | `specdojo:dss-rulebook` |
|
|
66
|
+
| `part_of` | 任意 | 所属する設計の入口等の ID 配列 |
|
|
67
|
+
| `based_on` | 任意 | 直接根拠にした要求・仕様の ID 配列。カタログ運用では依存関係の範囲に限る |
|
|
68
|
+
| `relations` | 任意 | `satisfies` 等の型付き参照。操作性要件との対応に用いる |
|
|
69
|
+
|
|
70
|
+
## 5. 本文要件
|
|
71
|
+
|
|
72
|
+
以下の章を番号付きで配置します。すべて必須とし、対象外の観点は理由を記載します。
|
|
73
|
+
|
|
74
|
+
| 順序 | 章 | 内容 |
|
|
75
|
+
| ---- | ------------------------ | -------------------------------------------------------------- |
|
|
76
|
+
| 1 | 目的・適用範囲 | 利用者、課題、対象 GUI・端末・表示環境、対象外、採用理由 |
|
|
77
|
+
| 2 | 正本と適用方法 | 領域ごとの正本・版・参照キー・更新責任、試作と実装への適用方法 |
|
|
78
|
+
| 3 | デザイントークン | 色・文字・余白・角丸等の用途、値または正本参照、利用制約 |
|
|
79
|
+
| 4 | 部品の使い方 | 選択条件、バリエーション、組合せ、禁止する使い方 |
|
|
80
|
+
| 5 | レイアウトの型 | 適用条件、情報の優先順位、幅・拡大時の振る舞い |
|
|
81
|
+
| 6 | 状態の見せ方 | 通常・エラー・無効・読み込み中・空・完了の表現と通知 |
|
|
82
|
+
| 7 | アクセシビリティ | キーボード、フォーカス、読み上げ、色以外の識別、視認性の決まり |
|
|
83
|
+
| 8 | 検証・変更管理と関連文書 | 要求と決まりの対応、確認方法・担当、例外と更新の入口 |
|
|
84
|
+
|
|
85
|
+
## 6. 記述ガイド
|
|
86
|
+
|
|
87
|
+
各節は「本文要件」の同名の章に対応します。共通の要求・用語・実装契約は上位文書を正本とし、DSS には参照と設計上の選択だけを残します。
|
|
88
|
+
|
|
89
|
+
### 6.1. 目的・適用範囲
|
|
90
|
+
|
|
91
|
+
- 誰のどの課題を解くかを示し、色・文字・部品等の採用理由を結び付けます。
|
|
92
|
+
- 対象 GUI、入力手段、画面幅、テーマ、支援技術の確認範囲を表で定めます。端末の物理寸法と CSS viewport 幅を混同しません。
|
|
93
|
+
- 対象外を明記し、画面固有の業務仕様は UIS、測れる利用結果の目標は NFR を参照します。
|
|
94
|
+
|
|
95
|
+
判断基準は、実装者が対象環境と規則の適用境界を判断できることです。
|
|
96
|
+
|
|
97
|
+
- 良い例: 「店頭で金額を読み違えないよう主要金額の文字を大きくする。ライトテーマ、CSS viewport 幅 360px 以上の販売 GUI を対象とし、レシートは対象外。」
|
|
98
|
+
- 悪い例: 「すべての端末で使いやすく美しい画面にする。」(利用者・環境・採用理由を判断できない)
|
|
99
|
+
|
|
100
|
+
### 6.2. 正本と適用方法
|
|
101
|
+
|
|
102
|
+
- 推奨表は「領域 / 正本の所在 / 版・参照キー / 更新責任」です。デザインツールはファイルとライブラリ、コードはリポジトリと相対パスを特定し、閲覧権限の取得先も必要に応じて示します。
|
|
103
|
+
- 正本が分かれる場合は領域ごとの優先順位を決め、不一致の報告先を指定します。正本がない範囲は DSS で定義することを明記します。
|
|
104
|
+
- UIS と DSS から作る試作の置き場所、実装へ採用する際の反映先、入力文書と試作の版の記録方法を示します。
|
|
105
|
+
|
|
106
|
+
判断基準は、同じ版の定義へ到達でき、重複した値を保守せず試作・実装に適用できることです。
|
|
107
|
+
|
|
108
|
+
- 良い例: 「色はプロダクトリポジトリの `design/tokens.json` の `color.action` を参照し、検証記録に commit を残す。不一致は ARC へ報告する。」
|
|
109
|
+
- 悪い例: 「最新のデザインファイルに合わせる。」(所在・版・更新責任がなく、再現できない)
|
|
110
|
+
|
|
111
|
+
### 6.3. デザイントークン
|
|
112
|
+
|
|
113
|
+
- 推奨表は「名前 / 用途 / 値・単位または参照キー / 制約」です。色・文字・余白・角丸に加え、操作領域とフォーカス枠等に必要な値を扱います。
|
|
114
|
+
- 色は前景と背景の許可された組合せ、文字はサイズ・行高・太さ、寸法は単位と拡大時の扱いを定めます。テーマを複数持つ場合は切替条件も記載します。
|
|
115
|
+
- 外部に正本がある値は転載せず、用途と利用制約を記載します。既存の用途に合わない場合の追加依頼先を示し、画面内での独自値の増殖を防ぎます。
|
|
116
|
+
|
|
117
|
+
判断基準は、利用者が値を推測せず用途に合うトークンを選べることです。
|
|
118
|
+
|
|
119
|
+
- 良い例: 「`text-caption` は補足専用。金額・エラー・操作名には使わず、寸法は相対値で拡大に追従させる。」
|
|
120
|
+
- 悪い例: 「小さい文字と青を使う。」(名前・単位・利用制約がない)
|
|
121
|
+
|
|
122
|
+
### 6.4. 部品の使い方
|
|
123
|
+
|
|
124
|
+
- 推奨表は「規則 ID・部品 / 選択条件・使い方 / 禁止・制約」です。ボタン・入力・表・ダイアログを含め、使わない部品は理由を示します。
|
|
125
|
+
- 選択条件、バリエーション、ラベル、寸法の参照先、組合せを記載します。業務上の操作名や確認の要否は UIS に委ねます。
|
|
126
|
+
- 状態表示とアクセシビリティの共通規則を参照し、部品ごとに違いがある条件だけ補います。
|
|
127
|
+
|
|
128
|
+
判断基準は、同じ用途に同じ部品が選ばれ、禁止する組合せも判別できることです。
|
|
129
|
+
|
|
130
|
+
- 良い例: 「一つの操作群の主操作は一つ。補助操作は枠付きとし、ラベルは UIS の操作名を使う。」
|
|
131
|
+
- 悪い例: 「重要そうな操作をすべて塗りボタンにする。」(選択条件が揃わず、優先度を区別できない)
|
|
132
|
+
|
|
133
|
+
### 6.5. レイアウトの型
|
|
134
|
+
|
|
135
|
+
- 一覧・入力・確認等、複数画面に再利用できる型を選び、推奨表を「規則 ID・型 / 適用条件 / 配置と幅変化の決まり」とします。
|
|
136
|
+
- 情報の優先順位と幅の境界を決め、列の切替、折り返し、スクロール、拡大時の扱いを指定します。画面別の座標や配置図は作りません。
|
|
137
|
+
- 視覚上の順序と読み上げ・Tab 順序を揃え、長文・大量データ・最大桁の金額等が収まらない場合も操作を失わない条件を書きます。
|
|
138
|
+
|
|
139
|
+
判断基準は、境界の前後や拡大時にも情報の意味と操作順序を保てることです。
|
|
140
|
+
|
|
141
|
+
- 良い例: 「入力と集計は幅 960px 以上で二列、未満で一列。入力、集計、操作の順を保ち、操作群は折り返す。」
|
|
142
|
+
- 悪い例: 「販売画面の確定ボタンを座標 (800, 600) に置く。」(画面固有の配置であり、再利用可能な型にならない)
|
|
143
|
+
|
|
144
|
+
### 6.6. 状態の見せ方
|
|
145
|
+
|
|
146
|
+
- 推奨表は「状態 / 視覚表現 / 通知・フォーカス / 操作上の注意」です。通常・エラー・無効・読み込み中・空・完了を含めます。
|
|
147
|
+
- 原因・対処・次の操作は UIS を参照し、DSS では表示位置、色以外の識別、通知のタイミング、フォーカスと入力値の保持を定めます。
|
|
148
|
+
- 通信中や失敗を空と区別し、読み込み中の重複操作防止とフォーカス保持を両立させます。通信の再送条件は横断ルールに委ねます。
|
|
149
|
+
|
|
150
|
+
判断基準は、利用者が現在の状態と次の操作を認識でき、支援技術にも変化が伝わることです。
|
|
151
|
+
|
|
152
|
+
- 良い例: 「エラーは枠と『エラー』の文字を併用する。送信時は最初の不正入力へフォーカスし、値を保持する。」
|
|
153
|
+
- 悪い例: 「失敗時は赤くし、一定時間後に消す。」(色に依存し、確認・回復前に情報が失われる)
|
|
154
|
+
|
|
155
|
+
### 6.7. アクセシビリティ
|
|
156
|
+
|
|
157
|
+
- キーボード操作、フォーカスの出入り、ラベルと説明の関連付け、読み上げ通知、色以外の識別を必須の決まりとして記載します。
|
|
158
|
+
- コントラスト、操作領域、文字拡大、動きの抑制は適用する要求・規格と評価条件に結び付けます。設計値と操作性の達成目標を区別し、目標を複製しません。
|
|
159
|
+
- 推奨表は「規則 ID / 必須の決まり / 確認条件」です。支援技術とブラウザの組合せ、版の記録、対象の状態、手動確認が必要な操作を特定します。
|
|
160
|
+
|
|
161
|
+
判断基準は、確認者が同じ環境と操作で合否を再現でき、数値の一部だけで規格全体への適合を宣言していないことです。
|
|
162
|
+
|
|
163
|
+
- 良い例: 「ダイアログの Tab は内部を循環し、Escape で中止して起点へ戻す。起点消失時は次の操作群へ移す。」
|
|
164
|
+
- 悪い例: 「アクセシビリティに配慮する。」(確認する操作と合否の条件がない)
|
|
165
|
+
|
|
166
|
+
### 6.8. 検証・変更管理と関連文書
|
|
167
|
+
|
|
168
|
+
- 「対象の規則・正本キー / 対応する要求 / 確認方法 / 担当」の表で、静的確認・部品表示・試作操作・利用者評価を使い分けます。規則への適合だけで操作性目標の達成とみなしません。
|
|
169
|
+
- 試作確認、規則検証、利用者評価、設計採用の順と終了条件を示します。未作成の入力や試験文書には、想定 ID・定義責任・確認期限・未確定時に止める段階を書きます。
|
|
170
|
+
- 変更時はトークン・部品・適用画面・検証への影響を調べます。検証不適合・変更提案・例外判断の報告先と責任を分け、例外には対象規則、理由、影響範囲、承認 Role、期限、判断記録と失効時の扱いを示します。
|
|
171
|
+
- 関連文書には UIS、操作性要件、設計の入口・横断ルール、受入・試験への導線を置きます。実在する文書は project 修飾 ID の wikilink、未作成なら想定 ID のインラインコードとします。
|
|
172
|
+
|
|
173
|
+
判断基準は、必要な証跡と未解決事項を添えて採用判断へ進められ、更新後も規則から検証・判断記録へ辿れることです。責務は [[specdojo:people-and-organization-definition-standard|人と組織の定義標準]] の Role code で示します。
|
|
174
|
+
|
|
175
|
+
- 良い例: 「QE が規則ごとの検証結果を試験記録に残し、BA が要件と受入条件を確認した後、PO が未解決事項と残余リスクを確認して基準版の採用を判断する。」
|
|
176
|
+
- 悪い例: 「試作ができたらそのまま採用する。」(要件の確認・検証結果・承認責任がなく、採用可否を追えない)
|
|
177
|
+
|
|
178
|
+
## 7. 禁止事項
|
|
179
|
+
|
|
180
|
+
| 禁止事項 | 理由 |
|
|
181
|
+
| ------------------------------------------------------------ | ----------------------------------------- |
|
|
182
|
+
| 画面ごとの目的・項目・操作・遷移、業務上の判定条件を定義する | UIS と責務が重複するため |
|
|
183
|
+
| 画面ごとのワイヤーフレームを文書として保守する | UIS・DSS と試作の間に別の正本ができるため |
|
|
184
|
+
| 実装の共通ルールや操作性の達成目標を再定義する | 横断ルールや NFR と競合するため |
|
|
185
|
+
| デザインツール・トークン定義・部品カタログの内容を転載する | 正本の更新が反映されず二重管理になるため |
|
|
186
|
+
| 値・選択条件・検証方法を示さず、抽象的な形容だけで規則を書く | 実装と合否判断が揃わないため |
|
|
187
|
+
|
|
188
|
+
## 8. 運用ルール
|
|
189
|
+
|
|
190
|
+
- 本文要件や記述ガイドを変えたら、Frontmatter で宣言した完成例の同名の章と必須項目を確認します。正本への参照で済む値や規則を追加転載しません。
|
|
191
|
+
- 本型は Markdown の設計文書であり、章ごとの判断基準と完成例で作成できるため、recipe と template は不要とします。要否を見直す場合は Frontmatter の宣言も更新します。
|
|
192
|
+
- 改訂時は [[specdojo:rulebook-authoring-standard|Rulebook 記述標準]]、完成例は [[specdojo:sample-authoring-standard|Sample 記述標準]] に照らし、Frontmatter・Markdown 検査と grade で整合を確認します。`ready` への昇格と公開は人間の PO が判断し、根拠と承認を実行記録へ残します。
|
|
193
|
+
- 名称・略号・配置を変える場合は、命名標準、成果物・配置のリファレンス、文書サイトの導線、種類を列挙するレビュー観点の適用設定を確認します。保護された設定の変更が必要なら変更案を申し送り、executor は変更しません。
|