specdojo 0.6.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.
Files changed (366) hide show
  1. package/.github/agents/specdojo-orchestrator.md +3 -2
  2. package/CHANGELOG.md +193 -0
  3. package/README.md +2 -2
  4. package/dist/catalog/build.js +24 -1
  5. package/dist/catalog/plan.js +1 -1
  6. package/dist/catalog/scaffold.js +4 -1
  7. package/dist/commands/agent.js +33 -0
  8. package/dist/commands/init.js +6 -1
  9. package/dist/commands/night-orchestrator.js +6 -4
  10. package/dist/commands/orchestrator.js +10 -1
  11. package/dist/dashboard/dashboard-timeline.js +18 -16
  12. package/dist/dashboard/dashboard.js +612 -259
  13. package/dist/dashboard/epic-plan.js +81 -0
  14. package/dist/dashboard/exec-records.js +16 -20
  15. package/dist/dashboard/routines.js +8 -6
  16. package/dist/dashboard/timeline-build.js +5 -9
  17. package/dist/dashboard/timeline.js +9 -4
  18. package/dist/devcontainer/command.js +18 -0
  19. package/dist/devcontainer/host-script.js +21 -0
  20. package/dist/devcontainer/scaffold.js +22 -3
  21. package/dist/docs/frontmatter-namespace.js +1 -48
  22. package/dist/docs/yaml-pages.js +125 -3
  23. package/dist/exec/agent-config.js +22 -0
  24. package/dist/exec/agent-plan.js +3 -2
  25. package/dist/exec/antigravity-session.js +154 -0
  26. package/dist/exec/commands.js +69 -21
  27. package/dist/exec/commit-hook-skips.js +78 -0
  28. package/dist/exec/core.js +19 -7
  29. package/dist/exec/events.js +159 -8
  30. package/dist/exec/evidence.js +64 -16
  31. package/dist/exec/handoff.js +9 -13
  32. package/dist/exec/limit.js +1 -1
  33. package/dist/exec/mechanical-result.js +45 -0
  34. package/dist/exec/migrate-records.js +249 -0
  35. package/dist/exec/parent-validation.js +160 -12
  36. package/dist/exec/pipeline-state.js +27 -5
  37. package/dist/exec/plan-markdownlint.js +89 -0
  38. package/dist/exec/plans-condense-findings.js +89 -0
  39. package/dist/exec/plans-core.js +24 -17
  40. package/dist/exec/plans-generation.js +52 -25
  41. package/dist/exec/plans-grade-findings.js +8 -3
  42. package/dist/exec/plans-kata-findings.js +61 -0
  43. package/dist/exec/plans-planning.js +3 -3
  44. package/dist/exec/plans-storage.js +12 -24
  45. package/dist/exec/register-resume.js +69 -42
  46. package/dist/exec/register.js +26 -22
  47. package/dist/exec/repo-integration-sync.js +8 -4
  48. package/dist/exec/repo-integration.js +21 -1
  49. package/dist/exec/reporter.js +121 -23
  50. package/dist/exec/results.js +85 -24
  51. package/dist/exec/review-completion.js +47 -0
  52. package/dist/exec/review-kata.js +109 -0
  53. package/dist/exec/run/agent-pipeline.js +75 -6
  54. package/dist/exec/run/agent.js +20 -7
  55. package/dist/exec/run/in-place.js +69 -32
  56. package/dist/exec/run/job.js +81 -24
  57. package/dist/exec/run/lifecycle-commands.js +264 -43
  58. package/dist/exec/run/mode-shared.js +11 -3
  59. package/dist/exec/run/register-command.js +12 -10
  60. package/dist/exec/run/register-core.js +20 -13
  61. package/dist/exec/run/register-mode.js +12 -12
  62. package/dist/exec/run/register-post-review.js +21 -9
  63. package/dist/exec/run/register-resume.js +28 -18
  64. package/dist/exec/run/register-state.js +10 -7
  65. package/dist/exec/run/register-worktree.js +60 -30
  66. package/dist/exec/run/schedule-mode.js +26 -6
  67. package/dist/exec/run/schedule-prepare.js +228 -45
  68. package/dist/exec/run/schedule-task.js +132 -25
  69. package/dist/exec/run/shared.js +4 -3
  70. package/dist/exec/run/trailing-records.js +35 -0
  71. package/dist/exec/run-records.js +2 -0
  72. package/dist/exec/strategy.js +1 -0
  73. package/dist/exec/trailing-records.js +242 -0
  74. package/dist/exec/trial-commands.js +3 -2
  75. package/dist/exec/validate-records-commit.js +110 -0
  76. package/dist/exec/validate-records.js +148 -0
  77. package/dist/exec/worktree-command.js +29 -16
  78. package/dist/exec/worktree-ops-commit.js +118 -59
  79. package/dist/exec/worktree-ops-lifecycle.js +77 -44
  80. package/dist/exec/worktree-ops-merge.js +13 -2
  81. package/dist/exec/worktree-ops.js +2 -2
  82. package/dist/exec/worktree.js +19 -2
  83. package/dist/grade/apply.js +32 -6
  84. package/dist/grade/command-inspect.js +2 -2
  85. package/dist/grade/command-run.js +2 -0
  86. package/dist/grade/command-shared.js +1 -1
  87. package/dist/grade/core.js +18 -5
  88. package/dist/grade/markdown.js +3 -3
  89. package/dist/grade/pipeline-state.js +15 -11
  90. package/dist/grade/plan.js +37 -17
  91. package/dist/grade/result.js +3 -3
  92. package/dist/grade/run.js +23 -3
  93. package/dist/grade/target-discovery.js +17 -4
  94. package/dist/grade/targets.js +12 -11
  95. package/dist/job/job.js +31 -17
  96. package/dist/job/noop.js +104 -0
  97. package/dist/register/core.js +2 -0
  98. package/dist/register/create-commands.js +28 -3
  99. package/dist/register/deliverable-target.js +9 -1
  100. package/dist/register/epic.js +104 -26
  101. package/dist/register/event-merge.js +3 -0
  102. package/dist/register/events.js +4 -0
  103. package/dist/register/external-project.js +3 -0
  104. package/dist/register/item.js +6 -0
  105. package/dist/register/maintenance-commands.js +4 -1
  106. package/dist/register/planning.js +7 -14
  107. package/dist/register/register.js +74 -32
  108. package/dist/register/track-domains.js +34 -0
  109. package/dist/register/track-plan.js +78 -0
  110. package/dist/register/transition-commands.js +8 -0
  111. package/dist/register/work-table.js +64 -0
  112. package/dist/review/grade.js +35 -13
  113. package/dist/routine/definition.js +4 -3
  114. package/dist/routine/failure.js +30 -0
  115. package/dist/routine/routine.js +56 -32
  116. package/dist/routine/storage.js +33 -0
  117. package/dist/schedule/schedule.js +1 -0
  118. package/dist/schedule/strategy-generate-document.js +26 -14
  119. package/dist/schedule/strategy-generate-scope.js +17 -45
  120. package/dist/schedule/strategy-generate.js +33 -3
  121. package/dist/schedule/strategy-profiles.js +86 -12
  122. package/dist/shared/agent-types.js +2 -0
  123. package/dist/shared/condense-records.js +25 -0
  124. package/dist/shared/deprecation.js +8 -0
  125. package/dist/shared/document-metadata.js +20 -0
  126. package/dist/shared/finding-cause.js +20 -0
  127. package/dist/shared/frontmatter-namespace.js +48 -0
  128. package/dist/shared/git.js +149 -15
  129. package/dist/shared/grade-result.js +17 -1
  130. package/dist/shared/local-state.js +20 -0
  131. package/dist/shared/markdownlint-config.js +8 -3
  132. package/dist/shared/plan-conventions.js +129 -0
  133. package/dist/shared/plan-templates.js +57 -41
  134. package/dist/shared/provider-scaffold.js +2 -0
  135. package/dist/shared/run-records.js +224 -0
  136. package/dist/shared/specdojo-config.js +39 -21
  137. package/dist/shared/specdojo-gitignore.js +1 -0
  138. package/dist/shared/text.js +65 -5
  139. package/dist/shared/timeline-index.js +2 -0
  140. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
  141. package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
  142. package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
  143. package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
  144. package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
  145. package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
  146. package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
  147. package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
  148. package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
  149. package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
  150. package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
  151. package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
  152. package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
  153. package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
  154. package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
  155. package/docs/ja/specdojo/guides/docs-editing-guide.md +48 -0
  156. package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
  157. package/docs/ja/specdojo/guides/exec-config-guide.md +61 -28
  158. package/docs/ja/specdojo/guides/exec-operation-guide.md +61 -13
  159. package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
  160. package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +4 -2
  161. package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
  162. package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
  163. package/docs/ja/specdojo/guides/quick-start-guide.md +589 -807
  164. package/docs/ja/specdojo/guides/register-operation-guide.md +26 -4
  165. package/docs/ja/specdojo/guides/remote-host-development-guide.md +33 -4
  166. package/docs/ja/specdojo/guides/review-guide.md +22 -19
  167. package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
  168. package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
  169. package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
  170. package/docs/ja/specdojo/guides/schedule-operation-guide.md +41 -3
  171. package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
  172. package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
  173. package/docs/ja/specdojo/guides/use-case-guide.md +471 -74
  174. package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
  175. package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
  176. package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
  177. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +88 -86
  178. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +108 -122
  179. package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
  180. package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
  181. package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
  182. package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
  183. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
  184. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
  185. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
  186. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
  187. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
  188. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
  189. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
  190. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
  191. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
  192. package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
  193. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
  194. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
  195. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
  196. package/docs/ja/specdojo/references/command-reference.md +146 -99
  197. package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
  198. package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
  199. package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
  200. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
  201. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
  202. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
  203. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
  204. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
  205. package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
  206. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
  207. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +367 -0
  208. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +6 -5
  209. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +96 -100
  210. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +38 -47
  211. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +132 -106
  212. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
  213. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
  214. package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
  215. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
  216. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
  217. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
  218. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
  219. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
  220. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
  221. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
  222. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
  223. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
  224. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
  225. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
  226. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
  227. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
  228. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
  229. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
  230. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
  231. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
  232. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
  233. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
  234. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
  235. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
  236. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
  237. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
  238. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
  239. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
  240. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
  241. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
  242. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
  243. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
  244. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
  245. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
  246. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
  247. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
  248. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
  249. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
  250. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
  251. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
  252. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
  253. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
  254. package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
  255. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
  256. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
  257. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
  258. package/docs/ja/specdojo/samples/bac-sample.md +106 -21
  259. package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
  260. package/docs/ja/specdojo/samples/bds-sample.md +100 -21
  261. package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
  262. package/docs/ja/specdojo/samples/bes-sample.md +80 -21
  263. package/docs/ja/specdojo/samples/br-sample.md +68 -14
  264. package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
  265. package/docs/ja/specdojo/samples/cdfd-overview-sample.md +248 -140
  266. package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
  267. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +130 -97
  268. package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
  269. package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
  270. package/docs/ja/specdojo/samples/cld-sample.md +3 -30
  271. package/docs/ja/specdojo/samples/clis-sample.md +132 -0
  272. package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
  273. package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
  274. package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
  275. package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
  276. package/docs/ja/specdojo/samples/dss-sample.md +175 -0
  277. package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
  278. package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
  279. package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
  280. package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
  281. package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
  282. package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
  283. package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
  284. package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
  285. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
  286. package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
  287. package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
  288. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
  289. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
  290. package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
  291. package/docs/ja/specdojo/samples/sf-sample.md +121 -21
  292. package/docs/ja/specdojo/samples/sld-sample.md +107 -21
  293. package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
  294. package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
  295. package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
  296. package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
  297. package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
  298. package/docs/ja/specdojo/samples/uis-sample.md +164 -20
  299. package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
  300. package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
  301. package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
  302. package/docs/ja/specdojo/templates/bac-template.md +76 -0
  303. package/docs/ja/specdojo/templates/bes-template.md +56 -0
  304. package/docs/ja/specdojo/templates/br-template.md +64 -0
  305. package/docs/ja/specdojo/templates/cdfd-overview-template.md +161 -83
  306. package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
  307. package/docs/ja/specdojo/templates/cdfd-uc-template.md +130 -89
  308. package/docs/ja/specdojo/templates/cnd-template.md +137 -0
  309. package/docs/ja/specdojo/templates/cpd-template.md +129 -0
  310. package/docs/ja/specdojo/templates/cxd-template.md +105 -0
  311. package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
  312. package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
  313. package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
  314. package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
  315. package/docs/ja/specdojo/templates/ifd-template.md +86 -0
  316. package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
  317. package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
  318. package/docs/ja/specdojo/templates/opr-template.md +2 -4
  319. package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
  320. package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
  321. package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
  322. package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
  323. package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
  324. package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
  325. package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
  326. package/docs/ja/specdojo/templates/stsd-template.md +46 -21
  327. package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
  328. package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
  329. package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
  330. package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
  331. package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
  332. package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
  333. package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
  334. package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
  335. package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
  336. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
  337. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +54 -3
  338. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
  339. package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
  340. package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
  341. package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
  342. package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
  343. package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
  344. package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
  345. package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
  346. package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
  347. package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
  348. package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +1 -0
  349. package/package.json +6 -3
  350. package/templates/antigravity/README.md +19 -46
  351. package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
  352. package/templates/antigravity/orchestrator.md +3 -2
  353. package/templates/antigravity/settings.edit.json +73 -0
  354. package/templates/antigravity/settings.orchestrator.json +15 -0
  355. package/templates/antigravity/settings.report.json +7 -0
  356. package/templates/antigravity/settings.review.json +7 -0
  357. package/templates/claude/agents/specdojo-orchestrator.md +3 -2
  358. package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
  359. package/templates/codex/orchestrator.md +3 -2
  360. package/templates/devcontainer/remote-host/devcontainer-tmux.sh +217 -0
  361. package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -96
  362. package/templates/devcontainer/remote-host/ssh-config.sample +3 -1
  363. package/templates/devcontainer/tmux.conf +6 -0
  364. package/templates/init-agent-members.yaml +1 -0
  365. package/templates/init-exec-defaults.yaml +1 -1
  366. package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
