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