specdojo 0.8.0 → 0.9.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.
Files changed (284) hide show
  1. package/.github/agents/specdojo-orchestrator.md +4 -1
  2. package/CHANGELOG.md +64 -0
  3. package/dist/catalog/catalog.js +16 -14
  4. package/dist/commands/agent.js +5 -3
  5. package/dist/commands/build.js +69 -10
  6. package/dist/commands/git.js +206 -0
  7. package/dist/commands/init.js +4 -2
  8. package/dist/commands/where.js +25 -0
  9. package/dist/dashboard/dashboard.js +5 -3
  10. package/dist/dashboard/routines.js +4 -7
  11. package/dist/dashboard/timeline.js +14 -14
  12. package/dist/docs/index-command.js +2 -2
  13. package/dist/docs/yaml-business-tables.js +243 -0
  14. package/dist/docs/yaml-interface-tables.js +106 -0
  15. package/dist/docs/yaml-pages-command.js +5 -3
  16. package/dist/docs/yaml-pages.js +146 -3
  17. package/dist/docs/yaml-table-shared.js +70 -0
  18. package/dist/docs/yaml-tables.js +39 -0
  19. package/dist/exec/agent-config.js +9 -0
  20. package/dist/exec/agent-protected-config.js +2 -0
  21. package/dist/exec/commands.js +31 -18
  22. package/dist/exec/events.js +34 -14
  23. package/dist/exec/evidence.js +13 -3
  24. package/dist/exec/parent-validation.js +56 -3
  25. package/dist/exec/plans-core.js +21 -2
  26. package/dist/exec/plans-generation.js +6 -7
  27. package/dist/exec/post-integration.js +162 -0
  28. package/dist/exec/queue-command.js +166 -0
  29. package/dist/exec/queue.js +285 -0
  30. package/dist/exec/register-foreign-wait.js +84 -0
  31. package/dist/exec/repo-integration-sync.js +17 -5
  32. package/dist/exec/reporter.js +2 -2
  33. package/dist/exec/results.js +24 -4
  34. package/dist/exec/review-kata.js +4 -1
  35. package/dist/exec/run/agent-pipeline.js +3 -2
  36. package/dist/exec/run/agent.js +12 -6
  37. package/dist/exec/run/change-scope.js +365 -0
  38. package/dist/exec/run/deferred-cleanup.js +31 -0
  39. package/dist/exec/run/in-place.js +4 -1
  40. package/dist/exec/run/job-lock.js +66 -0
  41. package/dist/exec/run/job-sequence.js +137 -0
  42. package/dist/exec/run/job.js +56 -19
  43. package/dist/exec/run/lifecycle-commands.js +1 -1
  44. package/dist/exec/run/lock.js +22 -1
  45. package/dist/exec/run/register-command.js +8 -5
  46. package/dist/exec/run/register-mode.js +68 -8
  47. package/dist/exec/run/register-resume.js +68 -14
  48. package/dist/exec/run/register-state.js +13 -8
  49. package/dist/exec/run/register-worktree.js +140 -125
  50. package/dist/exec/run/schedule-mode.js +75 -14
  51. package/dist/exec/run/schedule-prepare.js +3 -0
  52. package/dist/exec/run/schedule-task.js +88 -38
  53. package/dist/exec/run/shared.js +5 -0
  54. package/dist/exec/schedule/schedule.js +116 -4
  55. package/dist/exec/shared.js +1 -1
  56. package/dist/exec/smoke.js +190 -0
  57. package/dist/exec/strategy.js +13 -3
  58. package/dist/exec/task-view.js +6 -4
  59. package/dist/exec/trial-commands.js +5 -2
  60. package/dist/exec/trial-core.js +6 -1
  61. package/dist/exec/validation-metrics.js +181 -0
  62. package/dist/exec/worktree-cleanup-lock.js +26 -0
  63. package/dist/exec/worktree-command.js +9 -1
  64. package/dist/exec/worktree-ops-commit.js +2 -2
  65. package/dist/exec/worktree.js +13 -2
  66. package/dist/grade/command-apply.js +3 -3
  67. package/dist/grade/command-inspect.js +5 -3
  68. package/dist/grade/command-plan.js +1 -1
  69. package/dist/grade/command-run.js +5 -1
  70. package/dist/grade/run.js +64 -8
  71. package/dist/job/definition.js +84 -8
  72. package/dist/job/job.js +79 -23
  73. package/dist/register/authoring-sources.js +22 -16
  74. package/dist/register/maintenance-commands.js +2 -2
  75. package/dist/register/register.js +31 -7
  76. package/dist/routine/definition.js +9 -0
  77. package/dist/routine/routine.js +137 -43
  78. package/dist/routine/status.js +62 -0
  79. package/dist/schedule/schedule.js +38 -39
  80. package/dist/shared/agent-types.js +5 -0
  81. package/dist/shared/cross-process-lock.js +9 -1
  82. package/dist/shared/dist-freshness.js +8 -2
  83. package/dist/shared/git-environment.js +2 -1
  84. package/dist/shared/git.js +44 -1
  85. package/dist/shared/lefthook-scaffold.js +3 -0
  86. package/dist/shared/local-config.js +244 -0
  87. package/dist/shared/specdojo-config.js +34 -20
  88. package/dist/shared/specdojo-gitignore.js +1 -0
  89. package/dist/shared/text.js +9 -1
  90. package/dist/shared/where-alias.js +13 -0
  91. package/dist/specdojo.js +4 -0
  92. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  93. package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
  94. package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
  95. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  96. package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
  97. package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
  98. package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
  99. package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
  100. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  101. package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
  102. package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
  103. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  104. package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
  105. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  106. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  107. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
  108. package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
  109. package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
  110. package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
  111. package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
  112. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
  113. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
  114. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  115. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  116. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
  117. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
  118. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
  119. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
  120. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
  121. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
  122. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  123. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
  124. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  125. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  126. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  127. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  128. package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
  129. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
  130. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
  131. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
  132. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  133. package/docs/ja/specdojo/references/command-reference.md +257 -117
  134. package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
  135. package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
  136. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  137. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  138. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
  139. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
  140. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
  141. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
  142. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
  143. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  144. package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
  145. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
  146. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  147. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  148. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  149. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  150. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
  151. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  152. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
  153. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
  154. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
  155. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  156. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
  157. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  158. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  159. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  160. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
  161. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  162. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
  163. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
  164. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
  165. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
  166. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  167. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  168. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
  169. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  170. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  171. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
  172. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
  173. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  174. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
  175. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
  176. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
  177. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  178. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
  179. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  180. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
  181. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  182. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  183. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  184. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  185. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  186. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
  187. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  188. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  189. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  190. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  191. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  192. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  193. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  194. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  195. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  196. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  197. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  198. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  199. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  200. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  201. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  202. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  203. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
  204. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  205. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  206. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  207. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  208. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
  209. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
  210. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
  211. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
  212. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  213. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
  214. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
  215. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
  216. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  217. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
  218. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  219. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  220. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  221. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  222. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  223. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
  224. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
  225. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
  226. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  227. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  228. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
  229. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
  230. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
  231. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
  232. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
  233. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  234. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
  235. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  236. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  237. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  238. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  239. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
  240. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  241. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  242. package/docs/ja/specdojo/samples/bds-sample.md +58 -71
  243. package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
  244. package/docs/ja/specdojo/samples/bes-sample.md +43 -53
  245. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  246. package/docs/ja/specdojo/samples/br-sample.md +40 -52
  247. package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
  248. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  249. package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
  250. package/docs/ja/specdojo/samples/clis-sample.md +70 -77
  251. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  252. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  253. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  254. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  255. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  256. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  257. package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
  258. package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
  259. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
  260. package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
  261. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
  262. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  263. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
  264. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  265. package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
  266. package/docs/ja/specdojo/samples/sf-sample.md +73 -85
  267. package/docs/ja/specdojo/samples/sld-sample.md +60 -79
  268. package/docs/ja/specdojo/samples/uis-sample.md +98 -121
  269. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  270. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  271. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
  272. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
  273. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
  274. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  275. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  276. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  277. package/package.json +9 -6
  278. package/templates/antigravity/orchestrator.md +4 -1
  279. package/templates/claude/agents/specdojo-orchestrator.md +4 -1
  280. package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
  281. package/templates/codex/orchestrator.md +4 -1
  282. package/templates/init-exec-defaults.yaml +13 -0
  283. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  284. package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