@@ -4,205 +4,202 @@ specdojo:
4
4
  type: rulebook
5
5
  deliverable_type: ui
6
6
  status: draft
7
- recipe: undecided
7
+ target_format: markdown
8
+ recipe: not-needed
8
9
  sample: specdojo:uis-sample
9
- template: undecided
10
+ template: not-needed
11
+ based_on:
12
+ - specdojo:rulebook-authoring-standard
10
13
  ---
11
14
 
12
- # 画面仕様(UI) 作成ルール
15
+ # 画面仕様(UIS)作成ルール
13
16
 
14
- 本ドキュメントは、業務分析・要求定義のために **画面仕様(User Interface: UI)を統一形式で記述する標準ルール**です。
17
+ User Interface Specification (UIS) Authoring Rule
15
18
 
16
- ## 1. 全体方針
17
-
18
- - 画面仕様は、**業務ユーザー視点**での画面の目的・表示項目・操作・遷移を明確に記述します。
19
- - 画面の機能に着目し、**画面のレイアウトやワイヤーフレームは含めません**。
20
- - 実装詳細(例: 物理テーブル名、SQL、実装クラス/関数名、UIコンポーネント名)は記載しません。
21
- - 1ファイル = 1画面。
22
-
23
- ## 2. 用語定義
24
-
25
- | 用語 | 定義 |
26
- | -------------- | ---------------------------------------------------------------- |
27
- | 画面 | 業務ユーザーが操作する単位。目的・表示項目・操作・遷移を持つ |
28
- | 表示項目 | 画面に表示する情報(一覧列、詳細項目、集計値、メッセージ等) |
29
- | 操作 | ユーザーが実行できるアクション(検索、登録、更新、削除、確定等) |
30
- | 遷移 | 画面間の移動。条件・遷移先・引き渡し(識別子など)を含む |
31
- | バリデーション | 入力値の妥当性判定(必須、形式、範囲、相関等) |
32
- | エラー表示 | 入力不備・権限不足・対象なし等をユーザーに伝える表示 |
33
-
34
- ## 3. ファイル命名・ID規則
35
-
36
- - ファイル名: `uis-<番号>-<短い日本語名>.md`(例: `uis-0010-商品一覧.md`)
37
- - Frontmatter:
38
- - `id`: `uis-product-list` のように小文字ハイフン形式
39
- - `title`: 「商品一覧」などの画面名
19
+ 業務ユーザーが GUI 画面を介して達成する目的、表示情報、操作、遷移、入力の制約、エラー時の回復を統一形式で記述するためのルールです。
40
20
 
