specdojo 0.8.0 → 0.9.1
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 +4 -1
- package/CHANGELOG.md +77 -0
- package/dist/catalog/catalog.js +16 -14
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +4 -2
- package/dist/commands/orchestrator.js +5 -77
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/shared.js +2 -2
- package/dist/dashboard/timeline.js +14 -14
- package/dist/deliverable/trash.js +2 -1
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +146 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +9 -0
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +31 -18
- package/dist/exec/events.js +34 -14
- package/dist/exec/evidence.js +13 -3
- package/dist/exec/opencode-permissions.js +117 -0
- package/dist/exec/parent-validation.js +56 -3
- package/dist/exec/plans-core.js +21 -2
- package/dist/exec/plans-generation.js +6 -7
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +82 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/repo-trace.js +2 -1
- package/dist/exec/reporter.js +2 -2
- package/dist/exec/results.js +24 -4
- package/dist/exec/review-kata.js +4 -1
- package/dist/exec/run/agent-pipeline.js +3 -2
- package/dist/exec/run/agent.js +12 -6
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +5 -2
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +56 -19
- package/dist/exec/run/lifecycle-commands.js +1 -1
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/register-command.js +8 -5
- package/dist/exec/run/register-mode.js +68 -8
- package/dist/exec/run/register-resume.js +68 -14
- package/dist/exec/run/register-state.js +13 -8
- package/dist/exec/run/register-worktree.js +140 -125
- package/dist/exec/run/schedule-mode.js +75 -14
- package/dist/exec/run/schedule-prepare.js +3 -0
- package/dist/exec/run/schedule-task.js +88 -38
- package/dist/exec/run/shared.js +5 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +2 -2
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-repos.js +19 -4
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trial-commands.js +5 -2
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +12 -2
- package/dist/exec/worktree-ops-commit.js +2 -2
- package/dist/exec/worktree.js +13 -2
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +5 -3
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +5 -1
- package/dist/grade/run.js +64 -8
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +79 -23
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/maintenance-commands.js +2 -2
- package/dist/register/register.js +31 -7
- package/dist/register/renumber.js +1 -3
- package/dist/routine/definition.js +9 -0
- package/dist/routine/routine.js +137 -43
- package/dist/routine/status.js +62 -0
- package/dist/schedule/schedule.js +38 -39
- package/dist/shared/agent-types.js +5 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +44 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/specdojo-config.js +34 -20
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +17 -1
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
- package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
- package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
- package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
- package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
- package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
- package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
- package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
- package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +258 -118
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +47 -10
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bds-sample.md +58 -71
- package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
- package/docs/ja/specdojo/samples/bes-sample.md +43 -53
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +40 -52
- package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
- package/docs/ja/specdojo/samples/clis-sample.md +70 -77
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
- package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
- package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
- package/docs/ja/specdojo/samples/sf-sample.md +73 -85
- package/docs/ja/specdojo/samples/sld-sample.md +60 -79
- package/docs/ja/specdojo/samples/uis-sample.md +98 -121
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +9 -6
- package/templates/antigravity/orchestrator.md +4 -1
- package/templates/claude/agents/specdojo-orchestrator.md +4 -1
- package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
- package/templates/codex/orchestrator.md +4 -1
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
|
@@ -13,25 +13,20 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
System Test Catalog (STC) Documentation Rules
|
|
15
15
|
|
|
16
|
-
本ドキュメントは、総合テストカタログ(STC)の対象別 `stc-<term>` を統一形式で記述するためのルールです。
|
|
17
|
-
`stc-index` を前提に、SSOTの本体として、対象ごとの **総合テストの目的・責務・境界・環境前提、観点 x 条件=ケース、トレース、証跡** を明文化します。
|
|
18
|
-
|
|
19
16
|
## 1. 全体方針
|
|
20
17
|
|
|
21
|
-
個別 STC(`stc-<term>`)は、総合テストにおける SSOT
|
|
22
|
-
観点×条件=ケース(末端表)を最小情報で整理して、テスト実装/CI/テストレポート証跡へ確実に接続できる形で記述する。
|
|
18
|
+
個別 STC(`stc-<term>`)は、総合テストにおける SSOT の本体として、対象ごとの狙いと境界を明確化し、観点×条件=ケース(末端表)を最小情報で整理して、テスト実装/CI/テストレポート証跡へ接続できる形で記述する。
|
|
23
19
|
|
|
24
20
|
- `stc-<term>` は **対象固有の情報のみ** を記述し、共通ルールは `stc-index` を参照する(重複記述しない)
|
|
25
21
|
- 総合テストの目的は「**実運用に近い経路で、システム全体として業務が成立すること**」の確認である
|
|
26
22
|
- ケースは「表の1行=1テスト(1シナリオ)」とし、手順と期待値は **判定可能** な粒度で簡潔に書く
|
|
27
|
-
-
|
|
28
|
-
-
|
|
23
|
+
- 手順は **高位の行動** と **観測点** に寄せ、クリック列挙や画面要素の細部はテストコードへ寄せる
|
|
24
|
+
- すべての観点・ケースは、根拠仕様(`トレース`)と証跡(CI/レポート/ログ相関等)に接続されていること
|
|
29
25
|
- 環境・テストデータ・外部依存(sandbox/スタブ等)は **再現性** を優先し、対象ごとに無根拠に変更しない(例外は根拠を明記)
|
|
26
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、ケースの期待値や証跡に含めない。
|
|
30
27
|
|
|
31
28
|
## 2. 位置づけ(他ドキュメントとの関係)
|
|
32
29
|
|
|
33
|
-
個別 STC(`stc-<term>`)と他ドキュメントの関係を示します。
|
|
34
|
-
|
|
35
30
|
```mermaid
|
|
36
31
|
flowchart BT
|
|
37
32
|
TSP["tsp-index<br>テスト戦略・方針"]
|
|
@@ -56,34 +51,22 @@ flowchart BT
|
|
|
56
51
|
|
|
57
52
|
- `id` は `stc-<term>`(kebab-case。例: `stc-order-place`)。
|
|
58
53
|
- ファイル名は `stc-010-総合テストカタログ-<term>.md` 等(例: `stc-010-総合テストカタログ-注文確定.md`)。
|
|
59
|
-
- `<term>` は用語集(GL) の論理名キー(英小文字kebab-case)を用いる(表示名は
|
|
54
|
+
- `<term>` は用語集(GL) の論理名キー(英小文字kebab-case)を用いる(表示名は H1 / ファイル名で日本語を使用してよい)。
|
|
55
|
+
- H1 は `# 総合テストカタログ: <対象名>` とする。
|
|
60
56
|
|
|
61
57
|
## 4. 推奨 Frontmatter 項目
|
|
62
58
|
|
|
63
59
|
### 4.1. 設定内容
|
|
64
60
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
68
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
61
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
69
62
|
|
|
70
|
-
|
|
71
|
-
| ---------- | -------------------------------------------------------------------------------- | ---- |
|
|
72
|
-
| id | STC ID(個別: `stc-<term>`) | ○ |
|
|
73
|
-
| type | `test` 固定 | ○ |
|
|
74
|
-
| title | 総合テストカタログ: <対象名> | ○ |
|
|
75
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
76
|
-
| based_on | 根拠仕様(最低限: `tsp-index`, `stc-index`。対象固有の根拠は本文トレースに集約) | ○ |
|
|
77
|
-
| part_of | 集約ドキュメントへの所属(ID配列) | 任意 |
|
|
78
|
-
| supersedes | 置き換え関係(ID配列) | 任意 |
|
|
63
|
+
- `specdojo.type` は `test`、`specdojo.rulebook` は `specdojo:stc-rulebook` とする。
|
|
79
64
|
|
|
80
65
|
### 4.2. 推奨ルール
|
|
81
66
|
|
|
82
|
-
- `based_on` は原則 `[tsp-index, stc-index]` を最低限とする。
|
|
83
|
-
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` / `ac-*` / `issue-*`
|
|
84
|
-
|
|
85
|
-
- 記述内容が多くなる場合は、対象を分割し、`part_of` で集約ドキュメントに所属させる。
|
|
86
|
-
- `part_of` / `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
|
|
67
|
+
- `specdojo.based_on` は原則 `[tsp-index, stc-index]` を最低限とする。
|
|
68
|
+
- 対象固有の根拠(`br-*` / `bac-*` / `spec-*` / `nfr-*` / `ac-*` / `issue-*` 等)は本文「トレース」に集約する。機械処理上の都合で `based_on` にも列挙する場合は、本文トレースと矛盾しないこと。
|
|
69
|
+
- 記述内容が多くなる場合は、対象を分割し、`specdojo.part_of` で集約ドキュメントに所属させる。
|
|
87
70
|
|
|
88
71
|
## 5. 本文構成(標準テンプレ)
|
|
89
72
|
|
|
@@ -98,8 +81,7 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
98
81
|
| 5 | トレース | ○ |
|
|
99
82
|
| 6 | テスト観点とケース | ○ |
|
|
100
83
|
|
|
101
|
-
|
|
102
|
-
生成する `stc-<term>` 本文の見出しは各章で指定された **番号付き** の形式に置き換えてください。
|
|
84
|
+
次章の見出しは参照用であり、生成する本文の見出しは各章で指定する番号付きの形式とします。
|
|
103
85
|
|
|
104
86
|
## 6. 記述ガイド
|
|
105
87
|
|
|
@@ -107,10 +89,7 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
107
89
|
|
|
108
90
|
生成する `stc-<term>` 本文の見出しは **## 1. 概要(<term>)**
|
|
109
91
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
- `<term>` の説明(1〜3行):業務/ユーザ価値のまとまりとして記述する(開始条件→完了条件が想像できる形)
|
|
113
|
-
- 期待する利用者:レビューア/実装者/テスト実装者が前提を把握できる内容にする
|
|
92
|
+
- `<term>` の説明(1〜3行):本カタログで扱う業務シナリオ/経路を、開始条件→完了条件が想像できる形で書く
|
|
114
93
|
- 対象の粒度:`stc-index` の分割基準に従い、過分割/肥大化を避ける
|
|
115
94
|
- 関連コンポーネントや主要I/F(任意):主要画面、API、バッチ、イベント等を列挙してよい
|
|
116
95
|
- 詳細な仕様説明や長い背景は書かない(根拠はトレースで示す)
|
|
@@ -119,65 +98,40 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
119
98
|
|
|
120
99
|
生成する `stc-<term>` 本文の見出しは **## 2. 目的**
|
|
121
100
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
- 箇条書きで 3〜7 個程度を目安に、**動詞で始まる** 形で記述する
|
|
101
|
+
- 「この対象で何を保証したいか(狙い)」を、3〜7 個程度、**動詞で始まる** 箇条書きで記述する
|
|
125
102
|
- 例:主要業務フローが完了できる/主要分岐で破綻しない/再実行で二重処理しない/監査証跡が残る
|
|
126
|
-
|
|
127
103
|
- 目的は観点の上位概念であり、観点は目的を分解した切り口(目的≠観点)
|
|
128
104
|
- 可能なら観測可能な成果(画面表示、API応答、DB状態、イベント、ログ相関ID等)とセットで書く
|
|
129
|
-
-
|
|
105
|
+
- 目的に含まれないものは「対象外」へ移す
|
|
130
106
|
|
|
131
107
|
### 6.3. 対象外
|
|
132
108
|
|
|
133
109
|
生成する `stc-<term>` 本文の見出しは **## 3. 対象外**
|
|
134
110
|
|
|
135
|
-
本節では、「この対象カタログ(`stc-<term>`)ではやらないこと」を明示します。
|
|
136
111
|
`stc-index` の「対象外・除外理由(共通)」と矛盾しないことが前提です。
|
|
137
112
|
|
|
138
|
-
-
|
|
139
|
-
- 可能なら「代替するレベル」(UT/IT/ET/AT/NFR 等)も併記する
|
|
140
|
-
- 対象固有の対象外(例:別業務フロー、別サブシステムの責務)を明確にする
|
|
113
|
+
- 対象外は「理由」と、可能なら「代替するレベル」(UT/IT/ET/AT/NFR 等)を併記する(形式:`対象外:xxx(理由:yyy、代替:zzz)`)
|
|
141
114
|
- 例外としてSTで扱う場合は、条件・根拠・環境前提(sandbox/スタブ/データ準備)を明記する
|
|
142
115
|
|
|
143
|
-
推奨フォーマット(簡易):
|
|
144
|
-
|
|
145
|
-
- 対象外:xxx(理由:yyy、代替:zzz)
|
|
146
|
-
|
|
147
116
|
### 6.4. 境界/環境/依存
|
|
148
117
|
|
|
149
118
|
生成する `stc-<term>` 本文の見出しは **## 4. 境界/環境/依存**
|
|
150
119
|
|
|
151
|
-
本節では、総合テストにおける「境界(どこからどこまでが対象か)」と
|
|
152
|
-
「環境前提」「外部依存(sandbox/スタブ/疑似等)」を明確にします。
|
|
153
|
-
|
|
154
120
|
- 境界:開始トリガ/入口(画面/API/バッチ等)と、完了条件/出口(完了状態、発行イベント等)を明記する
|
|
155
121
|
- 環境:ST環境名、主要設定、テストデータの準備・後始末(namespace/初期化/削除)を列挙する
|
|
156
|
-
-
|
|
157
|
-
|
|
158
|
-
- メール/SMS/Push:ダミー配送・検証用受信箱・ログ確認の方針
|
|
159
|
-
- 決済/配送など:本番課金/実配送は原則しない(例外は条件を明記)
|
|
160
|
-
|
|
161
|
-
- 観測点(Evidence):何を見て合否判定するかを明記する
|
|
162
|
-
- 画面/レスポンス、DB状態、イベント、監査ログ、相関ID、外部リクエストID 等
|
|
163
|
-
|
|
122
|
+
- 外部依存:依存先ごとに sandbox/スタブ/疑似応答(成功/代表失敗/一時不可など)、ダミー配送などの扱いを決める。本番課金/実配送は原則しない(例外は条件を明記)
|
|
123
|
+
- 観測点(Evidence):何を見て合否判定するか(画面/レスポンス、DB状態、イベント、監査ログ、相関ID 等)を明記する
|
|
164
124
|
- 例外:環境や依存の扱いを変える場合は、理由と影響(再現性・コスト・安全性)を明記する
|
|
165
125
|
|
|
166
126
|
### 6.5. トレース
|
|
167
127
|
|
|
168
128
|
生成する `stc-<term>` 本文の見出しは **## 5. トレース**
|
|
169
129
|
|
|
170
|
-
本節では、`stc-<term>` の根拠となる上位成果物との対応関係を示します。
|
|
171
|
-
本カタログにおけるトレースの一次情報(SSOT)は **`## 5. トレース`** とし、
|
|
172
|
-
観点・ケース表では **trace_key(`TR-xx`)参照** に統一します。
|
|
173
|
-
|
|
174
130
|
#### 6.5.1. 記述ルール(trace_key)
|
|
175
131
|
|
|
176
|
-
-
|
|
177
|
-
- `trace_key` は **本ドキュメント内で一意**で、原則変更しない
|
|
132
|
+
- 各トレース項目に、本ドキュメント内で一意の **trace_key(`TR-xx`)** を付与する。採番は追加順で、削除しても欠番は詰めない
|
|
178
133
|
- 観点・ケース表の `トレース` 列には **仕様IDを直書きせず**、`TR-xx` を列挙する
|
|
179
134
|
- ケース表に新しい根拠が必要になった場合は、**先に本節の表へ行追加**し、付与された `trace_key` をケース表で参照する
|
|
180
|
-
- `TR-xx` の採番は追加順。削除しても欠番は詰めない。
|
|
181
135
|
|
|
182
136
|
#### 6.5.2. トレース表(標準フォーマット)
|
|
183
137
|
|
|
@@ -192,8 +146,6 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
192
146
|
|
|
193
147
|
生成する `stc-<term>` 本文の見出しは **## 6. テスト観点とケース**
|
|
194
148
|
|
|
195
|
-
本節は `stc-<term>` の中心です。観点(見出し)→ ケース表(末端表)の順で構成します。
|
|
196
|
-
|
|
197
149
|
#### 6.6.1. 観点:<観点>
|
|
198
150
|
|
|
199
151
|
生成する `stc-<term>` 本文の見出しは **### 6.1. 観点:<観点>**
|
|
@@ -212,19 +164,12 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
212
164
|
|
|
213
165
|
生成する `stc-<term>` 本文の見出しは **#### 6.1.2. 条件・ケース表**
|
|
214
166
|
|
|
215
|
-
- ケース表の 1 行は「1テスト(1シナリオ)」を表す(条件×期待値が一意)
|
|
216
167
|
- 必須カラムは `stc-index` の定義に従う
|
|
217
|
-
- `case_id`
|
|
218
|
-
- 形式:`<level>-<term>-<perspective_key>-<nnn>`(`level` は `st`)
|
|
219
|
-
- `perspective_key`:kebab-case(英小文字+数字+ハイフン)。原則変更しない
|
|
220
|
-
- `nnn`:3桁、10刻み(010,020,030…)推奨
|
|
221
|
-
|
|
168
|
+
- `case_id` の形式は `<level>-<term>-<perspective_key>-<nnn>`(`level` は `st`、`perspective_key` は英小文字+数字+ハイフン、`nnn` は3桁で10刻み推奨)とする
|
|
222
169
|
- 条件は `入力:` `状態:` `環境:` `経路:` の要点で表現する(必要な要素のみ記載)
|
|
223
|
-
-
|
|
224
|
-
- 期待値は判定可能に書く(画面/レスポンスに加え、DB状態、イベント、監査ログ、相関IDなどの観測点を含める)
|
|
170
|
+
- 期待値は判定可能に書き、画面/レスポンスに加え DB状態、イベント、監査ログ、相関IDなどの観測点を含める
|
|
225
171
|
- 証跡は CI/レポート/ログ相関/スクショ等へ接続できる形で書く(例:パス、CI run ID、レポートURLキー等)
|
|
226
|
-
|
|
227
|
-
推奨:観点ごとのケース数は「代表→重要分岐→重大例外」の順で増やし、直積(全組合せ)を原則避ける
|
|
172
|
+
- 観点ごとのケース数は「代表→重要分岐→重大例外」の順で増やす
|
|
228
173
|
|
|
229
174
|
## 7. 禁止事項
|
|
230
175
|
|
|
@@ -240,59 +185,54 @@ Frontmatter は共通スキーマに従います(あわせてドキュメン
|
|
|
240
185
|
|
|
241
186
|
## 8. サンプル(最小)
|
|
242
187
|
|
|
243
|
-
|
|
188
|
+
注:以下は形式の輪郭を示す最小例である。生成する `stc-<term>` では `## 1...` から始まる。
|
|
244
189
|
|
|
245
|
-
```
|
|
190
|
+
```markdown
|
|
246
191
|
---
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
status: draft
|
|
251
|
-
|
|
252
|
-
based_on: [tsp-index, stc-index]
|
|
253
|
-
supersedes: []
|
|
192
|
+
specdojo:
|
|
193
|
+
id: stc-order-place
|
|
194
|
+
type: test
|
|
195
|
+
status: draft
|
|
196
|
+
rulebook: specdojo:stc-rulebook
|
|
197
|
+
based_on: [tsp-index, stc-index]
|
|
254
198
|
---
|
|
255
|
-
```
|
|
256
199
|
|
|
257
|
-
|
|
200
|
+
# 総合テストカタログ: 注文確定(order-place)
|
|
258
201
|
|
|
259
|
-
|
|
202
|
+
## 1. 概要(order-place)
|
|
260
203
|
|
|
261
|
-
|
|
204
|
+
カートから注文を確定し、決済(sandbox)を経て注文が確定状態になる経路を扱う。
|
|
205
|
+
|
|
206
|
+
## 2. 目的
|
|
262
207
|
|
|
263
208
|
- 注文確定フローが完了条件(注文=確定)まで到達できることを保証する
|
|
264
|
-
- 決済失敗時に注文が不整合にならず、適切にエラーハンドリングされることを保証する
|
|
265
|
-
- 監査ログ/相関IDにより追跡可能であることを保証する
|
|
266
209
|
|
|
267
|
-
|
|
210
|
+
## 3. 対象外
|
|
268
211
|
|
|
269
212
|
- 本番決済の実課金(理由:安全性、代替:ET/事業者検証)
|
|
270
|
-
- 全ブラウザ網羅の表示互換(理由:範囲過大、代替:別途互換試験)
|
|
271
213
|
|
|
272
|
-
|
|
214
|
+
## 4. 境界/環境/依存
|
|
273
215
|
|
|
274
216
|
- 境界:開始=カート確定操作、完了=注文が確定状態+通知イベント発行
|
|
275
|
-
- 環境:staging
|
|
276
|
-
- 外部決済:sandbox(成功/残高不足の代表失敗のみ)
|
|
277
|
-
- 観測点:画面結果、注文DB状態、イベント、監査ログ(correlation_id)
|
|
217
|
+
- 環境:staging、外部決済=sandbox
|
|
278
218
|
|
|
279
|
-
|
|
219
|
+
## 5. トレース
|
|
280
220
|
|
|
281
221
|
| trace_key | 仕様ID | 要点 | 備考 |
|
|
282
222
|
| --------- | ----------- | ------------------ | ---- |
|
|
283
223
|
| TR-01 | br-order-01 | 注文確定の完了条件 | |
|
|
284
|
-
| TR-02 | bac-pay-02 | 決済失敗時の扱い | |
|
|
285
224
|
|
|
286
|
-
|
|
225
|
+
## 6. テスト観点とケース
|
|
287
226
|
|
|
288
|
-
|
|
227
|
+
### 6.1. 観点:業務フロー成立
|
|
289
228
|
|
|
290
|
-
|
|
229
|
+
#### 6.1.1. 意図
|
|
291
230
|
|
|
292
|
-
|
|
231
|
+
代表条件で注文確定が完了し、監査証跡が揃うことを確認する。
|
|
293
232
|
|
|
294
|
-
|
|
233
|
+
#### 6.1.2. 条件・ケース表
|
|
295
234
|
|
|
296
235
|
| case_id | 条件 | 手順(最小) | 期待値 | 観測点(アサーション) | 環境/依存 | トレース | 優先度 | 自動化 | 証跡 |
|
|
297
236
|
| ------------------------------- | --------------------------------------- | ------------------ | --------------------------------------- | -------------------------------------- | -------------------- | -------- | ------ | --------- | ---------------------------- |
|
|
298
237
|
| st-order-place-flow-success-010 | 状態: 在庫あり / 環境: 決済=sandbox成功 | 注文確定を実行する | 注文=確定になり通知イベントが発行される | DB状態/イベント/監査ログcorrelation_id | staging, pay=sandbox | TR-01 | P0 | automated | e2e/order/place.spec.ts, CI# |
|
|
238
|
+
```
|
|
@@ -29,15 +29,11 @@ STSD の「状態遷移」章の図を Mermaid の `stateDiagram-v2` で一貫
|
|
|
29
29
|
|
|
30
30
|
| 用語 | 定義 |
|
|
31
31
|
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
32
|
-
| 状態 | STSD の状態一覧に定義された業務状態 |
|
|
33
32
|
| 表示名 | 図上に表示するラベル。値がある場合は `状態名<br>値` の 2 行とし、1 行目は状態一覧の状態名、2 行目は状態一覧の値と完全一致させる。値が `-` の場合は状態名だけを表示する |
|
|
34
33
|
| `state_id` | Mermaid コード内で状態を参照する内部 ID。表示名と分けて使用し、表示する値の代わりにはしない |
|
|
35
34
|
| 別名 | 表示名の状態名部分に使用する、状態一覧の状態名とは異なる名前。本 rulebook では使用しない |
|
|
36
|
-
| 初期点 | ライフサイクルの開始を示す `[*]` |
|
|
37
|
-
| 終了点 | ライフサイクルの終了を示す `[*]` |
|
|
38
|
-
| 遷移 | `遷移元 --> 遷移先 : T-<nn> イベント / 条件` で示す状態変化 |
|
|
39
35
|
|
|
40
|
-
|
|
36
|
+
同じイベントによる分岐は疑似状態を置かず、同じ遷移元から出る複数の遷移として表します。遷移元と遷移先に使用できるのは、状態一覧にある業務状態と初期点・終了点だけです。
|
|
41
37
|
|
|
42
38
|
## 3. ファイル命名・ID規則
|
|
43
39
|
|
|
@@ -54,13 +50,11 @@ STSD の「状態遷移」章の図を Mermaid の `stateDiagram-v2` で一貫
|
|
|
54
50
|
|
|
55
51
|
## 5. 本文要件
|
|
56
52
|
|
|
57
|
-
| 要素 | 必須 | 記述
|
|
58
|
-
| ---------- | ---- |
|
|
59
|
-
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする
|
|
60
|
-
| 業務状態 | ○ | 状態一覧の状態名・値に基づく表示名を使用する
|
|
61
|
-
| 遷移ラベル | ○ | `T-<nn> イベント / 条件` を記載する
|
|
62
|
-
| 初期点 | ○ | `[*] --> 初期状態 : T-<nn> イベント / 条件` で示す |
|
|
63
|
-
| 終了点 | 任意 | `終了状態 --> [*] : T-<nn> イベント / 条件` で示す |
|
|
53
|
+
| 要素 | 必須 | 記述 |
|
|
54
|
+
| ---------- | ---- | ----------------------------------------------- |
|
|
55
|
+
| 宣言 | ○ | コードブロックの先頭を `stateDiagram-v2` とする |
|
|
56
|
+
| 業務状態 | ○ | 状態一覧の状態名・値に基づく表示名を使用する |
|
|
57
|
+
| 遷移ラベル | ○ | `T-<nn> イベント / 条件` を記載する |
|
|
64
58
|
|
|
65
59
|
初期点は STSD 全体で必須とし、分割時の配置は「図の分割」に従います。終了点の要否、継続状態の扱い、省略時に「適用範囲」へ記載する内容は、[[specdojo:stsd-rulebook|ステータス定義作成ルール]] の「状態遷移」に従います。
|
|
66
60
|
|
|
@@ -18,16 +18,15 @@ specdojo:
|
|
|
18
18
|
|
|
19
19
|
Status Definition Documentation Rulebook
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
業務上の一つの対象が取り得る状態と状態間の遷移を、一文書で定義するためのルールです。
|
|
22
22
|
|
|
23
23
|
## 1. 全体方針
|
|
24
24
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
- 状態値や記録形式に既存の schema・型定義・リファレンスがある場合、その値・構文・構造の詳細は正本を参照します。STSD には状態を識別する値と業務上の判定に必要な意味・条件を残し、正本の全項目や実装手順は再掲しません。
|
|
25
|
+
- 一文書は一つの対象(エンティティまたは業務概念)だけを扱います。
|
|
26
|
+
- 状態一覧を状態の意味・成立条件の正本、「状態遷移」の遷移表を遷移の正本とし、同じ文書で管理します。状態遷移図は遷移表の全行の投影であり、不一致時は遷移表へ合わせて両者を同じ変更で更新します。
|
|
27
|
+
- スコープは現行を既定とし、同じ対象の TO-BE 文書と並ぶ場合だけ AS-IS / TO-BE を明記して文書を分けます。両者を同じ図に混在させません。
|
|
28
|
+
- 状態値や記録形式に schema・型定義・リファレンスがある場合は、構文・構造の詳細を正本に委ね、STSD には状態を識別する値と業務上の判定に必要な意味・条件だけを残します。
|
|
29
|
+
- 共通の運用: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、成果物の完成判定に含めません。
|
|
31
30
|
|
|
32
31
|
## 2. 位置づけと用語定義
|
|
33
32
|
|
|
@@ -35,44 +34,38 @@ Status Definition Documentation Rulebook
|
|
|
35
34
|
| ---------- | ----------------------------------------------------------------------------------- |
|
|
36
35
|
| 対象 | 状態を持つ一つの業務上のエンティティまたは概念 |
|
|
37
36
|
| 状態 | 対象について、意味と成立条件を業務上判定できる時点の区分 |
|
|
38
|
-
| 管理場所 | 現在状態を確認する正本の帳簿、台帳、記録、または概念上の保管先 |
|
|
39
37
|
| 遷移 | イベントと条件により、対象が遷移元の状態から遷移先の状態へ変わること |
|
|
40
|
-
| イベント | 遷移の契機となる業務上の出来事または操作 |
|
|
41
|
-
| 遷移条件 | イベント発生時に遷移を成立させる、業務上判定可能な条件 |
|
|
42
38
|
| 初期・終了 | Mermaid の `[*]` で表すライフサイクルの開始点・終了点。業務上の状態一覧には含めない |
|
|
43
39
|
|
|
44
40
|
## 3. ファイル命名・ID規則
|
|
45
41
|
|
|
46
42
|
- ファイル名は `stsd-<term>.md`、成果物 ID は拡張子を除いた `stsd-<term>` とします。
|
|
47
43
|
- `<term>` は対象を表す英小文字・数字・ハイフンのスラッグにし、同じ対象の TO-BE 文書と並ぶ場合だけ AS-IS / TO-BE を識別するスコープを含めます。
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
- 外部参照に使う状態値は文書内で一意にし、一つの値を複数の状態へ割り当てません。コードを持たない状態で使う `-` は一意性確認の対象外です。
|
|
44
|
+
- 一つの対象・スコープに STSD は一つとし、同じライフサイクルの例外状態も同じ文書へ記載します。
|
|
45
|
+
- 状態名は業務で使う日本語の名詞句にします。外部参照に使う状態値は `lower-kebab-case` で文書内で一意にし、一つの値を複数の状態へ割り当てません(コードを持たない `-` は対象外)。
|
|
51
46
|
- 遷移 ID は文書内で一意な `T-<nn>` 形式とし、図のラベル・遷移表・レビュー指摘で同じ ID を使います。
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
- 一度確定(`status: ready`)した後は、外部参照を保つため、遷移の追加・削除・並べ替えでも既存 ID を振り直しません。削除した ID は欠番として再利用せず、新規遷移には過去に未使用の ID を割り当てます。
|
|
47
|
+
- 初回の確定前(`status: draft`)は、図と表の順に `T-01` から文書全体の通し番号で振り直してかまいません。図のラベル・遷移表・本文中の参照を同じ変更で更新し、旧 ID・新 ID の対応は STSD 本文ではなく作業の記録へ残します。
|
|
48
|
+
- 確定(`status: ready`)後は既存 ID を振り直さず、削除した ID も再利用しません。新規遷移には未使用の ID を割り当てます。
|
|
55
49
|
|
|
56
50
|
## 4. 推奨 Frontmatter 項目
|
|
57
51
|
|
|
58
|
-
|
|
52
|
+
共通の項目と値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。STSD 固有の指定は次のとおりです。
|
|
59
53
|
|
|
60
54
|
- `id` の文書名部分は「ファイル命名・ID規則」に従います。
|
|
61
55
|
- `type` は `data`、`rulebook` は `specdojo:stsd-rulebook` とします。
|
|
62
56
|
- `based_on` には、作成根拠にした対象定義・業務データ辞書などのうち、成果物カタログの `depends_on` の推移閉包に含まれる先行成果物だけを記載します。
|
|
63
|
-
- 作成途中は `status: draft` とし、`ready` への昇格は定められた人間の承認後に行います。
|
|
64
57
|
- 対象名や文書タイトルの独自メタ項目は追加せず、H1 と「適用範囲」で示します。
|
|
65
58
|
|
|
66
59
|
## 5. 本文要件
|
|
67
60
|
|
|
68
|
-
|
|
61
|
+
見出し順と表の骨組みは template を正本とし、本章では満たすべき内容と必須性を定めます。構造・必須項目・禁止事項が recipe / sample / template と異なる場合は本 rulebook を優先します。
|
|
69
62
|
|
|
70
|
-
| 内容領域 | 必須 | 判断できること
|
|
71
|
-
| ---------------- | -------- |
|
|
72
|
-
| 主題・目的・境界 | ○ | 一つの対象の何を状態で管理し、誰が何を判断するか。状態変更を起こす業務範囲と対象外、終了または継続管理の到達点
|
|
73
|
-
| 現在状態の根拠 | ○ | 状態の正本となる管理場所、現在状態を一意に決める規則、互換の扱い
|
|
74
|
-
| 状態と遷移の定義 | ○ |
|
|
75
|
-
| 未決事項 | 条件付き |
|
|
63
|
+
| 内容領域 | 必須 | 判断できること |
|
|
64
|
+
| ---------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
|
|
65
|
+
| 主題・目的・境界 | ○ | 一つの対象の何を状態で管理し、誰が何を判断するか。状態変更を起こす業務範囲と対象外、終了または継続管理の到達点 |
|
|
66
|
+
| 現在状態の根拠 | ○ | 状態の正本となる管理場所、現在状態を一意に決める規則、互換の扱い |
|
|
67
|
+
| 状態と遷移の定義 | ○ | 各状態の意味・成立条件・管理場所と、初期・終了または継続状態を含む全遷移 |
|
|
68
|
+
| 未決事項 | 条件付き | 未決の例外状態・遷移・用語・責任境界の論点と影響。未決事項がある場合だけ記載する |
|
|
76
69
|
|
|
77
70
|
状態自体を持たない対象には STSD を作成しません。
|
|
78
71
|
|
|
@@ -80,9 +73,8 @@ Status Definition Documentation Rulebook
|
|
|
80
73
|
|
|
81
74
|
### 6.1. 頭書きと目的
|
|
82
75
|
|
|
83
|
-
- 頭書きは H1
|
|
84
|
-
-
|
|
85
|
-
- 対象・業務境界・到達点の詳細は「適用範囲」、正本の管理場所や判定の規則は「状態の判定」へ置き、頭書きや目的に再掲しません。
|
|
76
|
+
- 頭書きは H1 直下に見出しなしで置き、何の状態と遷移を定義するかを 1〜2 行で示します。
|
|
77
|
+
- 「目的」には、状態で対象の何を管理し、誰がその状態で何を判断するかを 1〜3 文で示します。文書の読み手や使い方は書かず、境界は「適用範囲」、判定規則は「状態の判定」へ置きます。
|
|
86
78
|
|
|
87
79
|
| 判断の基準 | 良い例 | 悪い例 |
|
|
88
80
|
| -------------------------------- | -------------------------------------------------------------- | ------------------------------------ |
|
|
@@ -91,9 +83,8 @@ Status Definition Documentation Rulebook
|
|
|
91
83
|
|
|
92
84
|
### 6.2. 適用範囲
|
|
93
85
|
|
|
94
|
-
-
|
|
95
|
-
-
|
|
96
|
-
- 業務上の到達点を示します。終了点を置かない場合は、管理を続ける状態と理由を記載し、出力遷移のない状態を継続状態として特定します。
|
|
86
|
+
- 対象を一つの業務用語で特定し、状態変更を起こす業務の開始と対象外の境界を示します。
|
|
87
|
+
- 業務上の到達点を示します。終了点を置かない場合は、管理を続ける理由と、出力遷移のない継続状態を示します。
|
|
97
88
|
|
|
98
89
|
| 判断の基準 | 良い例 | 悪い例 |
|
|
99
90
|
| ------------------------------ | -------------------------------------------------------------------------- | ------------------------------ |
|
|
@@ -102,9 +93,9 @@ Status Definition Documentation Rulebook
|
|
|
102
93
|
|
|
103
94
|
### 6.3. 状態の判定
|
|
104
95
|
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
96
|
+
- 現在状態を確認する正本の管理場所を示し、履歴・集約記録を併用する場合は正本か派生物かを区別します。
|
|
97
|
+
- 現在状態を一意に判定する規則として、イベント再生の順序と初期値、導出状態の導出条件と再判定の契機、複数の成立条件を満たす場合の優先関係を該当する範囲で定めます。
|
|
98
|
+
- 旧状態値・旧イベント、未設定・欠損記録の読み取りや移行など互換の扱いを、過去の記録を読む規則と現在発行する遷移に分けて示します。不要な場合はその旨を明記します。
|
|
108
99
|
|
|
109
100
|
| 判断の基準 | 良い例 | 悪い例 |
|
|
110
101
|
| -------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------- |
|
|
@@ -122,11 +113,10 @@ Status Definition Documentation Rulebook
|
|
|
122
113
|
| 成立条件 | いつその状態と判定できるかを、確認可能な事実で記述 |
|
|
123
114
|
| 管理場所 | 現在状態を確認する正本の帳簿、台帳、記録、または概念上の保管先 |
|
|
124
115
|
|
|
125
|
-
-
|
|
126
|
-
-
|
|
127
|
-
- 終了条件は「状態遷移」の遷移表へ置き、状態一覧の成立条件と同じ説明を重複させません。
|
|
116
|
+
- `値` の形式と一意性は「ファイル命名・ID規則」に従い、`-` は複数行で使用できます。
|
|
117
|
+
- 終了条件は遷移表へ置き、成立条件と重複させません。
|
|
128
118
|
- 同じ状態を管理場所ごとに別名で複製せず、意味または成立条件が異なる場合だけ別状態とします。
|
|
129
|
-
-
|
|
119
|
+
- 状態が一つしかない対象は、状態変化がない根拠を記載し、図では初期点からその状態への遷移を示します。
|
|
130
120
|
|
|
131
121
|
| 判断の基準 | 良い例 | 悪い例 |
|
|
132
122
|
| -------------------------------------- | -------------------------------------------------------- | ------------------------ |
|
|
@@ -135,10 +125,9 @@ Status Definition Documentation Rulebook
|
|
|
135
125
|
|
|
136
126
|
### 6.5. 状態遷移
|
|
137
127
|
|
|
138
|
-
-
|
|
139
|
-
-
|
|
140
|
-
-
|
|
141
|
-
- 図の矢印と表の行は、経路の俯瞰と条件の確認を対応付けるために必要です。分割図の共有状態の宣言も接続に必要なため保持し、冗長さは図表を言い換えた本文や共通条件の再列挙から削ります。
|
|
128
|
+
- 図と遷移表を同じ「状態遷移」章へ置き、各図のすぐ下にその図の遷移表を置きます。図を分けた場合も図と表を一組として繰り返し、分割理由・遷移 ID の範囲・共有状態の置き方は stsd-mermaid-rulebook の「図の分割」に従います。
|
|
129
|
+
- 複数の遷移に共通する条件や補足は、適用する遷移 ID を示して章の冒頭などへ集約し、表から参照します。
|
|
130
|
+
- 図の矢印・表の行・分割図の共有状態の宣言は対応に必要なため削らず、冗長さは図表をなぞる本文から削ります。
|
|
142
131
|
|
|
143
132
|
| 判断の基準 | 良い例 | 悪い例 |
|
|
144
133
|
| -------------------------------------- | ------------------------------------------------------------ | -------------------------------------- |
|
|
@@ -148,13 +137,11 @@ Status Definition Documentation Rulebook
|
|
|
148
137
|
|
|
149
138
|
#### 6.5.1. 図
|
|
150
139
|
|
|
151
|
-
- Mermaid の `stateDiagram-v2`
|
|
152
|
-
-
|
|
153
|
-
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
- 終了点は、対象範囲でライフサイクルを閉じる業務イベントと条件が定義されている場合に `[*]` で示します。業務上の完了・中止後も差し戻しや状態の確認・記録更新のために状態管理が続く場合は、終了点を置きません。記録の保存だけでは状態管理の継続とみなさず、終了点のためだけに未定義の業務イベントを追加しません。
|
|
157
|
-
- 終了点の省略理由などは「適用範囲」に記載します。差し戻せる完了には戻りの遷移を示し、以後の状態変更を行わず確認・記録更新を続ける中止は、出力遷移のない継続状態として示します。
|
|
140
|
+
- Mermaid の `stateDiagram-v2` を使い、表示名・`state_id`・遷移ラベル・図の分割の記法は [[specdojo:stsd-mermaid-rulebook|STSD の状態遷移図を Mermaid で記述するルール]] に委ねます。
|
|
141
|
+
- 同じ遷移元から同じイベントで分岐する場合は、遷移先ごとの矢印へ同じイベントと相互排他的な条件を記載します。異なるイベントで出る遷移は分岐として扱いません。
|
|
142
|
+
- 初期点は必ず `[*]` で示し、初期点・終了点を状態一覧へ追加しません。
|
|
143
|
+
- 終了点は、ライフサイクルを閉じる業務イベントと条件が定義されている場合だけ `[*]` で示します。完了・中止後も差し戻しや確認・記録更新のために状態管理が続く場合は置かず、省略理由を「適用範囲」に記載します。記録の保存だけでは継続とみなさず、終了点のためにイベントを作りません。
|
|
144
|
+
- 差し戻せる完了には戻りの遷移を示し、確認・記録更新だけを続ける中止は出力遷移のない継続状態とします。
|
|
158
145
|
|
|
159
146
|
#### 6.5.2. 遷移表
|
|
160
147
|
|
|
@@ -167,44 +154,38 @@ Status Definition Documentation Rulebook
|
|
|
167
154
|
| 条件 | 遷移成立を yes / no で判定できる条件。無条件なら `イベント発生時` |
|
|
168
155
|
| 補足 | 判断者、例外時の扱い、記録する証跡など、図だけでは伝わらない事項 |
|
|
169
156
|
|
|
170
|
-
-
|
|
171
|
-
- 同じイベントから複数の遷移先へ分岐する場合は、条件を相互排他的かつ判定可能にします。
|
|
157
|
+
- 直上の図にある全遷移を一行ずつ記載します。分割時も一つの遷移を複数の表へ重複させません。
|
|
172
158
|
- 自己遷移は、状態の意味を変えずに記録更新や再確認を行う業務上の必要がある場合だけ使用します。
|
|
173
159
|
|
|
174
160
|
### 6.6. 今後の検討メモ
|
|
175
161
|
|
|
176
|
-
- 調査で確定できる不足は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_:
|
|
177
|
-
-
|
|
178
|
-
- 未決事項がない場合は章を省略し、空欄や「なし」だけの章を残しません。
|
|
162
|
+
- 調査で確定できる不足は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: とし、論点・影響する状態または遷移 ID・決まるまでの扱いを記載します。
|
|
163
|
+
- 未決事項がない場合は章を省略します。
|
|
179
164
|
|
|
180
|
-
| 判断の基準
|
|
181
|
-
|
|
|
182
|
-
|
|
|
165
|
+
| 判断の基準 | 良い例 | 悪い例 |
|
|
166
|
+
| ------------------------------ | ---------------------------------------------------------------------------- | ------------------ |
|
|
167
|
+
| 未決の影響と当面の扱いが分かる | _UNDECIDED_: `T-07` の再開に承認を要するか。決まるまで再開は承認後だけとする | 再開は今後検討する |
|
|
183
168
|
|
|
184
169
|
### 6.7. 完成判定
|
|
185
170
|
|
|
186
|
-
-
|
|
187
|
-
- 外部参照に使う `値` が文書内で一意で、各値から状態を一つに特定できます。
|
|
171
|
+
- 状態一覧の全状態が状態遷移図に登場し、図の業務状態がすべて状態一覧にあります。各 `値` から状態を一つに特定できます。
|
|
188
172
|
- 「状態の判定」の正本・判定規則・互換の扱いと「状態一覧」の成立条件から、現在状態を一意に判定できます。
|
|
189
|
-
-
|
|
190
|
-
-
|
|
191
|
-
- 状態一覧の各業務状態が少なくとも一つの初期点から到達でき、到達不能な中間状態が残っていません。
|
|
173
|
+
- 各図の全遷移が直下の遷移表へ一度ずつ対応して内容が一致し、文書全体で遷移の重複や欠落がありません。
|
|
174
|
+
- 到達性が stsd-mermaid-rulebook の「完成判定」を満たし、例外系の全遷移について終了、正常系への復帰、または人間の判断への引き渡しを説明できます。
|
|
192
175
|
- 状態名、通称、イベント名が用語集・業務データ辞書・関連 CDFD と矛盾していません。
|
|
193
176
|
|
|
194
177
|
### 6.8. 改訂時の影響確認
|
|
195
178
|
|
|
196
|
-
-
|
|
197
|
-
- BA は状態値・状態名・遷移 ID の変更から、参照する業務データ辞書・CDFD・業務ルールの判断への影響を確認します。ARC・DEV は型・schema・イベント処理、QE は状態遷移テスト・受入条件の追従対象を確認します。
|
|
198
|
-
- 影響先と担当 Role code、旧 ID の参照の扱い、追従確認の結果は作業の記録へ残し、未完了の追従は PM へ引き継ぎます。
|
|
179
|
+
- 状態値・状態名・遷移 ID を変えるときは、参照する業務データ辞書・CDFD・業務ルール、型・schema、状態遷移テスト・受入条件の追従を確認します。
|
|
199
180
|
|
|
200
181
|
## 7. 禁止事項
|
|
201
182
|
|
|
202
183
|
- 同じ対象の状態一覧と状態遷移図を別文書へ分けません。
|
|
203
184
|
- 状態名に `is_active`、`FLAG_01`、数値だけのコードなど、実装上の識別子を使いません。
|
|
204
|
-
-
|
|
185
|
+
- 物理テーブル、画面ページ、API 呼び出し、関数実行を業務状態または業務イベントとしてそのまま記載しません。
|
|
205
186
|
- 遷移ラベルから遷移 ID やイベントを省略したり、条件を実装式だけで表したりしません。
|
|
206
|
-
-
|
|
187
|
+
- 直上の図にない遷移を遷移表へ追加しません。
|
|
207
188
|
- 「状態遷移」の図と表を別章へ分けたり、分割図の表を一括して後置したりしません。
|
|
208
|
-
- `<<choice>>`
|
|
189
|
+
- `<<choice>>` など、状態一覧にない状態や疑似状態を図へ追加しません。
|
|
209
190
|
- 親状態と下位状態を持つ複合状態を使用しません。階層化が必要な異なる対象を一つの STSD に混在させません。
|
|
210
191
|
- CDFD、業務データ辞書、用語集に同じ状態一覧や遷移表を複製しません。
|