specdojo 0.7.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 +153 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/init.js +5 -1
- package/dist/commands/night-orchestrator.js +6 -4
- 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/scaffold.js +18 -0
- 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/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 +153 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +48 -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 +55 -56
- 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 +188 -36
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +6 -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 +4 -4
- package/dist/exec/run/schedule-prepare.js +201 -59
- package/dist/exec/run/schedule-task.js +129 -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 +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- 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 +43 -9
- 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 +142 -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/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -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 +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +47 -16
- package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- 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 +70 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- 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 +27 -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 +92 -155
- 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-uc-recipe.md +36 -24
- 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 +79 -64
- 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-uc-rulebook.md +56 -35
- 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-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- 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-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- 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 +53 -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/package.json +2 -2
- package/templates/antigravity/orchestrator.md +3 -2
- 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/tmux.conf +6 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:sysd-cross-cutting-policy-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: ready
|
|
6
|
+
rulebook: specdojo:sysd-cross-cutting-policy-rulebook
|
|
7
|
+
sample: specdojo:sysd-cross-cutting-policy-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# システム設計 / 横断ルール 作成レシピ
|
|
11
|
+
|
|
12
|
+
System Design Cross-cutting Policy Writing Recipe
|
|
13
|
+
|
|
14
|
+
複数領域にまたがる失敗と回復を起点に、実装上の不変条件と検証可能な境界を抽出する。一般的な規約の列挙を、対象システムで判断に使える制約へ変えるための作成手順である。
|
|
15
|
+
|
|
16
|
+
## 1. このレシピの使い方
|
|
17
|
+
|
|
18
|
+
- 利用者と保守担当が困る失敗を上位の価値・制約へ結び付ける。背景を繰り返さず、重複処理、無期限待機、判断の属人化など、横断ルールで減らす負担を選ぶ。
|
|
19
|
+
- 概要から対象範囲を決め、ルール一覧、詳細、例外、関連導線、未決事項と公開条件の順に具体化する。実装の説明から始めた場合も、何を防ぐ制約なのかに戻る。
|
|
20
|
+
- 値・構文・データ構造は正本へ、担当・期限・進捗は計画や登録簿へ委ねる。制約と検証結果を Rule ID で結び、判断できない境界は公開責任者へ渡す。
|
|
21
|
+
|
|
22
|
+
## 2. 作成前に集める情報
|
|
23
|
+
|
|
24
|
+
| 入力 | 集める情報・問い |
|
|
25
|
+
| -------- | ---------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| 目的 | 誰が何を引き継げず、どの失敗で費用・作業負荷・価値が損なわれるか |
|
|
27
|
+
| 適用境界 | CLI、API、ジョブ、生成、外部プロセス、保存先のどこが共通制約を持つか |
|
|
28
|
+
| 正本 | 設定、schema、リファレンス、設計索引のどれが値と構造を決めるか。実在する検証コマンドと対象ケースへ進めるか |
|
|
29
|
+
| 途中状態 | 時間切れ・応答欠落・統合失敗の時点で、外部状態・ファイル・利用枠に何が残るか |
|
|
30
|
+
| 観測 | 誰がどの証跡から対象実行を特定し、停止と回復を判断するか。保持・閲覧・検知・通知の方針はどこにあるか |
|
|
31
|
+
| 責任 | 実装者、検証者、運用確認者、計画追跡者、人間の最終承認者は誰か |
|
|
32
|
+
| 不足 | 未定義の上限・優先順・通知先は何か。いつまでに誰が決めるか |
|
|
33
|
+
|
|
34
|
+
## 3. 全体の作成手順
|
|
35
|
+
|
|
36
|
+
1. **概要**: 上位価値に関係する対象者の困り事を選び、適用する実行と対象外・代替を定める。安全な保存と速度などが競合するとき、何を先に守るかを説明する。
|
|
37
|
+
2. **ルール一覧**: 同じ失敗を防ぐ制約をまとめ、ID と更新責務を付す。構成上の実行経路を横に並べ、エラー、冪等、時間・再試行、ログ・監査・追跡、秘密・権限、設定、モジュール境界の抜けを探す。確認待ちを先行する設定・契約の判断へ結び付ける。
|
|
38
|
+
3. **各ルール詳細**: 代表的な入力と途中失敗を追い、守る条件、防ぐ事故、適用境界、合否の観測、例外、正本を一組にする。検証する場所・コマンド・対象ケースを確かめ、実行結果と区別して記す。
|
|
39
|
+
4. **例外**: 過渡期の逸脱と未承認の不適合を区別する。期限・判断・復帰条件を決定記録へ接続し、不適合・リスク・変更を報告する人と追跡者を決める。
|
|
40
|
+
5. **関連導線**: 一つの規則変更から、実装・schema・生成物・互換性・移行・回帰対象までたどる。低レベル手順を本文に増やさず、担当と正本を接続する。
|
|
41
|
+
6. **未決事項と公開条件**: 確認できない事項を分離し、対象 ID・影響・判断者・期限・次アクションを揃える。実装適合の確認と人間による公開可否を分けて提示する。
|
|
42
|
+
|
|
43
|
+
## 4. 各章の書き方
|
|
44
|
+
|
|
45
|
+
### 4.1. 概要
|
|
46
|
+
|
|
47
|
+
- 共通規則がないと誰が同じ調査や回復を繰り返すか。
|
|
48
|
+
- HTTP API がないときの CLI エラー、DB がないときのファイル保存など、技術が非該当でも代わりの責務は残っていないか。代替も不要なら構成から説明できるか。
|
|
49
|
+
- 誰が実装と運用を確認し、誰が公開の説明責任を持つか。
|
|
50
|
+
|
|
51
|
+
良い例は「CLI と日次処理の失敗記録を共通化し、交代担当が再開対象を選べるようにする」。避けたい例は「API がないのでエラー・監視は対象外」で、代替の CLI の責務を消してしまう。
|
|
52
|
+
|
|
53
|
+
### 4.2. ルール一覧
|
|
54
|
+
|
|
55
|
+
- 禁止・必須と要約を組み合わせても意図は変わらないか。
|
|
56
|
+
- 一覧から詳細へ、詳細から確認担当・実装状況へたどれるか。
|
|
57
|
+
- 先に設定や契約を決めなければ確認できない規則はどれか。確認群を使うなら全 ID が対応し、変更着手前・起動前・公開前のどこで確認するか分かるか。
|
|
58
|
+
|
|
59
|
+
良い例は「未照合、設定確定後に失敗注入で確認」と記し、実作業へ接続すること。避けたい例は「規則を書いたので実装済み」で、進捗を誤認させる。
|
|
60
|
+
|
|
61
|
+
### 4.3. 各ルール詳細
|
|
62
|
+
|
|
63
|
+
- 同じ入力と前提なら次の動作は一つに決まるか。
|
|
64
|
+
- どの正本のキーと単位を使い、何を入力し、どの観測なら合格か。検証コマンドはその repository で実行でき、対象ケースへ到達するか。
|
|
65
|
+
- 条件を判定できない場合、どの受入を保留し、誰へ照合を依頼するか。
|
|
66
|
+
|
|
67
|
+
一つの途中失敗を次の問いで追う。答えは適用境界や検証の説明へ反映し、値・構文・構造の転記で埋めない。
|
|
68
|
+
|
|
69
|
+
| 観点 | 具体化する問い |
|
|
70
|
+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
71
|
+
| エラー | 入力不正、実行失敗、利用制限、競合、保護違反を何から識別するか。利用者は保持記録から訂正・回復・人間判断のどれを選べるか |
|
|
72
|
+
| 冪等 | 同じ論理処理と別 attempt をどう識別するか。応答欠落時に外部受付・保存・統合のどこを照合し、二重処理を見分けるか |
|
|
73
|
+
| 再試行 | 冪等性の前提、signal の分類、criticality を使う場合の区分はどこで確認するか。初回を含むかという回数の数え方、attempt・backoff 上限、fallback の候補条件、上限到達時の処置を一意に選べるか |
|
|
74
|
+
| 時間制御 | 経路別の設定キー・単位は何か。上限直前・到達時にどの子プロセスを終了し、部分出力・保存状態をどう確認して再開を判断するか |
|
|
75
|
+
| ログ・追跡 | 診断と監査で何を追うか。親子実行と attempt を結び、秘密を除去した後も失敗を特定できるか。保持・閲覧・検知・通知・一次対応の正本と担当へ進めるか |
|
|
76
|
+
| 設定 | 項目ごとにどの上書き階層が存在し、競合時の優先順・反映時点を何で確かめるか。不正値と指定なしで結果はどう変わるか |
|
|
77
|
+
| 境界・権限 | 各モジュールが変更できる状態と呼出し先は何か。権限を越える経路や、生成物から正本へ状態変更が逆流する経路をどう検出するか |
|
|
78
|
+
|
|
79
|
+
良い例は「上限到達では部分出力を保持して停止し、受付結果を照合してから再開する」。避けたい例は「criticality に従い再試行する」で、区分・signal・上限が不明のままになる。Rule は不変条件へ絞り、確認手段は Enforcement にまとめる。
|
|
80
|
+
|
|
81
|
+
### 4.4. 例外
|
|
82
|
+
|
|
83
|
+
- 一時許可なのか、既に発生した問題なのか、将来の懸念なのか。
|
|
84
|
+
- 例外の対象・期限が尽きたら誰が通常規則へ戻すか。
|
|
85
|
+
- 決定記録と課題・リスク・変更の追跡先を区別できるか。
|
|
86
|
+
|
|
87
|
+
良い例は「移行期間の対象 adapter のみ許可し、決定記録に期限と復帰の検証を付ける」。避けたい例は「緊急なら何でも許可」で、復帰できない。
|
|
88
|
+
|
|
89
|
+
### 4.5. 関連導線
|
|
90
|
+
|
|
91
|
+
- 読む人はその参照で何を判断するか。
|
|
92
|
+
- 参照先は現行・廃止・未作成のどれか。後継を一意に示せるか。
|
|
93
|
+
- 見出し・表・参照ラベルで同じ文書を同じ名称で呼び、略号から正式名へ戻れるか。
|
|
94
|
+
- schema 変更で古い記録・生成物・CLI 利用者に何が起きるか。
|
|
95
|
+
|
|
96
|
+
良い例は「DEV が schema と移行を更新し、旧形式の読込と再実行を検証する」。避けたい例は「関連文書一式を確認」で、更新と回帰の範囲が分からない。
|
|
97
|
+
|
|
98
|
+
### 4.6. 未決事項と公開条件
|
|
99
|
+
|
|
100
|
+
- 不明な事実、意思決定待ち、仮定のどれか。
|
|
101
|
+
- 誰がいつ判断し、解消しない間の受入・公開に何が制限されるか。
|
|
102
|
+
- 計画・登録簿の実 ID がない場合、誰が次の計画更新で接続するか。
|
|
103
|
+
|
|
104
|
+
良い例は「通知先は OPS が公開前に案を出し、PO が留保可否を判断。PM が未起票を接続する」。避けたい例は「OPD は後続で整備」で、判断と着手が浮いたままになる。
|
|
105
|
+
|
|
106
|
+
情報の照合待ちは `_TODO_:`、意思決定待ちは `_UNDECIDED_:`、仮説は `_ASSUMPTION_:` を使って書き分ける。各論点を対象 Rule ID と結び、未発行の作業 ID は発行済みの証拠に数えない。
|
|
107
|
+
|
|
108
|
+
## 5. 深掘り手順
|
|
109
|
+
|
|
110
|
+
1. 一つの途中失敗を選び、残る変更・外部受付・利用枠から目的への影響を追う。無関係な実装解説を削る。
|
|
111
|
+
2. 同じ失敗の再実行と並列の別実行を追い、識別、重複防止、時間上限、停止、観測の途切れを見つける。実装された手段だけがあり、支える制約や防ぐ失敗を説明できない箇所も拾う。
|
|
112
|
+
3. 途切れた箇所の正本を確認し、根拠不足なら確認者と判断期限を付ける。便宜的な固定値で穴を隠さず、影響を受ける検証と受入判断へつなぐ。
|
|
113
|
+
|
|
114
|
+
## 6. 良い例 / 悪い例
|
|
115
|
+
|
|
116
|
+
| 観点 | 良い例 | 悪い例 |
|
|
117
|
+
| ------ | ---------------------------------------------------------- | --------------------------------------- |
|
|
118
|
+
| 冪等 | 同じ論理処理と attempt を区別し、保存・受付を照合して再開 | 同じファイル名へ書くので安全とする |
|
|
119
|
+
| 検証 | 設定正本の上限直前・到達時を注入し、停止と保持状態で判定 | テスト名を列挙するだけ |
|
|
120
|
+
| 設定 | 同じ項目の競合指定を与え、正本の優先順と反映時点を確認する | 全項目で CLI が優先すると推測する |
|
|
121
|
+
| 観測 | 親子の識別子、保存先、秘匿化、確認者を結ぶ | ログがあるので運用可能とする |
|
|
122
|
+
| 未整備 | 対象 ID と影響・判断者・期限・計画接続を示す | 存在しない OPD やタスクを発行済みと書く |
|
|
123
|
+
|
|
124
|
+
## 7. レビュー観点
|
|
125
|
+
|
|
126
|
+
| 観点 | 確認する問い |
|
|
127
|
+
| ---------- | ------------------------------------------------------------------------------ |
|
|
128
|
+
| 目的と責務 | 各制約は対象者の負担・価値へつながり、個別実装や運用手順の詳細を抱えていないか |
|
|
129
|
+
| 実装と合否 | 正本・設定・入力・期待結果がつながり、未確認を実装済みとみなしていないか |
|
|
130
|
+
| 回復と判断 | 途中状態から安全に再開でき、判断不能なら人間へ情報を引き渡せるか |
|
|
131
|
+
| 変更 | 改訂・廃止時の参照元、生成、互換性、移行、回帰の担当が分かるか |
|
|
132
|
+
|
|
133
|
+
## 8. 仕上げチェック
|
|
134
|
+
|
|
135
|
+
- 本文の規定と実装確認の証拠を区別し、同じ状態に異なる動作を要求していない。
|
|
136
|
+
- 値・構文・構造の再掲を正本参照へ置き換え、Rule と検証説明の反復を整理している。
|
|
137
|
+
- 未決事項は判断者・期限・影響・次アクションを持ち、人間の承認・留保・差し戻しに必要な情報が残る。
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:sysd-index-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: ready
|
|
6
|
+
rulebook: specdojo:sysd-index-rulebook
|
|
7
|
+
sample: specdojo:sysd-index-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# システム設計索引 作成レシピ
|
|
11
|
+
|
|
12
|
+
System Design Index Writing Recipe
|
|
13
|
+
|
|
14
|
+
参照先を並べる前に、正本か派生物か、非該当か未確認かを切り分ける作成手順である。変更する人が最初の更新先と確認経路を選べる索引に仕上げる。
|
|
15
|
+
|
|
16
|
+
## 1. このレシピの使い方
|
|
17
|
+
|
|
18
|
+
- 担当交代時に正本探しや二重更新が起きる課題を引き継ぎ、対象範囲を先に定める。プロジェクトの背景全文は索引へ複製しない。
|
|
19
|
+
- 得たい成果は「設計領域から正本へ、変更目的から検証へたどれる状態」とする。所在、責任、追従先を同じ行で結び付ける。
|
|
20
|
+
- ファイルやコマンドの存在確認と、構成・公開の承認を分ける。値・構文・構造の詳細を作り込まず、未決事項を判断者へ渡す。
|
|
21
|
+
|
|
22
|
+
## 2. 作成前に集める情報
|
|
23
|
+
|
|
24
|
+
| 入力 | 集める情報・問い |
|
|
25
|
+
| ---------- | --------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| 利用目的 | 誰がどの設計情報を探すか。調査・引継ぎで困る領域はどこか |
|
|
27
|
+
| 対象境界 | 対象システムと外部委譲先はどこか。任意利用の構成は何か |
|
|
28
|
+
| 正本候補 | API・外部連携、保存・移行、モジュール境界、設定・実行構成、Job・定期処理、監視、ソース管理・CI の変更元はどこか |
|
|
29
|
+
| 生成経路 | 何を入力に、どのコマンドが、どこへ出力するか。業務記録や実行状態と区別できるか |
|
|
30
|
+
| 確認経路 | どの検査・対象ケースで、何が観測できれば合格か |
|
|
31
|
+
| 関連仕様 | 境界・品質条件・運用・テスト・判断の根拠はどの現行文書にあるか。未作成なら何で補うか |
|
|
32
|
+
| 責任と留保 | 更新者、確認者、承認者、根拠不足の領域と判断時機は何か |
|
|
33
|
+
|
|
34
|
+
## 3. 全体の作成手順
|
|
35
|
+
|
|
36
|
+
1. 「概要(対象範囲・更新責任)」に、対象・対象外と担当を短く置く。兼務しても確認と承認の責務を区別する。
|
|
37
|
+
2. 「SSOT 一覧(表形式)」の候補を、正本・派生物・業務記録・未確認に仕分ける。非該当は構成上の理由と代替正本、または代替不要の理由を確かめてから記入する。
|
|
38
|
+
3. 「自動生成物(生成コマンド/生成先/閲覧先)」で、設計の正本から再生成できる入力と出力を一対にする。script・サブコマンド、基準ディレクトリ、再生成する時機を照合する。
|
|
39
|
+
4. 「変更の入口(典型ケース)」で、集めた正本候補から代表的変更を選ぶ。最初の更新先から追従先、検証ケースまで一度たどり、非該当領域を導入する場合は構成判断も切り出す。
|
|
40
|
+
5. 「関連ドキュメント導線(C4 / NFR / OPD / DEC 等)」で参照目的を付け、現行・廃止・未作成を区別する。廃止文書は後継へ接続する。
|
|
41
|
+
6. 「未決事項・変更影響・公開前確認」へ未確認・承認待ちを集め、担当・判断時機・解消後の更新先を添える。
|
|
42
|
+
|
|
43
|
+
## 4. 各章の書き方
|
|
44
|
+
|
|
45
|
+
### 4.1. 概要
|
|
46
|
+
|
|
47
|
+
- どの利用者の調査・引継ぎを助けるか。
|
|
48
|
+
- 対象外と外部依存を混同していないか。
|
|
49
|
+
- 誰が更新し、QE は何を確認し、人間は何を承認するか。
|
|
50
|
+
|
|
51
|
+
範囲は機能・実行単位と、対象外になる境界から具体化する。良い例は「CLI と日次処理を対象に、DEV が更新、QE が失敗ケースを確認、PO が公開を承認する」。避けたい例は「全体を担当者が確認する」で、対象と責任の抜けを判断できない。
|
|
52
|
+
|
|
53
|
+
### 4.2. SSOT 一覧
|
|
54
|
+
|
|
55
|
+
- 値を変えるとき、最初に編集するのはどのファイルか。
|
|
56
|
+
- DB がない場合、保存形式と移行の契約はどこにあるか。
|
|
57
|
+
- 監視は出力先だけでなく、形式・検知・通知を決める設定まで特定できるか。
|
|
58
|
+
- モジュールの依存方向や統合条件を変える場合、境界の定義、ブランチ規約、CI・フック・検査 script のどれを更新するか。
|
|
59
|
+
|
|
60
|
+
「なし」を使う前に、未確認か構成上の非該当かを問う。良い例は「RDBMS は非該当。保存レコード schema と移行処理を DEV が更新し、旧形式の読込を確認する」。避けたい例は「DB はなし」で、保存契約が索引から消える。代替も不要なら理由を確かめ、判断できなければ担当付きの _TODO_: とする。
|
|
61
|
+
|
|
62
|
+
### 4.3. 自動生成物
|
|
63
|
+
|
|
64
|
+
- 入力、コマンド、出力が実際につながっているか。
|
|
65
|
+
- 生成後にどこを見れば更新を確認できるか。
|
|
66
|
+
- 手編集が次の生成で失われるファイルを正本にしていないか。
|
|
67
|
+
- 設計定義から再生成できる派生物か、取引・実行結果を保持する記録か。
|
|
68
|
+
|
|
69
|
+
出力名からコマンドを推測せず、既存の script と出力先を照合する。良い例は「契約変更時に API 定義から型を生成し、IDE と型検査で更新を確認する」。避けたい例は「ビルドで全ファイルを更新する」で、生成経路や業務記録との境界を確認できない。生成しない構成なら、その理由を短くまとめる。
|
|
70
|
+
|
|
71
|
+
### 4.4. 変更の入口
|
|
72
|
+
|
|
73
|
+
- 変更が起きたら最初に何を変えるか。
|
|
74
|
+
- 再生成・テスト・運用手順のどれに波及するか。
|
|
75
|
+
- 正常、失敗、再実行のどのケースを確認すれば今回の変更を判定できるか。
|
|
76
|
+
- 検査を行う場所とコマンド・対象ケースは実在するか。今後の確認手順と実行済みの証跡を区別できるか。
|
|
77
|
+
|
|
78
|
+
観測結果から必要なケースを選ぶ。良い例は「二つの実行で異なる保存先を使うことを、分離テストの対象ケースで確認する」。避けたい例は「代表実行が成功したので分離も確認済み」で、確認していない性質を成功の意味に含めている。
|
|
79
|
+
|
|
80
|
+
### 4.5. 関連ドキュメント導線
|
|
81
|
+
|
|
82
|
+
- 読み手はこの参照で何を判断するか。
|
|
83
|
+
- 同名・後継・廃止文書のどれを指しているか。
|
|
84
|
+
- 未作成なら当面どこを参照し、誰が導線を直すか。
|
|
85
|
+
|
|
86
|
+
分類は読み手の参照目的から選び、略語は初出時の説明と揃える。良い例は「運用方針・手順: 障害対応の判断に使う。索引は未作成のため、当面は現行の個別手順を参照し、OPS が整備後に接続する」。避けたい例は「関連: 運用一式、旧フロー」で、読む目的と現行性が分からない。
|
|
87
|
+
|
|
88
|
+
### 4.6. 未決事項・公開前確認
|
|
89
|
+
|
|
90
|
+
- 不明な事実、意思決定待ち、仮定のどれか。
|
|
91
|
+
- 何に影響し、いつまでに誰が判断するか。
|
|
92
|
+
- 解消後にどの行・設定・手順へ反映するか。
|
|
93
|
+
|
|
94
|
+
実装の検証結果と、非該当範囲・未整備の監視を留保して公開できるかの判断を分ける。良い例は「通知先は未決。OPS が検知要件を確認し、公開前に人間の PO が留保可否を判断、決定後に設定と手順を更新する」。避けたい例は「動いたので公開する」で、判断者と解消条件が抜けている。
|
|
95
|
+
|
|
96
|
+
## 5. 深掘り手順
|
|
97
|
+
|
|
98
|
+
1. 一つの変更を選び、目的から正本、生成物、検証へ進む。到達しない箇所を情報不足として切り出す。
|
|
99
|
+
2. 非該当行を選び、代替の保存・連携・観測手段が索引から消えていないか確かめる。
|
|
100
|
+
3. 不在の参照や実行できないコマンドがあれば、推測で埋めず影響と担当を留保欄へ戻す。
|
|
101
|
+
|
|
102
|
+
## 6. 良い例 / 悪い例
|
|
103
|
+
|
|
104
|
+
| 観点 | 良い例 | 悪い例 |
|
|
105
|
+
| ---------- | -------------------------------------------------------------------- | ------------------------------------- |
|
|
106
|
+
| パスの解釈 | 複数リポジトリの生成入力・出力に、それぞれの基準ディレクトリを添える | 同名の `src/` を基準なしで並べる |
|
|
107
|
+
| 検証の範囲 | CI の検査成功と実機受入の未実施を分け、公開判断へ引き継ぐ | CI が成功したので運用も確認済みとする |
|
|
108
|
+
| 改訂・廃止 | 旧正本の参照元を洗い出し、生成・検証・運用導線の更新を各担当へ渡す | 旧正本の行だけを削除して完了する |
|
|
109
|
+
|
|
110
|
+
## 7. レビュー観点
|
|
111
|
+
|
|
112
|
+
| 観点 | 確認する問い |
|
|
113
|
+
| ---------- | ----------------------------------------------------------- |
|
|
114
|
+
| 所在 | 初めて読む DEV が正本を選べるか。派生物を選んでしまわないか |
|
|
115
|
+
| 検証入力 | QE がコマンド・対象ケース・期待結果を一組で特定できるか |
|
|
116
|
+
| 運用・承認 | OPS が設定と手順へ、PO が留保事項と承認条件へ到達できるか |
|
|
117
|
+
|
|
118
|
+
## 8. 仕上げチェック
|
|
119
|
+
|
|
120
|
+
- 主な設計領域は所在または非該当理由と代替の要否に結び付き、未確認を確定情報にしていない。
|
|
121
|
+
- 変更トリガーから更新先・追従先・期待結果をたどれ、詳細定義は正本に委ねている。
|
|
122
|
+
- 現行文書のリンクと未作成のコード表記が区別され、判断待ちに担当と次アクションがある。
|