41
- ## 4. 推奨 Frontmatter 項目
42
-
43
- | 項目 | 説明 | 必須 |
44
- | -------- | ------------------------------------------- | ---- |
45
- | id | 画面ID(小文字ハイフン) | ○ |
46
- | type | `ui` 固定 | ○ |
47
- | title | 画面名 | ○ |
48
- | status | `draft`/`ready`/`deprecated` | ○ |
49
- | based_on | 根拠となる仕様ID(API/ドメイン/他画面など) | 任意 |
21
+ ## 1. 全体方針
50
22
 
51
- ### NG/OK例(抜粋)
23
+ - Web・タブレット・デスクトップ等の GUI を対象とし、1 ファイルで 1 画面を定義します。付随する確認ダイアログは、その画面の操作・遷移に含められます。
24
+ - 利用者から観察できる条件と結果を記述します。正常系に加え、空の一覧、処理中、入力不備、権限不足、通信失敗など、対象画面で起こる状態を扱います。
25
+ - CLI の仕様は [[specdojo:clis-rulebook|CLI仕様作成ルール]] に従います。
26
+ - 表示項目の意味と操作の業務上の効果を定義します。ワイヤーフレーム、レイアウト、装飾、内部実装は「禁止事項」に従います。画面をまたぐ色・文字・余白、部品、レイアウトの型、状態表示、アクセシビリティは [[specdojo:dss-rulebook|デザインシステム(DSS)]] で定めます。画面ごとのワイヤーフレームは文書として保守せず、UIS と DSS から試作を作ります。
27
+ - 規範語は **必須**・**任意**・**禁止** で統一します。条件付きの要件には適用条件を明記します。
52
28
 
53
- - NG例: `id: UI_ProductList`(大文字/アンダースコアNG), `type: data`(`ui`以外NG), `extra: foo`(未定義プロパティNG)
54
- - OK例: `id: uis-product-list`, `type: ui`, `status: ready`
29
+ ### 1.1. 利用者と確認すること
55
30
 
56
- ## 5. 本文構成(標準テンプレ)
31
+ | 利用者 | 本書に従う画面仕様で確認すること |
32
+ | ------------------------------------ | ---------------------------------------------------- |
33
+ | 業務担当者・ビジネスアナリスト(BA) | 業務目的、対象ロール、表示情報と業務上の判断の対応 |
34
+ | 設計者(ARC)・開発者(DEV) | 操作前後の状態、画面間の受け渡し、更新の確定時点 |
35
+ | 品質保証担当者(QE) | 入力境界、遷移条件、失敗時の状態と回復操作の期待結果 |
36
+ | プロダクトオーナー(PO) | 対象範囲と、利用者が業務を完了できる条件 |
57
37
 
