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,194 +3,19 @@ specdojo:
|
|
|
3
3
|
id: specdojo:cld-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: data
|
|
6
|
-
status:
|
|
7
|
-
recipe:
|
|
6
|
+
status: deprecated
|
|
7
|
+
recipe: not-needed
|
|
8
8
|
sample: specdojo:cld-sample
|
|
9
|
-
template:
|
|
9
|
+
template: not-needed
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
-
# 分類一覧(
|
|
12
|
+
# 分類一覧(CLD)ドキュメント作成ルール(非推奨)
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
分類は業務目的に応じて **業務分類(固定)/コード表(システム分類)/動的分類(ユーザー定義)** の3種類に分けて管理します。
|
|
14
|
+
Deprecated Classification Definition Rulebook
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
この rulebook は非推奨です。略号 `cld` は概念クラス図(`ccd`)と紛れるため、後継の [[specdojo:cdt-rulebook|分類一覧(CDT)作成ルール]] へ移行しました。
|
|
18
17
|
|
|
19
|
-
##
|
|
18
|
+
## 1. 移行方針
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
分類は以下の 3 種類に分類される:
|
|
24
|
-
|
|
25
|
-
### 1. **業務分類(Business Classification)**
|
|
26
|
-
|
|
27
|
-
- 業務ロジックに基づいて固定的に存在する分類
|
|
28
|
-
- 例:商品区分、顧客種別、売上種別
|
|
29
|
-
- 値は少数で変動しないことが多い
|
|
30
|
-
- システム依存性は低い
|
|
31
|
-
|
|
32
|
-
### 2. **コード表(Code List / System Code List)**
|
|
33
|
-
|
|
34
|
-
- システムで使用されるコード値の一覧
|
|
35
|
-
- 都道府県コード、支払方法コード、税種別コードなど
|
|
36
|
-
- 多くの場合 **マスターテーブルとして保持する**
|
|
37
|
-
- BDD の enum と密接に対応
|
|
38
|
-
|
|
39
|
-
### 3. **動的分類(Dynamic Classification)**
|
|
40
|
-
|
|
41
|
-
- ユーザーが自由に作成・編集・削除できる分類
|
|
42
|
-
- タグ、ラベル、フォルダ分類など
|
|
43
|
-
- **BDD の enum にしてはいけない**
|
|
44
|
-
- システムテーブルで管理し、BDD では string または reference とする
|
|
45
|
-
|
|
46
|
-
## 1. メタデータ
|
|
47
|
-
|
|
48
|
-
分類一覧を1つの YAML ドキュメントとして管理する場合、以下のメタデータを用いる。
|
|
49
|
-
|
|
50
|
-
| 項目 | 説明 | 必須 |
|
|
51
|
-
| ---- | ------------------------------ | ---- |
|
|
52
|
-
| id | 分類一覧ID(例:cll-xxx-xxxx) | ○ |
|
|
53
|
-
|
|
54
|
-
| type | `data` 固定 | ○ |
|
|
55
|
-
| title | 分類一覧名 | ○ |
|
|
56
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
57
|
-
| supersedes | 置き換え関係(旧仕様→新仕様) | 任意 |
|
|
58
|
-
|
|
59
|
-
### 1.1 ID規約
|
|
60
|
-
|
|
61
|
-
- 分類一覧IDは正規表現 **`^cll-[a-z0-9-]+$`** に合致すること
|
|
62
|
-
- `type: data` は画面やAPI仕様と切り離して管理することを示す
|
|
63
|
-
|
|
64
|
-
## 2. 記述ルール(共通)
|
|
65
|
-
|
|
66
|
-
- 日本語の単数形で記載する(例:商品区分、顧客種別)
|
|
67
|
-
- 分類を 分類定義 と 値の説明(値一覧) の二つの表で整理する。
|
|
68
|
-
- 値はシステム上の識別子として lower-kebab-case を使用する。
|
|
69
|
-
- 略語のみの記述や曖昧な説明は避ける。
|
|
70
|
-
- システム内部名称のみにしない
|
|
71
|
-
|
|
72
|
-
### 2.1 分類定義の説明
|
|
73
|
-
|
|
74
|
-
分類定義は、**「定義項目 / 内容」** の 2 列の表で記述します。
|
|
75
|
-
|
|
76
|
-
| 列名 | 説明 |
|
|
77
|
-
| ---------------- | -------------------------------------------------- |
|
|
78
|
-
| 対象エンティティ | 分類が属する業務上の主要対象(例:商品、顧客など) |
|
|
79
|
-
| 分類定義名 | 分類を表す項目(フィールド)名 |
|
|
80
|
-
| 種別 | 「業務分類」「コード表」「動的分類」のいずれか |
|
|
81
|
-
| 説明 | 分類が何を意味するか |
|
|
82
|
-
|
|
83
|
-
### 2.2 値一覧
|
|
84
|
-
|
|
85
|
-
値を持つ分類では、以下の列を基本とする。
|
|
86
|
-
|
|
87
|
-
| 列名 | 説明 |
|
|
88
|
-
| ------ | ------------------------------------------- |
|
|
89
|
-
| 値 | システム上の識別子。`lower-kebab-case` 推奨 |
|
|
90
|
-
| 分類名 | 正式名称。BDD/用語集と整合させる |
|
|
91
|
-
| 表示名 | UI や現場で使用される表示用名称 |
|
|
92
|
-
| 説明 | 値の意味・成立条件など |
|
|
93
|
-
|
|
94
|
-
## 3. 分類の種類別のルール
|
|
95
|
-
|
|
96
|
-
### 3.1 業務分類(Business Classification)
|
|
97
|
-
|
|
98
|
-
#### 特徴
|
|
99
|
-
|
|
100
|
-
- 業務ロジック上必然的に存在する分類
|
|
101
|
-
- 値は少数で固定的
|
|
102
|
-
- システム実装に強く依存しない
|
|
103
|
-
|
|
104
|
-
#### BDD での扱い
|
|
105
|
-
|
|
106
|
-
- 値が少ない場合は BDD の `type: enum` として記載してよい。
|
|
107
|
-
|
|
108
|
-
---
|
|
109
|
-
|
|
110
|
-
### 3.2 コード表(System Code List)
|
|
111
|
-
|
|
112
|
-
#### 特徴
|
|
113
|
-
|
|
114
|
-
- システム内で使用される **コード値の一覧**
|
|
115
|
-
- 多くの場合 **マスターテーブルとして管理すべき**
|
|
116
|
-
- 外部連携や識別子として利用される
|
|
117
|
-
|
|
118
|
-
#### マスターテーブル化すべき条件
|
|
119
|
-
|
|
120
|
-
以下のいずれかを満たす:
|
|
121
|
-
|
|
122
|
-
- 値が多い(10以上)
|
|
123
|
-
- 追加・変更・廃止の可能性がある
|
|
124
|
-
- 外部システム連携や帳票に必要
|
|
125
|
-
- 多言語化が必要
|
|
126
|
-
- BDD enum では収まらないメタ情報がある(例:税率、期間)
|
|
127
|
-
|
|
128
|
-
#### BDD enum で良いケース
|
|
129
|
-
|
|
130
|
-
- 値が3〜5個以下
|
|
131
|
-
- 業務ルールで固定されている
|
|
132
|
-
- ラベル変更の可能性が低い
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
### 3.3 動的分類(Dynamic Classification)
|
|
137
|
-
|
|
138
|
-
#### 特徴
|
|
139
|
-
|
|
140
|
-
- ユーザーが自由に追加・編集・削除可能
|
|
141
|
-
- タグ、ラベル、フォルダ分類などに用いられる
|
|
142
|
-
|
|
143
|
-
#### BDD の enum にしてはいけない
|
|
144
|
-
|
|
145
|
-
- 値の増減に対応できず仕様が破綻するため
|
|
146
|
-
|
|
147
|
-
#### BDD での扱い
|
|
148
|
-
|
|
149
|
-
- type: `string` または `reference` とする
|
|
150
|
-
|
|
151
|
-
#### 標準列
|
|
152
|
-
|
|
153
|
-
| 値 | 作成者 | 説明 |
|
|
154
|
-
|
|
155
|
-
---
|
|
156
|
-
|
|
157
|
-
## 4. BDD との関係(重要)
|
|
158
|
-
|
|
159
|
-
| 分類種類 | BDD の扱い |
|
|
160
|
-
| -------- | ---------------------------- |
|
|
161
|
-
| 業務分類 | enum 可能 |
|
|
162
|
-
| コード表 | enum または マスターテーブル |
|
|
163
|
-
| 動的分類 | enum 禁止、別テーブルで管理 |
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
|
|
167
|
-
## 5. サンプル(商品区分)
|
|
168
|
-
|
|
169
|
-
### 5.1 メタデータ
|
|
170
|
-
|
|
171
|
-
```yaml
|
|
172
|
-
---
|
|
173
|
-
id: cll-product-type
|
|
174
|
-
type: data
|
|
175
|
-
title: 商品区分
|
|
176
|
-
status: draft
|
|
177
|
-
supersedes: []
|
|
178
|
-
---
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
### 5.2 分類定義
|
|
182
|
-
|
|
183
|
-
| 定義項目 | 内容 |
|
|
184
|
-
| ---------------- | ---------------------- |
|
|
185
|
-
| 対象エンティティ | 商品 |
|
|
186
|
-
| 分類定義名 | 商品区分 |
|
|
187
|
-
| 種別 | 業務分類 |
|
|
188
|
-
| 説明 | 商品の業務上の上位分類 |
|
|
189
|
-
|
|
190
|
-
### 5.3 値一覧
|
|
191
|
-
|
|
192
|
-
| 値 | 分類名 | 表示名 | 説明 |
|
|
193
|
-
| ----- | ------ | -------- | ---------- |
|
|
194
|
-
| snack | お菓子 | おやつ | 食品系商品 |
|
|
195
|
-
| toy | 玩具 | おもちゃ | 玩具類 |
|
|
196
|
-
| drink | 飲料 | ドリンク | 飲み物類 |
|
|
20
|
+
- 新しい成果物は `cld-<term>` ではなく `cdt-<term>` として作成し、[[specdojo:cdt-rulebook|分類一覧作成ルール]] を参照します。
|
|
21
|
+
- 既存の `cld-*` 成果物やカタログ定義は、[[specdojo:id-and-file-naming-standard|ドキュメントIDおよびファイル命名標準]] の経路 B に従って `cdt-*` へ切り替えます。
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:clis-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: ui
|
|
6
|
+
status: draft
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: specdojo:clis-sample
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# CLI仕様(CLIS)作成ルール
|
|
16
|
+
|
|
17
|
+
Command Line Interface Specification (CLIS) Authoring Rule
|
|
18
|
+
|
|
19
|
+
システム自身が提供する CLI コマンド群について、利用者が目的を達成し、失敗時に次の操作を選べる仕様の記述規約を定めます。構文やデータ構造の詳細は正本を参照し、本書では利用目的、操作の流れ、入出力の要点、終了時の判断と回復を扱います。
|
|
20
|
+
|
|
21
|
+
## 1. 全体方針
|
|
22
|
+
|
|
23
|
+
- 1 ファイルは一つの業務目的または機能領域を担うコマンド群とします。利用者の課題と達成できる結果を対応付けます。
|
|
24
|
+
- 人が直接操作する場合と自動実行を設定・監視する場合について、対象者、開始条件、結果の確認方法を記述します。
|
|
25
|
+
- システムが外部コマンドを呼ぶ契約は `ifx-cmd` が扱います。CLIS は利用者がシステムを操作する側の仕様として記述します。
|
|
26
|
+
- 引数・オプションの構文や既定値はコマンドリファレンス、データの値・構文・構造はファイル仕様・schema・連携契約を正本とします。CLIS は操作の選択と結果の判断に必要な要点を持ちます。
|
|
27
|
+
- 共通事項は上位の索引を正本とし、個別仕様では差分と参照先を示します。索引が未作成なら未作成と記録し、個別仕様で定めた内容との照合を後続作業へ引き継ぎます。
|
|
28
|
+
- 必須・任意・禁止を区別します。推奨表は情報の配置例であり、必須情報を別列へまとめても構いません。
|
|
29
|
+
|
|
30
|
+
### 1.1. 対象者と確認する内容
|
|
31
|
+
|
|
32
|
+
| 対象者 | 解決する課題 | 確認する内容 |
|
|
33
|
+
| -------------------------------------------- | -------------------------------------- | ------------------------------------------------------------ |
|
|
34
|
+
| 業務担当者・運用者(OPS) | 開始・中断・回復時に操作を選べない | 目的に合う経路、実行後の状態、次の手を判断できる |
|
|
35
|
+
| 業務分析担当(BA)・プロダクトオーナー(PO) | 操作が業務目的に応えるか合意できない | 対象範囲、達成結果、確認・合意を担う役割が分かる |
|
|
36
|
+
| アーキテクト(ARC)・開発者(DEV) | CLI とデータ・外部連携の責務が重複する | 正本の所在と入出力の方向、未確定の契約が分かる |
|
|
37
|
+
| 品質保証担当(QE) | 完了・回復の合否を判定できない | 条件、表示、終了状態、保持される成果から期待結果を確認できる |
|
|
38
|
+
|
|
39
|
+
## 2. 位置づけと用語定義
|
|
40
|
+
|
|
41
|
+
CLIS は業務プロセス仕様やシステム化機能を受け、利用者とシステムの操作境界を定めます。
|
|
42
|
+
|
|
43
|
+
```mermaid
|
|
44
|
+
graph TD
|
|
45
|
+
SF["システム化機能 (sf)"] --> CLIS["CLI仕様 (clis)<br/>利用者視点の操作フロー・入力情報と出力情報・次の手"]
|
|
46
|
+
CLIS -.->|"構文・引数の正本参照"| CMDREF["コマンドリファレンス (command-reference)<br/>コマンド構文・オプション詳細の正本"]
|
|
47
|
+
CLIS -.->|"中身の正本参照"| IN["入力情報の仕様<br/>ファイル・API・外部コマンド等の正本"]
|
|
48
|
+
CLIS -.->|"中身の正本参照"| OUT["出力情報の仕様<br/>ファイル・API・外部コマンド等の正本"]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
| 用語 | この文書での意味 |
|
|
52
|
+
| ------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
53
|
+
| 入力情報 | CLI が受け取るもの。ファイル、標準入力、環境変数、対話入力、API 応答、外部コマンドの実行結果を含む |
|
|
54
|
+
| 出力情報 | CLI が外へ送り出すもの。標準出力・標準エラー、ファイルの作成・更新、API への送信、外部コマンドの起動を含む |
|
|
55
|
+
| 外部コマンド連携仕様(ifx-cmd) | システムが外部コマンドを呼ぶ契約。利用者が自システムを操作する CLIS とは責務が異なる |
|
|
56
|
+
|
|
57
|
+
## 3. ファイル命名・ID規則
|
|
58
|
+
|
|
59
|
+
命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
60
|
+
|
|
61
|
+
- ファイル名は `clis-<機能名またはコマンド群名>.md` とします。例: `clis-exec-commands.md`。
|
|
62
|
+
- プロダクト文書の ID は `clis-<kebab-case>`、プロジェクト文書は `<project-id>:clis-<kebab-case>` とします。同梱の完成例は成果物と衝突しない `specdojo:` の ID を使います。
|
|
63
|
+
- 文書名は本文先頭の H1 に記述します。CLI のコマンド名だけでなく、対象の機能領域を識別できる名前にします。
|
|
64
|
+
|
|
65
|
+
## 4. 推奨 Frontmatter 項目
|
|
66
|
+
|
|
67
|
+
共通の必須・任意項目と値・型の制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] および `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。CLIS 固有の指定と根拠の選び方は次のとおりです。
|
|
68
|
+
|
|
69
|
+
- `type` は本 rulebook の `deliverable_type` に対応する `ui`、`rulebook` は `specdojo:clis-rulebook` とします。
|
|
70
|
+
- `part_of` は所属する索引、`based_on` は実際に根拠とした業務プロセス・システム化機能等を示します。カタログ管理下では依存関係と照合し、未作成の文書を作成済みとして登録しません。
|
|
71
|
+
- 未作成の依存先や根拠を接続できない理由は「メモ / 将来課題」へ記録します。空の `based_on` を埋めるために無関係な ID を追加しません。
|
|
72
|
+
|
|
73
|
+
## 5. 本文要件
|
|
74
|
+
|
|
75
|
+
次の順に構成します。「入力と出力の要点」は「入力情報」「出力情報」に分けます。Markdown の `##`〜`####` には階層ごとの連番と末尾の `.` を付け、章への参照は章タイトルで示します。
|
|
76
|
+
|
|
77
|
+
| 章 | 必須・任意 | 目的と内容要件 |
|
|
78
|
+
| -------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------- |
|
|
79
|
+
| 概要 | 必須 | コマンド群で達成する結果と対象範囲を 1〜2 文で示す |
|
|
80
|
+
| 利用目的と対象ユーザー | 必須 | 誰のどの課題に応えるか、対象外の操作とその引き渡し先、手順や完了判断を確認する役割を示す |
|
|
81
|
+
| 操作の流れ | 必須 | 開始条件、標準経路、選択が必要な分岐、中断・再開、完了時に確認する結果を示す |
|
|
82
|
+
| 操作とコマンド参照 | 必須 | 操作と対象コマンドを対応付け、構文の正本へ案内する。意味がフローから分かる場合、説明列は任意とする |
|
|
83
|
+
| 入力と出力の要点 | 必須 | 受け取るものと送り出すものを分離し、対象・役割・正本と入力失敗時の扱いを示す |
|
|
84
|
+
| 終了コードとエラー表示・利用者の次の手 | 必須 | 正常・警告・異常の判断、表示要点、回復の条件と操作を示す。該当なしや処理のスキップがあり得る場合も扱う |
|
|
85
|
+
| メモ / 将来課題 | 任意 | 未作成の参照先、未確認の動作、未決事項の影響・担当・解消条件・引き継ぎ先を示す。該当事項があれば省略しない |
|
|
86
|
+
|
|
87
|
+
## 6. 記述ガイド
|
|
88
|
+
|
|
89
|
+
各章は次の判断基準で記述します。完成例は frontmatter で宣言した sample を正本とし、ここには判断に必要な短い対比例だけを置きます。
|
|
90
|
+
|
|
91
|
+
### 6.1. 概要
|
|
92
|
+
|
|
93
|
+
- 判断基準: 利用者が何を達成でき、何を引き継げるかを読み取れること。内部処理の説明は含めません。
|
|
94
|
+
- 良い例: 「作業指示の準備から実行・進捗確認・再開をつなぎ、結果と判断を次の担当者へ引き継ぐコマンド群。」
|
|
95
|
+
- 悪い例: 「引数を解析し、内部関数を呼び出す CLI。」利用者が得る結果を判断できません。
|
|
96
|
+
|
|
97
|
+
### 6.2. 利用目的と対象ユーザー
|
|
98
|
+
|
|
99
|
+
- 判断基準: 対象者と達成結果が対応し、操作する人と結果を確認・合意する人の役割が分かること。自動実行は設定・監視する人も示します。
|
|
100
|
+
- 良い例: 「運用者は停止した作業の状態と残存成果を確認して再開する。レビュー担当は記録から完了条件の充足を確認する。」
|
|
101
|
+
- 悪い例: 「対象は全ユーザー。目的はコマンドの実行。」課題、達成結果、確認者が特定できません。
|
|
102
|
+
|
|
103
|
+
### 6.3. 操作の流れ
|
|
104
|
+
|
|
105
|
+
- 判断基準: 開始前の確認から結果の確認へ進め、分岐の選択条件が分かること。中断時は同じ試行の再開と新規のやり直しを区別し、保持する成果と再開先を示します。
|
|
106
|
+
- 表現は順序付きリストまたは Mermaid を使います。両方使う場合、図は分岐、本文は選択条件など情報を分担し、同じ手順を繰り返しません。状態や実行主体の固有語は初出で定義または正本へ案内します。
|
|
107
|
+
- 良い例: 「状況確認 → 対象を選んで実行 → 記録と差分で結果を確認。中断時は保存済みの試行と成果を確認して該当段から再開する。」
|
|
108
|
+
- 悪い例: 「実行後は常に完了。失敗したら最初から実行。」業務上の完了確認と既存成果の扱いが欠けます。
|
|
109
|
+
|
|
110
|
+
### 6.4. 操作とコマンド参照
|
|
111
|
+
|
|
112
|
+
- 判断基準: 各操作から実行するコマンドと構文の正本を特定できること。参照先に該当する小節があればそこへ接続し、なければ章へ案内します。
|
|
113
|
+
- 推奨列は「操作」「対象コマンド」「正本リファレンス」です。複数コマンドをまとめても、用途が異なり選べなくなる場合は行を分けます。フローにない操作の意味はこの章で補います。
|
|
114
|
+
- 良い例: 「状況確認 → `exec status` → [[specdojo:command-reference#7-exec|CLIコマンドリファレンス: exec]]」。操作の意味はフローと重複させません。
|
|
115
|
+
- 悪い例: 全フラグの型・既定値・組合せを表へ転載する。構文の変更を二重管理することになります。
|
|
116
|
+
|
|
117
|
+
### 6.5. 入力と出力の要点
|
|
118
|
+
|
|
119
|
+
判断基準は、CLI を境界とした情報の方向、利用する操作、目的、中身の正本を追えることです。入力・出力はそれぞれ以下の必須情報を持つ表で示し、利用する操作は専用列または対象欄で識別します。同じ扱いの操作はまとめ、全種類を埋めるための該当なし行は作りません。
|
|
120
|
+
|
|
121
|
+
#### 6.5.1. 入力情報
|
|
122
|
+
|
|
123
|
+
- 必須情報は「種類」「対象」「役割」「正本の参照」「ない/壊れている/届かないときの扱い」です。標準入力、対話、環境変数、API 応答、外部処理の結果も確認対象とします。
|
|
124
|
+
- 失敗時は停止・代替・再入力・警告継続を区別し、対応する事象名または参照でエラー章につなげます。欠落と破損で扱いが異なれば分けて示します。
|
|
125
|
+
- 良い例: 「設定ファイルを実行条件の解決に使う。中身は schema を参照し、欠落時は既定設定、破損時は『設定不正』として停止する。」
|
|
126
|
+
- 悪い例: 「設定を読む。なければ適切に処理する。」停止するか続行するかを判断できません。
|
|
127
|
+
|
|
128
|
+
#### 6.5.2. 出力情報
|
|
129
|
+
|
|
130
|
+
- 必須情報は「種類」「対象」「役割」「正本の参照」です。標準出力の要点はこの小節にまとめ、作成・更新するファイルと外部への送信・起動も扱います。
|
|
131
|
+
- 表示先は実際の契約に合わせます。エラーを標準エラーだけと決め付けず、標準出力に診断が出る場合も区別します。表示要点は利用者が確認する内容に絞り、全文を再掲しません。
|
|
132
|
+
- 良い例: 「実行記録を保存し、次の担当が結果と再開段を確認する。項目と形式は記録の schema を参照する。」
|
|
133
|
+
- 悪い例: 保存する JSON の全フィールドや API のペイロードを列挙する。中身の正本と重複します。
|
|
134
|
+
|
|
135
|
+
#### 6.5.3. 正本の選び方と参照の境界
|
|
136
|
+
|
|
137
|
+
| 対象 | 中身を委ねる正本 | CLIS に残す判断情報 |
|
|
138
|
+
| -------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
|
139
|
+
| ファイル | 対象の rulebook または schema | どの操作で読み書きするか、用途、欠落・破損時の扱い |
|
|
140
|
+
| 外部 API | [[specdojo:ifx-api-rulebook\|外部API仕様作成ルール]] に従う契約 | 呼ぶ目的、送信と応答の方向、接続不能・時間切れ・拒否時の扱い |
|
|
141
|
+
| 自システム API | [[specdojo:sysd-index-rulebook\|システム設計索引作成ルール]] に従う索引が案内する内部 API 定義 | 名前と用途。定義が未作成なら詳細を仮定しない |
|
|
142
|
+
| 外部コマンド | [[specdojo:ifx-cmd-rulebook\|外部コマンド連携仕様作成ルール]] に従う契約 | 起動する目的、渡すもの、受け取る結果、失敗時の扱い |
|
|
143
|
+
|
|
144
|
+
- API への送信は出力、応答は入力です。取得と更新を兼ねる呼出しは両方に挙げます。外部コマンドも起動を出力、実行結果を入力に挙げます。
|
|
145
|
+
- 正本が未作成なら文書 ID またはファイル名をインラインコードで示し、未作成であることと影響を記録します。独立した正本が不要な対話表示などは、その理由を添えて参照なしとします。
|
|
146
|
+
- 認証情報は名前と用途だけを記述し、値を記載しません。
|
|
147
|
+
|
|
148
|
+
### 6.6. 終了コードとエラー表示・利用者の次の手
|
|
149
|
+
|
|
150
|
+
- 判断基準: 事象の発生条件、終了コードの意味、表示要点、次の確認・操作から、完了または回復を判定できること。原因は表示要点から分からない場合に補います。
|
|
151
|
+
- 終了コードの値と伝播条件は対象コマンドの正本に従います。外部処理のコードを CLI 全体へ一律に当てはめません。警告継続、対象なし、処理のスキップなどは、正常終了でも未実施・未完了になり得るかを明記します。
|
|
152
|
+
- 再試行の前に確認する状態・保持成果・担当を示します。再実行で二重処理や成果の消失が起こり得る場合は、回避条件を記述します。
|
|
153
|
+
- 良い例: 「対象なしの正常終了は新規作業の完了を意味しない。運用者は依存関係と対象条件を確認してから選択をやり直す。」
|
|
154
|
+
- 悪い例: 「非ゼロなら再実行する。」原因の解消、残存成果、再開先が判断できません。
|
|
155
|
+
|
|
156
|
+
推奨表の列は次のとおりです。入出力章では表示先・役割、この表では事象ごとの判断と回復を記述します。
|
|
157
|
+
|
|
158
|
+
| 列 | 記述する内容 |
|
|
159
|
+
| -------------- | ---------------------------------------------------------------------- |
|
|
160
|
+
| 事象・条件 | 正常、警告、異常を分ける条件。入力章の事象名と対応させる |
|
|
161
|
+
| 終了コード | 正本で定義された値または参照。経路で異なる場合は適用条件を付ける |
|
|
162
|
+
| 表示要点 | 利用者が事象を識別する情報。出力先が分かれる場合はその区別 |
|
|
163
|
+
| 利用者の次の手 | 担当者、確認対象、再開・再入力・引き継ぎ等の操作と回復を確認できる結果 |
|
|
164
|
+
|
|
165
|
+
### 6.7. メモ / 将来課題
|
|
166
|
+
|
|
167
|
+
- 判断基準: 現行の確定仕様と未確定事項が区別され、誰が何を確かめれば解消できるかが分かること。恒久的な課題は登録簿へ担当と参照先を付けて引き継ぎます。
|
|
168
|
+
- 良い例: 「外部 agent 契約は未作成。ARC が終了状態と再開条件を確定し、DEV が連携定義へ接続、QE が異常時の期待結果を照合する。それまでは当該経路の受入判断を保留する。」
|
|
169
|
+
- 悪い例: 「今後検討する。」影響する経路、確認者、解消条件が分かりません。
|
|
170
|
+
|
|
171
|
+
## 7. 禁止事項
|
|
172
|
+
|
|
173
|
+
| 禁止する記述 | 理由 |
|
|
174
|
+
| -------------------------------------------------------------- | -------------------------------------------------------- |
|
|
175
|
+
| 構文・値・構造・実装詳細の正本の再掲 | 引数表、ペイロード、内部クラス、SQL 等の二重管理を避ける |
|
|
176
|
+
| 外部コマンド連携契約や GUI レイアウトの混入 | 利用者の CLI 操作という責務を保つ |
|
|
177
|
+
| 入力と出力の混同、正本未作成を隠したリンク | 情報の方向と仕様の確定範囲を誤認させる |
|
|
178
|
+
| 次の手を伴わないエラー列挙、一律の再実行指示 | 回復条件を判断できず、二重処理や成果消失につながる |
|
|
179
|
+
| 認証情報の値の記載 | 仕様には名前と用途のみが必要である |
|
|
180
|
+
| フロー・表・図での同じ説明の繰り返し | 利用者の判断を増やさず保守箇所だけを増やす |
|
|
181
|
+
| 本文への sample・recipe・template のリンク章や wikilink の設置 | 対応関係は frontmatter で宣言する |
|
|
182
|
+
|
|
183
|
+
## 8. 運用ルール
|
|
184
|
+
|
|
185
|
+
- コマンド構文だけの変更は正本へ反映し、参照先を確認します。利用目的、操作の流れ、入出力の要点、終了時の判断、回復条件が変わる場合は CLIS も改訂します。
|
|
186
|
+
- 改訂・廃止は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従います。BA は索引・カタログ・業務フロー、ARC は API・外部コマンド契約、DEV は実装・schema、QE は受入・テストへの影響を確認し、PM が追従作業を管理、PO が置き換え・廃止を判断します。
|
|
187
|
+
- BA と利用者側の確認者は目的・範囲・経路を、OPS は回復操作と保持成果を、QE は正常・警告・異常時の観測結果を照合します。未確認の経路は担当と解消条件を記録し、人が文書の確定可否を判断します。作業の完了状態と成果物の確定状態を同一視しません。
|