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,206 +3,190 @@ specdojo:
|
|
|
3
3
|
id: specdojo:bds-rulebook
|
|
4
4
|
type: rulebook
|
|
5
5
|
deliverable_type: ui
|
|
6
|
-
status:
|
|
7
|
-
|
|
6
|
+
status: ready
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
8
9
|
sample: specdojo:bds-sample
|
|
9
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
10
13
|
---
|
|
11
14
|
|
|
12
|
-
#
|
|
15
|
+
# 帳票仕様(BDS)作成ルール
|
|
13
16
|
|
|
14
|
-
Business Document Specification (BDS)
|
|
17
|
+
Business Document Specification (BDS) Authoring Rule
|
|
15
18
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
帳票仕様は、業務ユーザーが利用する「出力物」(印刷物/PDF/CSV/Excel等)の内容を、**業務用語でレビュー可能な形**で定義します。
|
|
19
|
+
業務で使う出力物(報告書、一覧、集計表、ファイル出力など)について、読み手が何のためにいつ受け取り、何を確かめられるかを業務用語でレビューできる仕様の記述規約を定めます。出力物の本文構成や記録の構造は各正本を参照し、本書では利用目的、読み手、出力の時期、表示項目、元にする記録と算出の規則を扱います。
|
|
19
20
|
|
|
20
21
|
## 1. 全体方針
|
|
21
22
|
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
| 用語 | 定義 |
|
|
29
|
-
| --------- | -------------------------------------------------------------------- |
|
|
30
|
-
| 帳票 | 業務で利用する出力物(印刷物/PDF/CSV/Excel/画面出力等) |
|
|
31
|
-
| 表示項目 | 帳票に出力される項目(ヘッダ、明細、フッタ、集計値、注記等) |
|
|
32
|
-
| 抽出条件 | 対象データの範囲を決める条件(期間、店舗、状態、担当者等) |
|
|
33
|
-
| 集計/算出 | 帳票内で計算・集計される値(合計、平均、税、差額、件数、グループ化) |
|
|
34
|
-
| 出力形式 | PDF/CSV/Excel/印刷/画面など、提供するファイル/媒体と形式 |
|
|
35
|
-
| 配布/配信 | ダウンロード、メール送付、印刷、外部システム連携などの提供方法 |
|
|
36
|
-
|
|
37
|
-
## 3. ファイル命名・ID規則
|
|
38
|
-
|
|
39
|
-
- ファイル名: `bds-<番号>-<短い日本語名>.md`(例: `bds-0010-日次売上サマリ.md`)
|
|
40
|
-
- Frontmatter:
|
|
41
|
-
- `id`: `bds-daily-sales-summary` のように小文字ハイフン形式
|
|
42
|
-
- `title`: 「日次売上サマリ」などの帳票名
|
|
43
|
-
|
|
44
|
-
## 4. 推奨 Frontmatter 項目
|
|
45
|
-
|
|
46
|
-
Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` の制約に従います。
|
|
47
|
-
|
|
48
|
-
| 項目 | 説明 | 必須 |
|
|
49
|
-
| ---- | ------------------- | ---- |
|
|
50
|
-
| id | 帳票ID(`bds-...`) | ○ |
|
|
51
|
-
|
|
52
|
-
| type | `ui` 固定 | ○ |
|
|
53
|
-
| title | 帳票名 | ○ |
|
|
54
|
-
|
|
55
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
56
|
-
| based_on | 根拠となる仕様ID(BPS/UIS/BR/BES 等) | 任意 |
|
|
57
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
58
|
-
|
|
59
|
-
### 4.1 ID規約
|
|
60
|
-
|
|
61
|
-
- BDS の `id` は正規表現 `^bds-[a-z0-9-]+$` に合致する一意IDを使用します。
|
|
62
|
-
- `type: ui` は帳票の利用者向け仕様であることを示します。
|
|
63
|
-
|
|
64
|
-
## 5. 本文構成(標準テンプレ)
|
|
23
|
+
- 1 ファイルは 1 帳票とします。同じ読み手・目的・時期で出力する出力物を 1 帳票にまとめ、読み手や時期が異なれば分けます。
|
|
24
|
+
- 読み手が帳票から下す判断を先に定め、表示項目はその判断に要るものに絞ります。
|
|
25
|
+
- 各表示項目は、元にする記録と算出の規則まで追えるようにします。記録から値を再現できない項目は、確かめ方が未確定であることを明記します。
|
|
26
|
+
- 出力物自体の本文構成を定める rulebook や、記録・ファイルの schema があれば正本とし、帳票仕様は項目の意味・出所・判断用途を持ちます。
|
|
27
|
+
- 共通事項は上位の索引を正本とし、個別仕様では差分と参照先を示します。索引が未作成なら未作成と記録します。
|
|
28
|
+
- 物理名・SQL・実装クラス・帳票ツールなどの実装詳細は記載しません。
|
|
65
29
|
|
|
66
|
-
|
|
30
|
+
### 1.1. 対象者と確認する内容
|
|
67
31
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
8. 例外/注意事項
|
|
76
|
-
9. メモ / 将来課題
|
|
32
|
+
| 対象者 | 解決する課題 | 確認する内容 |
|
|
33
|
+
| ------------------------------------------- | ---------------------------------------- | -------------------------------------------------------- |
|
|
34
|
+
| 業務分析担当(BA) | 出力物が業務の判断に足りるか分からない | 読み手、利用目的、表示項目、出力の時期が対応している |
|
|
35
|
+
| プロダクトオーナー(PO) | 報告・出力の範囲を承認できない | 対象範囲、対象外、未確定の判断が区別されている |
|
|
36
|
+
| アーキテクト(ARC)・開発者(DEV) | 出力の契機と記録の出所が実装と食い違う | 出力の契機、元にする記録、算出規則と正本の所在 |
|
|
37
|
+
| 品質保証担当(QE) | 出力内容の正しさを判定できない | 各項目を記録から再現する方法、境界条件、例外時の期待結果 |
|
|
38
|
+
| UX / Documentation Designer(UX)・読み手側 | 必要な情報へたどり着けない、用語が揺れる | 項目名と用語、並び順、次に見る文書 |
|
|
77
39
|
|
|
78
|
-
##
|
|
40
|
+
## 2. 位置づけと用語定義
|
|
79
41
|
|
|
80
|
-
|
|
42
|
+
帳票仕様は業務仕様の `user-interface-model` に属し、業務プロセスや業務イベントを受けて、出力物の読み手と出力側の境界を定めます。成果物としての位置づけは [[specdojo:deliverables-reference|成果物リファレンス]] を正本とします。
|
|
81
43
|
|
|
82
|
-
|
|
44
|
+
- 画面仕様(`uis`)と同じ `ui` 種別ですが、画面仕様は利用者が操作して業務を進める対話を、帳票仕様は操作を伴わずに受け取る出力物とその値の出所を扱います。
|
|
45
|
+
- 画面上に表示するだけの一覧でも、定期的に作られて後から読み返す出力物であれば帳票仕様に、利用者の操作・遷移を伴う画面であれば画面仕様に書き、片方から他方を参照します。
|
|
83
46
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
- 出力の契機(例: 日次締め、会計確定、手動出力、バッチ)
|
|
92
|
-
- 対象期間の基準(営業日、締め日時、会計確定日時など)
|
|
93
|
-
|
|
94
|
-
### 6.4 出力形式/配布・配信
|
|
95
|
-
|
|
96
|
-
- 出力形式(PDF/CSV/Excel/印刷/画面)を明示します。
|
|
97
|
-
- 配布・配信(ダウンロード、メール送付、印刷、外部連携)を明示します。
|
|
98
|
-
- CSV 等のエクスポートがある場合は、- 文字コード(例: UTF-8)- ヘッダ行の有無 - 区切り文字(例: カンマ)
|
|
99
|
-
を記載します(ただし実装ライブラリ名等は不要)。
|
|
100
|
-
|
|
101
|
-
### 6.5 抽出条件/対象範囲
|
|
102
|
-
|
|
103
|
-
- 対象となるデータの範囲(期間、店舗、担当者、ステータス等)を列挙します。
|
|
104
|
-
- 除外条件(取消は除外、締め済みのみ対象 等)があれば明記します。
|
|
47
|
+
```mermaid
|
|
48
|
+
graph TD
|
|
49
|
+
BPS["業務プロセス・業務イベント"] --> BDS["帳票仕様 (bds)<br/>読み手・利用目的・出力の時期・表示項目・元にする記録"]
|
|
50
|
+
BDS -.->|"本文構成の正本参照"| DOC["出力物自体の rulebook<br/>例: 進捗報告"]
|
|
51
|
+
BDS -.->|"構造の正本参照"| REC["元にする記録の仕様<br/>schema・設計書"]
|
|
52
|
+
BDS -.->|"契機の正本参照"| TRG["出力の契機の仕様<br/>定期実行・手動操作"]
|
|
53
|
+
```
|
|
105
54
|
|
|
106
|
-
|
|
55
|
+
| 用語 | この文書での意味 |
|
|
56
|
+
| ------------ | -------------------------------------------------------------------------------------- |
|
|
57
|
+
| 帳票 | 業務で利用する出力物。文書、一覧、集計表、ファイル出力、画面上の出力を含む |
|
|
58
|
+
| 元にする記録 | 帳票の値を得るために読む業務記録。実行記録、状態の変化、前回の帳票などを含む |
|
|
59
|
+
| 対象範囲 | 元にする記録のうち帳票に含める範囲。期間、対象組織・プロジェクト、状態、除外条件で示す |
|
|
60
|
+
| 出力の時期 | 帳票を作る契機と、対象期間の区切り方の組み合わせ |
|
|
61
|
+
| 表示項目 | 帳票に出力される項目。見出し情報、明細、集計値、注記を含む |
|
|
107
62
|
|
|
108
|
-
|
|
63
|
+
## 3. ファイル命名・ID規則
|
|
109
64
|
|
|
110
|
-
|
|
65
|
+
命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
111
66
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
67
|
+
- ファイル名は `bds-<帳票名の kebab-case>.md` とします。例: `bds-progress-report.md`。
|
|
68
|
+
- プロダクト文書の ID は `bds-<kebab-case>`、プロジェクト文書は `<project-id>:bds-<kebab-case>` とします。同梱の完成例は成果物と衝突しない `specdojo:` の ID を使います。
|
|
69
|
+
- 帳票名は本文先頭の H1 に記述し、「対象 + 観点 + 粒度」で識別できる名前にします。例: 「週次進捗報告」「日次売上サマリ」。
|
|
115
70
|
|
|
116
|
-
|
|
71
|
+
## 4. 推奨 Frontmatter 項目
|
|
117
72
|
|
|
118
|
-
-
|
|
119
|
-
- 項目の意味が用語集にある場合は、備考に `tm-...` を併記して整合性を保ちます。
|
|
73
|
+
共通の必須・任意項目と値・型の制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] および `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。BDS 固有の指定は次のとおりです。
|
|
120
74
|
|
|
121
|
-
|
|
75
|
+
- `type` は本 rulebook の `deliverable_type` に対応する `ui`、`rulebook` は `specdojo:bds-rulebook` とします。
|
|
76
|
+
- `part_of` は所属する索引、`based_on` は実際に根拠とした業務プロセス・業務イベント・設計書を示します。未作成の文書を作成済みとして登録しません。
|
|
77
|
+
- 接続できない依存先や根拠は「メモ / 将来課題」へ記録します。空の `based_on` を埋めるために無関係な ID を追加しません。
|
|
122
78
|
|
|
123
|
-
|
|
124
|
-
- 算出式は、業務上の意味が分かる形で記述します(例: 「売上合計 = 数量 × 単価 の合計」)。
|
|
125
|
-
- 端数処理、税の扱い、丸め(四捨五入/切り捨て/切り上げ)は明記します。
|
|
79
|
+
## 5. 本文要件
|
|
126
80
|
|
|
127
|
-
|
|
81
|
+
次の順に構成します。Markdown の `##`〜`####` には階層ごとの連番と末尾の `.` を付け、章への参照は章タイトルで示します。
|
|
128
82
|
|
|
129
|
-
|
|
83
|
+
| 章 | 必須・任意 | 目的と内容要件 |
|
|
84
|
+
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------ |
|
|
85
|
+
| 概要 | 必須 | 帳票が何を示し、読み手が何を判断できるかを 1〜3 文で示す |
|
|
86
|
+
| 読み手と利用目的 | 必須 | 読み手ごとの利用目的と判断、作成・確認・承認の役割、対象外の用途と引き渡し先を示す |
|
|
87
|
+
| 出力の時期と契機 | 必須 | 出力の契機、対象期間の区切り方、取りこぼし・再出力の扱い、時刻の基準を示す |
|
|
88
|
+
| 出力形式と提供方法 | 必須 | 媒体・形式、保存先または配布先、1 回の出力で作る単位、出力物自体の本文構成の正本を示す |
|
|
89
|
+
| 対象範囲と元にする記録 | 必須 | 対象と対象外、元にする記録ごとの用途と正本、記録が欠けるときの扱いを示す |
|
|
90
|
+
| 表示項目 | 必須 | 項目ごとの意味、元にする記録、記録からの確かめ方を表で示す |
|
|
91
|
+
| 集計・算出ルール | 必須 | 期間への割り当て、件数・合計・差分の算出、重複と端数の扱いを示す。算出がない帳票は該当なしと理由を書く |
|
|
92
|
+
| 例外と注意事項 | 必須 | 対象 0 件、記録の欠落、再出力、出力の失敗などで読み手と作成者が取る対応を示す |
|
|
93
|
+
| メモ / 将来課題 | 任意 | 未作成の参照先、未確認の動作、未決事項の影響・担当・解消条件を示す。該当事項があれば省略しない |
|
|
130
94
|
|
|
131
|
-
##
|
|
95
|
+
## 6. 記述ガイド
|
|
132
96
|
|
|
133
|
-
|
|
134
|
-
- 記述は「業務用語」を優先し、略語は用語集にあるもののみ使用します。
|
|
97
|
+
各章は次の判断基準で記述します。完成例は frontmatter で宣言した sample を正本とし、ここには判断に必要な短い対比例だけを置きます。
|
|
135
98
|
|
|
136
|
-
|
|
99
|
+
### 6.1. 概要
|
|
137
100
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
| 実装クラス/関数名、ライブラリ名 | 実装依存で変更に弱い |
|
|
142
|
-
| レイアウト/座標/ピクセル指定 | 要求定義段階で過剰、変更に弱い |
|
|
143
|
-
| クリック手順の逐語列挙 | UI変更に弱い(必要なら UI 仕様へ) |
|
|
144
|
-
| 「正しく出る」等の曖昧表現 | 検証不能 |
|
|
101
|
+
- 判断基準: 帳票が示す対象・期間・観点と、読み手がそれで何を判断できるかが分かること。作成処理の説明は含めません。
|
|
102
|
+
- 良い例: 「1 週間分の作業の完了・進行・課題・翌週予定をまとめ、PM と PO が次週の優先度を判断する報告。」
|
|
103
|
+
- 悪い例: 「定期処理が作る週次ファイル。」読み手と判断が分かりません。
|
|
145
104
|
|
|
146
|
-
|
|
105
|
+
### 6.2. 読み手と利用目的
|
|
147
106
|
|
|
148
|
-
-
|
|
149
|
-
-
|
|
150
|
-
-
|
|
107
|
+
- 判断基準: 読み手ごとに利用目的と判断が対応し、作成・確認・承認を担う役割が分かること。責務は Role code、読み手の表示は役割名で示します。
|
|
108
|
+
- 対象外の用途(監査、会計、評価など)がある場合は、引き渡し先を示します。
|
|
109
|
+
- 推奨列は「読み手」「利用目的」「帳票から判断すること」です。
|
|
110
|
+
- 良い例: 「PO: 完了と未完了の差から、翌週に優先する成果物を判断する。」
|
|
111
|
+
- 悪い例: 「関係者全員が状況を把握する。」読み手と判断が特定できません。
|
|
151
112
|
|
|
152
|
-
|
|
113
|
+
### 6.3. 出力の時期と契機
|
|
153
114
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
title: 日次売上サマリ
|
|
159
|
-
status: draft
|
|
160
|
-
part_of: []
|
|
161
|
-
based_on: [bps-closing-daily, uis-closing, bes-sale-checkout]
|
|
162
|
-
supersedes: []
|
|
163
|
-
---
|
|
164
|
-
|
|
165
|
-
## 概要
|
|
115
|
+
- 判断基準: いつ、何を契機に、どの期間を対象に作るかが一意に読めること。時刻とタイムゾーンの基準、期間の始点・終点を含めます。
|
|
116
|
+
- 停止中に過ぎた回の扱い、同じ期間の再出力、手動出力の可否を区別します。契機の設定値の正本は定義ファイルや設計書を参照し、値を全文転載しません。
|
|
117
|
+
- 良い例: 「毎週金曜 17 時(日本時間)に当該 ISO 週を対象に作る。停止中に過ぎた週も 1 週ずつ作り、同じ週の再出力は新しい報告を増やさない。」
|
|
118
|
+
- 悪い例: 「週 1 回出力する。」曜日・時刻・期間の区切り・再出力が判断できません。
|
|
166
119
|
|
|
167
|
-
|
|
120
|
+
### 6.4. 出力形式と提供方法
|
|
168
121
|
|
|
169
|
-
|
|
122
|
+
- 判断基準: 読み手がどこで何を受け取るか、1 回の出力で何件できるかが分かること。
|
|
123
|
+
- 形式(文書、CSV、印刷、画面など)、保存先または配布先、ファイル単位を示します。CSV など機械可読な形式では、文字コード・見出し行・区切り文字の要否を業務上の前提として示します。
|
|
124
|
+
- 出力物自体の本文構成を定める rulebook があれば正本として参照し、章立てを再掲しません。
|
|
125
|
+
- 良い例: 「Markdown 文書として報告保存先へ 1 期間 1 件で保存する。本文の章立ては進捗報告の rulebook に従う。」
|
|
126
|
+
- 悪い例: 「ファイルで出す。」保存先・単位・構成の正本が分かりません。
|
|
170
127
|
|
|
171
|
-
|
|
172
|
-
- 利用目的: 日次の売上状況を把握し、締め処理の確認に使う
|
|
128
|
+
### 6.5. 対象範囲と元にする記録
|
|
173
129
|
|
|
174
|
-
|
|
130
|
+
- 判断基準: 帳票に含める記録と含めない記録を区別でき、各記録の正本と用途が分かること。
|
|
131
|
+
- 対象範囲は期間、対象組織・プロジェクト、状態、除外条件で示します。取消・差し戻しなどを含めるかを明記します。
|
|
132
|
+
- 元にする記録は「記録」「用途」「正本」「欠けるときの扱い」で示します。端末内だけに残る記録など、作成者が参照できない記録は区別します。
|
|
133
|
+
- 良い例: 「作業の完了は実行の状態記録から期間内に完了したものを数える。記録が読めない場合は報告を保留し、推測で補わない。」
|
|
134
|
+
- 悪い例: 「システムのデータを使う。」記録の種類、正本、欠落時の扱いが分かりません。
|
|
175
135
|
|
|
176
|
-
|
|
177
|
-
- 手動出力(必要に応じて再出力可)
|
|
136
|
+
### 6.6. 表示項目
|
|
178
137
|
|
|
179
|
-
|
|
138
|
+
- 判断基準: 各項目の意味と出所が分かり、記録から値を再現して確かめられること。レイアウトは指定せず、何が出力されるかを示します。
|
|
139
|
+
- 推奨列は次のとおりです。区分が不要な帳票では「区分」を省略できます。
|
|
180
140
|
|
|
181
|
-
|
|
141
|
+
| 列 | 記述する内容 |
|
|
142
|
+
| ------------------ | ------------------------------------------------------ |
|
|
143
|
+
| No | 項目の通し番号 |
|
|
144
|
+
| 区分 | 見出し、明細、集計、注記など |
|
|
145
|
+
| 項目名 | 帳票上の名前。用語集があれば用語集の表記に合わせる |
|
|
146
|
+
| 意味・定義 | 項目が表す内容と単位・書式 |
|
|
147
|
+
| 元にする記録 | 「対象範囲と元にする記録」の記録名。複数あれば列挙する |
|
|
148
|
+
| 記録からの確かめ方 | 値を記録から再現する手順、または照合する条件 |
|
|
182
149
|
|
|
183
|
-
|
|
150
|
+
- 良い例: 「完了事項: 期間内に完了したタスク ID。元にする記録は実行の状態記録。期間内に完了へ遷移したタスクと一致することを照合する。」
|
|
151
|
+
- 悪い例: 「完了事項: 完了したもの。」期間の判定と照合先がありません。
|
|
184
152
|
|
|
185
|
-
|
|
186
|
-
- 対象店舗: ログインユーザーの所属店舗
|
|
153
|
+
### 6.7. 集計・算出ルール
|
|
187
154
|
|
|
188
|
-
|
|
155
|
+
- 判断基準: 同じ記録から誰が算出しても同じ値になること。
|
|
156
|
+
- 記録を期間へ割り当てる時刻の基準、集計単位、件数・合計・差分の式、重複の除き方、端数処理を示します。
|
|
157
|
+
- 割合や進捗率を出す場合は分母・分子を定義します。根拠のない割合は出しません。
|
|
158
|
+
- 良い例: 「完了件数 = 期間内に完了へ遷移したタスクの件数。同じタスクが再度完了した場合は 1 件と数える。」
|
|
159
|
+
- 悪い例: 「進捗率を表示する。」分母・分子と判定時点が分かりません。
|
|
189
160
|
|
|
190
|
-
|
|
191
|
-
| --- | ------ | -------- | ---------------------- | ---------------- | ---------- | ------------------- |
|
|
192
|
-
| 1 | ヘッダ | 営業日 | 集計対象の営業日 | date(YYYY-MM-DD) | 2025-12-19 | - |
|
|
193
|
-
| 2 | 明細 | 売上合計 | 当日の売上合計 | integer(円) | 12345 | 税抜/税込は別ルール |
|
|
194
|
-
| 3 | 明細 | 取引件数 | 会計確定した取引の件数 | integer | 42 | - |
|
|
161
|
+
### 6.8. 例外と注意事項
|
|
195
162
|
|
|
196
|
-
|
|
163
|
+
- 判断基準: 通常と異なる状況で、帳票を作るか、何を表示するか、誰が何をするかが分かること。
|
|
164
|
+
- 対象 0 件、記録の欠落・不整合、停止中に過ぎた回、同じ期間の再出力、出力の失敗、締め前後の違いのうち該当するものを扱います。
|
|
165
|
+
- 良い例: 「対象期間に完了がない場合も報告を作り、完了事項に該当なしと書く。」
|
|
166
|
+
- 悪い例: 「エラー時は適切に対応する。」作成可否と対応者が分かりません。
|
|
197
167
|
|
|
198
|
-
|
|
199
|
-
- 端数処理: 税計算の端数は切り捨て(br-tax-rounding に従う)
|
|
168
|
+
### 6.9. メモ / 将来課題
|
|
200
169
|
|
|
201
|
-
|
|
170
|
+
- 判断基準: 確定した仕様と未確定事項が区別され、誰が何を確かめれば解消するかが分かること。恒久的な課題は登録簿へ担当と参照先を付けて引き継ぎます。
|
|
171
|
+
- 推奨列は「項目」「未整備事項と影響」「担当・解消条件」です。
|
|
172
|
+
- 良い例: 「期間の終点が未確定。PO が決め、QE が境界の期待結果を確かめるまで、週末の記録の扱いを受入対象外とする。」
|
|
173
|
+
- 悪い例: 「今後検討する。」影響・担当・解消条件が分かりません。
|
|
202
174
|
|
|
203
|
-
|
|
175
|
+
## 7. 禁止事項
|
|
204
176
|
|
|
205
|
-
|
|
177
|
+
| 禁止する記述 | 理由 |
|
|
178
|
+
| -------------------------------------------------------------- | ---------------------------------------------- |
|
|
179
|
+
| 物理テーブル名・物理カラム名・SQL 全文・実装クラス名・ツール名 | 概念レベルを逸脱し、実装変更に弱くなる |
|
|
180
|
+
| レイアウト・座標・フォントなどの見た目の指定 | 要求の段階で過剰であり、表示項目の判断を妨げる |
|
|
181
|
+
| 元にする記録や確かめ方のない表示項目 | 値の正しさを判定できない |
|
|
182
|
+
| 出力物の本文構成・記録の構造・契機の設定値の正本の再掲 | 二重管理になり、片方が取り残される |
|
|
183
|
+
| 根拠のない割合・進捗率、「正しく出る」などの曖昧な表現 | 検証できない |
|
|
184
|
+
| 本文への sample・recipe・template のリンク章や wikilink の設置 | 対応関係は frontmatter で宣言する |
|
|
185
|
+
|
|
186
|
+
## 8. 運用ルール
|
|
206
187
|
|
|
207
|
-
-
|
|
208
|
-
|
|
188
|
+
- 表示項目・元にする記録・出力の時期・算出規則が変わる場合は帳票仕様を改訂します。出力物の本文構成や記録の構造だけの変更は各正本へ反映し、参照先を確認します。
|
|
189
|
+
- 改訂・廃止は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従います。BA は索引・業務プロセス、ARC と DEV は契機・記録・実装、QE はテストへの影響を確認し、PM が追従作業を管理、PO が置き換え・廃止を判断します。
|
|
190
|
+
- 未確定の期間境界や未確認の出力経路は担当と解消条件を記録し、人が文書の確定可否を判断します。
|
|
191
|
+
- 確定の前提は、必須章がすべて記述され、各表示項目に元にする記録と確かめ方があり、「メモ / 将来課題」の未決事項に担当と解消条件が付いていることです。BA が読み手と利用目的、QE が確かめ方と例外時の期待結果を確認し、PO が `status` を `ready` にするかを判断します。
|
|
192
|
+
- 作成・改訂後は、利用リポジトリの package・hook 設定から適用する文書検査(Markdown 整形と lint、Frontmatter・参照の検査など)を確認して実行し、すべてエラーなく終了することを確かめます。検査の合格は表示項目の値の正しさの確認には代わりません。
|
|
@@ -5,99 +5,187 @@ specdojo:
|
|
|
5
5
|
deliverable_type: requirement
|
|
6
6
|
status: draft
|
|
7
7
|
target_format: markdown
|
|
8
|
-
recipe:
|
|
8
|
+
recipe: not-needed
|
|
9
9
|
sample: specdojo:bes-index-sample
|
|
10
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
#
|
|
13
|
+
# 業務イベント一覧(BES Index)作成ルール
|
|
14
14
|
|
|
15
15
|
Business Event Specification Index (BES Index) Documentation Rules
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
業務の各プロセス領域を起動する出来事を一覧にし、業務プロセス仕様・イベント処理設計・テスト設計が同じ出来事の単位を参照できるようにする入口文書の作成ルールです。一覧の網羅範囲、行の粒度、個別の業務イベント仕様(BES)へ詳細化する判断を定めます。
|
|
18
18
|
|
|
19
19
|
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
21
|
+
- 一つのシステムまたは合意した対象範囲につき、業務イベント一覧の正本を一つにします。範囲は上位の概念データフロー図(全体概要)が定めるプロセス領域とし、一覧の行はその起点イベントから起こします。
|
|
22
|
+
- 網羅は上位のプロセス領域に対して判定します。すべての領域に一つ以上の行が対応し、どの行も一つの領域へたどれる状態を目指します。領域の内部で生じる出来事は、上位文書の起点イベントでない限り一覧に加えません。
|
|
23
|
+
- 一行は一つの業務上の出来事を、発生した事実として過去形で表します。処理手順、画面操作、実装上のメッセージは扱いません。
|
|
24
|
+
- 一行で発生境界・時点・起点・相関を判定できない出来事だけを個別 BES へ詳細化します。詳細化の要否の判断と個別仕様の書き方は [[specdojo:bes-rulebook|業務イベント仕様 作成ルール]] を正本とします。
|
|
25
|
+
- 上位文書から確認できた内容と、推定・未決の内容を分けます。範囲の承認は人間の PO が担い、承認までは `status: draft` を維持します。
|
|
26
|
+
- 本書の `ready` 化には、ARC による完成例と本文要件の照合、recipe・template の要否判断の記録、QE による未解決指摘の確認を要します。残る判断は `_UNDECIDED_:` として影響・判断者・次のアクションを記録し、人間の PO が公開可否を判断します。
|
|
24
27
|
|
|
25
28
|
## 2. 位置づけと用語定義
|
|
26
29
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
+
| 文書・用語 | 本書での意味・責務 |
|
|
31
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| 概念データフロー図(全体概要) | プロセス領域の分割、領域 ID、起点イベントの文言の正本。一覧の網羅を判定する基準になる |
|
|
33
|
+
| 業務イベント一覧(BES Index) | 起点イベントを行として並べ、イベント ID・発生条件・事実データの概要と個別仕様への入口を持つ |
|
|
34
|
+
| 業務イベント仕様(BES) | 一覧の行、または行の一部の成立の仕方について、発生境界を詳細化する個別仕様 |
|
|
35
|
+
| 業務プロセス仕様(BPS) | イベントを受けた後の手順を定める。イベントとプロセスの起動関係は BPS 側で記述する |
|
|
36
|
+
| 業務ルール・状態定義 | 判定の規則と状態の意味・遷移の正本。一覧には発生に必要な条件の要旨だけを置く |
|
|
37
|
+
| 起点イベント | プロセス領域を起動する業務上の出来事。一覧の行の出典 |
|
|
38
|
+
| 事実データ | 出来事の発生時点で観測できる業務上の情報。項目の構造・値・構文はデータモデル・schema を正本とする |
|
|
39
|
+
|
|
40
|
+
- **主要な関係者(Role code)と確認観点**:
|
|
41
|
+
- **BA(主作成者)**: 起点イベントの網羅、行の粒度、事実データの業務上の意味を定義する。
|
|
42
|
+
- **PO(承認者)**: 一覧の範囲と、未決事項を制限事項として受け入れるかを判断する。
|
|
43
|
+
- **ARC(確認者)**: 上位文書・個別 BES・データモデルとの構造整合と、イベント処理設計の入力としての単位を確認する。
|
|
44
|
+
- **QE(確認者)**: 発生条件から発生する場合・しない場合を判定でき、テスト設計で網羅を確かめられるかを確認する。
|
|
45
|
+
- **主な利用者(Role code)**: BA は BPS・BR、UX は UI 仕様、QE はテスト仕様の作成時にイベント ID と発生条件を参照します。ARC・DEV は個別 BES とデータモデルを併せてイベント処理設計へ接続します。
|
|
30
46
|
|
|
31
47
|
## 3. ファイル命名・ID規則
|
|
32
48
|
|
|
33
|
-
|
|
49
|
+
- ファイル名は `bes-index.md`、文書 ID は `bes-index` を基本とし、プロジェクト配下ではそのプロジェクトの authority を付けます。命名・配置の共通規則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正本とします。
|
|
50
|
+
- 一覧のイベント ID は `bes-<event>` とし、`<event>` は出来事を区別できる英小文字・数字・ハイフンのスラッグにします(例: `bes-cash-sale-confirmed`)。`^bes-[a-z0-9][a-z0-9-]*$` に適合し、廃止行を含め一覧の中で一意にします。
|
|
51
|
+
- 個別 BES が行の全体を詳細化する場合は、個別 BES の文書 ID を行のイベント ID と一致させます。行の一部の成立の仕方だけを詳細化する場合は、個別 BES に別の ID を付け、「個別仕様への詳細化」の表で対応を示します。sample の文書 ID はメタ情報標準に従って実物と区別し、イベント ID との対応を詳細化表で示します。
|
|
52
|
+
- 既存文書への参照は相対パスではなく、project 修飾 doc id の `[[id|title]]` 形式を使います。表のセル内では `[[id\|title]]` とし、未作成文書は文書 ID をインラインコードで仮置きします。詳細化表から個別 BES へリンクし、個別 BES からも一覧と対応行のイベント ID を識別できるようにします。
|
|
34
53
|
|
|
35
|
-
|
|
36
|
-
- 一覧表のイベントIDは `^bes-[a-z0-9][a-z0-9-]*$` に合致する一意IDを用いる。
|
|
37
|
-
- 個別 BES ドキュメントを作成する場合、イベントIDとファイル名を対応させる(例: `bes-sale-checkout` ↔ `bes-sale-checkout.md`)。
|
|
54
|
+
### 3.1. 追加・変更・廃止の管理
|
|
38
55
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
- 相対リンクで一覧から個別仕様へ遷移できる命名・配置を維持する。
|
|
56
|
+
- 新規追加時は BA が上位文書の起点イベントと既存行を照合し、重複のない ID と必須列を記入します。上位にない出来事は先に上位文書の範囲を確認し、ARC が詳細化の要否、QE が発生・不成立の判定を確認します。
|
|
57
|
+
- イベント ID は再利用しません。廃止・置換時は行を残し、イベント名に「(廃止)」を付け、発生条件に廃止理由・時期・後継 ID(なければ代替運用)を記載します。廃止行を現行領域の網羅件数に含めず、有効な参照元は後継または代替へ更新します。
|
|
58
|
+
- ID の変更・廃止時は BA が個別 BES・BPS・BR、UX が UI、QE がテスト仕様・受入条件の参照を抽出して更新し、ARC・DEV がデータモデル・イベント契約・実装への影響を確認します。未完の追従は PM が担当と移行時期を持つ PJR 項目へ引き継ぎます。
|
|
59
|
+
- 文書を置き換える場合は、新しい一覧または個別 BES の `supersedes` に旧文書 ID を指定します。文書でない一覧の行 ID は Frontmatter の `supersedes` に入れず、旧行と新行の対応を本文で示します。文書の廃止・承認は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従います。
|
|
44
60
|
|
|
45
61
|
## 4. 推奨 Frontmatter 項目
|
|
46
62
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
63
|
+
項目の構文と許容値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`(共通項目は `common-frontmatter.schema.yaml`)を正本とします。本書自身のメタ情報は [[specdojo:rulebook-authoring-standard|Rulebook 記述標準]] と `docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml` に従います。
|
|
64
|
+
|
|
65
|
+
| 項目 | 必須 | 値・記述内容 |
|
|
66
|
+
| ------------ | -------- | -------------------------------------------------------------- |
|
|
67
|
+
| `id` | ○ | `bes-index` 系の ID |
|
|
68
|
+
| `type` | ○ | `requirement` |
|
|
69
|
+
| `status` | ○ | `draft` / `ready` / `deprecated`。`ready` への昇格は人間が行う |
|
|
70
|
+
| `rulebook` | 推奨 | `specdojo:bes-index-rulebook` |
|
|
71
|
+
| `based_on` | 推奨 | 起点イベントの出典とした概念データフロー図(全体概要)の ID |
|
|
72
|
+
| `supersedes` | 条件付き | 既存の業務イベント一覧を置き換える場合の旧文書 ID 配列 |
|
|
73
|
+
|
|
74
|
+
## 5. 本文要件
|
|
75
|
+
|
|
76
|
+
template は置かないため、以下を本文構成の基準とします。Markdown の `##`〜`####` には階層ごとに連番と末尾の `.` を付けます。
|
|
77
|
+
|
|
78
|
+
| 記述対象 | 必須・任意 | 判定基準 |
|
|
79
|
+
| ------------------ | ----------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
80
|
+
| 冒頭の概要 | 必須 | 対象範囲、起点イベントの出典、一覧の利用者と委譲先(BES・BPS・BR・状態定義)が分かる |
|
|
81
|
+
| 業務イベント一覧 | 必須 | 上位文書のすべての起点イベントが行に対応し、各行が下表の列を満たす |
|
|
82
|
+
| 個別仕様への詳細化 | 個別 BES がある、または予定する場合 | 詳細化する行、個別仕様、詳細化する範囲、理由を対応させる |
|
|
83
|
+
| 未決事項と承認条件 | 未決・推定の内容がある場合 | 論点、現時点の扱い、判断者・確認担当、解消の時期と記録先、一覧を確定入力として扱う条件を示す |
|
|
84
|
+
|
|
85
|
+
「個別仕様への詳細化」「未決事項と承認条件」は該当する内容がなければ省略できます。目的・適用範囲は冒頭の概要にまとめ、独立章の追加は任意とします。処理手順・構文・データ構造の詳細を記す章は不要であり、それぞれの正本を参照します。
|
|
54
86
|
|
|
55
|
-
|
|
87
|
+
### 5.1. 業務イベント一覧の列
|
|
56
88
|
|
|
57
|
-
|
|
58
|
-
| --- | ---------------------- | ---- |
|
|
59
|
-
| 1 | 業務イベント一覧(表) | ○ |
|
|
89
|
+
列順は次の表の順に固定します。
|
|
60
90
|
|
|
61
|
-
|
|
91
|
+
| 列名 | 必須 | 記述内容 |
|
|
92
|
+
| ------------ | ---- | ---------------------------------------------------------- |
|
|
93
|
+
| イベントID | ○ | 「ファイル命名・ID規則」に従う一意の ID |
|
|
94
|
+
| イベント名 | ○ | 業務の利用者が理解できる過去形の日本語名 |
|
|
95
|
+
| 起点領域 | ○ | 起動するプロセス領域の領域 ID |
|
|
96
|
+
| 何が起きたか | ○ | 成立した業務上の事実を一文で記述する |
|
|
97
|
+
| いつ | ○ | 発生時点として観測する時点。要求・確定・後処理の区別を示す |
|
|
98
|
+
| 誰が/何が | ○ | 出来事を起こす人・システム・外部、または時間の経過 |
|
|
99
|
+
| 発生条件 | ○ | 成立に必要な条件の要旨。成立の仕方が複数あれば区別する |
|
|
100
|
+
| 事実データ | ○ | 発生時点で観測できる情報の業務上の概念名 |
|
|
62
101
|
|
|
63
|
-
|
|
64
|
-
| ------------ | ------------------------------------- | ---- |
|
|
65
|
-
| イベントID | 一意識別子(例: `bes-sale-checkout`) | ○ |
|
|
66
|
-
| イベント名 | 業務ユーザーが理解可能な日本語名 | ○ |
|
|
67
|
-
| 何が起きたか | 業務的出来事を一文で記述 | ○ |
|
|
68
|
-
| いつ | 発生タイミング・周期 | ○ |
|
|
69
|
-
| 誰が/何が | 人・システム・外部の起点 | ○ |
|
|
70
|
-
| 発生条件 | 観測条件・成立条件 | ○ |
|
|
71
|
-
| 事実データ | 観測可能情報(概念レベル) | ○ |
|
|
102
|
+
列の追加・削除・意味の変更時は、ARC が rulebook の本文要件と sample の対応を確認し、BA が一覧・個別 BES・BPS・BR、UX が UI、QE がテスト仕様の利用箇所を照合して、影響する記述を同じ変更の採用時に更新します。契約・schema への影響は DEV と確認し、値・構文・構造をこの一覧へ複製しません。
|
|
72
103
|
|
|
73
|
-
### 5.2.
|
|
104
|
+
### 5.2. 個別仕様への詳細化の列
|
|
74
105
|
|
|
75
|
-
|
|
76
|
-
|
|
106
|
+
| 列名 | 必須 | 記述内容 |
|
|
107
|
+
| -------------- | ---- | ----------------------------------------------------------- |
|
|
108
|
+
| イベントID | ○ | 詳細化する一覧の行 |
|
|
109
|
+
| 個別仕様 | ○ | 個別 BES へのリンク。未作成なら文書 ID を仮置きして明示する |
|
|
110
|
+
| 詳細化する範囲 | ○ | 行の全体か、行の一部の成立の仕方か |
|
|
111
|
+
| 詳細化の理由 | ○ | 一行では判定できない点(境界・時点・起点・相関のどれか) |
|
|
77
112
|
|
|
78
113
|
## 6. 記述ガイド
|
|
79
114
|
|
|
80
|
-
|
|
115
|
+
上位文書の領域 ID・領域名・起点イベントの文言は転記で済ませ、一覧では発生の判定に要る情報を足します。共通の対象範囲と用語は一覧を正本とし、個別 BES では差分だけを具体化します。
|
|
116
|
+
|
|
117
|
+
### 6.1. 冒頭の概要
|
|
118
|
+
|
|
119
|
+
- 判断基準: 読者が、何を網羅した一覧か、何を一覧で扱わずどこへ委ねるかを説明できるようにします。
|
|
120
|
+
- 良い例: 「概念データフロー図(全体概要)の 10 領域の起点イベントを一覧にする。受けた後の手順は BPS、金額の計算は BR に委ねる。」
|
|
121
|
+
- 悪い例: 「システムで発生するイベントをまとめる。」範囲も網羅の基準も分かりません。
|
|
122
|
+
|
|
123
|
+
### 6.2. 行の切り出し
|
|
124
|
+
|
|
125
|
+
- 判断基準: 上位文書の起点イベントに「、」で別々の出来事が並ぶ場合は行を分け、「または」で同じ出来事の成立の仕方が並ぶ場合は一行にして発生条件で区別します。複数の領域に同じ出来事が書かれていても、同じ事実か判断できなければ別の行にして未決事項へ挙げます。
|
|
126
|
+
- 良い例: 「『閉店した』と『月末の締めが確定した』を別の行にする。」
|
|
127
|
+
- 悪い例: 「締めに関する出来事をまとめて一行にする。」発生時点も起点領域も一つに決まりません。
|
|
128
|
+
|
|
129
|
+
### 6.3. 何が起きたか・イベント名
|
|
130
|
+
|
|
131
|
+
- 判断基準: 成立した事実を過去形で書き、処理や操作の名前にしません。名前だけで隣接する出来事と区別できるようにします。
|
|
132
|
+
- 良い例: 「店頭の現金会計が確定した」
|
|
133
|
+
- 悪い例: 「会計処理」出来事なのか手順なのか判定できません。
|
|
134
|
+
|
|
135
|
+
### 6.4. いつ
|
|
136
|
+
|
|
137
|
+
- 判断基準: 要求・受付・確定・後処理の完了のどれを発生時点とするかを示します。周期で到来する出来事は、周期の定めに達した時点とします。
|
|
138
|
+
- 良い例: 「店番担当が受領を確認して確定した時点。控えの印字完了は待たない。」
|
|
139
|
+
- 悪い例: 「会計時」入力・確定・印字のどれか分かりません。
|
|
140
|
+
|
|
141
|
+
### 6.5. 誰が/何が
|
|
142
|
+
|
|
143
|
+
- 判断基準: 出来事を起こす主体を Role code・役割名・システムの責務名で書きます。時間の経過で生じる出来事は、その旨を書き、担当者を当てはめません。承認の責任と出来事を起こす主体は分けます。
|
|
144
|
+
- 良い例: 「店番担当(管理責任: 店主代表)」「時間の経過(閉店時刻)」
|
|
145
|
+
- 悪い例: 「担当者またはシステム」どちらが起こすのか分かりません。
|
|
146
|
+
|
|
147
|
+
### 6.6. 発生条件
|
|
148
|
+
|
|
149
|
+
- 判断基準: 成立に必要な条件の要旨を書き、判定の規則そのものは BR、状態の遷移は状態定義を参照します。発生しない典型の場合が判定に要るなら、条件の否定として読める形にします。
|
|
150
|
+
- 良い例: 「受領金額が請求金額以上で、未確定の取引である。」
|
|
151
|
+
- 悪い例: 「会計可能な場合」判定の根拠がありません。
|
|
152
|
+
|
|
153
|
+
### 6.7. 事実データ
|
|
154
|
+
|
|
155
|
+
- 判断基準: 発生時点で観測できる情報だけを業務上の概念名で挙げます。発生後にしか分からない結果は含めません。正本のデータモデルと照合していない場合は、その旨を未決事項に残します。
|
|
156
|
+
- 良い例: 「取引番号、確定時点、確定担当、請求金額」
|
|
157
|
+
- 悪い例: 「`sales_tbl.amt`、処理結果」物理名と、発生後の結果が混ざっています。
|
|
158
|
+
|
|
159
|
+
### 6.8. 個別仕様への詳細化
|
|
81
160
|
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
-
|
|
161
|
+
- 判断基準: 一行では境界・時点・起点・相関のどれかを判定できない行だけを詳細化します。行の一部だけを詳細化する場合は範囲を書き、残りが一覧の定義のままであることが分かるようにします。未作成の個別仕様は wikilink にせず、文書 ID を仮置きします。
|
|
162
|
+
- 良い例: 「つけ販売の受付は、上限超過時に受付と承認のどちらで成立するかが割れるため個別仕様へ詳細化する。」
|
|
163
|
+
- 悪い例: 「重要なので個別仕様を作る。」何が一行で判定できないのか分かりません。
|
|
85
164
|
|
|
86
|
-
### 6.
|
|
165
|
+
### 6.9. 未決事項と承認条件
|
|
87
166
|
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
-
|
|
167
|
+
- 判断基準: 推定で埋めた列、上位文書から判断できない境界、正本との未照合を論点として残し、判断者・確認担当・時期・記録先を添えます。確定入力として扱える条件を一文で示します。
|
|
168
|
+
- 良い例: 「事実データは販売記録のデータモデルと未照合。ARC がイベント処理設計への引き渡し前に確認する。」
|
|
169
|
+
- 悪い例: 「詳細は今後検討する。」誰がいつ何を決めるのか分かりません。
|
|
91
170
|
|
|
92
|
-
### 6.
|
|
171
|
+
### 6.10. 検証と引き渡し
|
|
93
172
|
|
|
94
|
-
-
|
|
95
|
-
-
|
|
96
|
-
-
|
|
173
|
+
- 判断基準: BA・QE が上位領域と有効な行の対応、必須列、ID の形式と一意性、個別 BES の対応範囲、未決事項の扱いを照合できることを引き渡し条件とします。ID は「業務イベント一覧」の表から抽出し、「ファイル命名・ID規則」の正規表現へ全件適合し、廃止行を含む重複が 0 件であることを確認します。
|
|
174
|
+
- Markdown は `npm run lint:md`、Frontmatter は `npm run lint:fm` でエラーがないことを確認します。これらの lint は行 ID の一意性や業務上の網羅を保証しないため、前項の照合を別に記録します。executor / reporter pipeline で親検証に設定されているコマンドは runner の結果を用います。
|
|
175
|
+
- 良い例: 「14 領域に有効な 16 行が対応し、廃止行を含む ID の形式違反・重複は 0 件。事実データの未照合は ARC がテスト設計への引き渡し前に確認する。」
|
|
176
|
+
- 悪い例: 「lint が通ったので網羅・承認済み。」静的検査では業務範囲や承認を判定できません。
|
|
97
177
|
|
|
98
178
|
## 7. 禁止事項
|
|
99
179
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
180
|
+
| 禁止する記述・扱い | 理由 |
|
|
181
|
+
| ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
|
|
182
|
+
| 上位文書にない領域・起点イベントを、根拠なく一覧へ追加する | 網羅の基準が崩れ、範囲を誤って確定するため |
|
|
183
|
+
| 上位文書の起点イベントに対応する行を欠く | 下流の BPS・テスト設計が出来事を取りこぼすため |
|
|
184
|
+
| 処理手順、画面の操作、例外時の回復を一覧に書く | BPS・画面仕様の責務と重複するため |
|
|
185
|
+
| BR の判定規則や状態遷移表を一覧に複製する | 正本の変更に追従できなくなるため |
|
|
186
|
+
| 発生条件・事実データを「その他」「適宜」「など」で省略し、成立条件や対象項目を特定できなくする | 発生有無と必要な情報の充足を判定できないため |
|
|
187
|
+
| 物理テーブル・カラム、SQL、実装クラス・関数、API、コマンドの構文を記載する | 概念上の出来事と実装契約を混同するため |
|
|
188
|
+
| 発生後にしか分からない結果を事実データにする | 観測時点と事実が矛盾するため |
|
|
189
|
+
| 未作成の個別仕様を存在するようにリンクする | 参照切れと、詳細化済みとの誤認を招くため |
|
|
190
|
+
| 廃止したイベント ID を別の出来事に再利用する | 参照元の BPS・テストが別の出来事を指してしまうため |
|
|
191
|
+
| 推定や未決の内容を確定済みとして表し、範囲の承認前に確定入力とする | 下流が不確かな前提で設計・検証を始めるため |
|