specdojo 0.7.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 (462) hide show
  1. package/.github/agents/specdojo-orchestrator.md +7 -3
  2. package/CHANGELOG.md +217 -0
  3. package/dist/catalog/build.js +24 -1
  4. package/dist/catalog/catalog.js +16 -14
  5. package/dist/catalog/plan.js +1 -1
  6. package/dist/catalog/scaffold.js +4 -1
  7. package/dist/commands/agent.js +5 -3
  8. package/dist/commands/build.js +69 -10
  9. package/dist/commands/git.js +206 -0
  10. package/dist/commands/init.js +9 -3
  11. package/dist/commands/night-orchestrator.js +6 -4
  12. package/dist/commands/where.js +25 -0
  13. package/dist/dashboard/dashboard-timeline.js +18 -16
  14. package/dist/dashboard/dashboard.js +616 -261
  15. package/dist/dashboard/epic-plan.js +81 -0
  16. package/dist/dashboard/exec-records.js +16 -20
  17. package/dist/dashboard/routines.js +11 -12
  18. package/dist/dashboard/timeline-build.js +5 -9
  19. package/dist/dashboard/timeline.js +23 -18
  20. package/dist/devcontainer/scaffold.js +18 -0
  21. package/dist/docs/frontmatter-namespace.js +1 -48
  22. package/dist/docs/index-command.js +2 -2
  23. package/dist/docs/yaml-business-tables.js +243 -0
  24. package/dist/docs/yaml-interface-tables.js +106 -0
  25. package/dist/docs/yaml-pages-command.js +5 -3
  26. package/dist/docs/yaml-pages.js +268 -3
  27. package/dist/docs/yaml-table-shared.js +70 -0
  28. package/dist/docs/yaml-tables.js +39 -0
  29. package/dist/exec/agent-config.js +31 -0
  30. package/dist/exec/agent-plan.js +3 -2
  31. package/dist/exec/agent-protected-config.js +2 -0
  32. package/dist/exec/commands.js +100 -39
  33. package/dist/exec/commit-hook-skips.js +78 -0
  34. package/dist/exec/core.js +19 -7
  35. package/dist/exec/events.js +179 -8
  36. package/dist/exec/evidence.js +77 -19
  37. package/dist/exec/handoff.js +9 -13
  38. package/dist/exec/limit.js +1 -1
  39. package/dist/exec/mechanical-result.js +45 -0
  40. package/dist/exec/migrate-records.js +249 -0
  41. package/dist/exec/parent-validation.js +209 -15
  42. package/dist/exec/pipeline-state.js +27 -5
  43. package/dist/exec/plans-condense-findings.js +89 -0
  44. package/dist/exec/plans-core.js +45 -19
  45. package/dist/exec/plans-generation.js +52 -30
  46. package/dist/exec/plans-grade-findings.js +8 -3
  47. package/dist/exec/plans-kata-findings.js +61 -0
  48. package/dist/exec/plans-planning.js +3 -3
  49. package/dist/exec/plans-storage.js +12 -24
  50. package/dist/exec/post-integration.js +162 -0
  51. package/dist/exec/queue-command.js +166 -0
  52. package/dist/exec/queue.js +285 -0
  53. package/dist/exec/register-foreign-wait.js +84 -0
  54. package/dist/exec/register-resume.js +55 -56
  55. package/dist/exec/register.js +26 -22
  56. package/dist/exec/repo-integration-sync.js +21 -5
  57. package/dist/exec/repo-integration.js +21 -1
  58. package/dist/exec/reporter.js +121 -23
  59. package/dist/exec/results.js +106 -25
  60. package/dist/exec/review-completion.js +47 -0
  61. package/dist/exec/review-kata.js +112 -0
  62. package/dist/exec/run/agent-pipeline.js +78 -8
  63. package/dist/exec/run/agent.js +32 -13
  64. package/dist/exec/run/change-scope.js +365 -0
  65. package/dist/exec/run/deferred-cleanup.js +31 -0
  66. package/dist/exec/run/in-place.js +73 -33
  67. package/dist/exec/run/job-lock.js +66 -0
  68. package/dist/exec/run/job-sequence.js +137 -0
  69. package/dist/exec/run/job.js +135 -41
  70. package/dist/exec/run/lifecycle-commands.js +189 -37
  71. package/dist/exec/run/lock.js +22 -1
  72. package/dist/exec/run/mode-shared.js +11 -3
  73. package/dist/exec/run/register-command.js +14 -15
  74. package/dist/exec/run/register-core.js +20 -13
  75. package/dist/exec/run/register-mode.js +77 -17
  76. package/dist/exec/run/register-post-review.js +21 -9
  77. package/dist/exec/run/register-resume.js +95 -31
  78. package/dist/exec/run/register-state.js +23 -15
  79. package/dist/exec/run/register-worktree.js +184 -139
  80. package/dist/exec/run/schedule-mode.js +79 -18
  81. package/dist/exec/run/schedule-prepare.js +204 -59
  82. package/dist/exec/run/schedule-task.js +203 -49
  83. package/dist/exec/run/shared.js +9 -3
  84. package/dist/exec/run/trailing-records.js +35 -0
  85. package/dist/exec/run-records.js +2 -0
  86. package/dist/exec/schedule/schedule.js +116 -4
  87. package/dist/exec/shared.js +1 -1
  88. package/dist/exec/smoke.js +190 -0
  89. package/dist/exec/strategy.js +14 -3
  90. package/dist/exec/task-view.js +6 -4
  91. package/dist/exec/trailing-records.js +242 -0
  92. package/dist/exec/trial-commands.js +8 -4
  93. package/dist/exec/trial-core.js +6 -1
  94. package/dist/exec/validate-records-commit.js +110 -0
  95. package/dist/exec/validate-records.js +148 -0
  96. package/dist/exec/validation-metrics.js +181 -0
  97. package/dist/exec/worktree-cleanup-lock.js +26 -0
  98. package/dist/exec/worktree-command.js +38 -17
  99. package/dist/exec/worktree-ops-commit.js +119 -48
  100. package/dist/exec/worktree-ops-lifecycle.js +77 -48
  101. package/dist/exec/worktree-ops-merge.js +13 -2
  102. package/dist/exec/worktree-ops.js +2 -2
  103. package/dist/exec/worktree.js +32 -4
  104. package/dist/grade/apply.js +32 -6
  105. package/dist/grade/command-apply.js +3 -3
  106. package/dist/grade/command-inspect.js +7 -5
  107. package/dist/grade/command-plan.js +1 -1
  108. package/dist/grade/command-run.js +7 -1
  109. package/dist/grade/command-shared.js +1 -1
  110. package/dist/grade/core.js +18 -5
  111. package/dist/grade/markdown.js +3 -3
  112. package/dist/grade/pipeline-state.js +15 -11
  113. package/dist/grade/plan.js +37 -17
  114. package/dist/grade/result.js +3 -3
  115. package/dist/grade/run.js +87 -11
  116. package/dist/grade/target-discovery.js +17 -4
  117. package/dist/grade/targets.js +12 -11
  118. package/dist/job/definition.js +84 -8
  119. package/dist/job/job.js +109 -39
  120. package/dist/job/noop.js +104 -0
  121. package/dist/register/authoring-sources.js +22 -16
  122. package/dist/register/core.js +2 -0
  123. package/dist/register/create-commands.js +28 -3
  124. package/dist/register/deliverable-target.js +9 -1
  125. package/dist/register/epic.js +104 -26
  126. package/dist/register/event-merge.js +3 -0
  127. package/dist/register/events.js +4 -0
  128. package/dist/register/external-project.js +3 -0
  129. package/dist/register/item.js +6 -0
  130. package/dist/register/maintenance-commands.js +6 -3
  131. package/dist/register/planning.js +7 -14
  132. package/dist/register/register.js +74 -16
  133. package/dist/register/track-domains.js +34 -0
  134. package/dist/register/track-plan.js +78 -0
  135. package/dist/register/transition-commands.js +8 -0
  136. package/dist/register/work-table.js +64 -0
  137. package/dist/review/grade.js +35 -13
  138. package/dist/routine/definition.js +13 -3
  139. package/dist/routine/failure.js +30 -0
  140. package/dist/routine/routine.js +189 -71
  141. package/dist/routine/status.js +62 -0
  142. package/dist/routine/storage.js +33 -0
  143. package/dist/schedule/schedule.js +39 -39
  144. package/dist/schedule/strategy-generate-document.js +26 -14
  145. package/dist/schedule/strategy-generate-scope.js +17 -45
  146. package/dist/schedule/strategy-generate.js +33 -3
  147. package/dist/schedule/strategy-profiles.js +86 -12
  148. package/dist/shared/agent-types.js +7 -0
  149. package/dist/shared/condense-records.js +25 -0
  150. package/dist/shared/cross-process-lock.js +9 -1
  151. package/dist/shared/deprecation.js +8 -0
  152. package/dist/shared/dist-freshness.js +8 -2
  153. package/dist/shared/document-metadata.js +20 -0
  154. package/dist/shared/finding-cause.js +20 -0
  155. package/dist/shared/frontmatter-namespace.js +48 -0
  156. package/dist/shared/git-environment.js +2 -1
  157. package/dist/shared/git.js +186 -16
  158. package/dist/shared/grade-result.js +17 -1
  159. package/dist/shared/lefthook-scaffold.js +3 -0
  160. package/dist/shared/local-config.js +244 -0
  161. package/dist/shared/local-state.js +20 -0
  162. package/dist/shared/markdownlint-config.js +8 -3
  163. package/dist/shared/plan-conventions.js +129 -0
  164. package/dist/shared/plan-templates.js +57 -41
  165. package/dist/shared/run-records.js +224 -0
  166. package/dist/shared/specdojo-config.js +73 -41
  167. package/dist/shared/specdojo-gitignore.js +1 -0
  168. package/dist/shared/text.js +74 -6
  169. package/dist/shared/timeline-index.js +2 -0
  170. package/dist/shared/where-alias.js +13 -0
  171. package/dist/specdojo.js +4 -0
  172. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
  173. package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
  174. package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
  175. package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
  176. package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
  177. package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
  178. package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
  179. package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
  180. package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
  181. package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
  182. package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
  183. package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
  184. package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
  185. package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
  186. package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
  187. package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
  188. package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
  189. package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
  190. package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
  191. package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
  192. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  193. package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
  194. package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
  195. package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
  196. package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
  197. package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
  198. package/docs/ja/specdojo/guides/review-guide.md +22 -19
  199. package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
  200. package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
  201. package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
  202. package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
  203. package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
  204. package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
  205. package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
  206. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  207. package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
  208. package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
  209. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  210. package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
  211. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  212. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  213. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
  214. package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
  215. package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
  216. package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
  217. package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
  218. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
  219. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
  220. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  221. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  222. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
  223. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
  224. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
  225. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
  226. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
  227. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
  228. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  229. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
  230. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  231. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  232. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  233. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  234. package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
  235. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
  236. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
  237. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
  238. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  239. package/docs/ja/specdojo/references/command-reference.md +303 -148
  240. package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
  241. package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
  242. package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
  243. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  244. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  245. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
  246. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
  247. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
  248. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
  249. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
  250. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  251. package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
  252. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
  253. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  254. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  255. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  256. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  257. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
  258. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  259. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
  260. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
  261. package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
  262. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
  263. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  264. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
  265. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  266. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  267. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  268. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
  269. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  270. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
  271. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
  272. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
  273. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
  274. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  275. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  276. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
  277. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  278. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  279. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
  280. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
  281. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  282. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
  283. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
  284. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
  285. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  286. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
  287. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  288. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
  289. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  290. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  291. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  292. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  293. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  294. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
  295. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  296. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  297. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  298. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  299. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  300. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  301. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  302. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  303. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  304. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  305. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  306. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  307. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  308. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  309. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  310. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  311. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
  312. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  313. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  314. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  315. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  316. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
  317. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
  318. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
  319. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
  320. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  321. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
  322. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
  323. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
  324. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  325. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
  326. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  327. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  328. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  329. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  330. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  331. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
  332. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
  333. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
  334. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  335. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  336. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
  337. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
  338. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
  339. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
  340. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
  341. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  342. package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
  343. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
  344. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  345. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  346. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  347. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  348. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
  349. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  350. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  351. package/docs/ja/specdojo/samples/bac-sample.md +106 -21
  352. package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
  353. package/docs/ja/specdojo/samples/bds-sample.md +87 -21
  354. package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
  355. package/docs/ja/specdojo/samples/bes-sample.md +70 -21
  356. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  357. package/docs/ja/specdojo/samples/br-sample.md +57 -15
  358. package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
  359. package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
  360. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
  361. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  362. package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
  363. package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
  364. package/docs/ja/specdojo/samples/cld-sample.md +3 -30
  365. package/docs/ja/specdojo/samples/clis-sample.md +125 -0
  366. package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
  367. package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
  368. package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
  369. package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
  370. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  371. package/docs/ja/specdojo/samples/dss-sample.md +175 -0
  372. package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
  373. package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
  374. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  375. package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
  376. package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
  377. package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
  378. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  379. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  380. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  381. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  382. package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
  383. package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
  384. package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
  385. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
  386. package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
  387. package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
  388. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
  389. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  390. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
  391. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  392. package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
  393. package/docs/ja/specdojo/samples/sf-sample.md +109 -21
  394. package/docs/ja/specdojo/samples/sld-sample.md +88 -21
  395. package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
  396. package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
  397. package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
  398. package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
  399. package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
  400. package/docs/ja/specdojo/samples/uis-sample.md +141 -20
  401. package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
  402. package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
  403. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  404. package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
  405. package/docs/ja/specdojo/templates/bac-template.md +76 -0
  406. package/docs/ja/specdojo/templates/bes-template.md +56 -0
  407. package/docs/ja/specdojo/templates/br-template.md +64 -0
  408. package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
  409. package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
  410. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  411. package/docs/ja/specdojo/templates/cnd-template.md +137 -0
  412. package/docs/ja/specdojo/templates/cpd-template.md +129 -0
  413. package/docs/ja/specdojo/templates/cxd-template.md +105 -0
  414. package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
  415. package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
  416. package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
  417. package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
  418. package/docs/ja/specdojo/templates/ifd-template.md +86 -0
  419. package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
  420. package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
  421. package/docs/ja/specdojo/templates/opr-template.md +2 -4
  422. package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
  423. package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
  424. package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
  425. package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
  426. package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
  427. package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
  428. package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
  429. package/docs/ja/specdojo/templates/stsd-template.md +46 -21
  430. package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
  431. package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
  432. package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
  433. package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
  434. package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
  435. package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
  436. package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
  437. package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
  438. package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
  439. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
  440. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
  441. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
  442. package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
  443. package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
  444. package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
  445. package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
  446. package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
  447. package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
  448. package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
  449. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  450. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  451. package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
  452. package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
  453. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  454. package/package.json +10 -7
  455. package/templates/antigravity/orchestrator.md +7 -3
  456. package/templates/claude/agents/specdojo-orchestrator.md +7 -3
  457. package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
  458. package/templates/codex/orchestrator.md +7 -3
  459. package/templates/devcontainer/tmux.conf +6 -0
  460. package/templates/init-exec-defaults.yaml +13 -0
  461. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  462. package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
