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,245 +3,128 @@ specdojo:
|
|
|
3
3
|
id: specdojo:sysd-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: architecture
|
|
6
|
-
status:
|
|
7
|
-
|
|
6
|
+
status: ready
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: specdojo:sysd-index-recipe
|
|
8
9
|
sample: specdojo:sysd-index-sample
|
|
10
|
+
template: specdojo:sysd-index-template
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
9
13
|
---
|
|
10
14
|
|
|
11
|
-
#
|
|
15
|
+
# システム設計索引(SYSD Index)作成ルール
|
|
12
16
|
|
|
13
|
-
System Design
|
|
17
|
+
System Design Index Documentation Rules
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
「どこに一次情報(SSOT)があるか」を迷わず辿れるようにする **System Design (SYSD) Index** の記述ルールを定義する。
|
|
19
|
+
システム設計の正本、派生物、変更時の更新先への導線を集約する索引の規約を定める。値・構文・構造の詳細はコード、schema、リファレンスを正本とし、索引では所在と責任、変更影響、確認経路を扱う。
|
|
17
20
|
|
|
18
21
|
## 1. 全体方針
|
|
19
22
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
|
|
26
|
-
ことを目的とする。
|
|
27
|
-
|
|
28
|
-
Code as Spec の原則:
|
|
29
|
-
|
|
30
|
-
- SYSD Index は「一次情報」ではなく「導線」とし、仕様本文(詳細)は書かない
|
|
31
|
-
- SYSD Index は SSOT(一次情報)へのリンクと最小限の補足のみを記載する
|
|
32
|
-
- SSOT は機械可読・差分検知可能な定義を優先する(OpenAPI / migration / workflow / schema など)
|
|
33
|
-
- 補足は意図・境界・ルールに限定し、詳細は SSOT に寄せる
|
|
23
|
+
- 合意したシステム範囲につき、設計情報の入口を一つにする。全依存ファイルの台帳にはしない。
|
|
24
|
+
- 公開インターフェース、データ保存・移行、設定、実行構成、運用・監視の正本へ到達できるようにする。
|
|
25
|
+
- 未記載と非該当を区別する。非該当には理由と代替正本、未確認には担当と確認条件を付ける。
|
|
26
|
+
- 正本と生成物を分け、生成コマンド、出力先、閲覧方法を対応付ける。生成物を直接編集しない。
|
|
27
|
+
- 変更目的から更新先、追従対象、検証対象と期待結果を逆引きできるようにする。
|
|
28
|
+
- 人間が構成判断と公開を承認する。未決事項の解消や `ready` 昇格をエージェントが代行しない。
|
|
34
29
|
|
|
35
30
|
## 2. 位置づけと用語定義
|
|
36
31
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
| 用語 | 定義 |
|
|
46
|
-
| ------------ | ----------------------------------------------------------------------------- |
|
|
47
|
-
| SYSD Index | System Design Index。一次情報そのものではなく、設計情報への導線をまとめる文書 |
|
|
48
|
-
| SSOT | Single Source of Truth。仕様の正本となる一次情報 |
|
|
49
|
-
| Code as Spec | コード/定義ファイルを仕様の正本として扱う運用方針 |
|
|
32
|
+
| 用語・情報 | この索引での役割 |
|
|
33
|
+
| --------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
34
|
+
| SSOT(Single Source of Truth、正本) | 各設計要素を最初に更新・参照する一次情報。コード・定義ファイルを仕様として扱う運用を Code as Spec と呼ぶ |
|
|
35
|
+
| システム設計(System Design、SYSD)索引 | 正本の所在と変更経路をつなぐ入口。詳細な設計判断は分冊へ委ねる |
|
|
36
|
+
| 技術スタック・構成図 | 採用技術や境界を理解するための上位・隣接情報。索引では参照目的を示す |
|
|
37
|
+
| 自動生成物 | 正本を入力とする型、索引、閲覧ページ、配布物などの派生物 |
|
|
38
|
+
| 運用・テスト仕様 | 変更後の検証と運用判断の入力。索引では対象ケースと手順への入口を示す |
|
|
50
39
|
|
|
51
40
|
## 3. ファイル命名・ID規則
|
|
52
41
|
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
- `id`(参照用の不変キー)とファイル名(可読性/並び順)は独立であり、ファイル名変更は許容する。
|
|
42
|
+
- ファイル名は `sysd-index.md` とし、対象のシステム設計文書群に置く。
|
|
43
|
+
- ID は対象範囲で一意な `sysd-index` 系とする。名前空間・配置は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] に従う。
|
|
44
|
+
- H1 にはシステム名と索引であることを示す。分冊を追加しても索引の正本を複製しない。
|
|
57
45
|
|
|
58
46
|
## 4. 推奨 Frontmatter 項目
|
|
59
47
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
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))。
|
|
63
|
-
|
|
64
|
-
| 項目 | 説明 | 必須 |
|
|
65
|
-
| ---------- | ------------------------------------------------------ | ---- |
|
|
66
|
-
| id | SYSD ID(推奨: `sysd-index`) | ○ |
|
|
67
|
-
| type | `architecture` 固定 | ○ |
|
|
68
|
-
| title | システム設計: 全体構成(リンク集)など対象が分かる名称 | ○ |
|
|
69
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
70
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
71
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
48
|
+
共通の型・許可項目は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正とする。タイトルは H1 に記載し、schema が許可しない `specdojo.title` を追加しない。
|
|
72
49
|
|
|
73
|
-
|
|
50
|
+
| 項目 | 扱い | 索引での記述判断 |
|
|
51
|
+
| ------------------------ | -------- | -------------------------------------------------------------------------------- |
|
|
52
|
+
| `id` / `type` / `status` | 必須 | 一意な ID、`architecture`、現在の成熟度を記す。作成・編集時は `draft` を維持する |
|
|
53
|
+
| `rulebook` | 必須 | 本規約の完全 ID を宣言する |
|
|
54
|
+
| `part_of` | 任意 | 所属する上位文書がある場合にだけ指定する |
|
|
55
|
+
| `based_on` | 条件付き | 許可された依存関係内の直接根拠だけを指定する。関連リンクを転記しない |
|
|
56
|
+
| `supersedes` | 条件付き | 旧索引を置き換える場合に指定する |
|
|
74
57
|
|
|
75
|
-
|
|
76
|
-
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
58
|
+
## 5. 本文要件
|
|
77
59
|
|
|
78
|
-
|
|
60
|
+
見出し順・表の列・記入欄は Frontmatter で宣言した template を正本とし、本章は内容の成立条件を定める。`##`〜`####` は階層ごとの連番と末尾の `.` を付ける。
|
|
79
61
|
|
|
80
|
-
|
|
62
|
+
| 内容領域 | 必須・任意 | 成立条件 |
|
|
63
|
+
| -------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
64
|
+
| 対象と責任 | 必須 | 対象範囲、更新責任、QE の確認対象、人間の承認対象が分かる。使う略語は初出時に展開するか用語への導線を置く |
|
|
65
|
+
| 設計正本 | 必須 | API・外部連携、データ契約・DB・移行、モジュール境界、設定・実行構成、Job・定期処理、監視・ログ・通知、ソース管理・CI の所在、更新責任、検証方法を示す |
|
|
66
|
+
| 派生物 | 必須 | 入力、実在する生成コマンド、生成先、閲覧先・再生成時機を対応付ける。生成しない場合はその理由を記す |
|
|
67
|
+
| 変更経路 | 必須 | API・DB・設定・Job・監視などの変更トリガーから、最初の更新先、追従する文書・生成物、具体的検査・ケース・期待結果へつながる |
|
|
68
|
+
| 関連仕様 | 必須 | 上位・同階層・下流の参照目的と整備状態が分かる。実在文書と未作成文書を区別する |
|
|
69
|
+
| 留保と公開判断 | 条件付き必須 | `draft`、未決・未整備事項、公開判断のいずれかがある場合、影響、担当、解消条件、解消後の更新先、確認者・承認者を示す |
|
|
81
70
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
| 2 | SSOT 一覧(表形式) | ○ |
|
|
86
|
-
| 3 | 自動生成物(生成コマンド/生成先/閲覧先) | 任意 |
|
|
87
|
-
| 4 | 変更の入口(どこを修正すればよいか:典型ケース) | ○ |
|
|
88
|
-
| 5 | 関連ドキュメント導線(C4 / NFR / OPD / DEC 等) | ○ |
|
|
89
|
-
|
|
90
|
-
補足:
|
|
91
|
-
|
|
92
|
-
- 本文は「リンク集」としての導線に徹し、仕様本文の再掲はしない。
|
|
93
|
-
- `3. 自動生成物` を省略する場合は `(なし)` または `(該当なし)` を明記する。
|
|
71
|
+
- API・DB・監視などが存在しない場合も該当領域を残し、非該当理由と代替正本または代替不要の理由を記す。
|
|
72
|
+
- パスは基準ディレクトリを明示し、glob を用いる場合は集合を特定できる範囲にする。候補のパスを実在する正本として扱わない。
|
|
73
|
+
- 値、API 電文、SQL、設定キー全量、クラス構造、詳細運用手順は転載しない。
|
|
94
74
|
|
|
95
75
|
## 6. 記述ガイド
|
|
96
76
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
生成する本文の見出しは **## 1. 概要(対象範囲・更新責任)**
|
|
100
|
-
|
|
101
|
-
- SDI が扱う範囲(内部API、内部イベント、外部I/F、DB、ジョブ、設定、モジュール境界)を明記する。
|
|
102
|
-
- 更新責任(Owner)を role ベースで明記する。
|
|
103
|
-
|
|
104
|
-
### 6.2. SSOT 一覧(表形式)
|
|
105
|
-
|
|
106
|
-
生成する本文の見出しは **## 2. SSOT 一覧(表形式)**
|
|
107
|
-
|
|
108
|
-
SDI の中核は **SSOT 一覧表** とする。
|
|
109
|
-
|
|
110
|
-
必須列:
|
|
77
|
+
共通の記法・メタ情報は上位標準を正本とし、各章では次の判断に集中する。
|
|
111
78
|
|
|
112
|
-
|
|
113
|
-
- SSOT(一次情報の種類)
|
|
114
|
-
- 参照先(パス/場所/リンク)
|
|
115
|
-
- 更新責任(Owner:role でよい)
|
|
116
|
-
- 備考(最小補足:任意)
|
|
79
|
+
### 6.1. 概要の書き方
|
|
117
80
|
|
|
118
|
-
|
|
81
|
+
対象範囲と対象外、更新者、確認者、承認者を分ける。全ロールを機械的に列挙せず、兼務があれば責務の違いを残す。
|
|
119
82
|
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
- External I/F
|
|
123
|
-
- Database Schema
|
|
124
|
-
- Jobs / Batch
|
|
125
|
-
- Configurations
|
|
126
|
-
- Observability(ログ/監査/トレースの定義がある場合)
|
|
127
|
-
- Module Boundary(依存方向・構成の規約)
|
|
83
|
+
- 良い例: 「対象はローカル CLI と日次処理。DEV が定義を更新し、QE が変更ケースを確認、PO が保存範囲と公開を承認する。」
|
|
84
|
+
- 悪い例: 「システム全体を扱い、担当者が適宜確認する。」対象と責任の境界がない。
|
|
128
85
|
|
|
129
|
-
|
|
86
|
+
### 6.2. SSOT 一覧の書き方
|
|
130
87
|
|
|
131
|
-
|
|
132
|
-
- 外部URLは最小限(SaaSの画面リンク等)。可能なら repo 内に保存する
|
|
133
|
-
- 複数ある場合は代表を1つ示し、備考で派生を列挙する
|
|
88
|
+
「種別」は設計領域、「正本」は最初に更新する定義、「参照先」はその所在、「更新責任」は担当ロール、「検証方法」は変更後の確認手段を記す。ログの出力ディレクトリと、ログ形式・出力・通知を決める設定を区別する。ソース管理・CI はブランチや統合の規約、ワークフロー・フック・検査 script の正本へ接続し、設定全文は転載しない。
|
|
134
89
|
|
|
135
|
-
|
|
90
|
+
- 良い例: 「DB は非該当(ファイル保存のみ)。正本は保存レコード schema と移行処理。DEV が更新し、既存形式の読込テストで検証する。」
|
|
91
|
+
- 悪い例: 「DB はなし」「監視は運用文書を参照」。理由、代替正本、具体的な設定が分からない。
|
|
136
92
|
|
|
137
|
-
|
|
138
|
-
- バージョニング方針の入口(詳細はSCR/DECへ)
|
|
139
|
-
- 読者や利用方法の要点(1〜2行)
|
|
93
|
+
### 6.3. 自動生成物の書き方
|
|
140
94
|
|
|
141
|
-
|
|
95
|
+
対象リポジトリの script・サブコマンド定義と出力先を照合する。一括コマンドと個別コマンドがある場合は役割を示し、同じ出力を別の正本にしない。業務記録や実行状態は、設計の正本から再生成する派生物と分ける。
|
|
142
96
|
|
|
143
|
-
|
|
97
|
+
- 良い例: 「API 定義から型を生成する script と出力ファイルを示し、API 変更時に再生成してビルドで整合を確かめる。」
|
|
98
|
+
- 悪い例: 「ビルドすれば更新される」。入力・出力・実行方法が対応しない。
|
|
144
99
|
|
|
145
|
-
|
|
146
|
-
- AsyncAPI → HTML
|
|
147
|
-
- migration → schema dump / ERD
|
|
148
|
-
- config schema → 設定一覧ドキュメント
|
|
100
|
+
### 6.4. 変更の入口の書き方
|
|
149
101
|
|
|
150
|
-
|
|
102
|
+
正常系に加え、変更が壊しやすい失敗・境界ケースを選ぶ。実行場所、検査コマンド、対象テストファイルまたはケース、期待結果を特定する。これから行う検証と実行済みの証跡を混同しない。
|
|
151
103
|
|
|
152
|
-
|
|
104
|
+
- 良い例: 「保存形式変更時は schema と移行処理を更新し、移行テストで旧形式の読込成功と再実行時の重複なしを確認する。検査の終了コードは `0`。」
|
|
105
|
+
- 悪い例: 「代表実行で経路と分離を確認する」。対象、操作、期待結果が未定義である。
|
|
153
106
|
|
|
154
|
-
|
|
107
|
+
### 6.5. 関連ドキュメント導線の書き方
|
|
155
108
|
|
|
156
|
-
|
|
157
|
-
- SDI 更新はリンク表の差分を中心とし、仕様本文は更新対象に含めない。
|
|
158
|
-
- 典型ケース(例: API追加、テーブル追加、ジョブ追加)ごとに「どこを修正するか」を短く記述する。
|
|
109
|
+
実在する現行文書は `[[id|title]]`、表では `[[id\|title]]` で接続する。未作成文書はコード表記にして代替参照先と後続作業を記す。廃止済み ID は後継へ置き換える。
|
|
159
110
|
|
|
160
|
-
|
|
111
|
+
区分は文書の役割を示す名称で統一し、略語を使う場合は概要で展開した表記と揃える。C4 / NFR / OPD / DEC 等の略号だけを必須の分類にせず、対象の文書体系に合わせる。表の途中に空行を挟まず、各行を同じ列構成で記す。
|
|
161
112
|
|
|
162
|
-
|
|
113
|
+
- 良い例: 「非機能要件(NFR)」「運用方針・手順(OPD / OPR)」で分類し、未作成の運用索引は ID と整備担当、当面使う個別手順を示す。
|
|
114
|
+
- 悪い例: 同じ非機能要件を「品質」「NFR」と呼び分け、「関連: 旧フロー、運用一式」とだけ記す。区分の対応と現行・未整備の違いが分からない。
|
|
163
115
|
|
|
164
|
-
|
|
165
|
-
- 分冊が無い場合でも `(なし)` または `(本書のみ)` を明記する。
|
|
116
|
+
### 6.6. 未決事項・公開前確認の書き方
|
|
166
117
|
|
|
167
|
-
|
|
118
|
+
不明なものは _TODO_:、意思決定待ちは _UNDECIDED_:、仮置き前提は _ASSUMPTION_: として分ける。未決事項に影響範囲、担当、判断時機、次アクションを付ける。
|
|
168
119
|
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
- **内部API / 内部イベント**:OpenAPI / AsyncAPI / gRPC proto 等を SSOT とし、SDI 本体にはリンクと横断ルールへの参照のみを記載する。
|
|
172
|
-
- **DB**:migration / schema 定義を SSOT とし、物理設計は「理由(意図)」のみを横断ルールまたは重要フローに残す。
|
|
173
|
-
- **UI 詳細**:画面の目的・項目は UIS を SSOT とし、実装構成(コンポーネント分割等)はコード参照とする。
|
|
174
|
-
- **Module Boundary**:クラス図は追随コストが高いため原則作らず、依存方向のルールとして横断ルールに記載する。
|
|
175
|
-
- **Jobs / Batch**:定義ファイル(workflow/cron/IaC)とコードを SSOT とし、運用上の重要事項のみ横断ルールに記載する。
|
|
176
|
-
- **Configurations**:config schema とデフォルト設定を SSOT とし、運用が触る項目のみ横断ルールまたは SDI から参照できる形で一覧化する。
|
|
120
|
+
- 良い例: 「通知先は未決。OPS が障害検知要件を確認し、公開前に PO が留保可否を判断する。決定後に設定正本と監視手順への導線を更新する。」
|
|
121
|
+
- 悪い例: 「今後検討」。承認待ちの対象と解消条件が分からない。
|
|
177
122
|
|
|
178
123
|
## 7. 禁止事項
|
|
179
124
|
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
| 備考に詳細仕様を書き始める | 本文肥大化と責務混在を招くため |
|
|
187
|
-
|
|
188
|
-
## 8. サンプル
|
|
189
|
-
|
|
190
|
-
注:以下はルール文書内の例示です。生成する `sysd-index` では `## 1...` から始まります。
|
|
191
|
-
|
|
192
|
-
```yaml
|
|
193
|
-
---
|
|
194
|
-
id: sysd-index
|
|
195
|
-
type: architecture
|
|
196
|
-
title: システム設計: 全体構成リンク集
|
|
197
|
-
status: draft
|
|
198
|
-
based_on: []
|
|
199
|
-
supersedes: []
|
|
200
|
-
---
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### 8.1. 概要(対象範囲・更新責任)
|
|
204
|
-
|
|
205
|
-
本書は、システム設計情報のSSOTを参照するための導線を一元化する。
|
|
206
|
-
更新責任: Dev Lead(構成管理)/ Ops Lead(運用系SSOT)
|
|
207
|
-
|
|
208
|
-
### 8.2. SSOT 一覧(例)
|
|
209
|
-
|
|
210
|
-
<!-- prettier-ignore -->
|
|
211
|
-
| 種別 | SSOT | 参照先 | 更新責任 | 備考 |
|
|
212
|
-
| --- | --- | --- | --- | --- |
|
|
213
|
-
| Internal API | OpenAPI | `api/openapi.yaml` | Dev | CIでlint、破壊的変更はDEC必須 |
|
|
214
|
-
| Internal Events | AsyncAPI + CloudEvents | `api/asyncapi.yaml` | Dev | schema互換性チェックを実施 |
|
|
215
|
-
| External I/F | 外部連携定義 | `spec/external-if/` | Dev | 接続先契約変更時は `dec-*` を更新 |
|
|
216
|
-
| Database Schema | migrations | `db/migrations/` | Dev | schema dumpはCI生成 |
|
|
217
|
-
| Jobs / Batch | workflow | `ops/workflows/` | Ops | 失敗時通知・リトライもここで定義 |
|
|
218
|
-
| Configurations | config schema | `config/schema.yaml` | Dev/Ops | 上書き階層はSCR参照 |
|
|
219
|
-
| Observability | ログ/監査定義 | `ops/observability/` | Ops | 監査ログ保持方針は `opd-*` 参照 |
|
|
220
|
-
| Module Boundary | package rule | `docs/architecture/module-boundary.md` | Dev | 依存方向はSCR参照 |
|
|
221
|
-
|
|
222
|
-
### 8.3. 自動生成物(例)
|
|
223
|
-
|
|
224
|
-
| 生成物 | 入力SSOT | 生成コマンド | 生成先 | 閲覧先 | 更新方式 |
|
|
225
|
-
| ------------- | ------------------- | ----------------------- | -------------------------- | ------------------------------------ | -------- |
|
|
226
|
-
| OpenAPI Docs | `api/openapi.yaml` | `npm run docs:openapi` | `docs/generated/openapi/` | `docs/generated/openapi/index.html` | CI |
|
|
227
|
-
| AsyncAPI Docs | `api/asyncapi.yaml` | `npm run docs:asyncapi` | `docs/generated/asyncapi/` | `docs/generated/asyncapi/index.html` | CI |
|
|
228
|
-
| ERD | `db/migrations/` | `npm run docs:erd` | `docs/generated/erd/` | `docs/generated/erd/index.html` | CI |
|
|
229
|
-
|
|
230
|
-
### 8.4. 変更の入口(典型ケース例)
|
|
231
|
-
|
|
232
|
-
| 変更トリガ | 最初に直す場所(SSOT) | 併せて更新する場所 | 完了条件(最低限) |
|
|
233
|
-
| --------------------- | ---------------------- | ---------------------------------------- | ------------------------- |
|
|
234
|
-
| APIエンドポイント追加 | `api/openapi.yaml` | `docs/generated/openapi/`, SDIのSSOT一覧 | API lint通過、SDI導線追加 |
|
|
235
|
-
| テーブル追加 | `db/migrations/` | `docs/generated/erd/`, SDIのSSOT一覧 | migration適用可、ERD更新 |
|
|
236
|
-
| バッチ新設 | `ops/workflows/` | 監視設定、SDIのSSOT一覧 | 実行定義・通知先が明記 |
|
|
237
|
-
| 設定項目追加 | `config/schema.yaml` | 設定一覧生成物、SDIのSSOT一覧 | 既定値・型・説明が確定 |
|
|
238
|
-
|
|
239
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
240
|
-
|
|
241
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
242
|
-
| ------ | ------------------- | ---------------------- | ---------------------- |
|
|
243
|
-
| アーキ | cpd-business-domain | 外部境界・依存先の把握 | 入口として必須 |
|
|
244
|
-
| 品質 | nfr-index | 非機能要件との整合確認 | 可用性・性能の判断基準 |
|
|
245
|
-
|
|
246
|
-
| 運用方針 | opd-index | 運用統制(監視/証跡/権限)確認 | 監査観点で参照 |
|
|
247
|
-
| 決定記録 | dec-index | 設計判断の背景追跡 | 破壊的変更時に必須 |
|
|
125
|
+
- 詳細定義を正本から転載し、索引を第二の仕様書にする。
|
|
126
|
+
- 非該当と未確認を同一視し、調べていない領域を無言で省略する。
|
|
127
|
+
- 未作成・廃止済みの文書や存在しないコマンドを現行の導線として示す。
|
|
128
|
+
- 完成例を本書へ埋め込む、または sample / recipe / template の本文リンク章を作る。対応関係は Frontmatter だけで宣言する。
|
|
129
|
+
- 対象システムの実例にある製品、ファイル配置、ロール兼務を全案件の必須構成にする。
|
|
130
|
+
- 改訂・廃止時に参照元への影響を放置する。[[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、ARC は設計導線、DEV は実装・schema・生成物、OPS は監視・手順、QE は検証入力を追従させ、PM が後続作業、人間の PO が公開判断を管理する。
|
|
@@ -3,7 +3,7 @@ specdojo:
|
|
|
3
3
|
id: specdojo:tml-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: project
|
|
6
|
-
status:
|
|
6
|
+
status: deprecated
|
|
7
7
|
target_format: yaml
|
|
8
8
|
recipe: not-needed
|
|
9
9
|
sample: specdojo:tml-sample
|
|
@@ -16,8 +16,9 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Timeline Documentation Rules
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
本 Kata は非推奨です。全体計画は epic で管理し、`dashboard build` で生成します。移行先は [[specdojo:pjr-rulebook|プロジェクト登録簿ルール]]、手順は [[specdojo:timeline-design-guide|Timeline からの移行ガイド]] を参照してください。
|
|
20
|
+
|
|
21
|
+
以下は既存の `tml-index.yaml` を互換運用するための旧規約です。新しい計画には使いません。
|
|
21
22
|
|
|
22
23
|
本書は命名・ID 規則と schema で表現できない記述規範を定義し、構造・必須キーは schema を、トラックの標準構成と実行順序の考え方は [[specdojo:track-design-guide]] を参照します。
|
|
23
24
|
|
|
@@ -136,9 +137,3 @@ schema で機械検証できない記述規範だけを定める。トラック
|
|
|
136
137
|
- `sch-milestones.yaml` のマイルストーンを `tml-index.yaml` に複製すること。
|
|
137
138
|
- プロジェクトごとに `tml-index.yaml` を複数置くこと、またはトラック単位へ分割すること。
|
|
138
139
|
- `specdojo timeline build` の生成物を直接編集すること。
|
|
139
|
-
|
|
140
|
-
## 7. 今後の検討
|
|
141
|
-
|
|
142
|
-
- 現時点の `catalog_status` は3値の軽量フィールドであり、カタログ作成作業そのものを子カタログ(`done_criteria` 付きの成果物エントリ)として管理する「フル成果物カタログ化」は採用していない。カタログ作成の工数管理をタスク粒度で行う必要が出た場合に、フル化を再検討する。
|
|
143
|
-
- フル化する場合でも `tml-index.yaml` はトラック粒度の計画層として残し、カタログ作成タスクは Schedule 側へ展開する方針を想定する。
|
|
144
|
-
- 複数プロジェクトを横断したトラック順序計画(プログラム単位の Timeline)は現時点では扱わない。
|
|
@@ -34,11 +34,10 @@ Requirements Traceability (Requirements to Specs) Rulebook
|
|
|
34
34
|
|
|
35
35
|
## 3. ファイル命名・ID規則
|
|
36
36
|
|
|
37
|
-
- 対象ドキュメント ID は
|
|
38
|
-
|
|
37
|
+
- 対象ドキュメント ID は `<project-id>:trc-requirements-to-specs` とする(例: `prj-0001:trc-requirements-to-specs`)。
|
|
39
38
|
- 推奨ファイル名は `trc-requirements-to-specs.md` とする。
|
|
40
39
|
- 本 rulebook の ID は `specdojo:trc-requirements-to-specs-rulebook` とする。
|
|
41
|
-
- 追加分割が必要な場合は
|
|
40
|
+
- 追加分割が必要な場合は `<project-id>:trc-requirements-to-specs-<term>` 形式を用いる。
|
|
42
41
|
|
|
43
42
|
## 4. 推奨 Frontmatter 項目
|
|
44
43
|
|
|
@@ -46,7 +45,7 @@ Requirements Traceability (Requirements to Specs) Rulebook
|
|
|
46
45
|
|
|
47
46
|
| 項目 | 説明 | 必須 |
|
|
48
47
|
| ---------- | --------------------------------------------- | ---- |
|
|
49
|
-
| id |
|
|
48
|
+
| id | `<project-id>:trc-requirements-to-specs` | ○ |
|
|
50
49
|
| type | `project` | ○ |
|
|
51
50
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
52
51
|
| rulebook | `specdojo:trc-requirements-to-specs-rulebook` | ○ |
|
|
@@ -34,10 +34,10 @@ Requirements Traceability (Requirements to Tests) Rulebook
|
|
|
34
34
|
|
|
35
35
|
## 3. ファイル命名・ID規則
|
|
36
36
|
|
|
37
|
-
- 対象ドキュメント ID は
|
|
37
|
+
- 対象ドキュメント ID は `<project-id>:trc-requirements-to-tests` とする(例: `prj-0001:trc-requirements-to-tests`)。
|
|
38
38
|
- 推奨ファイル名は `trc-requirements-to-tests.md` とする。
|
|
39
39
|
- 本 rulebook の ID は `specdojo:trc-requirements-to-tests-rulebook` とする。
|
|
40
|
-
- 追加分割が必要な場合は
|
|
40
|
+
- 追加分割が必要な場合は `<project-id>:trc-requirements-to-tests-<term>` 形式を用いる。
|
|
41
41
|
|
|
42
42
|
## 4. 推奨 Frontmatter 項目
|
|
43
43
|
|
|
@@ -45,7 +45,7 @@ Requirements Traceability (Requirements to Tests) Rulebook
|
|
|
45
45
|
|
|
46
46
|
| 項目 | 説明 | 必須 |
|
|
47
47
|
| -------- | --------------------------------------------- | ---- |
|
|
48
|
-
| id |
|
|
48
|
+
| id | `<project-id>:trc-requirements-to-tests` | ○ |
|
|
49
49
|
| type | `project` | ○ |
|
|
50
50
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
51
51
|
| rulebook | `specdojo:trc-requirements-to-tests-rulebook` | ○ |
|