@@ -13,37 +13,21 @@ specdojo:
13
13
 
14
14
  Test Strategy and Policy (TSP) Index Documentation Rules
15
15
 
16
- 本ドキュメントは、品質保証・テスト設計のために **テスト戦略・方針を統一形式で記述する標準ルール**です。
17
- TSP は「全体として、どのようにテストで品質を担保するか」を明文化し、テスト設計・実施・受入判断の認識ズレを防ぎます。
18
-
19
- TSP は「個別のテストケース集」ではありません。
20
- 各テストレベル(単体/内部結合/外部結合/総合/受入など)の **目的・範囲・体制**、および **フェーズ間の入口/出口条件(品質ゲート)** を合意することが主目的です。
16
+ テスト設計者・実施者・受入判断者が、各テストレベルの目的・範囲・体制と入口/出口条件(品質ゲート)を合意するための記述基準を定めます。
21
17
 
22
18
  ## 1. 全体方針
23
19
 
24
- - TSP は **プロジェクト/システムのテストの全体像**(考え方)を定義します。
25
- - 例: 「ドメインロジックは単体〜結合まで自動化し、UI は主要シナリオのみ E2E を行う」
26
20
  - テスト戦略は全体の考え方・分配、テスト方針は各レベル・領域での具体的な判断基準を指します。
