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
|
@@ -3,62 +3,140 @@ specdojo:
|
|
|
3
3
|
id: specdojo:ifx-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: api
|
|
6
|
-
status:
|
|
6
|
+
status: ready
|
|
7
7
|
target_format: yaml
|
|
8
|
-
recipe:
|
|
8
|
+
recipe: specdojo:ifx-index-recipe
|
|
9
9
|
sample: specdojo:ifx-index-sample
|
|
10
|
-
template:
|
|
10
|
+
template: specdojo:ifx-index-template
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
# 外部システム
|
|
13
|
+
# 外部システムI/F一覧 作成ルール
|
|
14
14
|
|
|
15
|
-
External System Interface List
|
|
15
|
+
External System Interface List Documentation Rules
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
外部システムI/F一覧は、システム境界を越える連携の目的、相手、方式、発生条件を YAML で整理する入口である。詳細な接続・認証・障害回復の設計と、外部結合テストの対象を特定できる粒度を定める。
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
- 一覧の対象範囲を冒頭コメントに示し、その範囲の連携を一つの正本で管理する。外部サービスだけでなく、境界を越えて起動する CLI や受け渡すファイルも候補にする。
|
|
22
|
+
- 連携目的と成功後に得る結果を `name` とコメントで示す。目的、相手、タイミング、失敗の影響が異なる契約は別要素にする。
|
|
23
|
+
- 一覧には連携境界と異常時の判断を残す。引数、データ項目、接続先、認証値、終了コード表、再試行の数値は詳細仕様・設定・リファレンスへ委譲する。
|
|
24
|
+
- 未決の方式や仮置きの範囲を合意済みとして記さない。未決事項・合意・計画への引き継ぎはコメントで扱い、schema にない管理用キーを追加しない。
|
|
22
25
|
|
|
23
|
-
|
|
26
|
+
## 2. 位置づけと用語定義
|
|
24
27
|
|
|
25
|
-
|
|
28
|
+
| 文書・用語 | 本系統での役割・意味 |
|
|
29
|
+
| ------------------- | ---------------------------------------------------------------------------------- |
|
|
30
|
+
| 外部システムI/F一覧 | 連携スコープと詳細契約への入口。内部の関数・全依存パッケージの一覧にはしない |
|
|
31
|
+
| 連携境界 | 対象システムと、別システム・外部プロセス・外部管理データの間の受け渡し |
|
|
32
|
+
| 詳細 I/F 仕様 | プロトコル、認証、入出力、失敗・回復条件を定義する契約。`spec_ref` で対応づける |
|
|
33
|
+
| 結合テスト | 一覧の連携名と詳細仕様から正常・失敗時の対象を選ぶ。テスト手順は本一覧へ展開しない |
|
|
26
34
|
|
|
27
|
-
|
|
28
|
-
- ESIL は `docs/**/ifx-*.yaml` のような YAML ファイルとして作成し、スキーマに従って記述します。
|
|
35
|
+
要求や業務判断の理由は上位の正本に置く。一覧で必要な影響だけを要約し、技術方式の選択を業務承認の代わりにしない。
|
|
29
36
|
|
|
30
|
-
##
|
|
37
|
+
## 3. ファイル命名・ID規則
|
|
31
38
|
|
|
32
|
-
-
|
|
33
|
-
- `id
|
|
34
|
-
-
|
|
39
|
+
- 全体一覧は `ifx-index.yaml` とし、外部 I/F 仕様の文書群へ配置する。分割時は領域を表す接尾辞を付け、同じ対象範囲の一覧を複製しない。
|
|
40
|
+
- `id` は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う修飾 ID とし、ローカル ID は `ifx-index` を基準に対象範囲内で一意にする。許容形式の正本は `docs/specdojo/schemas/v1/ifx-index.schema.yaml` とし、独自の正規表現で制限しない。成果物の `prj-0001:ifx-index` と完成例の `specdojo:ifx-index-sample` は、所有元と用途を区別する ID である。
|
|
41
|
+
- 連携名は一覧内で一意にし、改称・分割時は旧名との対応をコメントへ残す。位置番号を連携の識別子として使用しない。
|
|
42
|
+
- 追加・廃止・方式変更時は ARC が影響する連携と詳細仕様を特定し、DEV へ実装範囲、QE へ結合テスト対象、スコープ変更なら PO へ判断事項を引き継ぐ。文書の置き換えは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。
|
|
35
43
|
|
|
36
|
-
##
|
|
44
|
+
## 4. 先頭メタ項目
|
|
37
45
|
|
|
38
|
-
|
|
39
|
-
| ---------- | ----------------------------- | ---- |
|
|
40
|
-
| id | ESIL ID(`ifx-...`) | ○ |
|
|
41
|
-
| type | `api` 固定 | ○ |
|
|
42
|
-
| title | 外部システムIF一覧名 | ○ |
|
|
43
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
44
|
-
| rulebook | `specdojo:ifx-index-rulebook` | ○ |
|
|
45
|
-
| interfaces | 外部連携の配列(1件以上) | ○ |
|
|
46
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
46
|
+
YAML のトップレベルへメタ情報を置く。必須キー、値域、型、参照形式は `docs/specdojo/schemas/v1/ifx-index.schema.yaml` を正本とし、ファイル先頭の modeline で参照する。
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
- `id`・`title` は一覧と対象システムを識別できる内容にし、`type` は本系統の成果物種別、`rulebook` は本書の ID とする。
|
|
49
|
+
- `status` は文書の成熟度(`draft`・`ready`・`deprecated`)を表し、個々の連携の採否・進捗や公開許可を代用しない。人間の PO が一覧の承認・保留・差し戻し、`ready` への昇格と公開可否の最終判断を担う。agent は `draft` のまま引き継ぐ。
|
|
50
|
+
- `based_on` は実際の依存関係に含まれる直接の根拠だけを記す。プロジェクト共通文脈や詳細仕様を機械的に転記しない。
|
|
49
51
|
|
|
50
|
-
##
|
|
52
|
+
## 5. 本文要件
|
|
51
53
|
|
|
52
|
-
|
|
54
|
+
キーの骨組みは宣言された雛形に置く。本章は各記入領域の目的と判断条件を定め、キーの型・構文は schema へ委譲する。列挙値は選び方に関わるものだけを本章で示す。
|
|
53
55
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
|
|
|
63
|
-
|
|
64
|
-
|
|
56
|
+
| 記入領域 | 必須性 | 目的・記述要件 |
|
|
57
|
+
| ------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
58
|
+
| 冒頭コメント | 必須 | 対象範囲・境界・主要な対象外、一覧の管理担当 Role code、承認・公開判断者と公開対象を示す。仮定や未決のスコープはラベルで区別する |
|
|
59
|
+
| `interfaces` の目的と両端 | 必須 | `name`・`source`・`target` で連携目的と両端を特定する。抽象名だけなら目的をコメントで補う |
|
|
60
|
+
| 方向と方式 | 必須 | `direction`・`kind`・`format` で境界上の受け渡しを示す。サービス内部の方式と呼び出し側の方式を混同しない |
|
|
61
|
+
| 発生条件 | 必須 | `timing` で業務イベント・操作・周期と、起動する条件を示す。周期が不明なら仮の時刻を固定しない |
|
|
62
|
+
| 異常時の判断 | 必須 | `error_handling` に未完了・結果不明になる結果、停止・保留の条件、確認対象と担当を示す。副作用の確認前に再送できると断定しない |
|
|
63
|
+
| 詳細への導線 | 必須 | `spec_ref` に実在する対応仕様 ID を置く。未整備・対応未確認なら `TBD` とし、「詳細参照と未決事項」の情報をコメントに残す |
|
|
64
|
+
| 合意・管理への導線 | 必須 | IF ごとの確認者・合意対象をコメントで対応づける。未決事項・リスク・課題・変更要求がある場合は、影響する後続作業と計画・管理記録への引き継ぎ先を示す |
|
|
65
|
+
|
|
66
|
+
`direction` は指定した `source` と `target` に対して読み、`source` から送るなら `source_to_target`、`target` から受けるなら `target_to_source` とする。要求と応答の両方を一契約として扱う場合は `bidirectional` とし、送信データと受付結果の意味をコメントで区別する。`kind` は境界で受け渡す手段を `API`・`ファイル`・`メッセージ`・`コマンド` から選ぶ。`format` は `CSV`・`JSON`・`XML` から選び、どれにも当たらなければ `その他`、未決なら `TBD` としてコメントで内訳や論点を補う。schema で任意の項目でも、本一覧から下流へ判断を渡すために本章が要求する項目は記入する。
|
|
67
|
+
|
|
68
|
+
## 6. 記述ガイド
|
|
69
|
+
|
|
70
|
+
### 6.1. メタ情報と対象範囲
|
|
71
|
+
|
|
72
|
+
- 判断基準: どのシステム・利用場面の境界を管理するか、対象外と仮定を含めて識別でき、管理担当と公開判断者をたどれること。
|
|
73
|
+
- 良い例: 「店舗端末から本部への商品照会・売上登録を対象とする。仕入先連携は対象外。管理は ARC、一覧の承認と社外公開判断は人間の PO」と冒頭に記す。
|
|
74
|
+
- 悪い例: タイトルを「外部連携」とだけ書いて将来候補を現在の対象へ混ぜる、または `status` だけで公開可能と扱う。
|
|
75
|
+
|
|
76
|
+
### 6.2. 連携単位・目的・両端
|
|
77
|
+
|
|
78
|
+
- 判断基準: 同じ詳細契約と完了条件で追える単位に分け、相手を一意に識別できること。同じ相手でも参照と更新の失敗影響が異なれば分ける。
|
|
79
|
+
- 良い例: 「商品照会」と「売上登録」を別要素にし、それぞれ取得結果と受付結果を示す。
|
|
80
|
+
- 悪い例: 「本部連携」に照会・登録・夜間転送をまとめ、どの操作が失敗したか追えない。
|
|
81
|
+
|
|
82
|
+
### 6.3. 方向・方式・形式
|
|
83
|
+
|
|
84
|
+
- 判断基準: この境界で渡す形式を選ぶ。外部 CLI の背後に API があっても、呼び出し側がプロセスを起動する契約ならコマンドとして扱う。
|
|
85
|
+
- 良い例: CLI へ印字を依頼し結果を受け取る契約を双方向・コマンドとし、テキストと結果報告が混在するなら形式の内訳をコメントで補う。
|
|
86
|
+
- 悪い例: SaaS を使うという理由だけで API に分類する、または stdout の一部が JSON だから全ストリームを JSON と断定する。
|
|
87
|
+
|
|
88
|
+
### 6.4. 発生条件
|
|
89
|
+
|
|
90
|
+
- 判断基準: 誰の操作・どのイベントで、何が整ったら連携するかを読み取れること。
|
|
91
|
+
- 良い例: 「会計確定と控え保存の後、レシート印字を要求した時」とする。
|
|
92
|
+
- 悪い例: 「随時」「必要時」だけで終え、実行条件を実装者へ任せる。
|
|
93
|
+
|
|
94
|
+
### 6.5. 異常時の判断
|
|
95
|
+
|
|
96
|
+
- 判断基準: 失敗で何が未完了・結果不明になるか、誰が確認して次へ進むかが分かること。
|
|
97
|
+
- 良い例: 「印字結果不明なら会計は維持し、控えを保持して店番担当が紙面確認する」とする。
|
|
98
|
+
- 悪い例: 「失敗したらリトライ」とだけ書き、二重登録・二重印字の可能性を扱わない。
|
|
99
|
+
|
|
100
|
+
### 6.6. 詳細参照と未決事項
|
|
101
|
+
|
|
102
|
+
- 判断基準: 実在する契約へ到達できること。`TBD` や未決の方式には、論点、担当 Role code、解消条件、期限または判断するマイルストーン、影響する業務・後続作業・公開範囲、次アクションをコメントで残す。作成・確認待ちは `_TODO_:`、意思決定待ちは `_UNDECIDED_:`、仮定は `_ASSUMPTION_:` で区別する。
|
|
103
|
+
- 良い例: `spec_ref: TBD` に「`_UNDECIDED_:` ARC が DEV と売上受付の照合方式を決め、詳細仕様を作成する。外部結合テスト着手前に QE が結果不明時の期待結果を確認するまで、売上登録の受入を保留し PO へ判断を依頼する」と添える。
|
|
104
|
+
- 悪い例: 説明なしの `TBD`、担当・判断時期のない「後で決める」、未作成の文書 ID を完成した契約として扱う参照。期限を推測で固定したり、影響する連携を区別せず一覧全体を完了扱いにしたりしない。
|
|
105
|
+
|
|
106
|
+
共通条件は一覧冒頭、契約固有条件は詳細仕様を正本とする。詳細仕様が存在しても未決事項があれば `spec_ref` だけで解決済みとせず、判断に必要な影響と追跡先を一覧に残す。
|
|
107
|
+
|
|
108
|
+
### 6.7. 合意・計画・課題への引き継ぎ
|
|
109
|
+
|
|
110
|
+
IF ごとのコメントは次の情報を対応づける。既存の計画・管理記録にある情報は参照先から解決できればよく、値を転載しない。複数 IF で共通なら、対象の連携名を明示して冒頭または末尾にまとめてよい。
|
|
111
|
+
|
|
112
|
+
| 対象 | コメントに残す判断情報 | 正本・引き継ぎ先 |
|
|
113
|
+
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
114
|
+
| 確認と合意 | 利用場面・業務影響を確認する BA、契約を確認する ARC・DEV、期待結果を確認する QE と合意対象。外部側との調整が必要なら確認窓口も示す | 役割の割当は組織・メンバー定義を参照する。必要な窓口が未特定なら担当 Role と特定する時点を未決事項として残す |
|
|
115
|
+
| 詳細仕様の作成と進捗 | 担当 Role code、未着手・作成中・確認待ちなどの現在の論点、完了条件、期限または判断するマイルストーン、依存する後続作業 | PM が Schedule の作業へ接続する。担当・期日・進捗の正本は計画に置き、一覧には作業 ID と引き継ぎ時点の未完了事項を残す |
|
|
116
|
+
| リスク・課題・変更・決定 | 対象の連携名、発生条件または未決論点、業務・公開・後続仕様・Schedule への影響、対応担当 Role code、報告先、次アクション | PM が PJR または採用済み管理簿へ接続し、PO の判断を決定記録へ残す。一覧には転送先レコードと連携への影響を残す |
|
|
117
|
+
|
|
118
|
+
- 判断基準: 連携名から確認者、未完了作業、管理記録を追跡できること。未登録なら PM への登録依頼と登録時点を記し、登録後は実在するレコードへ参照を付け替える。採否・公開条件が未決なら、PO に渡す判断対象と保留する範囲を明示する。
|
|
119
|
+
- 良い例: 「売上登録は ARC が契約を作成中。BA と本部運用窓口が保留時の運用、QE が結果照合を確認する。PM は外部結合テスト計画確定前に認証未合意を PJR へ登録し、テスト着手への影響と PO の採否判断を追跡する」と記す。
|
|
120
|
+
- 悪い例: 「関係者確認済み」「進捗は順調」だけで合意対象や残作業を隠す、または一覧に管理簿の全履歴・期日・進捗表を複製する。
|
|
121
|
+
|
|
122
|
+
### 6.8. 検証と引き渡しの判定
|
|
123
|
+
|
|
124
|
+
- 対象と方法: repository のルートで、`<対象YAMLファイルのrepository相対パス>` を実際の一覧に置き換える。schema 検証は `validate:schema:file` script がある場合、整形検査は Prettier が導入されている場合に次を実行する。別環境では同じ schema による検証と採用済み整形手順を用いる。
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
npm run validate:schema:file -- --schema docs/specdojo/schemas/v1/ifx-index.schema.yaml --data '<対象YAMLファイルのrepository相対パス>'
|
|
128
|
+
npx prettier --check '<対象YAMLファイルのrepository相対パス>'
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
- 合格条件: 両コマンドが終了コード 0 となり、schema 違反と整形差分がないこと。エラーは対象箇所を修正して再実行し、検証対象・コマンド・結果を実行記録に残す。
|
|
132
|
+
- 内容の判定: schema だけではコメントの充足や参照先の実在を判定できない。各連携について「本文要件」の必須領域、連携名の一意性、方向と両端の一致、詳細仕様との対応、未決事項と管理記録への導線を照合する。不足は未解消として担当と次アクションを引き継ぎ、検証成功を承認・公開判断の代わりにしない。
|
|
133
|
+
|
|
134
|
+
## 7. 禁止事項
|
|
135
|
+
|
|
136
|
+
- 根拠のない接続方式、認証方式、承認済みの範囲を確定情報として記すこと。
|
|
137
|
+
- 連携の目的・失敗影響が異なる操作を、相手が同じという理由だけでまとめること。
|
|
138
|
+
- 認証情報、個人環境の認証パス、秘密値入り URL を記載すること。
|
|
139
|
+
- 引数、ペイロード構造、設定値、再試行回数、終了コード一覧を正本から転載すること。
|
|
140
|
+
- 未作成文書へのリンク、確認していない詳細仕様 ID、説明のない `TBD` を残すこと。
|
|
141
|
+
- `status` や技術レビューの成功だけで、人間の PO の承認・公開判断を済んだものとすること。
|
|
142
|
+
- schema にない担当・期限・進捗・リスクのキーを追加したり、Schedule・管理簿・決定記録を一覧へ複製したりすること。
|
|
@@ -35,24 +35,24 @@ Impact Analysis (Business) Rulebook
|
|
|
35
35
|
|
|
36
36
|
## 3. ファイル命名・ID規則
|
|
37
37
|
|
|
38
|
-
- 対象ドキュメント ID は
|
|
38
|
+
- 対象ドキュメント ID は `<project-id>:imp-business` とする(例: `prj-0001:imp-business`)。
|
|
39
39
|
- 対象ドキュメントの推奨ファイル名は `imp-business.md` とする。
|
|
40
40
|
- `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
|
|
41
|
-
- 関連する追補文書を分割する場合は
|
|
41
|
+
- 関連する追補文書を分割する場合は `<project-id>:imp-business-<term>` 形式を用いる。
|
|
42
42
|
|
|
43
43
|
## 4. 推奨 Frontmatter 項目
|
|
44
44
|
|
|
45
45
|
影響調査(業務)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
|
|
46
46
|
|
|
47
|
-
| 項目 | 説明
|
|
48
|
-
| ---------- |
|
|
49
|
-
| id | ドキュメント ID(例:
|
|
50
|
-
| type | `project`
|
|
51
|
-
| status | `draft` / `ready` / `deprecated`
|
|
52
|
-
| rulebook | `specdojo:imp-business-rulebook` 固定
|
|
53
|
-
| part_of | 一覧/親ドキュメントへの所属 ID 配列
|
|
54
|
-
| based_on | 変更要求や根拠資料の ID 配列
|
|
55
|
-
| supersedes | 置き換え対象ドキュメント ID 配列
|
|
47
|
+
| 項目 | 説明 | 必須 |
|
|
48
|
+
| ---------- | -------------------------------------------------- | ---- |
|
|
49
|
+
| id | ドキュメント ID(例: `<project-id>:imp-business`) | ○ |
|
|
50
|
+
| type | `project` | ○ |
|
|
51
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
52
|
+
| rulebook | `specdojo:imp-business-rulebook` 固定 | ○ |
|
|
53
|
+
| part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
|
|
54
|
+
| based_on | 変更要求や根拠資料の ID 配列 | 任意 |
|
|
55
|
+
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
56
56
|
|
|
57
57
|
## 5. 本文構成(標準テンプレ)
|
|
58
58
|
|
|
@@ -36,22 +36,22 @@ Impact Analysis (Data) Rulebook
|
|
|
36
36
|
|
|
37
37
|
## 3. ファイル命名・ID規則
|
|
38
38
|
|
|
39
|
-
- 対象ドキュメント ID は
|
|
39
|
+
- 対象ドキュメント ID は `<project-id>:imp-data` とする(例: `prj-0001:imp-data`)。
|
|
40
40
|
- 対象ドキュメントの推奨ファイル名は `imp-data.md` とする。
|
|
41
41
|
- `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
|
|
42
|
-
- 関連する追補文書を分割する場合は
|
|
42
|
+
- 関連する追補文書を分割する場合は `<project-id>:imp-data-<term>` 形式を用いる。
|
|
43
43
|
|
|
44
44
|
## 4. 推奨 Frontmatter 項目
|
|
45
45
|
|
|
46
46
|
影響調査(データ)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
|
|
47
47
|
|
|
48
|
-
| 項目 | 説明
|
|
49
|
-
| -------- |
|
|
50
|
-
| id | ドキュメント ID(例:
|
|
51
|
-
| type | `project`
|
|
52
|
-
| status | `draft` / `ready` / `deprecated`
|
|
53
|
-
| rulebook | `specdojo:imp-data-rulebook` 固定
|
|
54
|
-
| part_of | 一覧/親ドキュメントへの所属 ID 配列
|
|
48
|
+
| 項目 | 説明 | 必須 |
|
|
49
|
+
| -------- | ---------------------------------------------- | ---- |
|
|
50
|
+
| id | ドキュメント ID(例: `<project-id>:imp-data`) | ○ |
|
|
51
|
+
| type | `project` | ○ |
|
|
52
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
53
|
+
| rulebook | `specdojo:imp-data-rulebook` 固定 | ○ |
|
|
54
|
+
| part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
|
|
55
55
|
|
|
56
56
|
| based_on | 変更要求や根拠資料の ID 配列 | 任意 |
|
|
57
57
|
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
@@ -35,10 +35,10 @@ Impact Analysis (Interface) Rulebook
|
|
|
35
35
|
|
|
36
36
|
## 3. ファイル命名・ID規則
|
|
37
37
|
|
|
38
|
-
- 対象ドキュメント ID は
|
|
38
|
+
- 対象ドキュメント ID は `<project-id>:imp-interface` とする(例: `prj-0001:imp-interface`)。
|
|
39
39
|
- 対象ドキュメントの推奨ファイル名は `imp-interface.md` とする。
|
|
40
40
|
- `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
|
|
41
|
-
- 関連する追補文書を分割する場合は
|
|
41
|
+
- 関連する追補文書を分割する場合は `<project-id>:imp-interface-<term>` 形式を用いる。
|
|
42
42
|
|
|
43
43
|
## 4. 推奨 Frontmatter 項目
|
|
44
44
|
|
|
@@ -46,8 +46,8 @@ Impact Analysis (Interface) Rulebook
|
|
|
46
46
|
|
|
47
47
|
| 項目 | 説明 | 必須 |
|
|
48
48
|
|
|
49
|
-
| ---------- |
|
|
50
|
-
| id | ドキュメント ID(例:
|
|
49
|
+
| ---------- | ---------------------------------------------------- | ---- |
|
|
50
|
+
| id | ドキュメント ID(例: `<project-id>:imp-interface`) | ○ |
|
|
51
51
|
| type | `project` | ○ |
|
|
52
52
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
53
53
|
| rulebook | `specdojo:imp-interface-rulebook` 固定 | ○ |
|
|
@@ -36,24 +36,24 @@ Impact Analysis (Operations) Rulebook
|
|
|
36
36
|
|
|
37
37
|
## 3. ファイル命名・ID規則
|
|
38
38
|
|
|
39
|
-
- 対象ドキュメント ID は
|
|
39
|
+
- 対象ドキュメント ID は `<project-id>:imp-operations` とする(例: `prj-0001:imp-operations`)。
|
|
40
40
|
- 対象ドキュメントの推奨ファイル名は `imp-operations.md` とする。
|
|
41
41
|
- `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
|
|
42
|
-
- 関連する追補文書を分割する場合は
|
|
42
|
+
- 関連する追補文書を分割する場合は `<project-id>:imp-operations-<term>` 形式を用いる。
|
|
43
43
|
|
|
44
44
|
## 4. 推奨 Frontmatter 項目
|
|
45
45
|
|
|
46
46
|
影響調査(運用)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
|
|
47
47
|
|
|
48
|
-
| 項目 | 説明
|
|
49
|
-
| ---------- |
|
|
50
|
-
| id | ドキュメント ID(例:
|
|
51
|
-
| type | `project`
|
|
52
|
-
| status | `draft` / `ready` / `deprecated`
|
|
53
|
-
| rulebook | `specdojo:imp-operations-rulebook` 固定
|
|
54
|
-
| part_of | 一覧/親ドキュメントへの所属 ID 配列
|
|
55
|
-
| based_on | 変更要求や根拠資料の ID 配列
|
|
56
|
-
| supersedes | 置き換え対象ドキュメント ID 配列
|
|
48
|
+
| 項目 | 説明 | 必須 |
|
|
49
|
+
| ---------- | ---------------------------------------------------- | ---- |
|
|
50
|
+
| id | ドキュメント ID(例: `<project-id>:imp-operations`) | ○ |
|
|
51
|
+
| type | `project` | ○ |
|
|
52
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
53
|
+
| rulebook | `specdojo:imp-operations-rulebook` 固定 | ○ |
|
|
54
|
+
| part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
|
|
55
|
+
| based_on | 変更要求や根拠資料の ID 配列 | 任意 |
|
|
56
|
+
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
57
57
|
|
|
58
58
|
## 5. 本文構成(標準テンプレ)
|
|
59
59
|
|
|
@@ -35,24 +35,24 @@ Impact Analysis (Test) Rulebook
|
|
|
35
35
|
|
|
36
36
|
## 3. ファイル命名・ID規則
|
|
37
37
|
|
|
38
|
-
- 対象ドキュメント ID は
|
|
38
|
+
- 対象ドキュメント ID は `<project-id>:imp-test` とする(例: `prj-0001:imp-test`)。
|
|
39
39
|
- 対象ドキュメントの推奨ファイル名は `imp-test.md` とする。
|
|
40
40
|
- `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
|
|
41
|
-
- 関連する追補文書を分割する場合は
|
|
41
|
+
- 関連する追補文書を分割する場合は `<project-id>:imp-test-<term>` 形式を用いる。
|
|
42
42
|
|
|
43
43
|
## 4. 推奨 Frontmatter 項目
|
|
44
44
|
|
|
45
45
|
影響調査(テスト)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
|
|
46
46
|
|
|
47
|
-
| 項目 | 説明
|
|
48
|
-
| ---------- |
|
|
49
|
-
| id | ドキュメント ID(例:
|
|
50
|
-
| type | `project`
|
|
51
|
-
| status | `draft` / `ready` / `deprecated`
|
|
52
|
-
| rulebook | `specdojo:imp-test-rulebook` 固定
|
|
53
|
-
| part_of | 一覧/親ドキュメントへの所属 ID 配列
|
|
54
|
-
| based_on | 変更要求や根拠資料の ID 配列
|
|
55
|
-
| supersedes | 置き換え対象ドキュメント ID 配列
|
|
47
|
+
| 項目 | 説明 | 必須 |
|
|
48
|
+
| ---------- | ---------------------------------------------- | ---- |
|
|
49
|
+
| id | ドキュメント ID(例: `<project-id>:imp-test`) | ○ |
|
|
50
|
+
| type | `project` | ○ |
|
|
51
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
52
|
+
| rulebook | `specdojo:imp-test-rulebook` 固定 | ○ |
|
|
53
|
+
| part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
|
|
54
|
+
| based_on | 変更要求や根拠資料の ID 配列 | 任意 |
|
|
55
|
+
| supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
|
|
56
56
|
|
|
57
57
|
## 5. 本文構成(標準テンプレ)
|
|
58
58
|
|
|
@@ -30,12 +30,13 @@ Meeting Minutes Documentation Rulebook
|
|
|
30
30
|
|
|
31
31
|
- 推奨: `mm-<yyyy-mm-dd>-<nn>.md`
|
|
32
32
|
- 日付はISO形式、連番は2桁ゼロ埋めを推奨する。
|
|
33
|
+
- 文書 ID は `<project-id>:mm-<yyyy-mm-dd>-<nn>` 形式とする(例: `prj-0001:mm-2026-03-01-01`)。
|
|
33
34
|
|
|
34
35
|
## 4. 推奨 Frontmatter 項目
|
|
35
36
|
|
|
36
|
-
| 項目 | 説明
|
|
37
|
-
| ---- |
|
|
38
|
-
| id |
|
|
37
|
+
| 項目 | 説明 | 必須 |
|
|
38
|
+
| ---- | ----------------------------------- | ---- |
|
|
39
|
+
| id | `<project-id>:mm-<yyyy-mm-dd>-<nn>` | ○ |
|
|
39
40
|
|
|
40
41
|
| type | `project` | ○ |
|
|
41
42
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
@@ -56,33 +56,37 @@ Project Register Documentation Rules
|
|
|
56
56
|
|
|
57
57
|
個票には `register-item-frontmatter.schema.yaml` が定義する次の項目を置く。未定の担当、期限、完了日時、結論は表用のプレースホルダを保存せず、該当キーを省略する(期限なしだけは `due_on: null`)。
|
|
58
58
|
|
|
59
|
-
| 項目 | 説明
|
|
60
|
-
| ----------------- |
|
|
61
|
-
| `id` | `<project-id>:pjr-XXXX-<topic>`
|
|
62
|
-
| `type` | `project`
|
|
63
|
-
| `status` | 文書成熟度。`draft` / `ready` / `deprecated`
|
|
64
|
-
| `rulebook` | `specdojo:pjr-rulebook`
|
|
65
|
-
| `part_of` | `<project-id>:pjr-index` を要素に持つ配列
|
|
66
|
-
| `item_type` | 登録項目の分類
|
|
67
|
-
| `track` | epic が担う track。ほかの type では指定しない
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
70
|
-
| `
|
|
71
|
-
| `
|
|
72
|
-
| `
|
|
73
|
-
| `
|
|
74
|
-
| `
|
|
75
|
-
| `
|
|
76
|
-
| `
|
|
77
|
-
| `
|
|
78
|
-
| `
|
|
79
|
-
| `
|
|
80
|
-
| `
|
|
81
|
-
| `
|
|
82
|
-
| `
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
59
|
+
| 項目 | 説明 | 必須 |
|
|
60
|
+
| ----------------- | ----------------------------------------------------------------- | ----------- |
|
|
61
|
+
| `id` | `<project-id>:pjr-XXXX-<topic>` | ○ |
|
|
62
|
+
| `type` | `project` | ○ |
|
|
63
|
+
| `status` | 文書成熟度。`draft` / `ready` / `deprecated` | ○ |
|
|
64
|
+
| `rulebook` | `specdojo:pjr-rulebook` | ○ |
|
|
65
|
+
| `part_of` | `<project-id>:pjr-index` を要素に持つ配列 | ○ |
|
|
66
|
+
| `item_type` | 登録項目の分類 | ○ |
|
|
67
|
+
| `track` | epic が担う track。ほかの type では指定しない | epic で必須 |
|
|
68
|
+
| `domains` | epic が対象とする domain の文字列配列。ほかの type では指定しない | 任意 |
|
|
69
|
+
| `item_status` | 登録項目の処理状態 | ○ |
|
|
70
|
+
| `priority` | 対応優先度 | ○ |
|
|
71
|
+
| `difficulty` | agent 振り分け用の作業難易度 | 任意 |
|
|
72
|
+
| `owner` | 主担当者または役割 | 任意 |
|
|
73
|
+
| `registered_at` | 起票日時 | 任意 |
|
|
74
|
+
| `due_on` | 対応期限または判断期限 | 任意 |
|
|
75
|
+
| `start_on` | epic の予定開始日。ほかの type では指定しない | 任意 |
|
|
76
|
+
| `completed_at` | 完了・却下・決定日時 | 条件 |
|
|
77
|
+
| `block_reason` | `waiting` へ遷移した直近の理由 | 任意 |
|
|
78
|
+
| `conclusion` | 終端時の結論要約 | 任意 |
|
|
79
|
+
| `derived_from` | 起票の元になった登録項目 ID の配列 | 任意 |
|
|
80
|
+
| `depends_on` | 実行前に完了しているべき先行の登録項目 ID の配列 | 任意 |
|
|
81
|
+
| `approach` | 対象を作成・修正するときの進め方 | 任意 |
|
|
82
|
+
| `target_path` | カタログなしで作成する成果物のリポジトリ相対パス | 任意 |
|
|
83
|
+
| `target_rulebook` | 対象成果物の rulebook ID | 任意 |
|
|
84
|
+
| `targets` | 変更対象文書の doc id リスト | 任意 |
|
|
85
|
+
|
|
86
|
+
- `epic` は track ごとの全体計画の正本であり、自身は実行しない。`track` は英小文字・数字・ハイフンの識別子とし、先頭は英小文字または数字にする。同じ project 内の epic どうしで track を重複させない。旧 `tml-index.yaml` への登録は不要とする。
|
|
87
|
+
- `register add --type epic --track <track> --domain <domain>` で起票し、`register update --track <track> --domain <domain>` で変更する。epic の `track` は削除できない。`--domain` は反復指定で一覧を置き換え、update の `--domain -` 単独で削除する。`domains` を省略した場合だけ互換用 timeline へ範囲の解決を委ね、空配列は対象なしの明示指定とする。変更はイベントに残す。
|
|
88
|
+
- 全体計画の順序は epic 間の `depends_on`、範囲は `domains`、期間は `start_on`・着手・完了の記録と `due_on` から導く。開始日は `start_on`、epic 自身の最初の着手 event、先行 epic の最も遅い終了日の翌稼働日の順に使い、どれもなければ未定とする。子 todo の着手や起票日では補わない。`register build` は epic の依存循環と track の重複を拒否し、`start_on` が `due_on` より後なら警告する。この場合は期間を未定とする。epic のない track は全体計画へ出さない。生成は [[specdojo:register-operation-guide|登録簿運用ガイド]] に従う。
|
|
89
|
+
- `register add` / `update` の `--start-on <YYYY-MM-DD>` で予定開始日を設定し、`--start-on -` で省略・削除する。ほかの type への指定と、実在しない日付や形式不正は記帳前に拒否し、変更は event に残す。
|
|
86
90
|
- `status` は文書成熟度、`item_status` は処理状態であり、同じ状態軸として扱わない。
|
|
87
91
|
- `item_type`、`item_status`、`priority`、`difficulty` の値は schema の enum だけを使用する。`difficulty` は `hard` / `medium` / `easy` のいずれかとし、省略時は従来の agent 自動選択を使う。
|
|
88
92
|
- `block_reason` は `waiting` 中の直近の待機・失敗理由、`conclusion` は終端時の結論として用途を分ける。`register wait --reason` は前者だけを更新し、`waiting` 以外へ遷移すると現在値から削除する。削除前の理由は項目別イベントログの変更前の値に残す。
|
|
@@ -95,7 +99,7 @@ Project Register Documentation Rules
|
|
|
95
99
|
### 3.1. 日時と日付の使い分け
|
|
96
100
|
|
|
97
101
|
- 起票と終端は瞬間として記録し、`registered_at` / `completed_at` に UTC の RFC 3339・秒精度(`YYYY-MM-DDTHH:MM:SSZ`)で保存する。
|
|
98
|
-
-
|
|
102
|
+
- 予定開始日と期限は瞬間ではなくプロジェクトタイムゾーン上の暦日であるため、`start_on` と `due_on` は `YYYY-MM-DD` のまま保持する。未定の `start_on` は省略する。
|
|
99
103
|
- 一覧・派生ビューの「登録日」「完了日」は、保存した日時をプロジェクトの登録日タイムゾーンへ変換して導出する表示値であり、個票へ日付として重複保存しない。
|
|
100
104
|
- 日時は register コマンドが記録する。手書きで日時を入力する場合も、タイムゾーンを含む値から UTC へ変換した値だけを保存する。
|
|
101
105
|
|
|
@@ -153,8 +157,9 @@ Project Register Documentation Rules
|
|
|
153
157
|
- 関連ドキュメントには、判断根拠、変更対象、影響先、追跡先のうち該当する文書を記載する。
|
|
154
158
|
- 実行中に問題や後続作業を見つけて別の登録項目を起票するときは、起票元を `derived_from` に必ず記録する。decision から todo を起票する場合も同じ関係を使い、decision 本文へ追跡先を重複記載しない。既存本文の追跡先は移行のために書き換えない。
|
|
155
159
|
- 本項目の実施において確実に変更する対象文書が分かっている場合は、その文書 ID を Frontmatter の `targets` 配列へ宣言する。宣言した `targets` は agent 実行時の変更網羅検証(target coverage)に用いられる。未知の場合や対象を固定しない場合は宣言を省略する。
|
|
156
|
-
- `approach` を宣言する場合、`targets` は 1 件だけ必須とする。成果物の対象はカタログを優先して解決する。`cross-deliverable-dedup` はカタログを必須とする。それ以外の成果物の approach(`fully-guided`・`recipe-guided`・`freeform`・`bootstrap`・`retrofit`・`finalize`・`bootstrap-finalize`)は、カタログなしでも既存文書の索引と `specdojo.rulebook`、または個票の `target_path` と `target_rulebook` から解決できる。新規文書は両フィールドを必須とし、リポジトリ外のパスや別文書との衝突、既存文書と指定の不一致は認めない。カタログ設定済みで対象が未登録の場合も両フィールドがある場合だけ同じ解決を使う。`rulebook-maintenance`・`recipe-maintenance`・`sample-maintenance`・`template-maintenance` の対象は、名前に対応する種別の kata の doc id とし、文書索引で解決する。対応する正本で解決できない ID や、`approach` と種別が合わない対象は使用しない。
|
|
160
|
+
- `approach` を宣言する場合、`targets` は 1 件だけ必須とする。成果物の対象はカタログを優先して解決する。`cross-deliverable-dedup` はカタログを必須とする。それ以外の成果物の approach(`fully-guided`・`condense`・`recipe-guided`・`freeform`・`bootstrap`・`retrofit`・`finalize`・`bootstrap-finalize`)は、カタログなしでも既存文書の索引と `specdojo.rulebook`、または個票の `target_path` と `target_rulebook` から解決できる。新規文書は両フィールドを必須とし、リポジトリ外のパスや別文書との衝突、既存文書と指定の不一致は認めない。カタログ設定済みで対象が未登録の場合も両フィールドがある場合だけ同じ解決を使う。`rulebook-maintenance`・`recipe-maintenance`・`sample-maintenance`・`template-maintenance` の対象は、名前に対応する種別の kata の doc id とし、文書索引で解決する。対応する正本で解決できない ID や、`approach` と種別が合わない対象は使用しない。
|
|
157
161
|
|
|
162
|
+
- `condense` は既存成果物 1 件の冗長さを直す edit とし、未作成の対象は認めない。
|
|
158
163
|
- カタログなしの完了基準は個票の完了条件と rulebook とする。recipe・sample・template は rulebook frontmatter から辿り、`not-needed` のものを対象に含めない。`fully-guided` の必要な一式、`recipe-guided` の recipe が不足する場合は起票・更新を拒否する。
|
|
159
164
|
- カタログなしの `bootstrap` は `target_path`、新しい `target_rulebook`、設定の `kata_authority` を必須とする。既存 rulebook を再利用しない。rulebook の名前部分から recipe・sample・template の ID を導出し、`docs/ja/specdojo/<kind>s/<kata_authority>/` に配置する候補を plan へ示す。成果物には新しい `specdojo.rulebook` を記録する。
|
|
160
165
|
- `finalize`・`bootstrap-finalize` は既存成果物だけを対象にし、カタログなしでは個票の完了条件を確認チェック表にする。後者は成果物と frontmatter から辿る kata 一式を確定対象とする。
|
|
@@ -29,18 +29,18 @@ Change Request Log Documentation Rules
|
|
|
29
29
|
|
|
30
30
|
## 3. ファイル命名・ID規則
|
|
31
31
|
|
|
32
|
-
- `id` は
|
|
32
|
+
- `id` は `<project-id>:pm-change-request-log` を使用する。
|
|
33
33
|
- ファイル名は `pm-change-request-log-変更要求ログ.md` など、プロジェクト内で一意にする。
|
|
34
34
|
|
|
35
35
|
## 4. 推奨 Frontmatter 項目
|
|
36
36
|
|
|
37
|
-
| 項目 | 説明
|
|
38
|
-
| ---------- |
|
|
39
|
-
| id |
|
|
40
|
-
| type | `project` 固定
|
|
41
|
-
| status | `draft` / `ready` / `deprecated`
|
|
42
|
-
| based_on | 根拠仕様ID(配列)
|
|
43
|
-
| supersedes | 置換関係ID(配列)
|
|
37
|
+
| 項目 | 説明 | 必須 |
|
|
38
|
+
| ---------- | ------------------------------------ | ---- |
|
|
39
|
+
| id | `<project-id>:pm-change-request-log` | ○ |
|
|
40
|
+
| type | `project` 固定 | ○ |
|
|
41
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
42
|
+
| based_on | 根拠仕様ID(配列) | 任意 |
|
|
43
|
+
| supersedes | 置換関係ID(配列) | 任意 |
|
|
44
44
|
|
|
45
45
|
## 5. 本文構成(標準テンプレ)
|
|
46
46
|
|
|
@@ -28,14 +28,14 @@ Issue Log Documentation Rules
|
|
|
28
28
|
|
|
29
29
|
## 3. ファイル命名・ID規則
|
|
30
30
|
|
|
31
|
-
- `id` は
|
|
31
|
+
- `id` は `<project-id>:pm-issue-log` を使用する。
|
|
32
32
|
- ファイル名は `pm-issue-log-課題ログ.md` など一意にする。
|
|
33
33
|
|
|
34
34
|
## 4. 推奨 Frontmatter 項目
|
|
35
35
|
|
|
36
36
|
| 項目 | 説明 | 必須 |
|
|
37
37
|
| ---------- | -------------------------------- | ---- |
|
|
38
|
-
| id |
|
|
38
|
+
| id | `<project-id>:pm-issue-log` | ○ |
|
|
39
39
|
| type | `project` 固定 | ○ |
|
|
40
40
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
41
41
|
| based_on | 根拠仕様ID(配列) | 任意 |
|