58
- 各 UI 仕様ファイルは以下見出しを順番に並べます。
38
+ ## 2. 位置づけ
59
39
 
60
- 1. 概要
61
- 2. 対象ユーザー/利用目的
62
- 3. 表示項目
63
- 4. 操作
40
+ - 業務仕様の `user-interface-model` に属し、業務プロセス仕様(`bps`)やシステム化機能(`sf`)を利用者との対話へ具体化します。根拠とする成果物は `based_on` で参照します。
41
+ - 共通の業務規則・用語は上位仕様を正本として参照し、画面固有の表示・入力・操作条件を記述します。上位の画面索引がある場合、共通事項を索引へ集約します。
42
+ - 内部 API、保存方式、UI 部品の設計は後続のシステム設計で扱います。画面仕様には、利用者が確認できる保存の成否や再試行の条件までを記述します。
64
43
 
65
- 5. 遷移
66
- 6. バリデーション
67
- 7. エラー表示
68
- 8. メモ / 将来課題
44
+ ## 3. ファイル命名・ID規則
69
45
 
70
- ## 6. 記述ガイド詳細
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|ドキュメント構成ガイド]] に従います。
71
50
 
72
- ### 6.1 概要
51
+ ## 4. 推奨 Frontmatter 項目
73
52
 