@@ -3,130 +3,106 @@ specdojo:
3
3
  id: specdojo:bes-rulebook
4
4
  type: rulebook
5
5
  deliverable_type: requirement
6
- status: draft
7
- recipe: undecided
6
+ status: ready
7
+ target_format: markdown
8
+ recipe: specdojo:bes-recipe
8
9
  sample: specdojo:bes-sample
9
- template: undecided
10
+ template: specdojo:bes-template
10
11
  ---
11
12
 
12
13
  # 業務イベント仕様 作成ルール
13
14
 
14
- Business Event Specification (BES) Documentation Rules
15
+ Business Event Specification Documentation Rulebook
15
16
 
16
- BES は、BEL(業務イベント一覧)の各イベントについて、**重要/複雑なものだけ** を詳細化するための仕様です。
17
+ 業務イベント一覧の一行では解釈が分かれる出来事を、発生した事実として定義するためのルールです。発生境界、時点、主体、条件、事実データを明確にし、業務承認とイベント処理・テスト設計の入力にします。
17
18
 
18
- ## 1. 位置づけ
19
+ ## 1. 全体方針
19
20
 
20
- - BEL: イベントを網羅する一覧(表)
21
- - BES: イベント1件の記述を **責務の範囲で** 最小限に明確化(何が起きたか/いつ/誰が・何が/発生条件/事実データ)
22
- - BPS: イベントを契機に動く業務プロセスの手順(詳細手順ガイドは BPS 側に寄せる)
23
- - BR: 判断/計算ロジック(BES には直書きせず、必要なら `implements` で参照)
21
+ - 一つの BES は、一つの業務上の出来事を扱います。確定・受付などの境界、時点、起点、条件、データのいずれかが一覧だけでは判定できない場合に詳細化します。
22
+ - 冒頭には、この定義が解消する業務上の混同、対象範囲、定義を使えると判断する基準を簡潔に置きます。業務全体の目的は上位文書を正本とし、全文を再掲しません。
23
+ - 人、システム、外部からの要求を同じイベントにまとめる場合は、同じ事実が成立する境界と、一回の要求から生じるイベントの単位を示します。対象外と適用未判定は区別します。
24
+ - 確認できた事実と未決事項を分け、未決の境界・条件・相関情報が定義の利用に与える影響を示します。
25
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
24
26
 