27
- - TSP は下位成果物(各テストレベルのテストカタログ(`<level>c-index`/`<level>c-<term>`)、テストコード/CI成果物、受入条件(SAC/BAC))を導く **上位方針**です。
28
- - 下位成果物に“何をどこまで書くか”の境界は、[test-document-scope-standard.md](../standards/test-document-scope-standard.md) の責務分離に従って定義します。
29
- - TSP では、観点/条件を設計するための **共通原則(定義粒度・分類・判定軸)** を定義し、レベル共通の採用基準・分配方針は `*c-index`、対象別の観点→ケース化は `*c-<term>` に委譲します。
30
- - TSP では各テストレベルについて、**保証すること(合格したら何が言えるか)** と **やらないこと(何をこのレベルの責務にしないか)** をセットで明文化します。
31
- - 曖昧な表現(例: 「十分にテストする」「品質を確保する」)は禁止し、
32
- - スコープ(対象/対象外)
33
- - 品質ゲート(入口/出口条件)
34
- - エビデンス(何をもって合否判断するか)
35
- を明確に書きます。
36
- - クリック手順の逐語列挙は避け、**業務行為/入力/期待結果**として要約します。
37
- - 実装詳細(例: 物理テーブル名、SQL全文、実装クラス/関数名、特定ライブラリの設定値)は記載しません。
38
- - TSP は原則 **`tsp-index` 1本** に統一します。分割ルールは [セクション 3](#3-ファイル命名id規則) 参照。
39
- - 観点/条件の詳細は、`*c-index`(共通ルール)と `*c-<term>`(対象別)で管理します。
21
+ - TSP は BAC/SAC 等を根拠に、テスト全体の方針・品質ゲート・観点/条件設計の共通原則を定義します。責務の境界は [[specdojo:test-document-scope-standard|テストドキュメントスコープ定義標準]] に従います。
22
+ - レベル共通の採用基準・分配方針は `*c-index`、対象別の観点→ケース化と証跡リンクは `*c-<term>`、具体値・網羅展開・実行結果はテストコード/CI成果物を正とします。
23
+ - 原則 `tsp-index` 1本とし、分割時は「ファイル命名・ID規則」に従います。
24
+ - 共通の記述原則・禁止事項は [[specdojo:rulebook-authoring-standard|Rulebook 記述標準]] に従います。
25
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の検証に含めません。
40
26
 
41
27
  ## 2. 位置づけと用語定義
42
28
 
43
29
  ### 2.1. 位置づけ(他ドキュメントとの関係)
44
30
 
45
- TSP と下位ドキュメント(テストカタログ、テストコード/CI成果物)の関係を示します。
46
-
47
31
  ```mermaid
48
32
  flowchart BT
49
33
  TSP["tsp-index<br>テスト戦略・方針"]
@@ -69,21 +53,16 @@ flowchart BT
69
53
 
70
54
  ### 2.2. 用語定義
71
55
 
72
- | 用語 | 定義 |
73
- | ---------------------- | ------------------------------------------------------------------------------------------ |
74
- | スコープ | テスト対象(含む)と対象外(除外) |
75
- | 入口条件 | そのテストレベルを開始してよい状態(前提、準備完了条件) |
76
- | 出口条件 | そのテストレベルを完了(合格)してよい条件(合格基準、残課題扱い) |
77
- | エビデンス | 合否判定の根拠(レポート、メトリクス、ログ、記録、承認など) |
78
- | 回帰(リグレッション) | 変更により既存機能が壊れていないことを確認する試験 |
79
- | 重大度 | 不具合の影響度(業務影響/停止有無/回避可否など) |
80
- | スタブ | テスト対象外の依存を置き換え、決め打ちの応答を返すことでテスト対象を動かすための代替実装 |
81
- | モック | スタブの一種で、依存がどのように呼び出されたか(回数・引数・順序など)を検証できる代替実装 |
82
- | スモーク | システムの基本的な動作確認を目的とした簡易試験 |
56
+ | 用語 | 定義 |
57
+ | ---------------------- | -------------------------------------------------- |
58
+ | 回帰(リグレッション) | 変更後も既存機能が成立することを確認する試験 |
59
+ | スタブ | 対象外の依存を置き換え、決めた応答を返す代替実装 |
60
+ | モック | 依存の呼び出し回数・引数・順序を検証できる代替実装 |
61
+ | スモーク | 基本動作の成立を確認する簡易試験 |
83
62
 
84
63
  ## 3. ファイル命名・ID規則
85
64
 
86
- ID 命名ルールは [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) に従います。
65
+ ID 命名ルールは [[specdojo:id-and-file-naming-standard|ドキュメントIDおよびファイル命名標準]] に従います。
87
66
 
88
67
  - `id`: 小文字ハイフン形式で `tsp-<term>` の構造とします。
89
68
  - **デフォルト: `tsp-index`** (全体方針の入口・概説)
@@ -97,21 +76,13 @@ ID 命名ルールは [id-and-file-naming-standard.md](../standards/id-and-file-
97
76
 
98
77
  ### 4.1. 設定内容
99
78
 
100
- Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
79
+ 許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
101
80
 
102
- | 項目 | 説明 | 必須 |
103
- | ---------- | -------------------------------------------------- | ---- |
104
- | id | TSP ID(`tsp-...`) | ○ |
105
- | type | `test` 固定 | ○ |
106
- | title | 方針名(例: テスト戦略・方針: 全体) | ○ |
107
- | status | `draft`/`ready`/`deprecated` | ○ |
108
- | part_of | 集約ドキュメントへの所属(例: `tsp-index`) | 任意 |
109
- | based_on | 参照する仕様ID(BAC/NFR/SAC/DEC/TSL/UIS/EAPIS 等) | 任意 |
110
- | supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
81
+ - メタ情報は `specdojo:` 配下に置き、`type: test`、`rulebook: specdojo:tsp-index-rulebook` を指定します。
111
82
 
112
83
  ### 4.2. 推奨ルール
113
84
 
114
- - `part_of`: 複数ファイルに分割した場合、集約ドキュメント(`tsp-overview`など)を指定。
85
+ - `part_of`: 分割した個別方針から集約ドキュメント `tsp-index` を指定します。
115
86
  - `based_on`: 方針の根拠となる主要仕様(BAC/NFR/SAC/DECなど)を列挙し、スコープを明確にする。
116
87
 
117
88
  ## 5. 本文構成(標準テンプレ)
@@ -121,7 +92,6 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
121
92
  1. 概要
122
93
  2. テストレベル一覧(目的/範囲/体制)と観点/条件設計の共通原則
123
94
  3. スコープ(対象/対象外)
124
-
125
95
  4. テスト環境・テストデータ(スタブ/モック方針を含む)
126
96
  5. 入口/出口条件(品質ゲート)
127
97
  6. 自動化・回帰方針(任意だが推奨)
@@ -142,58 +112,44 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
142
112
 
143
113
  #### 6.2.1. 最小(必須)
144
114
 
145
- 最小構成(必須)の列は次を推奨します。
146
-
147
- | 列 | 目的 |
148
- | ------------ | ---------------------------------------------- |
149
- | テストレベル | 単体/結合/システム/受け入れ等 |
150
- | 目的 | そのレベルで何を保証したいか |
151
- | 範囲 | 対象(例: モジュール/画面/API/バッチ/外部I/F) |
152
-
153
- | 実施体制・備考 | 実施主体、ツール、自動化方針、除外など |
115
+ 最小構成(必須)の列は次の4列です。
154
116
 
155
- 記述のコツ:
156
-
157
- - “何をそのレベルで確認し、何を下位/上位に委ねるか”の境界をはっきりさせます。
158
- - 「範囲」は成果物(モジュール/画面/API/バッチ等)で書き、個別ケースは下位文書に委ねます。
117
+ | 列 | 目的 |
118
+ | -------------- | ---------------------------------------------- |
119
+ | テストレベル | 単体/結合/システム/受け入れ等 |
120
+ | 目的 | そのレベルで何を保証したいか |
121
+ | 範囲 | 対象(例: モジュール/画面/API/バッチ/外部I/F) |
122
+ | 実施体制・備考 | テストの実施主体、ツール、自動化方針、除外など |
159
123
 
160
124
  #### 6.2.2. 推奨(責任分界を明確化)
161
125
 
162
- 可能なら、次の列を追加して「合格の意味」と「非目的(やらないこと)」を明確にします。
126
+ 各レベルの責任分界は一覧表で明文化します。「目的」「範囲」「実施体制・備考」に収まらない場合は、次の推奨列を追加します。
163
127
 
164
- | 列 | 目的 |
165
- | -------------------------- | -------------------------------------------------------------------- |
166
- | 保証すること(合格の意味) | このレベルが合格したときに、ステークホルダーに対して何を保証できるか |
167
- | やらないこと(非目的) | このレベルでは確認しないこと(=上位/下位に委ねること) |
128
+ | 列 | 目的 |
129
+ | -------------------------- | -------------------------- |
130
+ | 保証すること(合格の意味) | 合格によって保証できること |
131
+ | やらないこと(非目的) | 他レベルへ委ねること |
168
132
 
169
133
  例(外部I/Fの責任分界):
170
134
 
171
- | テストレベル | 保証すること(合格の意味) | やらないこと(非目的) | 前提(下位で保証済み) |
172
- | -------------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
173
- | 単体テスト | I/Fに渡すデータの生成・変換・バリデーションが仕様どおり | 実ネットワーク経由の導通、相手システムの状態差分に起因する挙動 | ドメイン/計算/バリデーションの網羅 |
174
- | 外部結合テスト | 外部I/Fの契約(認証/リクエスト/レスポンス形式)と代表的な異常(タイムアウト等)への対処が成立 | 外部システムを含む業務の一貫性の完全保証(相手側の内部整合・SLA・全機能網羅)。一貫テストは導通/スモークに限定 | 内部結合で主要フローが成立している |
175
- | 総合/受入 | BAC/SACに紐づく主要シナリオが成立し、外部I/Fを含むE2Eが合意した範囲で通る | 外部システムの品質そのもの(相手側の障害・性能・データ品質の全面保証) | 外部結合でI/F契約と代表エラーが成立している |
135
+ | テストレベル | 保証すること(合格の意味) | やらないこと(非目的) | 前提(下位で保証済み) |
136
+ | -------------- | --------------------------------------------------------- | -------------------------------------------------------------------- | ----------------------------------- |
137
+ | 単体テスト | I/Fデータの生成・変換・検証が仕様どおり | 実ネットワークの導通、相手側の状態差分による挙動 | ドメイン/計算/検証の網羅 |
138
+ | 外部結合テスト | 認証・要求/応答形式とタイムアウト等の代表エラー対処が成立 | 相手側の内部整合・SLA・全機能の保証。一貫テストは導通/スモークに限定 | 内部結合で主要フローが成立 |
139
+ | 総合/受入 | BAC/SACの主要シナリオと合意範囲の外部I/Fを含むE2Eが成立 | 相手側の障害・性能・データ品質の全面保証 | 外部結合でI/F契約と代表エラーが成立 |
176
140
 
177
141
  #### 6.2.3. 観点/条件設計の共通原則(必須)
178
142
 
179
- 観点/条件は、次の原則で定義します(詳細の具体化は `*c-index` / `*c-<term>` で行う)。
143
+ 観点/条件は、次の原則で定義します。
180
144
 
181
145
  | 項目 | ルール | 最低限の記述要素 |
182
146
  | -------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
183
147
  | 定義粒度 | 1観点は「1つの合否命題」で定義する(1行に複数命題を混在させない)。1条件は「状態/入力の差分を表す1単位」とする。 | 観点名、条件名、期待結果を 1:1:1 で対応づける |
184
148
  | 分類 | 観点/条件は最低限「正常・境界・例外・状態(遷移)」で分類する。非機能や運用起因が重要な場合は追加分類を定義する。 | 分類名、採用理由、どのレベルで担保するか |
185
- | 判定軸 | 判定は「期待結果」「観測点」「合格条件」の3点で定義する。曖昧語(十分/適切/問題ない)は使わない。 | 期待結果(何が起きるか)、観測点(どこで確認するか)、合格条件(Pass/Fail基準) |
186
-
187
- 補足:
188
-
189
- - レベル共通の採用基準・分配方針は `*c-index` に記載する。
190
- - 対象別の観点→ケース化と証跡リンクは `*c-<term>` に記載する。
191
- - 具体値・網羅展開・実行結果はテストコード/CI成果物を正とする。
149
+ | 判定軸 | 判定は「期待結果」「観測点」「合格条件」の3点で定義する。 | 期待結果(何が起きるか)、観測点(どこで確認するか)、合格条件(Pass/Fail基準) |
192
150
 
193
151
  ### 6.3. スコープ(対象/対象外)
194
152
 
195
- TSP は必ず「どこまでがテスト対象か」を定義します。
196
-
197
153
  - 対象(含む)
198
154
  - 対象外(除外)
199
155
  - 除外の理由(任意)
@@ -205,9 +161,6 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
205
161
 
206
162
  ### 6.4. テスト環境・テストデータ
207
163
 
208
- 環境やデータの前提が曖昧だと、試験結果が比較できません。
209
- 次を“方針”として定義します。
210
-
211
164
  - 環境区分(例: 開発/内部結合/外部結合/総合/受入)と用途
212
165
  - データ方針(匿名化、代表データ量、マスタの扱い)
213
166
  - 外部I/Fの扱い(実接続/スタブ/モック、切り替え方針)
@@ -234,35 +187,23 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
234
187
 
235
188
  ### 6.5. 入口/出口条件(品質ゲート)
236
189
 
237
- フェーズ間の入口/出口条件は、**合否判定できる形**で書きます。
238
-
239
- 推奨の書き方(表):
190
+ 各レベルの開始前提・完了条件・判定根拠を次の列で定義します。
240
191
 
241
- | フェーズ/テストレベル | 入口条件(開始条件) | 出口条件(完了条件) | エビデンス(根拠) |
242
- | --------------------- | -------------------- | -------------------- | ------------------ |
243
- | 単体テスト | … | … | … |
244
- | 内部結合テスト | … | … | … |
245
- | 外部結合テスト | … | … | … |
246
- | 総合テスト | … | … | … |
247
- | 受け入れテスト | … | … | … |
248
-
249
- 記述のコツ:
192
+ | フェーズ/テストレベル | 入口条件(開始条件) | 出口条件(完了条件) | エビデンス(根拠) |
193
+ | --------------------- | -------------------- | ---------------------- | ------------------------ |
194
+ | 採用する各レベル | 前提・準備完了条件 | 合格基準・残課題の扱い | レポート・ログ・判定記録 |
250
195
 
251
196
  - 出口条件には「未解決不具合の扱い(重大度別の許容)」を含めます。
252
197
  - 非機能の出口条件は、可能なら NFR/SAC と接続します(例: 「全 NFR を満たす」)。
253
198
 
254
199
  ### 6.6. 自動化・回帰方針(任意)
255
200
 
256
- 自動化は “やる/やらない” ではなく、**どこを自動化し、どこを手動で補うか** を決めます。
257
-
258
201
  - 自動化の優先領域(例: ドメインロジック、計算、バリデーション、回帰)
259
202
  - 手動で行う領域(例: UX の探索、端末差異、教育/運用リハーサル)
260
203
  - 回帰の基本方針(例: 変更影響のある領域は自動回帰を必須)
261
204
 
262
205
  ### 6.7. 不具合管理方針(任意)
263
206
 
264
- 不具合管理は、テスト成果の解釈ブレを防ぐために記載してよいです。
265
-
266
207
  - 重大度(例: Blocker/Critical/Major/Minor)と判断観点(業務影響/回避可否)
267
208
  - 収束基準(出口条件との関係)
268
209
  - 既知不具合の扱い(残課題/例外承認/ロールバック条件)
@@ -277,27 +218,25 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
277
218
 
278
219
  - 未確定の前提(例: ピーク時の定義、想定データ量、外部依存の SLA)
279
220
  - 将来追加したい試験(例: DR 訓練、長期運用での監査手順、非機能の拡充)
221
+ - 未決の論点がスコープ・環境・品質ゲートのどこに影響し、決定までどう扱うかを記載します。
280
222
 
281
223
  ### 6.10. よくある誤りと対策
282
224
 
283
- | 誤り | 対策 |
284
- | ---------------------------- | ---------------------------------------------- |
285
- | テストレベルの役割分担が曖昧 | 「目的/範囲/体制」を表で固定する |
286
- | スコープが書かれていない | 対象/対象外と除外理由を必ず明記する |
287
- | 入口/出口条件がない | 品質ゲート(開始/完了条件)を表で定義する |
288
- | 自動化の範囲が不明 | 自動化領域と手動領域を分けて記述する |
289
- | 不具合が残ったまま“完了”扱い | 重大度別許容と例外承認ルールを出口条件に含める |
225
+ | 誤り | 対策 |
226
+ | ---------------------------- | ----------------------------------------------- |
227
+ | テストレベルの役割分担が曖昧 | 「目的/範囲/体制」を表で固定する |
228
+ | スコープが書かれていない | 「スコープ(対象/対象外)」を参照して不足を補う |
229
+ | 入口/出口条件がない | 品質ゲート(開始/完了条件)を表で定義する |
230
+ | 自動化の範囲が不明 | 自動化領域と手動領域を分けて記述する |
231
+ | 不具合が残ったまま“完了”扱い | 重大度別許容と例外承認ルールを出口条件に含める |
290
232
 
291
233
  ## 7. 禁止事項
292
234
 
293
- | 項目 | 理由 |
294
- | ----------------------------------------------- | ------------------------------------------------------------------- |
295
- | 物理テーブル名・物理カラム名・SQL全文 | 実装依存で変更に弱い |
296
- | 実装クラス/関数名、特定ライブラリの設定値の列挙 | 実装依存で変更に弱い |
297
- | クリック/画面遷移の逐語列挙 | UI変更に弱い・本質が埋もれる |
298
- | 個別テストケースの大量列挙 | 下位成果物(`<level>s-<term>`、テストコード、CI成果物)に委譲すべき |
299
- | 「十分」「適切」「問題ない」等の曖昧表現 | 合否判定不能 |
300
- | 前提なしの数値(条件が不明) | 合意不能、再現不能 |
235
+ | 項目 | 理由 |
236
+ | ---------------------------- | -------------------------------------------------------------------------- |
237
+ | クリック/画面遷移の逐語列挙 | 業務行為・入力・期待結果として要約し、方針の判断を読み取れるようにするため |
238
+ | 個別テストケースの大量列挙 | `*c-<term>`、テストコード、CI成果物の責務であるため |
239
+ | 前提なしの数値(条件が不明) | 合意不能、再現不能 |
301
240
 
302
241
  ## 8. サンプル(最小)
303
242
 
@@ -305,26 +244,17 @@ TSP は必ず「どこまでがテスト対象か」を定義します。
305
244
 
306
245
  ```yaml
307
246
  ---
308
- id: tsp-overview
309
- type: test
310
- title: テスト戦略・方針: 全体(駄菓子屋販売管理システム)
311
- status: draft
312
- part_of: []
313
- based_on:
314
- - bac-sale-checkout
315
- - bac-inventory-replenishment
316
- - nfr-performance
317
- - nfr-security
318
- - sac-performance
319
- - sac-disaster-recovery
320
- supersedes: []
247
+ specdojo:
248
+ id: tsp-index
249
+ type: test
250
+ status: draft
251
+ rulebook: specdojo:tsp-index-rulebook
321
252
  ---
322
253
  ```
323
254
 
324
255
  ### 8.2. 概要
325
256
 
326
- 駄菓子屋販売管理システムの主要業務(販売/在庫/発注・入荷/棚卸/レポート)と外部決済・帳票I/F境界、および主要非機能(性能/可用性/セキュリティ)を対象に品質を担保する。
327
- 担保方法は、単体→内部結合→外部結合→総合→受入の順に確認し、入口/出口条件(品質ゲート)とエビデンス(BAC/SAC含む)で合否を判定する。
257
+ 駄菓子屋販売管理システムを単体→内部結合→外部結合→総合→受入の順に確認し、品質ゲートと BAC/SAC に対応する証跡で合否を判定する。対象範囲は「スコープ(対象/対象外)」に示す。
328
258
 
329
259
  ### 8.3. テストレベル一覧
330
260
 
@@ -336,15 +266,13 @@ supersedes: []
336
266
  | 総合テスト | E2E成立の確認 | 販売→在庫→発注→入荷→棚卸→レポート | テスト担当・業務担当。代表データ量で実運用相当を確認 |
337
267
  | 受け入れテスト | BAC/SACで合否判定 | 受入シナリオ(BAC/SAC準拠) | 業務担当。承認をもって完了 |
338
268
 
339
- 補足: 結合テストは「社内境界(内部)」と「外部境界(外部)」で分け、切り分け容易性を上げる。
340
-
341
269
  #### 8.3.1. 観点/条件設計の共通原則(例)
342
270
 
343
- | 項目 | ルール(例) |
344
- | -------- | --------------------------------------------------------------------------------------------------------- |
345
- | 定義粒度 | 1観点は1合否命題、1条件は1差分単位で定義し、観点名・条件名・期待結果を 1:1:1 で対応づける |
346
- | 分類 | 最低限「正常・境界・例外・状態(遷移)」で分類し、追加分類は採用理由と担保レベルを明示する |
347
- | 判定軸 | 各観点/条件は「期待結果」「観測点」「合格条件」で判定可能に定義し、曖昧語(十分/適切/問題ない)は使わない |
271
+ | 項目 | ルール(例) |
272
+ | -------- | ------------------------------------------------------------------------------------------------- |
273
+ | 定義粒度 | 決済要求の妥当性を1観点とし、必須項目の欠落を1条件、検証エラー応答を期待結果とする |
274
+ | 分類 | 正常・境界・例外・状態(遷移)を採用。決済タイムアウトは例外に分類し外部結合で担保する |
275
+ | 判定軸 | タイムアウト後の再送で二重決済が発生しないことを、決済履歴の取引ID別件数が1件であることで判定する |
348
276
 
349
277
  ### 8.4. スコープ(対象/対象外)
350
278
 
@@ -386,10 +314,7 @@ supersedes: []
386
314
 
387
315
  ### 8.8. 成果物(エビデンス)の最小セット(例)
388
316
 
389
- - CIのテスト結果(単体/結合)
390
- - 総合テスト結果(主要シナリオの結果)
391
- - NFR/SACに対応する試験レポート(性能/可用性/セキュリティの合否)
392
- - 受入判定記録(承認、残課題の扱い)
317
+ 「入口/出口条件(例)」のエビデンス列を最小セットとする。受入判定記録には承認と残課題の扱いを含める。
393
318
 
394
319
  ### 8.9. メモ / 将来課題
395
320
 
@@ -20,54 +20,29 @@ User Interface Specification (UIS) Authoring Rule
20
20
 
21
21
  ## 1. 全体方針
22
22
 
23
- - Web・タブレット・デスクトップ等の GUI を対象とし、1 ファイルで 1 画面を定義します。付随する確認ダイアログは、その画面の操作・遷移に含められます。
23
+ - Web・タブレット・デスクトップ・エディタ拡張の入力欄などの GUI を対象とし、1 ファイルで 1 画面を定義します。付随する確認ダイアログは、その画面の操作・遷移に含めます。CLI は [[specdojo:clis-rulebook|CLI仕様作成ルール]] に従います。
24
24
  - 利用者から観察できる条件と結果を記述します。正常系に加え、空の一覧、処理中、入力不備、権限不足、通信失敗など、対象画面で起こる状態を扱います。
25
- - CLI の仕様は [[specdojo:clis-rulebook|CLI仕様作成ルール]] に従います。
26
- - 表示項目の意味と操作の業務上の効果を定義します。ワイヤーフレーム、レイアウト、装飾、内部実装は「禁止事項」に従います。画面をまたぐ色・文字・余白、部品、レイアウトの型、状態表示、アクセシビリティは [[specdojo:dss-rulebook|デザインシステム(DSS)]] で定めます。画面ごとのワイヤーフレームは文書として保守せず、UIS と DSS から試作を作ります。
27
- - 規範語は **必須**・**任意**・**禁止** で統一します。条件付きの要件には適用条件を明記します。
28
-
29
- ### 1.1. 利用者と確認すること
30
-
31
- | 利用者 | 本書に従う画面仕様で確認すること |
32
- | ------------------------------------ | ---------------------------------------------------- |
33
- | 業務担当者・ビジネスアナリスト(BA) | 業務目的、対象ロール、表示情報と業務上の判断の対応 |
34
- | 設計者(ARC)・開発者(DEV) | 操作前後の状態、画面間の受け渡し、更新の確定時点 |
35
- | 品質保証担当者(QE) | 入力境界、遷移条件、失敗時の状態と回復操作の期待結果 |
36
- | プロダクトオーナー(PO) | 対象範囲と、利用者が業務を完了できる条件 |
25
+ - 表示項目の意味と操作の業務上の効果を定義します。画面をまたぐ色・文字・部品・レイアウトの型・アクセシビリティは [[specdojo:dss-rulebook|デザインシステム(DSS)]] で定め、画面ごとのワイヤーフレームは文書として保守しません。
26
+ - 同じ判断は 1 か所に書きます。入力の条件は「バリデーション」、失敗時の表示と回復は「エラー表示と利用者の次の手」を正とし、ほかの章は章タイトルで参照します。
27
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。
37
28
 
38
29
  ## 2. 位置づけ
39
30
 
40
- - 業務仕様の `user-interface-model` に属し、業務プロセス仕様(`bps`)やシステム化機能(`sf`)を利用者との対話へ具体化します。根拠とする成果物は `based_on` で参照します。
41
- - 共通の業務規則・用語は上位仕様を正本として参照し、画面固有の表示・入力・操作条件を記述します。上位の画面索引がある場合、共通事項を索引へ集約します。
31
+ - 業務仕様の `user-interface-model` に属し、業務プロセス仕様(`bps`)やシステム化機能(`sf`)を利用者との対話へ具体化します。共通の業務規則・用語は上位仕様を正本として参照します。
42
32
  - 内部 API、保存方式、UI 部品の設計は後続のシステム設計で扱います。画面仕様には、利用者が確認できる保存の成否や再試行の条件までを記述します。
43
33
 
44
34
  ## 3. ファイル命名・ID規則
45
35
 
46
- - ファイル名は `uis-<番号>-<短い日本語名>.md` とします。例として `uis-0010-販売登録.md` を用います。
47
- - プロダクト文書の ID は `uis-<kebab-case>`、プロジェクト文書は `<project-id>:uis-<kebab-case>` とします。例として `uis-sales-register`、`prj-0001:uis-sales-register` を用います。
48
- - 同梱の完成例は `specdojo:uis-sample` とします。画面の業務 ID と区別するための例外です。
49
- - 本文先頭の H1 に画面名を記述します。命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
36
+ - ファイル名は `uis-<term>.md` とし、`<term>` は画面を表す英小文字の kebab-case とします(例: `uis-sales-register.md`)。
37
+ - 文書 ID はプロダクトの文書で `uis-<term>`、プロジェクトの文書で `<project-id>:uis-<term>` とし、成果物カタログの宣言と一致させます。同梱の完成例は `specdojo:uis-sample` とします。
38
+ - H1 には画面名を書きます。命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
50
39
 
51
40
  ## 4. 推奨 Frontmatter 項目
52
41
 
53
- 共通スキーマ `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` と [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、次の項目を `specdojo:` 配下に置きます。
54
-
55
- | 項目 | 必須/任意 | 画面仕様での値・用途 |
56
- | ------------ | --------- | ---------------------------------------------------------------------------- |
57
- | `id` | 必須 | 「ファイル命名・ID規則」に従う文書 ID |
58
- | `type` | 必須 | `ui` 固定。主 rulebook の `deliverable_type` と一致させる |
59
- | `status` | 必須 | `draft` / `ready` / `deprecated`。作成・編集時は `draft` とし、人が確定する |
60
- | `rulebook` | 必須 | `specdojo:uis-rulebook` |
61
- | `part_of` | 任意 | 所属する画面索引などの ID 配列。所属先がなければ `[]` |
62
- | `based_on` | 任意 | 根拠となる業務プロセス・機能などの ID 配列。根拠がなければ `[]` |
63
- | `supersedes` | 任意 | 置き換える旧文書の ID 配列 |
64
- | `relations` | 任意 | `satisfies` / `verifies` / `implements` ごとに参照 ID 配列を持つオブジェクト |
42
+ 許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
65
43
 
66
- ### 4.1. メタ情報の判断基準と例
67
-
68
- - 良い例では、成果物の種別と所属・根拠を分けて宣言します。参照先には存在する文書 ID を使います。
69
- - 悪い例として `type: screen`、`id: UIS_Sales`、`title: 販売登録` を指定すると、種別・ID の制約や H1 に名前を書く規約に反します。
70
- - `part_of` と `based_on` は役割に応じて記入します。関係がない場合は空配列にし、未作成の文書 ID を架空の参照先として登録しません。
44
+ - `specdojo.type` は `ui`、`specdojo.rulebook` は `specdojo:uis-rulebook` とします。
45
+ - `part_of` には所属する画面索引、`based_on` には根拠とした作成済みの業務プロセス・機能の ID を書きます。関係がなければ空配列にし、未作成の文書 ID を書きません。
71
46
 
72
47
  ```yaml
73
48
  ---
@@ -83,7 +58,7 @@ specdojo:
83
58
 
84
59
  ## 5. 本文要件
85
60
 
86
- 章は次の順で構成し、`##` から `####` の見出しに 1 始まりの連番と末尾の `.` を付けます。任意章を省略した場合は番号を詰めます。
61
+ 章は次の順で構成します。任意章を省略した場合は番号を詰めます。
87
62
 
88
63
  | 章 | 必須/任意 | 目的と記述要件 |
89
64
  | -------------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
@@ -92,105 +67,63 @@ specdojo:
92
67
  | 表示項目 | 必須 | 項目名、種別、表示内容の意味、編集可否、初期値・未取得時・更新契機などを示す |
93
68
  | 操作 | 必須 | 操作名、対象、前提条件、結果を示す。更新の確定時点、処理中や失敗後の再実行条件を含める |
94
69
  | 遷移 | 必須 | 契機、遷移元、遷移先、条件、引き渡す情報を示す。戻る・中止時の入力の保持/破棄も示す。画面間移動がなければその旨を記す |
95
- | バリデーション | 任意。ただし入力がある場合は必須 | 対象、必須性、形式・範囲・相関、判定時点、違反時の扱いを示す。入力のない画面は省略できる |
70
+ | バリデーション | 任意。ただし入力がある場合は必須 | 対象、必須性、形式・範囲・相関、判定時点、違反時の扱いを示す |
96
71
  | エラー表示と利用者の次の手 | 必須 | 発生条件、表示要点、保持/更新される状態、利用者の回復操作とその結果を示す |
97
- | メモ / 将来課題 | 任意 | 現在の対象範囲に含めない拡張や、判断待ちの事項と次の確認先を記す |
72
+ | メモ / 将来課題 | 任意 | 現在の対象範囲に含めない拡張と、未決事項の論点と影響を示す |
98
73
 
99
- 関連する操作・遷移・入力制約・エラーは、同じ名称または画面内の識別子で対応づけます。既存の要求・業務規則・受入条件がある場合は参照し、本文へ全文を再掲しません。
74
+ 関連する操作・遷移・入力制約・エラーは、同じ名称で対応づけます。既存の要求・業務規則・受入条件は参照し、全文を再掲しません。
100
75
 
101
76
  ## 6. 記述ガイド
102
77
 
103
- 各節の判断基準を満たす粒度で記述します。表の列は推奨形式であり、本文要件を満たす別形式も使用できます。共通事項の正本と画面固有の条件は「位置づけ」に従って記述します。
78
+ 表の列は推奨形式であり、本文要件を満たす別形式も使えます。
104
79
 
105
80
  ### 6.1. 概要
106
81
 
107
- - どの業務のどの場面で、誰が何を完了する画面かを判断できることを基準とします。
108
- - 利用端末、開始・終了の境界、対象となる取引の範囲など、後続の操作条件に必要な前提を補足します。
109
- - 表示項目や操作の全件列挙はそれぞれの章へ置きます。
110
-
111
- **良い例**として「店員が店頭で購入商品と預かり金を登録し、販売を確定して釣銭を確認する画面。」と記述します。
112
-
113
- **悪い例**の「販売を便利にする画面。」では、利用者と完了する業務を判断できません。
82
+ - **判断基準**: どの業務のどの場面で、誰が何を完了する画面かが分かること。表示項目や操作の全件はそれぞれの章へ置く。
83
+ - **良い例**: 「店員が店頭で購入商品と預かり金を登録し、販売を確定して釣銭を確認する画面。」
84
+ - **悪い例**: 「販売を便利にする画面。」(利用者と完了する業務が分からない)
114
85
 
115
86
  ### 6.2. 対象ユーザー/利用目的
116
87
 
117
- - ロールごとに利用場面と達成する結果が対応することを基準とします。
118
- - 権限に差がある場合、参照・登録・取消など許可される操作の範囲を明記します。
119
- - 顧客が画面を操作するか、店員を介して結果を受け取るかを区別します。
120
-
121
- **良い例**として「店員・店主が接客中に購入明細と釣銭を確認する。両ロールに販売登録を許可する。来店客へは担当者が合計額を伝える。」と記述します。
122
-
123
- **悪い例**の「ユーザーがシステムを利用する。」では、業務ロールと利用目的が定まりません。
88
+ - **判断基準**: ロールごとに利用場面と達成する結果が対応し、権限差があれば許可される操作の範囲が分かること。顧客が直接操作するか、店員を介して結果を受け取るかを区別する。
89
+ - **良い例**: 「店員・店主が接客中に購入明細と釣銭を確認する。両ロールに販売登録を許可する。来店客へは担当者が合計額を伝える。」
90
+ - **悪い例**: 「ユーザーがシステムを利用する。」(業務ロールと利用目的が定まらない)
124
91
 
125
92
  ### 6.3. 表示項目
126
93
 
127
- - 表示する業務情報と、空・未取得・処理中を含む値の意味が読み取れることを基準とします。
128
- - 項目名、種別(入力・一覧・集計・状態等)、表示内容、編集可否、表示条件・初期値・更新契機を列として持たせます。金額や数量には単位を記します。
129
- - 計算値は算出の意味か上位規則の参照を示し、入力の許容範囲は「バリデーション」へまとめます。
130
-
131
- | 項目名 | 種別 | 表示内容 | 編集可否 | 表示条件・更新契機 |
132
- | ------------ | ---- | ---------------------- | -------- | ----------------------------------------------------- |
133
- | 合計請求金額 | 集計 | 明細小計の合計、円単位 | 不可 | 明細なしは 0 円。追加・数量変更・削除の成功時に再計算 |
134
-
135
- この表を **良い例**とします。**悪い例**の「合計欄を右下に赤色で表示する。」では、値の意味や更新条件が定まりません。
94
+ - **判断基準**: 表示する業務情報と、空・未取得・処理中を含む値の意味が読み取れること。金額や数量には単位を記す。計算値は算出の意味か上位規則を参照し、入力の許容範囲は「バリデーション」に置く。
95
+ - **良い例**: 「合計請求金額 / 集計 / 明細小計の合計、円単位 / 不可 / 明細なしは 0 円。追加・数量変更・削除の成功時に再計算」
96
+ - **悪い例**: 「合計欄を右下に赤色で表示する。」(値の意味や更新条件が定まらない)
136
97
 
137
98
  ### 6.4. 操作
138
99
 
139
- - 操作の実行可否と、成功・中止・失敗後の業務状態を判定できることを基準とします。
140
- - 操作名、対象、前提条件、結果を列として持たせます。利用できない状態と、その際に無効化するかエラーを表示するかを定めます。
141
- - 保存や確定を伴う操作では、処理中の再操作、結果が不明な場合の確認方法、再試行可能になる条件を記します。回復操作も操作表へ含めます。
142
-
143
- | 操作名 | 対象 | 前提条件 | 結果 |
144
- | -------- | ------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
145
- | 会計確定 | 「会計確定」 | 明細があり、入力制約を満たす登録中の取引 | 処理中は再操作を無効化。成功時に販売・在庫を確定して完了画面へ移る。結果不明時はエラー表に従って取引状態を確認 |
146
-
147
- この表を **良い例**とします。**悪い例**の「確定ボタンを押すと保存する。」では、保存の条件や二重操作時の扱いが不明です。
100
+ - **判断基準**: 操作の実行可否と、成功・中止・失敗後の業務状態を判定できること。保存や確定を伴う操作では、処理中の再操作、結果が不明な場合の確認方法、再試行できる条件を記す。
101
+ - **良い例**: 「会計確定 / 明細があり、入力制約を満たす登録中の取引 / 処理中は再操作を無効化。成功時に販売・在庫を確定して完了画面へ移る。結果不明時は「エラー表示と利用者の次の手」に従う」
102
+ - **悪い例**: 「確定ボタンを押すと保存する。」(保存の条件や二重操作時の扱いが不明)
148
103
 
149
104
  ### 6.5. 遷移
150
105
 
151
- - 流入・流出・戻りを、契機と業務上の条件から辿れることを基準とします。
152
- - 遷移名、契機、遷移元、遷移先、条件、引き渡し情報を列として持たせます。渡す情報がなければ「なし」と記します。
153
- - ダイアログを介する場合は、選択確定と取り消して戻る場合の両方を示します。遷移先の文書があればリンクし、未作成なら画面名・ID をバッククォートで記します。
154
-
155
- | 遷移名 | 契機 | 遷移元 | 遷移先 | 条件 | 引き渡し情報・入力の扱い |
156
- | ---------------- | -------- | -------------- | -------------- | -------------- | -------------------------------------------------------------- |
157
- | 商品選択から復帰 | 「選択」 | `商品検索画面` | `販売登録画面` | 商品を選択済み | 商品コード。既存明細を保持し、追加条件を満たす場合に明細へ反映 |
158
-
159
- この表を **良い例**とします。**悪い例**の「選択すると次画面へ進む。」では、行き先と受け渡し情報が定まりません。
106
+ - **判断基準**: 流入・流出・戻りを、契機と業務上の条件から辿れること。ダイアログを介する場合は確定と取り消しの両方を示し、渡す情報がなければ「なし」と記す。未作成の遷移先は画面名・ID をバッククォートで記す。
107
+ - **良い例**: 「商品選択から復帰 / 「選択」 / `商品検索画面` / `販売登録画面` / 商品を選択済み / 商品コード。既存明細を保持」
108
+ - **悪い例**: 「選択すると次画面へ進む。」(行き先と受け渡し情報が定まらない)
160
109
 
161
110
  ### 6.6. バリデーション
162
111
 
163
- - 同じ入力に対して同じ可否を判断でき、境界値で検証できることを基準とします。
164
- - 対象、必須性、形式・範囲・相関、判定時点、違反時の扱い・対応エラーを列として持たせます。空欄・範囲の上限下限を具体化します。
165
- - 入力時と確定時に判定する条件が異なる場合は区別します。失敗時に前の有効値を保持するか、修正用に入力値を残すかを明記します。
166
-
167
- | 対象 | 必須性 | 条件 | 判定時点 | 違反時の扱い |
168
- | ---- | ------ | ----------------------------- | ---------------------------------------- | -------------------------------------------------------- |
169
- | 数量 | 必須 | 1〜999 の整数かつ現在庫数以下 | 数量変更時。現在庫数は会計確定時にも確認 | 明細・合計は直前の有効値を保持し、修正対象と在庫数を表示 |
170
-
171
- この表を **良い例**とします。**悪い例**の「数量が適切であること。」では、許容範囲も確認時点も判定できません。
112
+ - **判断基準**: 同じ入力に同じ可否を判断でき、境界値で検証できること。入力時と確定時で条件が異なれば区別し、失敗時に前の有効値を保持するか、修正用に入力値を残すかを記す。
113
+ - **良い例**: 「数量 / 必須 / 1〜999 の整数かつ現在庫数以下 / 数量変更時と会計確定時 / 明細・合計は直前の有効値を保持」
114
+ - **悪い例**: 「数量が適切であること。」(許容範囲も確認時点も判定できない)
172
115
 
173
116
  ### 6.7. エラー表示と利用者の次の手
174
117
 
175
- - 利用者が現在の状態、確定の有無、次に実行できる操作を判断できることを基準とします。
176
- - エラー事象、発生条件、表示要点、状態の扱い、回復アクションを列として持たせます。内部例外名を表示要点の代わりに使用しません。
177
- - 入力不備・対象なし・権限不足・通信障害など、対象画面で起こる代表ケースを扱います。回復に別画面や運用担当者が必要な場合は、その行き先と連絡時に渡す情報を示します。
178
-
179
- | エラー事象 | 発生条件 | 表示要点 | 状態の扱い | 利用者の次の手 |
180
- | ------------ | ------------------------------ | ---------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------- |
181
- | 会計結果不明 | 確定要求後に応答を受信できない | 「会計結果を確認してください」と取引番号 | 明細と預かり金を保持し、編集・会計確定を無効化 | 「結果確認」で同じ取引を照会。確定済みは完了画面へ、未確定が確認できた場合は登録中へ戻る |
182
-
183
- この表を **良い例**とします。**悪い例**の「通信エラー。もう一度確定する。」では、確定済みの取引を再登録するおそれがあります。
118
+ - **判断基準**: 利用者が現在の状態、確定の有無、次に実行できる操作を判断できること。内部例外名を表示要点の代わりにしない。回復に別画面や運用担当者が要る場合は、行き先と渡す情報を示す。
119
+ - **良い例**: 「会計結果不明 / 確定要求後に応答を受信できない / 「会計結果を確認してください」と取引番号 / 明細と預かり金を保持し、編集・会計確定を無効化 / 「結果確認」で同じ取引を照会する」
120
+ - **悪い例**: 「通信エラー。もう一度確定する。」(確定済みの取引を再登録するおそれがある)
184
121
 
185
122
  ### 6.8. メモ / 将来課題
186
123
 
187
- - 現在の操作・制約と将来の拡張を識別できることを基準とします。
188
- - 未確定事項は共通ラベルを用い、影響範囲と確認先・次のアクションを示します。
189
- - 現行動作に必要な判断をこの章だけへ移さず、該当する本文要件にも反映します。
190
-
191
- **良い例**として「電子決済は将来の拡張候補とし、導入検討時に店主が決済方法と取消手順を確認する。」と記述します。
192
-
193
- **悪い例**の「エラー時の扱いは後で検討する。」では、現行画面を実装・検証する条件が欠落します。
124
+ - **判断基準**: 現在の動作と将来の拡張を区別できること。未決事項は `_UNDECIDED_` などを付けて論点と影響を書き、管理台帳の区分・担当・判断時期の列は設けない(追跡は登録簿で行う)。現行動作に要る判断はこの章だけに置かない。
125
+ - **良い例**: 「電子決済は将来の拡張とし、導入時に決済方法と取消手順を決める。」
126
+ - **悪い例**: 「エラー時の扱いは後で検討する。」(現行画面を実装・検証する条件が欠ける)
194
127
 
195
128
  ## 7. 禁止事項
196
129
 
@@ -201,5 +134,5 @@ specdojo:
201
134
  | 物理テーブル・物理カラム・SQL・実装クラスや関数・UI ライブラリの指定 | 後続設計の選択に結合するため |
202
135
  | クリックやキー入力の逐語列挙だけで操作を説明する | 操作の前提条件と業務上の効果を判断できないため |
203
136
  | 回復操作を伴わないエラー一覧、結果不明の更新を無条件に再実行させる指示 | 利用者が業務を安全に再開できる条件が欠けるため |
137
+ | 入力の条件や回復の手順を、正とする章以外で言い直す | 同じ判断が複数か所に書かれ、改訂時に食い違うため |
204
138
  | 共通の業務規則や上位仕様の全文再掲 | 正本との不整合や更新漏れを招くため |
205
- | 未定義の Frontmatter 項目、`ui` 以外の成果物 `type` | メタ情報スキーマと主 rulebook の宣言に反するため |