74
- 短い一文で「この画面が何をするか」を業務用語で書きます。
53
+ 共通スキーマ `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` と [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、次の項目を `specdojo:` 配下に置きます。
75
54
 
76
- ### 6.2 対象ユーザー/利用目的
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 配列を持つオブジェクト |
77
65
 
78
- - 対象ユーザー(例: 店員、店主)
79
- - 利用目的(例: 商品を検索し、詳細確認や販売登録へ進む)
66
+ ### 4.1. メタ情報の判断基準と例
80
67
 
81
- ### 6.3 表示項目
68
+ - 良い例では、成果物の種別と所属・根拠を分けて宣言します。参照先には存在する文書 ID を使います。
69
+ - 悪い例として `type: screen`、`id: UIS_Sales`、`title: 販売登録` を指定すると、種別・ID の制約や H1 に名前を書く規約に反します。
70
+ - `part_of` と `based_on` は役割に応じて記入します。関係がない場合は空配列にし、未作成の文書 ID を架空の参照先として登録しません。
82
71
 
83
- - 一覧/詳細/集計など、画面で表示する項目を列挙します。
84
- - レイアウト指定ではなく、**何が表示されるか**を記述します。
72
+ ```yaml
73
+ ---
74
+ specdojo:
75
+ id: uis-sales-register
76
+ type: ui
77
+ status: draft
78
+ rulebook: specdojo:uis-rulebook
79
+ part_of: []
80
+ based_on: []
81
+ ---
82
+ ```
85
83
 
86
- 推奨フォーマット:
84
+ ## 5. 本文要件
87
85
 
88
- | 項目名 | 種別 | 表示形式 | 編集可 | 必須 | 備考 |
89
- | -------- | ---- | -------- | ------ | ---- | --------------------------- |
90
- | 商品名 | 一覧 | テキスト | - | - | 部分一致検索対象 |
91
- | 販売価格 | 一覧 | 金額 | - | - | 税込/税別は別途ルールに従う |
86
+ 章は次の順で構成し、`##` から `####` の見出しに 1 始まりの連番と末尾の `.` を付けます。任意章を省略した場合は番号を詰めます。
92
87
 
93
- ### 6.4 操作
88
+ | 章 | 必須/任意 | 目的と記述要件 |
89
+ | -------------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
90
+ | 概要 | 必須 | 対象業務と画面で達成する結果を 1〜2 文で示す。利用環境や対象範囲を補足できる |
91
+ | 対象ユーザー/利用目的 | 必須 | 操作する業務ロールと、各ロールが達成する業務目的を示す。権限差があれば操作範囲を示す |
92
+ | 表示項目 | 必須 | 項目名、種別、表示内容の意味、編集可否、初期値・未取得時・更新契機などを示す |
93
+ | 操作 | 必須 | 操作名、対象、前提条件、結果を示す。更新の確定時点、処理中や失敗後の再実行条件を含める |
94
+ | 遷移 | 必須 | 契機、遷移元、遷移先、条件、引き渡す情報を示す。戻る・中止時の入力の保持/破棄も示す。画面間移動がなければその旨を記す |
95
+ | バリデーション | 任意。ただし入力がある場合は必須 | 対象、必須性、形式・範囲・相関、判定時点、違反時の扱いを示す。入力のない画面は省略できる |
96
+ | エラー表示と利用者の次の手 | 必須 | 発生条件、表示要点、保持/更新される状態、利用者の回復操作とその結果を示す |
97
+ | メモ / 将来課題 | 任意 | 現在の対象範囲に含めない拡張や、判断待ちの事項と次の確認先を記す |
94
98
 
95
- - ユーザーが実行できる操作を列挙し、前提条件と結果(更新/遷移)を明確にします。
96
- - クリック手順の逐語列挙ではなく、**操作の意味**を書きます。
97
- - ボタンなどのUI部品は原則として列挙しません(**操作**に包含します)。
98
- - 例外: 誤解を避ける必要がある場合のみ、備考に**表示ラベル(文言)**を補足してもよい(レイアウト指定はしない)。
99
+ 関連する操作・遷移・入力制約・エラーは、同じ名称または画面内の識別子で対応づけます。既存の要求・業務規則・受入条件がある場合は参照し、本文へ全文を再掲しません。
99
100
 
100
- 推奨フォーマット:
101
+ ## 6. 記述ガイド
101
102
 
102
- | 操作名 | 対象 | 前提条件 | 結果(更新/遷移) |
103
- | -------- | -------- | ---------- | ---------------------------- |
104
- | 検索 | 検索条件 | なし | 条件に合致する商品一覧を表示 |
105
- | 新規登録 | - | 権限がある | 商品登録画面へ遷移 |
103
+ 各節の判断基準を満たす粒度で記述します。表の列は推奨形式であり、本文要件を満たす別形式も使用できます。共通事項の正本と画面固有の条件は「位置づけ」に従って記述します。
106
104
 
107
- ### 6.5 遷移
105
+ ### 6.1. 概要
108
106
 
109
- 遷移元/遷移先/遷移条件/引き渡す識別子(概念レベル)を明確にします。
107
+ - どの業務のどの場面で、誰が何を完了する画面かを判断できることを基準とします。
108
+ - 利用端末、開始・終了の境界、対象となる取引の範囲など、後続の操作条件に必要な前提を補足します。
109
+ - 表示項目や操作の全件列挙はそれぞれの章へ置きます。
110
110
 
111
- 推奨フォーマット:
111
+ **良い例**として「店員が店頭で購入商品と預かり金を登録し、販売を確定して釣銭を確認する画面。」と記述します。
112
112
 
113
- | 遷移名 | 遷移先 | 条件 | 引き渡し | 備考 |
114
- | ------ | ------------------------------ | ------------ | -------- | ---- |
115
- | 詳細へ | 商品詳細(uis-product-detail) | 一覧行を選択 | 商品ID | - |
113
+ **悪い例**の「販売を便利にする画面。」では、利用者と完了する業務を判断できません。
116
114
 
117
- ### 6.6 バリデーション
115
+ ### 6.2. 対象ユーザー/利用目的
118
116
 
119
- 入力欄がある場合、必須/形式/範囲/相関(開始日 ≤ 終了日など)を列挙します。
117
+ - ロールごとに利用場面と達成する結果が対応することを基準とします。
118
+ - 権限に差がある場合、参照・登録・取消など許可される操作の範囲を明記します。
119
+ - 顧客が画面を操作するか、店員を介して結果を受け取るかを区別します。
120
120
 
121
- ### 6.7 エラー表示
121
+ **良い例**として「店員・店主が接客中に購入明細と釣銭を確認する。両ロールに販売登録を許可する。来店客へは担当者が合計額を伝える。」と記述します。
122
122
 
123
- 代表的な2〜4ケース(入力不備、権限不足、対象なし等)と、ユーザーに見せるメッセージ方針(短く・行動可能)を記述します。
123
+ **悪い例**の「ユーザーがシステムを利用する。」では、業務ロールと利用目的が定まりません。
124
124
 
125
- ## 7. 命名・記述スタイル
125
+ ### 6.3. 表示項目
126
126
 
127
- - 画面名は「名詞+用途」: 例 `商品一覧`, `売上登録`, `在庫照会`
128
- - 操作名は短く動詞で: 例 `検索`, `登録`, `更新`, `取消`, `確定`
129
- - 画面/項目/操作は業務用語で統一し、略語は用語集にあるもののみ使用します
127
+ - 表示する業務情報と、空・未取得・処理中を含む値の意味が読み取れることを基準とします。
128
+ - 項目名、種別(入力・一覧・集計・状態等)、表示内容、編集可否、表示条件・初期値・更新契機を列として持たせます。金額や数量には単位を記します。
129
+ - 計算値は算出の意味か上位規則の参照を示し、入力の許容範囲は「バリデーション」へまとめます。
130
130
 
131
- ## 8. 階層分解ガイド
131
+ | 項目名 | 種別 | 表示内容 | 編集可否 | 表示条件・更新契機 |
132
+ | ------------ | ---- | ---------------------- | -------- | ----------------------------------------------------- |
133
+ | 合計請求金額 | 集計 | 明細小計の合計、円単位 | 不可 | 明細なしは 0 円。追加・数量変更・削除の成功時に再計算 |
132
134
 
133
- | シグナル | 分割検討 |
134
- | --------------------- | -------------------------------- |
135
- | 表示項目が多い(>30) | 目的別に分割(一覧/詳細/設定等) |
136
- | 操作が多い(>10) | サブ画面または別仕様へ分割 |
137
- | 遷移先が多い(>6) | 目的別に導線を分ける |
135
+ この表を **良い例**とします。**悪い例**の「合計欄を右下に赤色で表示する。」では、値の意味や更新条件が定まりません。
138
136
 
139
- ## 9. 禁止事項
137
+ ### 6.4. 操作
140
138
 
141
- | 項目 | 理由 |
142
- | ------------------------------------- | ---------------------------------- |
143
- | ワイヤーフレーム/座標/ピクセル指定 | 設計変更に弱く、要求定義段階で過剰 |
144
- | 物理テーブル名・カラム名・SQL全文 | 概念レベル逸脱 |
145
- | 実装クラス/関数名・UIコンポーネント名 | 実装依存で変更に弱い |
146
- | クリック手順の逐語列挙 | 可読性低下・変更に弱い |
139
+ - 操作の実行可否と、成功・中止・失敗後の業務状態を判定できることを基準とします。
140
+ - 操作名、対象、前提条件、結果を列として持たせます。利用できない状態と、その際に無効化するかエラーを表示するかを定めます。
141
+ - 保存や確定を伴う操作では、処理中の再操作、結果が不明な場合の確認方法、再試行可能になる条件を記します。回復操作も操作表へ含めます。
147
142
 
148
- ## 10. よくある誤りと対策
143
+ | 操作名 | 対象 | 前提条件 | 結果 |
144
+ | -------- | ------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
145
+ | 会計確定 | 「会計確定」 | 明細があり、入力制約を満たす登録中の取引 | 処理中は再操作を無効化。成功時に販売・在庫を確定して完了画面へ移る。結果不明時はエラー表に従って取引状態を確認 |
149
146
 
150
- - 「どのDBを参照するか」を書く → 「どの概念データを表示するか」に置換
151
- - クリック手順を長文で列挙 → 操作の前提条件と結果(遷移/更新)に要約
152
- - 表示項目が列挙だけで目的が不明 → 「対象ユーザー/利用目的」を先に明確化
147
+ この表を **良い例**とします。**悪い例**の「確定ボタンを押すと保存する。」では、保存の条件や二重操作時の扱いが不明です。
153
148
 
154
- ## 11. サンプル(簡易)
149
+ ### 6.5. 遷移
155
150
 
156
- ```markdown
157
- ---
158
- id: uis-product-list
159
- type: ui
160
- title: 商品一覧
161
- status: draft
162
- part_of: []
163
- based_on: []
164
- ---
151
+ - 流入・流出・戻りを、契機と業務上の条件から辿れることを基準とします。
152
+ - 遷移名、契機、遷移元、遷移先、条件、引き渡し情報を列として持たせます。渡す情報がなければ「なし」と記します。
153
+ - ダイアログを介する場合は、選択確定と取り消して戻る場合の両方を示します。遷移先の文書があればリンクし、未作成なら画面名・ID をバッククォートで記します。
165
154
 
166
- ## 概要
155
+ | 遷移名 | 契機 | 遷移元 | 遷移先 | 条件 | 引き渡し情報・入力の扱い |
156
+ | ---------------- | -------- | -------------- | -------------- | -------------- | -------------------------------------------------------------- |
157
+ | 商品選択から復帰 | 「選択」 | `商品検索画面` | `販売登録画面` | 商品を選択済み | 商品コード。既存明細を保持し、追加条件を満たす場合に明細へ反映 |
167
158
 
168
- 商品を検索し、詳細確認や登録に進むための一覧画面。
159
+ この表を **良い例**とします。**悪い例**の「選択すると次画面へ進む。」では、行き先と受け渡し情報が定まりません。
169
160
 
170
- ## 対象ユーザー/利用目的
161
+ ### 6.6. バリデーション
171
162
 
172
- - 対象ユーザー: 店員
173
- - 利用目的: 商品を検索して販売登録に必要な情報を確認する
163
+ - 同じ入力に対して同じ可否を判断でき、境界値で検証できることを基準とします。
164
+ - 対象、必須性、形式・範囲・相関、判定時点、違反時の扱い・対応エラーを列として持たせます。空欄・範囲の上限下限を具体化します。
165
+ - 入力時と確定時に判定する条件が異なる場合は区別します。失敗時に前の有効値を保持するか、修正用に入力値を残すかを明記します。
174
166
 
175
- ## 表示項目
167
+ | 対象 | 必須性 | 条件 | 判定時点 | 違反時の扱い |
168
+ | ---- | ------ | ----------------------------- | ---------------------------------------- | -------------------------------------------------------- |
169
+ | 数量 | 必須 | 1〜999 の整数かつ現在庫数以下 | 数量変更時。現在庫数は会計確定時にも確認 | 明細・合計は直前の有効値を保持し、修正対象と在庫数を表示 |
176
170
 
177
- | 項目名 | 種別 | 表示形式 | 編集可 | 必須 | 備考 |
178
- | -------------- | ---- | -------- | ------ | ---- | --------------- |
179
- | 商品名 | 一覧 | テキスト | - | - | - |
180
- | 販売価格 | 一覧 | 金額 | - | - | - |
181
- | 商品ステータス | 一覧 | ラベル | - | - | 販売中/販売停止 |
171
+ この表を **良い例**とします。**悪い例**の「数量が適切であること。」では、許容範囲も確認時点も判定できません。
182
172
 
183
- ## 操作
173
+ ### 6.7. エラー表示と利用者の次の手
184
174
 
185
- | 操作名 | 対象 | 前提条件 | 結果(更新/遷移) |
186
- | -------- | -------- | -------------- | ---------------------------- |
187
- | 検索 | 検索条件 | なし | 条件に合致する商品一覧を表示 |
188
- | 詳細表示 | 一覧行 | 対象が存在する | 商品詳細へ遷移 |
175
+ - 利用者が現在の状態、確定の有無、次に実行できる操作を判断できることを基準とします。
176
+ - エラー事象、発生条件、表示要点、状態の扱い、回復アクションを列として持たせます。内部例外名を表示要点の代わりに使用しません。
177
+ - 入力不備・対象なし・権限不足・通信障害など、対象画面で起こる代表ケースを扱います。回復に別画面や運用担当者が必要な場合は、その行き先と連絡時に渡す情報を示します。
189
178
 
190
- ## 遷移
179
+ | エラー事象 | 発生条件 | 表示要点 | 状態の扱い | 利用者の次の手 |
180
+ | ------------ | ------------------------------ | ---------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------- |
181
+ | 会計結果不明 | 確定要求後に応答を受信できない | 「会計結果を確認してください」と取引番号 | 明細と預かり金を保持し、編集・会計確定を無効化 | 「結果確認」で同じ取引を照会。確定済みは完了画面へ、未確定が確認できた場合は登録中へ戻る |
191
182
 
192
- | 遷移名 | 遷移先 | 条件 | 引き渡し | 備考 |
193
- | ------ | ------------------------------ | ------------ | -------- | ---- |
194
- | 詳細へ | 商品詳細(uis-product-detail) | 一覧行を選択 | 商品ID | - |
183
+ この表を **良い例**とします。**悪い例**の「通信エラー。もう一度確定する。」では、確定済みの取引を再登録するおそれがあります。
195
184
 
196
- ## バリデーション
185
+ ### 6.8. メモ / 将来課題
197
186
 
198
- - 検索条件(商品名): 100文字以内
187
+ - 現在の操作・制約と将来の拡張を識別できることを基準とします。
188
+ - 未確定事項は共通ラベルを用い、影響範囲と確認先・次のアクションを示します。
189
+ - 現行動作に必要な判断をこの章だけへ移さず、該当する本文要件にも反映します。
199
190
 
200
- ## エラー表示
191
+ **良い例**として「電子決済は将来の拡張候補とし、導入検討時に店主が決済方法と取消手順を確認する。」と記述します。
201
192
 
202
- - 検索結果0件: 「該当する商品がありません」
203
- - 権限不足: 「権限がありません」
193
+ **悪い例**の「エラー時の扱いは後で検討する。」では、現行画面を実装・検証する条件が欠落します。
204
194
 
205
- ## メモ / 将来課題
195
+ ## 7. 禁止事項
206
196
 
207
- 将来: タグ検索を追加
208
- ```
197
+ | 禁止する記述 | 理由 |
198
+ | ------------------------------------------------------------------------- | ------------------------------------------------ |
199
+ | CLI コマンド群を画面・画面遷移として定義する | CLI 固有の要件は clis が担うため |
200
+ | ワイヤーフレーム、配置図、ピクセル座標、CSS、色・フォント・部品配置の指定 | 業務仕様の判断範囲を越えるため |
201
+ | 物理テーブル・物理カラム・SQL・実装クラスや関数・UI ライブラリの指定 | 後続設計の選択に結合するため |
202
+ | クリックやキー入力の逐語列挙だけで操作を説明する | 操作の前提条件と業務上の効果を判断できないため |
203
+ | 回復操作を伴わないエラー一覧、結果不明の更新を無条件に再実行させる指示 | 利用者が業務を安全に再開できる条件が欠けるため |
204
+ | 共通の業務規則や上位仕様の全文再掲 | 正本との不整合や更新漏れを招くため |
205
+ | 未定義の Frontmatter 項目、`ui` 以外の成果物 `type` | メタ情報スキーマと主 rulebook の宣言に反するため |
@@ -2,37 +2,122 @@
2
2
  specdojo:
3
3
  id: specdojo:bac-sample
4
4
  type: requirement
5
- status: draft
5
+ status: ready
6
6
  rulebook: specdojo:bac-rulebook
7
+ based_on: []
7
8
  ---
8
9
 
9
- # [業務受入条件](../rulebooks/bac-rulebook.md) サンプル
10
+ # 駄菓子屋きぬや 現金販売の業務受入条件
10
11
 
11
- ## 1. 目的と適用範囲
12
+ ## 1. 概要
12
13
 
13
- 本書は、業務として受け入れ可能であることを示す条件を定義するための最小サンプルである。
14
+ BAC を初めて作成する BA と、承認・設計・受入テストへ引き継ぐ担当者に向けた完成例である。構成と品質判定・検査・確定条件は [[specdojo:bac-rulebook|業務受入条件 作成ルール]] の「本文要件」、rulebook・共通文脈の変更時の追従は [[specdojo:sample-authoring-standard|Sample 記述標準]] の「運用ルール」に従う。
14
15
 
15
- ## 2. 入力情報
16
+ 店主代表または家族利用者代表が、現金販売を確定し、販売記録と在庫の変化を照合して店番を引き継げることを確認する。店主の記憶とノートへの転記に頼る負担を減らし、家族が担当しても同じ販売結果を確認できるようにする。
16
17
 
17
- - 対象: 駄菓子屋の販売管理システム
18
- - 前提: プロジェクト文脈は handbook の共通方針に準拠する
19
- - 参照: `../rulebooks/bac-rulebook.md`
18
+ - 価値との対応: 販売と在庫の記録を照合する価値を BAC-01、販売できない購入を誤って確定せず引き継ぐ価値を BAC-02・BAC-03 で確認する。
19
+ - 利用場面・対象範囲: 単一店舗・端末1台で、購入する商品と数量をそろえ、請求額への合意と現金受領を経て、販売と在庫の記録を確認するまで。
20
+ - 対象外: つけ販売、キャッシュレス決済、返品、確定後の訂正、仕入れ、オフラインでの販売継続。
21
+ - 根拠: [[specdojo:prj-overview-sample|プロジェクト概要]] の「まず記録する」方針と家族による店番の継続を、現金販売に限定して具体化する。本例用の業務仕様 `kinuya-bps-cash-sale` は未同梱の架空参照名であり、以下の仮定を完成例の条件とする。受入条件の直接の根拠となる先行成果物への `based_on` は未接続である。
20
22
 
21
- ## 3. 記述内容
23
+ _ASSUMPTION_: 本例では、商品・数量が確定し、在庫が足り、合意した請求額の現金を受領してから販売を確定する。確定時は販売を1件記録し、販売数だけ在庫を減らす。入力不足・在庫不足では確定せず、不足を解消してから同じ購入内容の確認へ戻る。これは学習用の業務仮定であり、実店舗の承認済み仕様ではない。
22
24
 
23
- - 主な内容: 業務シナリオ、受入条件、前提、操作、期待結果 など
24
- - 必須観点: 対象、条件、判定基準、責任者
25
+ _ASSUMPTION_: 未確定の購入は、分かっている商品・希望数量、不足情報、次に確認することを引継ぎメモに残す。購入中止が合意された場合は中止を記し、再開対象から外す。販売記録・在庫記録・引継ぎメモは論理的な証跡名であり、保存形式は本例で定めない。
25
26
 
26
- ## 4. 最小記述例
27
+ | 役割 | 確認・合意する内容 |
28
+ | ---------------- | -------------------------------------------------------------------------- |
29
+ | 家族利用者代表 | 店主不在でも、販売記録・在庫・未確定の購入内容を照合して引き継げること |
30
+ | 店主代表 | 販売確定の条件、販売を止める条件、停止後の次の行為を業務として承認すること |
31
+ | 同行レビュー担当 | 各シナリオの開始状態と確定後の記録から期待結果を確認できること |
32
+ | 開発担当 | 業務条件を設計と動作確認へ引き継ぎ、入力項目と保存構造の正本を整えること |
27
33
 
28
- | 項目 | 値 | 備考 |
29
- | ------------ | ---------------------------------------------------- | ------------------------------------ |
30
- | ドキュメント | [業務受入条件](../rulebooks/bac-rulebook.md) | 最小サンプル |
31
- | 目的 | 業務として受け入れ可能であることを示す条件を定義する | specdojo:deliverables-reference 準拠 |
32
- | 主な内容 | 業務シナリオ、受入条件、前提、操作、期待結果 など | 要点のみ記載 |
34
+ ## 2. 受入条件
33
35
 
34
- ## 5. 未解決事項
36
+ 共通前提として、店番担当は店主代表または家族利用者代表とする。商品Aは販売可能な商品で、単価は最終的な販売価格30円、開始時の在庫は5個とする。各ケースは独立した開始状態で確認し、端末と記録の利用に支障はない。計算方式・税区分・保存構造は本例では定めない。
35
37
 
36
- | 論点 | 処理方針 |
37
- | -------------- | ------------------------ |
38
- | 要件詳細の補強 | 実案件適用時に具体化する |
38
+ ### 2.1. BAC-01 現金販売を確定して記録を照合する
39
+
40
+ 根拠: 概要に記した販売確定と記録の仮定。
41
+
42
+ #### 2.1.1. 前提
43
+
44
+ - 商品Aと購入数量が確定し、在庫数以内である。
45
+ - 来店客と請求額を合意し、その金額の現金を受領している。
46
+
47
+ #### 2.1.2. 操作
48
+
49
+ - 店番担当が、商品と数量、請求額、受領額を確認して販売を確定する。
50
+
51
+ #### 2.1.3. 期待結果
52
+
53
+ | ケース ID | 条件・入力 | 期待結果(観測点) |
54
+ | --------- | ------------------------------------------------------------------ | -------------------------------------------------------------------- |
55
+ | C-01 | 家族利用者代表が商品Aを2個、請求額60円・受領額60円で販売する | 商品A・数量2・販売額60円の販売記録が1件残り、在庫が5個から3個になる |
56
+ | C-02 | 店主代表が商品Aを在庫と同じ5個、請求額150円・受領額150円で販売する | 商品A・数量5・販売額150円の販売記録が1件残り、在庫が5個から0個になる |
57
+
58
+ - 販売記録と在庫の変化を同じ販売へ対応付けて確認できる。次の店番担当は販売済みと未確定の購入を区別できる。
59
+
60
+ #### 2.1.4. 判定方法
61
+
62
+ - 同行レビュー担当が確定後の販売記録と開始前後の在庫記録を照合し、商品・数量・金額・件数と在庫差分を確認する。家族利用者代表は店番交代時に同じ販売記録と引継ぎメモから、販売済みの内容と未確定の購入を区別して説明する。
63
+
64
+ ### 2.2. BAC-02 在庫不足なら販売を確定せず確認へ戻る
65
+
66
+ 根拠: 概要に記した在庫不足時の仮定。
67
+
68
+ #### 2.2.1. 前提
69
+
70
+ - 商品Aの購入希望数は6個で、在庫5個を超えている。
71
+ - 販売は未確定で、現金をまだ受領していない。
72
+
73
+ #### 2.2.2. 操作
74
+
75
+ - 店番担当が、希望数量と在庫を照合して販売を進めようとする。
76
+
77
+ #### 2.2.3. 期待結果
78
+
79
+ - 不足1個と対象商品を店番担当が確認でき、販売は確定されない。販売記録は追加されず、在庫は5個のままである。
80
+ - 店番担当は不足を来店客へ説明し、数量変更または購入中止を確認できる。店番交代時には、商品A・希望6個・不足1個・来店客への数量変更または中止の確認待ちを引継ぎメモに残し、未確定の内容として次の担当へ渡せる。
81
+ - 来店客が2個への変更に合意した場合は、請求額と現金受領を確認してから BAC-01 の C-01 に相当する販売へ進む。希望数6個の販売記録は作られない。
82
+ - 購入中止に合意した場合は引継ぎメモを中止へ更新し、販売記録は追加せず在庫5個を維持する。
83
+
84
+ #### 2.2.4. 判定方法
85
+
86
+ - 同行レビュー担当が停止直後の不足の表示・販売記録・在庫記録を希望数と開始前の状態に照合する。家族利用者代表は交代時の引継ぎメモから対象・不足数・次の確認行為を説明する。数量変更と購入中止は独立した開始状態で確認し、合意後に同行レビュー担当が引継ぎメモと販売・在庫記録を照合する。変更時は在庫3個・記録1件、中止時は在庫5個・記録追加なしであることを確認する。
87
+
88
+ ### 2.3. BAC-03 必須情報が不足した購入を未確定のまま引き継ぐ
89
+
90
+ 根拠: 概要に記した入力不足時の仮定。
91
+
92
+ #### 2.3.1. 前提
93
+
94
+ - 共通前提と異なり、次のケースのいずれかで販売に必要な情報がそろっていない。
95
+ - 販売は未確定で、現金受領前である。各ケースは独立して確認する。
96
+
97
+ #### 2.3.2. 操作
98
+
99
+ - 店番担当が購入内容を確認し、不足があれば来店客または次の店番担当へ確認事項を伝える。
100
+
101
+ #### 2.3.3. 期待結果
102
+
103
+ | ケース ID | 条件・入力 | 期待結果(観測点) |
104
+ | --------- | --------------------------------------- | ---------------------------------------------------------------- |
105
+ | C-03 | 数量2は分かるが、対象商品が特定できない | 対象商品の確認が必要と分かり、別の商品を推測して販売を確定しない |
106
+ | C-04 | 商品Aは分かるが、数量が不明である | 数量の確認が必要と分かり、仮の数量で販売を確定しない |
107
+
108
+ - 両ケースで販売記録は追加されず、在庫は5個のままである。引継ぎメモに判明済みの情報と商品または数量の確認待ちを記し、確定済みの販売と区別して次の担当へ引き継げる。
109
+ - 不足が解消し商品A・数量2となった場合は、請求額と現金受領を確認してから BAC-01 の C-01 に相当する販売へ進める。不足中の内容を別の販売として残さない。
110
+
111
+ #### 2.3.4. 判定方法
112
+
113
+ - 同行レビュー担当が停止時の販売記録と在庫記録を開始前と照合する。店番交代時に家族利用者代表が引継ぎメモから判明済みの情報、不足情報、次に確認すること、未確定であることを説明する。補完後は同行レビュー担当が確定時の販売記録と在庫記録を C-01 の期待値に照合し、不足中の販売記録がないことを確認する。
114
+
115
+ ## 3. メモ / 将来課題
116
+
117
+ | 論点 | 影響するシナリオ・受入への影響 | 担当・判断者 | 判断時点・解消条件 | 追跡先 |
118
+ | --------------------------------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
119
+ | _ASSUMPTION_: 学習用の販売条件と数値 | BAC-01〜03 は粒度を示す完成例であり、実店舗の受入実績ではない | BA が仮定を整理し、店主代表(PO)が業務判断、開発担当(DEV)が試行準備 | 実案件適用前に業務仮定を承認済み仕様へ置き換え、対象商品・数量と引継ぎメモを準備する | 下記の仕様接続と併せて実案件の PJR 登録候補とする |
120
+ | _TODO_: 業務仕様と入力・記録の契約 | BAC-01〜03 の直接の根拠 `kinuya-bps-cash-sale` は未同梱。接続するまで実運用の受入を確定できない | BA が業務仕様と `based_on` を接続し、DEV が契約を整備。店主代表(PO)が業務条件を承認し、同行レビュー担当(QE)が照合 | 受入実施前に、各シナリオの根拠と販売・在庫・引継ぎの証跡をたどれ、全期待結果を判定できること | BA が受入保留への影響を PM へ渡す。登録後は実案件の PJR 個票を参照する |
121
+ | _UNDECIDED_: 通信・記録不能時の販売継続 | BAC-01〜03 の正常稼働前提を外れる。当該経路の受入は保留し、現行シナリオの合格で代替しない | BA が影響を整理し、技術メンター(ARC)が回復案を提示、店主代表(PO)が継続可否を判断 | 当該経路を追加する前に未確定取引の照合と再開条件を承認し、QE が停止・再開の期待結果を確認する | PM へのリスク登録候補。実案件の PJR 個票は未同梱 |
122
+
123
+ 返品と確定後の訂正は将来の別シナリオで扱う。店主代表が必要性と業務上の扱いを決めてから追加し、現行の販売条件へ混ぜない。