25
- ## 2. いつ BES を作るか
27
+ ## 2. 位置づけと用語定義
26
28
 
27
- 次のいずれかに当てはまる場合に作成します。
29
+ - 業務イベント一覧(BEL)は網羅性と個別仕様への入口を持ち、共通の対象範囲・用語の正本とします。BES は一覧で解釈が分かれる一件の事実と観測境界を詳細化します。
30
+ - イベントを受けた後の手順・担当解決・通知・回復は業務プロセス仕様(BPS)、選択・計算・可否判定の規則は業務ルール(BR)へ委ねます。状態の意味・遷移は状態定義、項目の構造・値・構文はデータモデル・schema・リファレンスを正本とします。
31
+ - 相関情報は、同じ要求・取引から生じた複数イベントを関連付ける業務上の識別情報です。個別イベントや実行一回の識別子とは区別します。
28
32
 
29
- 前提:
33
+ ## 3. ファイル命名・ID規則
30
34
 
31
- - BES の本文は「何が起きたか / いつ / 誰が/何が / 発生条件 / 事実データ」の **事実(観測)** に限定します。
32
- - それでも、BEL の 1 行だけでは **解釈が割れやすい**(= 後工程が迷う)場合があり、そのとき BES を作成します。
35
+ - ファイル名は `bes-<event>.md` とし、`<event>` は出来事を区別できる英小文字のスラッグにします。
36
+ - 文書 ID は `bes-<event>` を基本とし、プロジェクト配下ではそのプロジェクトの authority を付けます。命名・配置の共通規則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正本とします。
37
+ - イベント一覧が存在する場合は対応行から個別 BES へリンクし、BES からも一覧の対応イベントを識別できるようにします。一覧がなければ、対応の未照合を未決事項に残します。
33
38
 
34
- 判断基準(BEL 1 行では足りないサイン):
39
+ ## 4. 推奨 Frontmatter 項目
35
40
 
36
- - **何が起きたか** の解釈が割れる(例: 「確定」「受付」「取消」「訂正」「差戻し」など、事実の境界が曖昧)
37
- - **いつ** の基準が割れる(例: 入力時/承認時/締め処理時/外部応答時 のどれを指すかが曖昧)
38
- - **誰が/何が** が混在して割れる(例: 人の操作/システム自動/外部起点が混ざり、起点が一意にならない)
39
- - **発生条件** が複数パターンで揉める(例: 部分返品、分割納品、在庫差異の許容、締め済みへの訂正など)
40
- - **事実データ** の範囲が合意できない(例: ID体系、金額内訳、訂正元ID、理由の必須性、個人情報の含有可否など)
41
+ - メタ情報の構文と許容値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
42
+ - BES の `type` は `requirement`、`rulebook` は `specdojo:bes-rulebook` とします。
41
43
 
42
- 目安:
44
+ ## 5. 本文要件
43
45
 
44
- - 重要な「確定」を伴う出来事(売上確定/在庫確定/会計確定など)は、上記の曖昧さが起きやすいため BES 化を優先検討します。
46
+ 見出し順・表・記入欄の骨組みは template を正本とします。以下は各章の意味要件であり、任意の小節も該当する章の範囲に置きます。
45
47
 
46
- ### 2.1 BEL からのリンク
48
+ | 記述対象 | 必須・任意 | 判定基準 |
49
+ | -------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
50
+ | 導入 | 必須 | 解消する混同、対象範囲、利用できると判断する基準、上位一覧との対応が分かる |
51
+ | 「何が起きたか」の事実境界 | 必須 | 対象と確定した事実を過去形で示す。一回の発生単位、似ているが含めない出来事、対象業務の境界を区別できる |
52
+ | 「いつ」の観測時点 | 必須 | 要求・受付・確定・後処理のどの時点か判定できる。繰り返し・一括要求がある場合は各イベントの発生時点を説明できる |
53
+ | 「誰が/何が」の主体 | 必須 | 要求する主体と事実を成立させる主体を区別する。システム名は責務を定義する |
54
+ | 「発生条件」の成立・不成立 | 必須 | 共通条件と起点別の差異を示す。候補なし・条件未充足など、発生しない場合を判定できる。判断ロジックは BR、状態は状態定義へ委ねる |
55
+ | 「事実データ」の内容 | 必須 | 項目ごとの業務上の意味と必要になる条件を示す。一括・並列などでは相関情報の単位と照合先を示す。未来の処理結果を発生時点の事実にしない |
56
+ | 発生判定・相関の確認例 | 境界や相関の解釈が分かれる場合に必須 | 同じ条件から発生有無・回数・同じ要求への帰属を判断できる。テスト実装や網羅的なケース集は持ち込まない |
57
+ | 未決事項と承認条件 | 未決事項がある場合に必須 | 関連する章に論点と利用への影響を置き、当面の扱いと、確定時に見直す境界・条件・データを示す |
47
58
 
48
- 個別 BES を作成したら、対応する BEL の一覧表で **イベントIDをBESファイルへのリンク** に更新します。
59
+ ## 6. 記述ガイド
49
60
 
50
- - 例(例示はコード表記): `[bes-sale-checkout](./bes-sale-checkout.md)`
61
+ 共通の業務範囲・用語は上位一覧を参照し、各 BES では個別の差分だけを具体化します。
51
62
 
52
- ## 3. メタデータ(Frontmatter)
63
+ ### 6.1. 導入
53
64
 
54
- Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` の制約に従います。
65
+ - 判断基準: 読者が、何の混同を防ぎ、どこまでを判断できる定義か説明できるようにします。
66
+ - 良い例: 「入力途中を売上と混同しないため、店頭の現金会計の確定を定義する。成立・不成立の代表例から記録対象を判断できることを確認する。」
67
+ - 悪い例: 「システムの重要イベントを説明する。」対象も利用の判定基準も分かりません。
55
68
 
56
- | 項目 | 説明 | 必須 |
57
- | ---- | --------------------------------- | ---- |
58
- | id | BES ID(例: `bes-sale-checkout`) | ○ |
69
+ ### 6.2. 何が起きたか
59
70
 
60
- | type | `requirement` 固定 | ○ |
61
- | title | 業務イベント名(例: 業務イベント: 会計確定(販売)) | ○ |
62
- | status | `draft`/`ready`/`deprecated` | ○ |
63
- | based_on | 根拠となる仕様ID(BEL/UIS/BPS 等) | 任意 |
64
- | supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
71
+ - 判断基準: 対象、一回の単位、隣接する出来事との境界を示します。適用未判定の業務を、確認済みの対象や恒久的な対象外にしません。
72
+ - 良い例: 「一取引の現金会計が確定した。明細追加と日次締めの確定は含めない。」
73
+ - 悪い例: 「会計処理をする。」出来事が成立したのか、処理手順なのかを判定できません。
65
74
 
66
- ### 3.1 ID規約
75
+ ### 6.3. いつ
67
76
 
68
- - BES ID は `bes-...` の形式を推奨します(例: `bes-sale-checkout`)。
69
- - `type: requirement` は機能・業務イベントの要件であることを示します。
77
+ - 判断基準: 観測できる成立時点を選び、要求時や後処理の完了時と区別します。同時実行されることだけを根拠に、複数の事実を一つにしません。
78
+ - 良い例: 「店番担当が金額と受領を確認して会計を確定した時点。控えの印字完了は待たない。」
79
+ - 悪い例: 「会計時。」入力・確定・印字のどこかが分かりません。
70
80
 
71
- ## 4. 本文テンプレ(最小)
81
+ ### 6.4. 誰が/何が
72
82
 
73
- BES の責務は次に **限定** し、各項目を見出しとしてこの順序で記述します。
83
+ - 判断基準: 起点が複数なら、起点区分、要求者、成立させる主体、差異を表で並べます。
84
+ - 良い例: 「店番担当が確定を要求し、販売管理システムが確定を記録する。」
85
+ - 悪い例: 「担当またはシステム。」どちらが何をするか不明です。
74
86
 
75
- 1. 何が起きたか
76
- 2. いつ
77
- 3. 誰が/何が
78
- 4. 発生条件
79
- 5. 事実データ
87
+ ### 6.5. 発生条件
80
88
 
81
- 補足:
89
+ - 判断基準: 成立条件と不成立条件を対にして示します。根拠にない適用範囲は未決とし、利用への影響と当面の扱いを示します。
90
+ - 良い例: 「受領金額が請求金額以上で、未確定の取引を確定した場合に発生する。金額確認だけでは発生しない。」
91
+ - 悪い例: 「会計可能なら発生する。」判定根拠がなく、発生しない境界も分かりません。
82
92
 
83
- - 結果(出力/状態変化/通知)や例外、購読先、詳細手順は BES の責務外です。必要なら BPS(業務プロセス仕様)側で扱います。
84
- - イベントとプロセスは独立に保ち、起動関係は BPS(業務プロセス仕様)側で記載します。
93
+ ### 6.6. 事実データ
85
94
 
86
- ## 5. 禁止事項
95
+ - 判断基準: 項目、意味、必要になる条件を表で示します。相関は要求単位・取引単位・イベント単位を分け、正本との対応と確認例を添えます。物理項目名を推測して確定しません。
96
+ - 良い例: 「取引番号は確定対象を識別する。明細は同じ取引番号に属する。一括要求の識別が別に必要なら、その対応をデータモデルで確認する。」
97
+ - 悪い例: 「ID、明細など。」何の ID か、何を同じ単位とみなすか分かりません。
87
98
 
88
- | 項目 | 理由 |
89
- | ------------------------------------------ | ---------------------- |
90
- | 物理テーブル名・物理カラム名・SQL全文 | 概念レベル逸脱 |
91
- | 実装クラス/関数名・APIの実装詳細 | 実装依存で変更に弱い |
92
- | UIコンポーネント名、クリック手順の逐語列挙 | UI変更に弱い |
93
- | BRのロジックを本文に重複記載 | 変更時に不整合が起きる |
99
+ ## 7. 禁止事項
94
100
 
95
- ## 6. サンプル(最小)
96
-
97
- ```markdown
98
- ---
99
-
100
- id: bes-sale-checkout
101
- type: requirement
102
- title: 業務イベント: 会計確定(販売)
103
- status: draft
104
- part_of: []
105
- based_on:
106
- - bel-sale
107
- - uis-sale
108
- supersedes: []
109
- ---
110
-
111
- ## 1. 何が起きたか
112
-
113
- - 販売の会計が確定した。
114
-
115
- ## 2. いつ
116
-
117
- - 会計確定操作の実行時。
118
-
119
- ## 3. 誰が/何が
120
-
121
- - 店員(人)。
122
-
123
- ## 4. 発生条件
124
-
125
- - 対象の取引が確定可能な状態である。
126
-
127
- ## 5. 事実データ
128
-
129
- - 取引ID
130
- - 明細(商品、数量、単価 等)
131
- - 支払情報(支払方法、受領金額 等)
132
- ```
101
+ | 禁止する記述・扱い | 理由 |
102
+ | ----------------------------------------------------------------------------------- | ---------------------------------------- |
103
+ | 一覧にない適用範囲を、合意済みとして追加する | イベントの対象境界を誤って確定するため |
104
+ | 着手・通知・後処理・例外回復の詳細手順を BES に展開する | プロセス仕様の責務と重複するため |
105
+ | BR の順位付け・計算式、状態遷移表を複製する | 正本の変更を追従できなくなるため |
106
+ | 物理テーブル・カラム、SQL、実装クラス・関数、詳細 API、CLI 構文を正本として記載する | 概念上の事実と実装契約を混同するため |
107
+ | 発生後にしか分からない最終件数・結果を、発生時点の確定データとする | 観測時点と事実が矛盾するため |
108
+ | 相関情報を実行 ID や時刻で代用できると、根拠なしに断定する | 複数イベントの同一要求への帰属を誤るため |
@@ -18,58 +18,35 @@ Business Process Specification (BPS) Documentation Rulebook
18
18
 
19
19
  ## 1. 全体方針
20
20
 
21
- - 一文書は、概念データフローの一つのプロセス領域に属し、共通の起点と業務成果を持つ一連の流れを扱います。同じ領域に起点または業務成果が異なる流れがある場合は、BPS を分けます。
22
- - CDFD の個別プロセスは BPS の処理ステップとして具体化します。プロセス領域の境界、プロセス ID、主要な入出力、データストアの名称を変更する必要がある場合は、先に CDFD を更新します。
21
+ - 一文書は、CDFD の一つのプロセス領域に属し、共通の起点と業務成果を持つ流れを扱います。同じ領域でも起点または成果が異なる流れは別の BPS に分けます。
22
+ - CDFD の個別プロセスを処理ステップへ具体化します。領域の境界、プロセス ID、主要入出力、データストア名を変える場合は、先に CDFD を更新します。
23
23
  - 業務担当者が開始条件、判断、責任、完了条件を確認でき、設計者とテスト担当者が機能設計および受入シナリオの入力として利用できる粒度にします。
24
24
  - ビジネスルール、業務イベント、状態定義、データ定義は対応する仕様を正本とします。BPS には、その流れで参照する条件と利用目的だけを記載します。
25
- - 物理テーブル、SQL、クラス、関数、画面操作、詳細 API などの実装方式は扱いません。
26
25
  - 複数のプロセス領域またはプロセスグループをまたぐ順序と引き渡し条件はユースケース別 CDFD を正本とし、BPS では自文書が担う流れの入口と出口だけを記載します。
26
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint・Frontmatter 検証はリポジトリの検証で扱い、業務の受入確認に含めません。
27
27
 
28
- ## 2. 位置づけと用語定義
28
+ ## 2. 位置づけ
29
29
 
30
- | 用語 | 定義 |
31
- | ------------ | ------------------------------------------------------------------------------------------------------------ |
32
- | BPS | 一つのプロセス領域に属する一連の流れについて、開始から業務成果の確定までを記述する業務プロセス仕様 |
33
- | プロセス領域 | 固有の業務目的、主な担当、起点イベントを持つ CDFD 上の責務のまとまり |
34
- | 流れ | 共通の起点と業務成果を持つ、複数の処理ステップのまとまり |
35
- | 処理ステップ | CDFD の個別プロセスを引き継ぎ、担当、入力、活動または判断、出力、完了条件を示す BPS 内の単位 |
36
- | トリガー | 業務プロセスの開始を判定できる出来事。時刻到来、依頼受付、状態変化、業務イベントなど |
37
- | 前提条件 | トリガー発生時に、処理を開始できるかを判定する条件 |
38
- | 業務成果 | 処理の完了により確定する記録、状態変化、通知、判断結果、または次の業務への引き渡し |
39
- | 主要例外 | 正常な業務成果または後続処理の起動を妨げ、停止、差戻し、代替経路、または人による判断を必要とする業務上の事象 |
40
-
41
- BPS は CDFD が定めるプロセス領域と流れを詳細化し、BES が定める業務イベント、BR が定める判断・計算、STSD が定める状態と遷移を利用します。参照先の定義を BPS 内へ複製せず、このプロセスでいつ、何のために利用するかを明らかにします。
30
+ BPS は CDFD のプロセス領域と流れを詳細化し、BES の業務イベント、BR の判断・計算、STSD の状態と遷移を利用します。各仕様をいつ、何のために使うかを示します。
42
31
 
43
32
  ## 3. ファイル命名・ID規則
44
33
 
45
- - ファイル名は `bps-<term>.md`、成果物 ID は拡張子を除いた `bps-<term>` とします。`<term>` は対象の流れまたは業務成果を表す英小文字・数字・ハイフンのスラッグです。
46
- - product 成果物の ID にはプロジェクト ID や authority を付けません。例: ファイル名 `bps-order-candidate-generation.md`、ID `bps-order-candidate-generation`。
34
+ - ファイル名は `bps-<term>.md`、product 成果物 ID はプロジェクト ID や authority を付けない `bps-<term>` とします。`<term>` は流れまたは業務成果を表す英小文字・数字・ハイフンのスラッグです(例: `bps-replenishment-request.md`)。
47
35
  - 番号や一時的な組織名、実装名を `<term>` に含めません。同じ業務上の責務を保つ限り、処理順や担当組織が変わっても ID を維持します。
48
- - 一つの BPS に複数の独立した起点または業務成果を混在させません。起点または成果が独立して変更・承認される場合は、別の `bps-<term>` に分けます。
49
- - 処理ステップ ID は文書内で一意な `S-01` 形式、主要例外 ID は `E-01` 形式とします。CDFD のプロセス ID がある場合は、処理表の「CDFD プロセス」列で対応させます。
36
+ - 起点または成果が独立して変更・承認される場合は、別の `bps-<term>` に分けます。
37
+ - トリガー ID は `T-01`、処理ステップ ID は `S-01`、主要例外 ID は `E-01` 形式で、それぞれ文書内で一意にします。CDFD の個別プロセス ID は処理表の「CDFD プロセス」列で対応させます。
50
38
 
51
39
  ## 4. 推奨 Frontmatter 項目
52
40
 
53
- Frontmatter の共通原則はドキュメントメタ情報標準、許可される項目と型は成果物 Frontmatter スキーマを正本とします。
54
-
55
- | 項目 | 説明 | 必須 |
56
- | ---------- | ------------------------------------------------------- | ---- |
57
- | id | プロジェクト修飾なしの `bps-<term>` | ○ |
58
- | type | 業務フロー・プロセス仕様を表す `flow` | ○ |
59
- | status | `draft` / `ready` / `deprecated` | ○ |
60
- | rulebook | `specdojo:bps-rulebook` | ○ |
61
- | part_of | 一覧または親成果物との所属関係 | 任意 |
62
- | based_on | 作成時に直接確認した、依存関係上許可される先行成果物 ID | 任意 |
63
- | supersedes | 置き換える旧 BPS の ID | 任意 |
64
- | relations | 要求の充足などを表す型付き参照 | 任意 |
41
+ 許可キー・必須項目・型制約はドキュメントメタ情報標準と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
65
42
 
66
- - SpecDojo が所有する項目は `specdojo:` 配下に置きます。文書名は Frontmatter ではなく H1 に記載します。
67
- - `based_on` には、成果物カタログの `depends_on` の推移閉包に含まれ、実際に内容根拠として確認した ID だけを記載します。
68
- - 作成中は `status: draft` とします。完成条件と承認を満たした後の `ready` への昇格は、プロジェクトの責任分担と運用に従います。
43
+ - `id` は「ファイル命名・ID規則」に従います。
44
+ - `type` は `flow`、`rulebook` は `specdojo:bps-rulebook` とします。
45
+ - `based_on` は、成果物カタログの `depends_on` の推移閉包内で、直接の内容根拠として確認した先行成果物 ID に限ります。
69
46
 
70
47
  ## 5. 本文要件
71
48
 
72
- 見出し順、表の列、記入欄の骨組みは Frontmatter で宣言した template を正本とします。BPS は、骨組みを埋めた結果として次の意味要件を満たさなければなりません。
49
+ 見出し順・表の列・記入欄は Frontmatter で宣言した template を正本とし、次の意味要件を満たします。
73
50
 
74
51
  | 要件群 | 必須 | 目的と記載要件 |
75
52
  | ------------------ | -------- | -------------------------------------------------------------------------------------------------------------- |
@@ -80,15 +57,13 @@ Frontmatter の共通原則はドキュメントメタ情報標準、許可さ
80
57
  | 業務成果と引き渡し | ○ | 正常終了と条件付き終了の成果、受け手、確定条件、正本、後続処理を定義する |
81
58
  | 主要例外 | ○ | 業務成果または後続処理を変える例外について、検出条件、停止範囲、担当、処置、再開条件または代替成果を定義する |
82
59
  | 検証可能性 | ○ | 正常系・条件付き・例外系について、第三者が結果を判定できる入力条件、期待する業務成果、確認可能な記録を定義する |
83
- | 未決論点の追跡 | 条件付き | 調査または意思決定が未了の論点、影響、区分、決定者、決定時期を記載する。未決事項がある場合だけ扱う |
84
-
85
- 処理は操作の羅列ではなく、各ステップの業務目的と完了条件を含めます。検証条件はテストケースの実装ではなく、業務成果を受け入れられる条件を定義します。
60
+ | 未決論点の追跡 | 条件付き | 未決事項がある場合だけ、論点と影響する章・ステップ、当面の扱いを記載する |
86
61
 
87
62
  ## 6. 記述ガイド
88
63
 
89
64
  ### 6.1. 導入文と概要
90
65
 
91
- - 導入文は「在庫数更新を受け、補充が必要な商品について発注候補を確定する」のように、起点、対象、業務成果を一文で示します。
66
+ - 導入文は「現在庫が補充基準を下回ったことを受け、補充対象の商品と依頼数量を判断し、補充依頼を確定する」のように、起点、対象、業務成果を一文で示します。
92
67
  - 「概要」は、業務目的、対象者、対象範囲、対象外、主担当、開始点、終了点を箇条書きまたは表で示します。対象外には前後のプロセス、横断フロー、実装方式を明記します。
93
68
  - CDFD のプロセス領域名と対象の流れを示し、同じ領域にある他の流れとの境界を説明します。領域の分割そのものは BPS で変更しません。
94
69
 
@@ -102,7 +77,7 @@ Frontmatter の共通原則はドキュメントメタ情報標準、許可さ
102
77
 
103
78
  | 列 | 記載内容 |
104
79
  | -------------- | -------------------------------------- |
105
- | トリガー ID | 文書内で一意な `T-01` 形式 |
80
+ | トリガー ID | 「ファイル命名・ID規則」に従う識別子 |
106
81
  | 出来事 | 発生時点を判定できる業務上の出来事 |
107
82
  | 発生元 | 人、組織、外部主体、または業務イベント |
108
83
  | 受領情報 | 開始判断に使用する情報 |
@@ -126,7 +101,7 @@ Frontmatter の共通原則はドキュメントメタ情報標準、許可さ
126
101
 
127
102
  | 列 | 記載内容 |
128
103
  | -------------- | -------------------------------------------------- |
129
- | ステップ ID | 文書内で一意な `S-01` 形式 |
104
+ | ステップ ID | 「ファイル命名・ID規則」に従う識別子 |
130
105
  | CDFD プロセス | 対応する CDFD の個別プロセス ID |
131
106
  | 担当 | 実施または判断の責任主体 |
132
107
  | 入力 | このステップが使用する入力または直前ステップの成果 |
@@ -150,25 +125,19 @@ Frontmatter の共通原則はドキュメントメタ情報標準、許可さ
150
125
  ### 6.7. 検証・受入観点
151
126
 
152
127
  - 正常系、条件付き処理、主要例外について、入力条件、期待する業務成果、確認可能な記録を対応付けます。
153
- - 「正しく処理される」ではなく、「対象商品の発注候補が一件確定し、数量の根拠と判断に用いたルール ID を確認できる」のように判定可能な条件を記述します。
128
+ - 「正しく処理される」ではなく、「対象商品の補充依頼が一件確定し、依頼数量の根拠と判断に用いたルール ID を確認できる」のように判定可能な条件を記述します。
154
129
  - 業務受入条件やテスト仕様に詳細を委ねる場合も、BPS 自体の完了条件を空にせず、後続文書が確認すべき業務成果を残します。
155
130
 
156
131
  ### 6.8. 未決事項
157
132
 
158
- - 調査で解消する情報不足は `_TODO_`、意思決定待ちは `_UNDECIDED_`、仮置きする前提は `_ASSUMPTION_` として区別します。
159
- - 表は「論点」「影響する章・ステップ」「区分」「決定者」「決定時期」で構成し、本文中のラベルと対応させます。
160
- - `ready` へ昇格する前に `_TODO_` を解消します。`_UNDECIDED_` を残す場合は、業務成果の受入可否に影響しないことと決定の追跡先を確認します。
133
+ - 未決事項がある場合だけ章を置き、本文中の未確定ラベルに対応する論点と影響する章・ステップを示します。
134
+ - 影響には当面の開始可否、確定できない業務成果、決定後に直す条件を含めます。
161
135
 
162
136
  ### 6.9. 完成判定
163
137
 
164
- - Frontmatter に `id`、`type`、`status`、`rulebook` があり、ファイル名、ID、`type: flow` が本ルールと一致しています。
165
- - 対象が一つのプロセス領域に属する一連の流れであり、起点、業務成果、対象外を説明できます。
166
- - トリガー、前提条件、入力、全処理ステップ、出力、主要例外を開始から終了まで追跡でき、CDFD のプロセス ID と名称に矛盾がありません。
167
- - 各処理ステップに担当、入力、活動または判断、出力、完了条件があり、分岐先と例外の対応を確認できます。
168
- - BR、BES、BDD、CDSD、STSD などの参照先を正本として扱い、定義を複製していません。
169
- - 正常系、条件付き処理、主要例外の受入条件が第三者に判定可能で、確認可能な記録または業務成果を示しています。
170
- - 物理データ構造、詳細 API、画面操作、実装クラスなどの実装方式が混在していません。
171
- - `_TODO_` が残っていません。`_UNDECIDED_` がある場合は「未決事項」に決定者と決定時期があります。
138
+ - CDFD と領域・プロセス ID・名称・主要入出力・データストア名を照合し、「本文要件」の必須要件と条件付き要件を確認します。
139
+ - トリガーから全ステップの分岐・例外・再開先を順にたどり、開始から業務成果または代替成果まで途切れないことを確認します。
140
+ - 正常系・条件付き・主要例外の入力条件を当てはめ、成果と記録が「検証・受入観点」の期待結果に一致すれば合格とします。
172
141
 
173
142
  ## 7. 禁止事項
174
143
 
@@ -176,7 +145,6 @@ Frontmatter の共通原則はドキュメントメタ情報標準、許可さ
176
145
  - CDFD のプロセス領域、プロセス ID、データストア名を BPS だけで追加、削除、改名しません。
177
146
  - BR の判断式、BES のイベント契約、BDD・CDSD のデータ定義、STSD の状態定義・遷移表を複製しません。
178
147
  - 処理ステップを画面のクリック順、CLI コマンド列、API 呼び出し順、クラスや関数の呼び出し順として記載しません。
179
- - 物理テーブル、物理カラム、SQL、詳細 API 項目、実装クラス、ログ文言、秘密情報を記載しません。
148
+ - 物理テーブル、物理カラム、SQL、詳細 API 項目、実装クラス、ログ文言を記載しません。
180
149
  - 担当、完了条件、分岐先、再開条件を空欄にしたり、「適切に処理する」「問題がなければ完了」のような判定不能な表現だけで済ませたりしません。
181
150
  - 正常な非起動条件を主要例外として扱ったり、業務成果を変えない内部エラーを網羅的に列挙したりしません。
182
- - 作成状況やレビュー状態を本文で管理しません。進捗と判断履歴は登録簿やレビュー結果で追跡します。
@@ -3,148 +3,103 @@ specdojo:
3
3
  id: specdojo:br-rulebook
4
4
  type: rulebook
5
5
  deliverable_type: rule
6
- status: draft
7
- recipe: undecided
6
+ status: ready
7
+ target_format: markdown
8
+ recipe: specdojo:br-recipe
8
9
  sample: specdojo:br-sample
9
- template: undecided
10
+ template: specdojo:br-template
10
11
  ---
11
12
 
12
13
  # ビジネスルール 作成ルール
13
14
 
14
- Business Rule (BR) Documentation Rules
15
+ Business Rule Documentation Rulebook
15
16
 
16
- 本ドキュメントは、業務分析・要求定義のために **ビジネスルールを統一形式で記述する標準ルール**です。ビジネスルールは、複数の業務プロセス(BPS)から参照される横断的な判断・条件・計算ロジックを定義します。
17
+ 業務上の判断・制約・計算を、同じ入力から同じ結果を導ける仕様として記述するための規約です。業務担当者が妥当性を判断でき、実装とテスト設計へ引き継げる粒度を定めます。
17
18
 
18
19
  ## 1. 全体方針
19
20
 
20
- - 対象は「判断・条件・計算ロジック」であり、**概念レベルの入力条件+判定結果(または出力)** を明確化する。
21
- - 実装詳細(例: 物理テーブル名、SQL、UI操作、実装クラス/関数名)は記載しない(詳細は「9. 禁止事項」参照)。
22
- - 1ファイル = 1 ビジネスルール。複雑な場合はサブルールへ分解し、親子関係はサブルール側の `part_of` で表現する。
21
+ - 1 文書で一つの判断目的を扱い、適用条件、概念入力、判定、出力、例外を対応させる。
22
+ - 業務価値は上位文書から引き継ぎ、本書の判断が守る価値と適用境界だけを記す。共通事項は上位の index または標準を正本とする。
23
+ - 業務上の比較・計算の意味を定義し、設定値の列挙、構文、物理構造は対応する schema・リファレンスを参照する。実装コードを仕様の代替にしない。
24
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、成果物の業務の検証に含めない。
23
25
 
24
- ## 2. 用語定義
26
+ ## 2. 位置づけ
25
27
 
26
- | 用語 | 定義 |
27
- | -------------- | -------------------------------------------------------------------- |
28
- | ビジネスルール | 業務上の判断・制約・計算ロジック。複数プロセスで共通に参照される定義 |
29
- | 入力 | ルールが参照する概念データ・前提条件 |
30
- | 判定 | 真偽またはカテゴリ分類の結果 |
31
- | 出力 | 計算値・カテゴリ・フラグなど、ルールの適用結果 |
32
- | 例外 | 入力不備・矛盾・外部参照失敗など |
28
+ BR は業務プロセスから呼び出される判断の正本である。BPS が適用する場面と手順を定め、BR がその時点の入力に対する結果を定める。画面操作、保存方法、実行制御、テスト手順はそれぞれの責務を持つ成果物へ委譲する。
29
+
30
+ 独立して承認・変更できる判断目的が複数ある場合は文書を分ける。同じ判断を完結させる入力検証・計算・例外は、条件数だけを理由に分割しない。
33
31
 
34
32
  ## 3. ファイル命名・ID規則
35
33
 
36
- - ファイル名: `br-<番号>-<短い日本語名>.md` (例: `br-0010-在庫不足判定.md`)
37
- - Frontmatter:
38
- - `id`: `br-low-stock-judgment` のように小文字ハイフン形式。
39
- - `title`: 「在庫不足判定」など。
40
- - サブルールへ分割する場合: `br-low-stock-threshold`, `br-stock-reservation-deduction` などの id を付与し、サブルール側で `part_of: [br-low-stock-judgment]` を指定。
34
+ - ファイル名は判断の意味を表す `br-<subject>.md` を推奨する。連番や特定プロジェクトの管理番号を必須にしない。
35
+ - 成果物の ID はプロジェクト内で一意にし、文書参照では `<project-id>:br-<subject>` のように project 修飾する。
36
+ - 配置は対象プロジェクトの成果物カタログに従う。ディレクトリと ID の共通規則は [[specdojo:docs-structure-guide|ドキュメント構造ガイド]] を正とする。
41
37
 
42
38
  ## 4. 推奨 Frontmatter 項目
43
39
 
44
- | 項目 | 説明 | 必須 |
45
- | ---- | ---- | ---- |
46
-
47
- | id | ルールID (br-xxx-xxxx) | ○ |
48
- | type | `rule` 固定 | ○ |
49
- | title | ルール名 | ○ |
50
- | status | `draft`/`ready`/`deprecated` | ○ |
51
- | part_of | 親ルールID(サブルールの場合) | 任意 |
52
- | based_on | 根拠となる仕様ID(BPS/UIS/BEL/BES 等) | 任意 |
53
- | supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
40
+ 共通項目・型・許可値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と [成果物 Frontmatter schema](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) を正本とする。
54
41
 
55
- ### NG/OK例(抜粋)
42
+ - `type` は業務の判断を表す `rule` とし、適用する主 rulebook を宣言する。
43
+ - `based_on` は判断の根拠となる先行成果物を示す。依存先が未作成の場合は本文にも未確認の範囲を残し、内容を確認済みと扱わない。
44
+ - `part_of` は親ルールへの所属がある場合だけ用いる。
56
45
 
57
- - NG例: `type: api`(列挙外), `id: BR_LowStock`(大文字/アンダースコアNG), `extra: foo`(未定義プロパティNG)
58
- - OK例: `type: rule`, `id: br-low-stock-judgment`, `status: ready`
46
+ ## 5. 本文要件
59
47
 
60
- ## 5. 本文構成(標準テンプレ)
48
+ 内容要件は次のとおり。すべて必須とし、該当する例外や未決事項がなければ「なし」と明示する。見出し順・表・記入欄の骨組みは frontmatter で宣言した template を正本とする。
61
49
 
62
- 各 BR ファイルは以下見出しを順番に並べる。
50
+ | 扱う内容 | 成立条件 |
51
+ | ------------------- | -------------------------------------------------------------------------------------------------------------- |
52
+ | 概要 | 判断の目的、利用者、適用する業務場面、前提、対象外が分かる |
53
+ | 入力 | 判定に使う全入力について概念項目、利用目的、適用条件、欠損時の扱いが分かる。派生ビュー等を使う経路も含む |
54
+ | ルール(判定/計算) | 適用順、条件、結果、境界値が対応する。複数条件の優先順位、同順位・欠損時の扱いを定め、代表的な判定例を置く |
55
+ | 出力 | 正常な結果の意味、単位または区分、利用先が分かる。「対象なし」と判定不能を区別する |
56
+ | 例外 / 異常系 | 状況、判定を続けるか、結果の有無、回復のために誰が何をするかが分かる |
57
+ | メモ / 将来課題 | 未決事項の論点、下流への影響、当面の扱い、確定に必要な根拠を記し、決定後に反映する入力・規則・判定例を特定する |
63
58
 
64
- 1. 概要
65
- 2. 入力
66
- 3. ルール(判定/計算)
67
- 4. 出力
68
- 5. 例外 / 異常系
69
- 6. メモ / 将来課題
70
-
71
- ## 6. 記述ガイド詳細
59
+ ## 6. 記述ガイド
72
60
 
73
61
  ### 6.1. 概要
74
62
 
75
- 短い一文で、何を判断/計算するルールかを業務用語で記述する。
63
+ - 判断基準: どの業務場面のどの判断を引き受けるかが一意で、対象外の責務と重ならないこと。
64
+ - 良い例: 「在庫確認時に、販売可能数が発注点を下回るかを判定する。発注量と発注の承認は対象外とする」。
65
+ - 悪い例: 「在庫を適切に管理する」。判断結果と責務境界を特定できない。
76
66
 
77
67
  ### 6.2. 入力
78
68
 
79
- - 業務データ辞書のエンティティ・論理名を列挙し、利用目的を簡潔に付記。
80
- - 例: エンティティ:在庫、項目:在庫数・予約数、目的:不足判定の基準
81
- - 必要に応じて用語集の用語ID(tm-xxx-xxx)や外部 IF 仕様の ID を併記。
82
-
83
- - 入力は概念レベルで記述する(詳細は「9. 禁止事項」参照)。
69
+ - 判断基準: 条件式と例外が参照する情報を全件たどれ、任意入力・条件付き入力と必須入力を区別できること。
70
+ - 推奨列は「入力 / 概念データ・項目 / 利用目的 / 適用条件・欠損時の扱い」。数値は業務上の単位と比較時点を添える。値の形式や列挙の詳細は正本へ委譲する。
71
+ - 良い例: 「予約数は個数で受け取り、販売可能数の計算に使う。未設定なら判定不能とする」。
72
+ - 悪い例: 「在庫データ一式を参照する」。どの項目の欠損が結果に影響するか分からない。
84
73
 
85
74
  ### 6.3. ルール(判定/計算)
86
75
 
87
- - 箇条書きで条件式と意味をセットで記述する。
88
- - 数式や条件式は業務用語に沿って表現し、必要なら TypeScript 風の擬似コードで補足してもよい。
89
-
90
- 例:
91
-
92
- 1. 不足判定: `在庫数 − 予約数 < 発注点` → 真なら不足
93
- 2. 優先度分類: 定番商品は高優先、季節商品は中優先、その他は低優先
94
-
95
- 擬似コード例:
96
-
97
- ```ts
98
- type 商品 = { 商品ID: string; 定番: boolean; 発注点: number };
99
- type 在庫 = { 商品ID: string; 在庫数: number; 予約数: number };
100
-
101
- function 在庫不足判定(商品: 商品, 在庫: 在庫): boolean {
102
- return 在庫.在庫数 - 在庫.予約数 < 商品.発注点;
103
- }
104
- ```
76
+ - 判断基準: 同じ入力に対して複数の結果が生じないこと。比較対象の項目ごとに有無を定義し、既定値、同順位の決着、条件が重なる場合の優先順を明らかにする。
77
+ - 文字列で順位を決める場合は、照合方法の正本または決定済みの比較規則を示す。「辞書順」だけで言語・環境に依存する差を残さない。未決なら候補と影響をメモへ送る。
78
+ - 推奨する判定例の列は「例 / 入力・前提 / 適用規則 / 期待結果」。通常、境界、欠損、同順位のうち当該ルールに該当するケースを含める。
79
+ - 良い例: 「販売可能数と発注点が等しい場合は不足としない」。
80
+ - 悪い例: 「少なければ不足」。比較する量と等号の扱いが不明である。本文と同じ処理の擬似コードも重ねない。
105
81
 
106
82
  ### 6.4. 出力
107
83
 
108
- - 判定結果(真偽/カテゴリ/数値)を列挙。
109
- - 他プロセスが参照するための概念的な出力定義(例: 「不足フラグ」「優先度ランク」)。
84
+ - 判断基準: 利用者が結果の意味と次の業務への渡し方を判断でき、未計算を正常値と取り違えないこと。
85
+ - 良い例: 「不足判定は『不足 / 不足なし』。入力不備では判定値を返さず、不備項目を返す」。
86
+ - 悪い例: 「フラグを返す」。真偽の意味、判定不能時、利用先が分からない。
110
87
 
111
88
  ### 6.5. 例外 / 異常系
112
89
 
113
- - 入力欠損・値の矛盾(発注点 < 0 等)・外部参照失敗など。
114
- - 失敗時挙動(スキップ/再試行/警告ログ/オペ通知)を記述。
90
+ - 判断基準: 入力欠損、値の矛盾、外部参照の失敗など該当する状況を分け、正常な対象なしと区別すること。例外が重なる場合も扱いを決める。
91
+ - 推奨列は「ID / 状況 / 扱い / 利用者の次の手」。代替値や代替順位を使うなら、通常規則のどこを置き換えるかを特定する。
92
+ - 良い例: 「発注点が未設定なら判定を行わない。店主代表が発注点を登録した後に再判定する」。
93
+ - 悪い例: 「エラー時はログを出す」。業務が続くか、結果が有効かを判断できない。
115
94
 
116
95
  ### 6.6. メモ / 将来課題
117
96
 
118
- 既知の改善余地(閾値動的化、季節要因考慮など)。
119
-
120
- ## 7. 命名・記述スタイル
121
-
122
- - ルール名は「名詞+判断/計算」: 例 `在庫不足判定`, `発注優先度算定`。
123
- - 条件は簡潔に(禁止事項は「9. 禁止事項」参照)。
124
- - 数式は意味説明と併記し、業務用語で読み下せるようにする。
125
-
126
- ## 8. 階層分解ガイド
127
-
128
- | シグナル | サブルールへ分割検討 |
129
- | ---------------------- | -------------------- |
130
- | 条件が5種以上 | ルール別に分離 |
131
- | 出力が多種(>3) | 目的別再編 |
132
- | 複数ドメインに跨る参照 | 参照境界で分割 |
133
-
134
- 親子関係は、サブルール側で `part_of` を指定します(親ルール側に子を列挙しない)。
135
-
136
- ## 9. 禁止事項
137
-
138
- | 項目 | 理由 |
139
- | ------------------------ | -------------------- |
140
- | 物理テーブル名・SQL全文 | 概念レベル逸脱 |
141
- | 画面操作手順 | 概念レベル逸脱 |
142
- | 実装クラス・関数名の列挙 | 実装依存・メンテ不能 |
143
- | ビジネスルール重複記述 | 変更時不整合リスク |
144
- | 未定義略語乱用 | 用語集との整合欠如 |
97
+ - 判断基準: 現行仕様で判断できる範囲と、未決のため確定できない入力・規則・判定例を区別できること。
98
+ - 良い例: 「`_UNDECIDED_`: 季節別の発注点を採用するか。採用判断と季節別の設定値を根拠に、入力の適用条件・不足判定・判定例へ反映する。未決の間は季節別判定の実装・受入条件を確定できない」。
99
+ - 悪い例: 「将来検討する」。論点、下流への影響、確定に必要な根拠が分からない。
145
100
 
146
- ## 10. よくある誤りと対策
101
+ ## 7. 禁止事項
147
102
 
148
- - 複雑なロジックを長文で記述 → サブルールへ分割し参照。
149
- - 物理データ項目を記載 → 概念データ辞書の論理名に置換。
150
- - BPSの手順を流用 → 本ドキュメントでは判断・計算のみを記述。
103
+ - 業務プロセスの手順、画面操作、物理テーブル、SQL、実装クラスを BR の判断規則として持ち込まない。
104
+ - 複数の BR に同じ規則を複写しない。独立した判断は責務を分け、文書 ID で参照する。
105
+ - 不明な既定値、欠損時の順位、例外時の継続可否を推測で確定しない。未決事項を通常の判定例の期待値として扱わない。