specdojo 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (284) hide show
  1. package/.github/agents/specdojo-orchestrator.md +4 -1
  2. package/CHANGELOG.md +64 -0
  3. package/dist/catalog/catalog.js +16 -14
  4. package/dist/commands/agent.js +5 -3
  5. package/dist/commands/build.js +69 -10
  6. package/dist/commands/git.js +206 -0
  7. package/dist/commands/init.js +4 -2
  8. package/dist/commands/where.js +25 -0
  9. package/dist/dashboard/dashboard.js +5 -3
  10. package/dist/dashboard/routines.js +4 -7
  11. package/dist/dashboard/timeline.js +14 -14
  12. package/dist/docs/index-command.js +2 -2
  13. package/dist/docs/yaml-business-tables.js +243 -0
  14. package/dist/docs/yaml-interface-tables.js +106 -0
  15. package/dist/docs/yaml-pages-command.js +5 -3
  16. package/dist/docs/yaml-pages.js +146 -3
  17. package/dist/docs/yaml-table-shared.js +70 -0
  18. package/dist/docs/yaml-tables.js +39 -0
  19. package/dist/exec/agent-config.js +9 -0
  20. package/dist/exec/agent-protected-config.js +2 -0
  21. package/dist/exec/commands.js +31 -18
  22. package/dist/exec/events.js +34 -14
  23. package/dist/exec/evidence.js +13 -3
  24. package/dist/exec/parent-validation.js +56 -3
  25. package/dist/exec/plans-core.js +21 -2
  26. package/dist/exec/plans-generation.js +6 -7
  27. package/dist/exec/post-integration.js +162 -0
  28. package/dist/exec/queue-command.js +166 -0
  29. package/dist/exec/queue.js +285 -0
  30. package/dist/exec/register-foreign-wait.js +84 -0
  31. package/dist/exec/repo-integration-sync.js +17 -5
  32. package/dist/exec/reporter.js +2 -2
  33. package/dist/exec/results.js +24 -4
  34. package/dist/exec/review-kata.js +4 -1
  35. package/dist/exec/run/agent-pipeline.js +3 -2
  36. package/dist/exec/run/agent.js +12 -6
  37. package/dist/exec/run/change-scope.js +365 -0
  38. package/dist/exec/run/deferred-cleanup.js +31 -0
  39. package/dist/exec/run/in-place.js +4 -1
  40. package/dist/exec/run/job-lock.js +66 -0
  41. package/dist/exec/run/job-sequence.js +137 -0
  42. package/dist/exec/run/job.js +56 -19
  43. package/dist/exec/run/lifecycle-commands.js +1 -1
  44. package/dist/exec/run/lock.js +22 -1
  45. package/dist/exec/run/register-command.js +8 -5
  46. package/dist/exec/run/register-mode.js +68 -8
  47. package/dist/exec/run/register-resume.js +68 -14
  48. package/dist/exec/run/register-state.js +13 -8
  49. package/dist/exec/run/register-worktree.js +140 -125
  50. package/dist/exec/run/schedule-mode.js +75 -14
  51. package/dist/exec/run/schedule-prepare.js +3 -0
  52. package/dist/exec/run/schedule-task.js +88 -38
  53. package/dist/exec/run/shared.js +5 -0
  54. package/dist/exec/schedule/schedule.js +116 -4
  55. package/dist/exec/shared.js +1 -1
  56. package/dist/exec/smoke.js +190 -0
  57. package/dist/exec/strategy.js +13 -3
  58. package/dist/exec/task-view.js +6 -4
  59. package/dist/exec/trial-commands.js +5 -2
  60. package/dist/exec/trial-core.js +6 -1
  61. package/dist/exec/validation-metrics.js +181 -0
  62. package/dist/exec/worktree-cleanup-lock.js +26 -0
  63. package/dist/exec/worktree-command.js +9 -1
  64. package/dist/exec/worktree-ops-commit.js +2 -2
  65. package/dist/exec/worktree.js +13 -2
  66. package/dist/grade/command-apply.js +3 -3
  67. package/dist/grade/command-inspect.js +5 -3
  68. package/dist/grade/command-plan.js +1 -1
  69. package/dist/grade/command-run.js +5 -1
  70. package/dist/grade/run.js +64 -8
  71. package/dist/job/definition.js +84 -8
  72. package/dist/job/job.js +79 -23
  73. package/dist/register/authoring-sources.js +22 -16
  74. package/dist/register/maintenance-commands.js +2 -2
  75. package/dist/register/register.js +31 -7
  76. package/dist/routine/definition.js +9 -0
  77. package/dist/routine/routine.js +137 -43
  78. package/dist/routine/status.js +62 -0
  79. package/dist/schedule/schedule.js +38 -39
  80. package/dist/shared/agent-types.js +5 -0
  81. package/dist/shared/cross-process-lock.js +9 -1
  82. package/dist/shared/dist-freshness.js +8 -2
  83. package/dist/shared/git-environment.js +2 -1
  84. package/dist/shared/git.js +44 -1
  85. package/dist/shared/lefthook-scaffold.js +3 -0
  86. package/dist/shared/local-config.js +244 -0
  87. package/dist/shared/specdojo-config.js +34 -20
  88. package/dist/shared/specdojo-gitignore.js +1 -0
  89. package/dist/shared/text.js +9 -1
  90. package/dist/shared/where-alias.js +13 -0
  91. package/dist/specdojo.js +4 -0
  92. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  93. package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
  94. package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
  95. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  96. package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
  97. package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
  98. package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
  99. package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
  100. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  101. package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
  102. package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
  103. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  104. package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
  105. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  106. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  107. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
  108. package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
  109. package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
  110. package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
  111. package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
  112. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
  113. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
  114. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  115. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  116. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
  117. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
  118. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
  119. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
  120. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
  121. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
  122. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  123. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
  124. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  125. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  126. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  127. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  128. package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
  129. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
  130. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
  131. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
  132. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  133. package/docs/ja/specdojo/references/command-reference.md +257 -117
  134. package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
  135. package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
  136. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  137. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  138. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
  139. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
  140. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
  141. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
  142. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
  143. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  144. package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
  145. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
  146. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  147. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  148. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  149. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  150. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
  151. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  152. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
  153. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
  154. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
  155. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  156. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
  157. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  158. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  159. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  160. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
  161. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  162. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
  163. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
  164. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
  165. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
  166. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  167. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  168. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
  169. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  170. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  171. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
  172. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
  173. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  174. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
  175. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
  176. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
  177. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  178. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
  179. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  180. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
  181. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  182. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  183. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  184. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  185. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  186. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
  187. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  188. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  189. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  190. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  191. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  192. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  193. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  194. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  195. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  196. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  197. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  198. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  199. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  200. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  201. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  202. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  203. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
  204. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  205. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  206. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  207. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  208. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
  209. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
  210. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
  211. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
  212. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  213. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
  214. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
  215. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
  216. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  217. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
  218. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  219. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  220. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  221. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  222. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  223. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
  224. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
  225. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
  226. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  227. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  228. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
  229. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
  230. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
  231. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
  232. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
  233. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  234. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
  235. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  236. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  237. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  238. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  239. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
  240. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  241. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  242. package/docs/ja/specdojo/samples/bds-sample.md +58 -71
  243. package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
  244. package/docs/ja/specdojo/samples/bes-sample.md +43 -53
  245. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  246. package/docs/ja/specdojo/samples/br-sample.md +40 -52
  247. package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
  248. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  249. package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
  250. package/docs/ja/specdojo/samples/clis-sample.md +70 -77
  251. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  252. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  253. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  254. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  255. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  256. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  257. package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
  258. package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
  259. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
  260. package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
  261. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
  262. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  263. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
  264. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  265. package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
  266. package/docs/ja/specdojo/samples/sf-sample.md +73 -85
  267. package/docs/ja/specdojo/samples/sld-sample.md +60 -79
  268. package/docs/ja/specdojo/samples/uis-sample.md +98 -121
  269. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  270. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  271. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
  272. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
  273. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
  274. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  275. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  276. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  277. package/package.json +9 -6
  278. package/templates/antigravity/orchestrator.md +4 -1
  279. package/templates/claude/agents/specdojo-orchestrator.md +4 -1
  280. package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
  281. package/templates/codex/orchestrator.md +4 -1
  282. package/templates/init-exec-defaults.yaml +13 -0
  283. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  284. package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
@@ -11,74 +11,67 @@ specdojo:
11
11
 
12
12
  Business Rule Writing Recipe
13
13
 
14
- 業務担当者の判断を、実装と検証へ引き継げる条件・結果に具体化するための作成手順です。特に境界、欠損、競合する条件と未決事項を掘り下げます。
14
+ 業務担当者の判断を、誰が適用しても同じ結果になる条件に具体化する作り方を示す。
15
15
 
16
16
  ## 1. このレシピの使い方
17
17
 
18
- - 上位の業務目的から、この判断が誤った場合に誰が何に困るかを確認する。
19
- - 入力と期待する結果を対にして書き、判断の仕方を業務用語で説明する。画面操作や保存方式は、それを定める後続成果物へ渡す。
20
- - 根拠文書・規則・判定例を結び、判断が変わったときに影響箇所を追えるようにする。不足する根拠は業務担当者への問いに戻す。
18
+ - 業務プロセスから判断が要る理由(Why)を引き継ぎ、入力と結果の対応(What)、適用順と例外時の扱い(How)を決める。条件・判定例・未決事項は ID で結ぶ(Trace)。
21
19
 
22
20
  ## 2. 作成前に集める情報
23
21
 
24
- | 項目 | 集める情報・問い |
25
- | -------- | ---------------------------------------------------------- |
26
- | 利用場面 | 誰がどの業務の途中で判断し、誤判定で何が起きるか |
27
- | 境界 | 直前までに何が確定し、直後にどの業務へ結果を渡すか |
28
- | 判断材料 | 必要な概念項目、単位、比較時点、入力の出所 |
29
- | 結果 | 正常な結果、対象なし、判定できない場合をどう見分けるか |
30
- | 根拠 | 決定済みの条件、参照文書とその作成状況、承認が要る変更 |
31
- | 未決事項 | 誰へ何を判断してもらい、いつまでに決まらないと何が止まるか |
22
+ | 項目 | 集める情報 | 取り出し元 |
23
+ | ---------- | -------------------------------------- | ------------------------ |
24
+ | 利用場面 | 誰がどの業務で判断し、誤ると何が困るか | 業務プロセス、業務担当者 |
25
+ | 判断材料 | 使う項目、単位、比較時点 | 概念データ、業務担当者 |
26
+ | 代表例 | 実際の判断事例と、その結果になった理由 | 業務担当者への聞き取り |
27
+ | 未決の論点 | 決まらない判断と、止まる作業 | 聞き取りのメモ |
32
28
 
33
29
  ## 3. 全体の作成手順
34
30
 
35
- 1. 概要で「どの場面で何を判断するか」を一文にし、守る価値と対象外を添える。
36
- 2. 入力で、最初の具体例に必要な項目を書き出す。単位と比較時点をそろえる。
37
- 3. ルール(判定/計算)で、その例の結果になる理由を条件に変換する。等号・同順位・未設定の例へ広げ、適用順を決める。
38
- 4. 出力で、結果を受け取る相手が次の業務を選べる意味を添える。
39
- 5. 例外 / 異常系で、入力不備と参照失敗を通したときに、業務が続くかを確かめる。
40
- 6. メモ / 将来課題へ根拠不足と未決の判断を集め、依頼先、判断時点、下流の制約を残す。
31
+ 1. 代表例の入力と結果を対にして書く。条件から書くと根拠のない条件が混ざる。
32
+ 2. その結果になる理由を条件にし、等号・同順位・未設定の例へ広げて適用順を決める。
33
+ 3. 条件が使う項目を入力に、受け取る相手の次の行動を出力に書く。
34
+ 4. 入力不備と参照失敗で業務が続くかを決め、決めきれない判断はメモ / 将来課題へ送る。
35
+ 5. 概要は最後に書く。規則が決まると対象外を切りやすい。
41
36
 
42
37
  ## 4. 各章の書き方
43
38
 
44
- | 章 | 書き手が答える問い | 具体化のコツ |
45
- | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------ |
46
- | 概要 | この判断は誰のどの困りごとを減らすか。前後の手順と重複しないか | 実際の利用場面を一つ選び、開始条件と対象外を切り分ける |
47
- | 入力 | その材料が一つ欠けても判断できるか。どの時点の数値を使うか | 項目を一つずつ隠して、仮のゼロで代用していないか調べる |
48
- | ルール(判定/計算) | なぜその結果になるか。条件が同時成立したらどちらを優先するか | 境界の直前・一致・直後を並べ、期待値の異なる理由を説明する |
49
- | 出力 | 結果を受け取る人は何を判断できるか。対象なしと失敗を区別できるか | 結果の意味を言葉にし、利用先に不要な内部計算値を除く |
50
- | 例外 / 異常系 | 間違った値を使い続けた場合の業務影響は何か | 停止・代替・対象外のそれぞれで、結果の有効性と回復の行動を確認する |
51
- | メモ / 将来課題 | どの証拠または誰の判断があれば確定できるか | 現行範囲を変える論点と、確認作業だけの不足を分けて依頼する |
39
+ | 章 | 書き手が答える問い | コツ |
40
+ | ------------------- | -------------------------------------------- | -------------------------------------------- |
41
+ | 概要 | 誤ると誰が困るか。前後の業務と重ならないか | 上位の目的は写さず参照に置き換える |
42
+ | 入力 | 一つ欠けても判断できるか。いつの値か | 項目を一つずつ隠して聞き、仮のゼロを見つける |
43
+ | ルール(判定/計算) | なぜその結果か。同時に成り立てばどちらが先か | 境界の直前・一致・直後を並べて聞く |
44
+ | 出力 | 受け取った人は次に何を選ぶか | 利用先が使わない途中の値は外す |
45
+ | 例外 / 異常系 | 誤った値で続けると何が起きるか | 止める・代替値で続けるの両案を示して選ばせる |
46
+ | メモ / 将来課題 | 誰の判断か、どの証拠があれば確定するか | 範囲を変える論点と確認作業の不足を分ける |
52
47
 
53
48
  ## 5. 深掘り手順
54
49
 
55
- 1. 代表例を業務担当者へ説明し、根拠のない条件や、業務価値へつながらない計算を見つける。
56
- 2. 境界値、欠損、競合する条件で結果が変わる箇所を探す。文字列比較なら大小文字や数字を含む例で同順位の決着が変わらないかを問う。
57
- 3. 順位規則なら一つの項目だけが欠ける場合と、全件で計算できない場合を分ける。両者を同じ代替規則にしてよい根拠を確かめる。
58
- 4. 決められない期待値を作らず、選択肢によって変わる下流の作業とともに判断依頼へ戻す。
50
+ 次の順で対応のない主張を探す。
51
+
52
+ 1. 各条件が概要のどの困りごとに応えるかを確かめ、対応のない条件を外す。
53
+ 2. 判定例の期待値を導く条件を確かめる。文字列の順位は、大小文字や数字を含む例で決着が変わらないかを問う。
54
+ 3. 一項目だけ欠ける場合と全件で計算できない場合を分け、同じ代替規則にする根拠を聞く。
55
+ 4. 決められない期待値は、選択肢ごとに変わる下流の作業を添えて未決へ戻す。
59
56
 
60
57
  ## 6. 良い例 / 悪い例
61
58
 
62
- | 観点 | 良い例 | 悪い例 | 良し悪しを分ける点 |
63
- | ---------- | ---------------------------------------------------------------------------------- | ------------------------ | ---------------------------------- |
64
- | 境界 | 「発注点と等しければ不足なし」 | 「少なければ不足」 | 等号で結果を確定できるか |
65
- | 入力の不足 | 「予約数がないと販売可能数を算出できない」 | 「空欄はたぶんゼロ」 | 業務根拠のある扱いか |
66
- | 利用先 | 「不足判定を在庫確認担当へ返す。発注確定は担当者が行う」 | 「不足なら自動発注する」 | 判断から別の責務へ飛躍していないか |
67
- | 未決事項 | 「閾値変更は店主代表に導入承認前の判断を依頼する。未決なら新閾値の実装を保留する」 | 「閾値は後で考える」 | 次の判断と影響が追えるか |
59
+ | 観点 | 良い例 | 悪い例 |
60
+ | ------------ | ---------------------------------------------------- | ------------------------ |
61
+ | 入力の不足 | 「予約数がないと販売可能数を出せないため判定しない」 | 「空欄はたぶんゼロ」 |
62
+ | 部分的な欠損 | 「最早開始日だけ欠けるタスクの順位は未決とする」 | 「欠けたら末尾に置く」 |
63
+ | 利用先 | 「不足判定を在庫確認担当へ返し、発注は担当が決める」 | 「不足なら自動発注する」 |
68
64
 
69
65
  ## 7. レビュー観点
70
66
 
71
- | 観点 | 確認する問い |
72
- | ------------ | ------------------------------------------------------------------ |
73
- | 業務的な理由 | 主要な条件がどの課題・価値・決定に由来するか説明できるか |
74
- | 再現性 | 二人が同じ具体例に別の期待値を付ける余地はないか |
75
- | 引継ぎ | 正常結果と例外から、利用者が次に行う業務を選べるか |
76
- | 責務境界 | 手順、構文、保存構造を、それを定める成果物へ委譲できているか |
77
- | 判断待ち | 未決事項の影響する規則・例と、判断を依頼する相手を結び付けられるか |
67
+ | 観点 | 確認する問い |
68
+ | ------ | ------------------------------------------------ |
69
+ | 用語 | 業務担当者がふだんの言葉で条件を読めるか |
70
+ | 再現性 | 二人が同じ代表例に別の期待値を付ける余地はないか |
71
+ | 引継ぎ | 結果と例外から、受け取った人が次の業務を選べるか |
78
72
 
79
73
  ## 8. 仕上げチェック
80
74
 
81
- - 概要から入力、判定、出力、例外、残る判断へ読み進めて、参照していない材料や使われない結果がない。
82
- - 判定例は本文で説明した条件から導け、未決の期待値を確定済みの値として示していない。
83
- - 同じ条件を表・文章・擬似コードで繰り返さず、変更する箇所を一つに絞れている。
84
- - 上位の目的の再掲と実装の詳細を整理し、必要な根拠の参照と未決事項の引継ぎが残っている。
75
+ - 入力の各項目を、条件か例外のどれかが使っている。
76
+ - 出力の各結果が、条件か例外のどれかから生じる。
77
+ - 未決事項ごとに、影響する条件か判定例を ID で指せる。
@@ -11,147 +11,149 @@ specdojo:
11
11
 
12
12
  Conceptual Data Flow Diagram Overview Writing Recipe
13
13
 
14
- 業務または運用の全体像を、プロセス領域のまとまりと、それらが読み書きするデータの関係として示すための作成手順です。今の方式(プロセスグループ別 CDFD を置く方式)と、系統の関係を描く方式(区分を代表ノードにし、各系統をユースケース別 CDFD で詳細化する方式)から選びます。
14
+ 業務または運用の全体像を、プロセス領域のまとまりと、それらが読み書きするデータの関係として描くための作り方を示す。
15
15
 
16
16
  ## 1. このレシピの使い方
17
17
 
18
- - 最初に、対象業務・運用の範囲と、プロセス領域・データストアの候補を粗く書き出します。
19
- - 次に、各章の問いに答えながら、目的、適用範囲、プロセス領域の表、データストア、概念データフロー(概要)、詳細 CDFD 一覧を具体化します。
20
- - 最後に、レビュー観点で「表と図の名称が対応し、受け渡しが図で読み取れるか」「領域単位の詳細を書きすぎていないか」を確認します。
21
-
22
- この成果物は、プロセスグループまたは区分とデータストアの名称を軸に、プロセス領域の表・データストア・図・詳細 CDFD 一覧の四点を対応させ、上位の業務目的を領域分割の理由として引き継ぎます。領域内の手順や実装方式は作り込まず、各要素の対応関係で判断を追跡できるようにします(Trace)。
18
+ - 全体概要は、上位の業務目的を領域分割の理由として引き継ぎ(Why)、領域・グループまたは区分・データストアの分け方を定め(What)、受け渡しを代表ノードとストアの線で示す(How)。領域 ID とグループ・区分・ストアの名称で、領域表・ストア一覧・図・詳細 CDFD 一覧をたどれるようにする(Trace)。
19
+ - 「作成前に集める情報」をメモでそろえてから、「全体の作成手順」の順に書く。
20
+ - 書き終えたら「レビュー観点」で読み直し、「仕上げチェック」で確かめる。
23
21
 
24
22
  ## 2. 作成前に集める情報
25
23
 
26
- | 項目 | 集める情報 |
27
- | ------------------ | --------------------------------------------------------------------------------------------------------------- |
28
- | 全体像 | 対象業務を構成するプロセス領域のまとまりと、読み書きするデータの関係 |
29
- | 対象範囲 | 開始点、終了点、対象業務、組織、システム境界 |
30
- | 対象外 | 補助操作、領域内の手順、実装詳細、別成果物が責任を持つ事項 |
31
- | 領域候補 | 固有の業務目的、主な担当、起点イベントを持つ責務のまとまり |
32
- | グループ・区分候補 | 業務の性質が近い領域のまとまり。系統の関係を描く方式では、系統・実行サイクル・調整役などの区分 |
33
- | 主な担当 | 各領域を主に担うロール、複数ロールが担う場合の管理責任、人間の最終判断者 |
34
- | 起点イベント | 各領域の開始を判定できる出来事 |
35
- | データストア | 各グループまたは区分が参照・更新する論理的な正本と、その内容。マスタ・構成かトランザクションかの区分 |
36
- | 保管先 | データストアの物理的な所在。実装が先にある場合は確定値、設計中は候補、概念段階では扱わない |
37
- | 主要な受け渡し | グループまたは区分とデータストアの間で移動する情報・物、区分間の実行要求、調整役の直接読み書きと CLI 経由の区別 |
38
- | 物理保管 | 現物(商品・現金など)を保管する場所(物の流れを図示する場合) |
39
- | 外部主体 | 対象範囲外から入力を渡す人・組織・システムと、結果を受け取る主体。対象範囲内の参加者は含めない |
40
- | 横断ユースケース | 今の方式では複数グループをまたぐ業務、系統の関係を描く方式では各系統の流れ |
41
- | 未決事項 | 境界、名称、責務、判断者、保管先が未確定な論点と、影響、決定者、決定時期 |
24
+ | 項目 | 集める情報 | 取り出し元 |
25
+ | -------------------- | ---------------------------------------------------------------------------- | ---------------------------------- |
26
+ | 対象範囲 | 開始点、終了点、対象業務、組織・システム境界、別成果物に任せる事項 | 業務の責任者への確認、上位の概要 |
27
+ | 業務成果と起点 | 開始から結果利用までの業務成果と、それぞれの開始を判定できる出来事 | 業務の担当者への聞き取り、業務記録 |
28
+ | 担当 | 各領域を主に担う役割、複数で担う場合の管理責任、人間の最終判断者 | 役割の定義(Role code の一覧など) |
29
+ | データの正本 | 各領域が参照・更新する台帳・文書・設定と、更新される契機、物理的な所在 | 既存の台帳・保管場所、実装 |
30
+ | 受け渡しと外部主体 | 領域とストアの間で動く情報・物、対象範囲外から入力を渡す主体と受け取る主体 | 業務の担当者への聞き取り |
31
+ | 構成方式と横断の流れ | 今の方式か系統の関係を描く方式か、複数グループをまたぐ業務または各系統の流れ | 業務の責任者への確認 |
42
32
 
43
33
  ## 3. 全体の作成手順
44
34
 
45
- 1. 全体像として示す関係を 1〜2 文で書き、開始点、終了点、対象外を定義します。
46
- 2. 開始から結果利用までの業務成果を並べ、起点イベントと最終出力が異なるまとまりへ分け、各まとまりへ安定した領域 ID を付けます。
47
- 3. 一覧、検索、状態参照、検証、dry-run など、独立した業務成果を持たない候補を支援先の領域へ戻します。
48
- 4. 業務の性質が近い領域を、今の方式ではプロセスグループへ、系統の関係を描く方式では区分へまとめ、8 以下にします。各節には領域の表だけを置き、必要なら PDCA 列を追加します。受け渡しの正本は図とし、主要入力・主要出力の箇条書きは置きません。
49
- 5. 各グループまたは区分が参照・更新するデータストアを集め、更新契機でマスタ・構成データとトランザクションデータに区分し、一覧にします。保管先は確定度に応じて列を置くか省略します。
50
- 6. グループまたは区分を代表ノードにし、データストアとの関係と区分間の要求を名詞のラベル付きの線で描きます。16 ノードを超える場合は選択した方式で分けます。系統の関係を描く方式ではデータの種類で分け、区分の位置をそろえ、線のない区分を省きます。調整役の指示は別図にし、直接読み書きするストアだけを調整役につなぎます。
51
- 7. 今の方式ではプロセスグループ別 CDFD の表と、横断業務のユースケース別 CDFD の表を作ります。系統の関係を描く方式では、各系統の流れをユースケース別 CDFD の表に載せます。
52
- 8. 名称を使って領域表、データストア、図、詳細 CDFD 一覧を突き合わせ、重複、欠落、名称ゆれを解消します。
53
- 9. 確定できない論点は影響と決定時期を添えて未決事項へ分離します。
35
+ 1. 適用範囲を最初に書き、開始点・終了点・対象外を決める。範囲が決まらないと、領域の候補が増え続ける。
36
+ 2. 構成方式を選ぶ。代表ノードをプロセスグループにするか区分にするかで、以降の章の単位が変わる。
37
+ 3. 業務成果ごとに領域を切り、補助操作を支援先の領域へ戻してから、グループまたは区分にまとめる。
38
+ 4. 領域表から参照・更新するストアを集め、ストア一覧を作る。図に置く名称はここで決める。
39
+ 5. 代表ノードとストアを線でつなぎ、図を描く。
40
+ 6. 詳細 CDFD 一覧で、各グループまたは各系統の詳細化先を決める。
41
+ 7. 各章の冒頭文(領域数・グループ数、ストアの区分の意味、採用方式)を書く。表と図ができてから書くと数と名称がずれない。
42
+ 8. 最後に、H1 直下の導入文と目的を書く。領域分割が決まってから書くと、本文の言い直しにならない。
43
+ 9. 決めきれない論点は `_UNDECIDED_` を残し、未決事項に影響と合わせて置く。
54
44
 
55
45
  ## 4. 各章の書き方
56
46
 
57
- ### 4.1. 目的
47
+ ### 4.1. 導入文と目的
58
48
 
59
49
  問い:
60
50
 
61
- - どの業務または運用の全体像を示しますか。
62
- - その全体像を構成するプロセス領域のまとまりと、読み書きするデータの関係は何ですか。
51
+ - この文書は、どの業務または運用を扱うのか。
52
+ - 全体像として、どの領域のまとまりとデータの関係を示すのか。
53
+
54
+ コツ:
63
55
 
64
- 全体像として何を示すかを 1〜2 文で書きます。例えば「店舗運営の全体像として、仕入・販売・在庫・顧客・締めと、それらが読み書きするデータの関係を示す」とします。PO の承認や引き継ぎなどの作業、読み手の役割は目的に含めません。対象範囲と領域分割の PO 承認記録は、目的とは別に `ready` 昇格の完成判定で確認します。
56
+ - 導入文は対象を一文で定義するだけにし、効果や指標を並べたくなったら上位の概要への参照に置き換える。
57
+ - 目的に承認や引き継ぎの作業、読み手の役割を書き始めたら外す。
65
58
 
66
59
  ### 4.2. 適用範囲
67
60
 
68
61
  問い:
69
62
 
70
- - どの出来事から、どの成果または判断までを扱いますか。
71
- - 領域内部として選択した方式の詳細 CDFD へ委ねるものと、業務成果を持たないため補助操作として除外するものは何ですか。
72
- - 人間が責任を持つ判断と、AI Agent やシステムが支援できる処理の境界はどこですか。対応する責任分担文書はありますか。
73
- - 特定プロジェクトの実行計画・スケジュール上のフェーズ名を、前提知識のない読者への説明なく持ち込んでいませんか。
63
+ - どの出来事から、どの成果または判断までを扱うのか。
64
+ - 一覧・検索・検証などの補助操作と、領域内部の手順を、どこへ任せるのか。
65
+
66
+ コツ:
74
67
 
75
- 対象業務、開始点、終了点、対象外、補助操作の扱いを明示します。責任分担は対応する文書があれば参照し、なければ原則を一文で書きます。
68
+ - 責任分担は、対応する方針文書があれば参照し、なければ原則を一文で書く。
69
+ - 特定プロジェクトの計画上のフェーズ名を持ち込みやすい。前提知識のない読者に通じる言葉に直す。
76
70
 
77
71
  ### 4.3. プロセス領域
78
72
 
79
73
  問い:
80
74
 
81
- - 各領域には、他の領域と区別できる固有の起点イベントと業務成果がありますか。定義系の領域の起点を実行の契機で書いていませんか。
82
- - グループまたは区分の見出しと領域表から、そのまとまりの業務目的が読み取れますか。
83
- - 各領域は一つのグループまたは区分にだけ属していますか。PDCA を示す場合は任意の列にしていますか。
84
- - 主な担当を「全員」だけで終わらせず、管理責任のロールを示していますか。
75
+ - 各領域に、ほかと区別できる起点イベントと業務成果があるか。
76
+ - そのグループまたは区分の業務目的が、見出しと表から読み取れるか。
85
77
 
86
- グループまたは区分ごとに節を設け、領域 ID、プロセス領域、業務目的、主な担当、起点イベントの表だけを置きます。PDCA は任意の列です。受け渡しは図を正本とし、主要入力・主要出力の箇条書きは置きません。業務目的は手段名ではなく、対象者が利用する成果または維持したい状態で書きます。領域を分けるか迷う場合は、起点、最終出力、更新する正本の三点を比較します。領域内部の詳細は選択した方式の詳細 CDFD へ委ねます。
78
+ コツ:
79
+
80
+ - 分けるか迷ったら、起点、最終出力、更新する正本の三点を比べる。三点とも同じなら一つにする。
81
+ - 定義系の領域の起点を「時期が到来した」など実行の契機で書きやすい。定義系は「要件が判明した」で書く。
82
+ - 担当は役割の定義から取り、「全員」と書きたくなったら管理責任を持つ役割を聞く。
83
+ - 冒頭文の領域数とグループ数は、表を数えて書く。
87
84
 
88
85
  ### 4.4. データストア
89
86
 
90
87
  問い:
91
88
 
92
- - 各データストアは、何の正本かが分かる名称ですか。生成物の場合は生成元、退避先の場合は退避対象が主な内容に書かれていますか。
93
- - 区分は更新契機で判定していますか。定義から生成される生成物を、生成元と同じ区分にしていませんか。
94
- - 保管先の列を置く場合、確定度に合った書き方(確定値、`_UNDECIDED_`、列の省略)になっていますか。保管先を共有・包含する場合は、論理境界と共有相手を注記していますか。
95
- - リポジトリ基盤や開発環境の設定など、業務データでないものを除外していますか。
89
+ - 各ストアは、何の正本かが名称から分かるか。
90
+ - 承認された変更で更新されるか、業務活動のたびに更新されるか。
91
+
92
+ コツ:
96
93
 
97
- マスタ・構成データとトランザクションデータの 2 表に分けます。図に置くデータストアはこの一覧の行と一対一にするため、図で使いたい名称をここで確定します。
94
+ - 定義から生成される生成物は、更新の契機が違うため生成元と別の区分になりやすい。生成元を主な内容に書く。
95
+ - 保管先は、実装があれば確定値を、設計中なら候補と `_UNDECIDED_` を書き、概念段階では列ごと外す。推測でパスを書かない。
96
+ - 一つの保管先を複数のストアで共有するときは、どこまでがこのストアかと共有相手を注記する。
97
+ - 冒頭文では区分の意味、パスの略記、扱わないもの(リポジトリ基盤・開発環境の設定など)を各一文で書く。
98
98
 
99
99
  ### 4.5. 概念データフロー(概要)
100
100
 
101
101
  問い:
102
102
 
103
- - 今の方式と、系統の関係を描く方式のどちらを使いますか。凡例または章冒頭で宣言していますか。
104
- - 代表ノードはグループまたは区分ごとに一つで、名称と含む領域 ID をラベルにしていますか。`subgraph` で囲んでいませんか。
105
- - データストアは一覧の各行と一対一で名称が一致していますか。同じストアを複数図に再掲する場合も同じ名称ですか。
106
- - 線のラベルは、何がどこからどこへ渡るか分かる名詞ですか。区分から区分への「対応要求」「実行要求」なども名詞のラベルで描いていますか。
107
- - 対象範囲内の参加者を外部主体にしていませんか。外部主体は対象範囲外の入力元・出力先だけですか。
108
- - 16 ノードを超える場合、選択した方式で分割していますか。今の方式ではデータストアの区分または使い方の流れで分け、名称を統一していますか。
109
- - 系統の関係を描く方式では、データの種類で分けた図の間で区分の位置がそろっていますか。受け渡しの線のない区分をその図から省き、各区分をいずれかの図に出していますか。配置制御の非表示の線を受け渡しとして数えていませんか。
110
- - 系統の関係を描く方式では、調整役(Orchestrator)をデータの図から外し、必要なら指示の図を別に設けていますか。調整役からストアへの線は直接の読み書きだけですか。CLI 経由のものはデータの図で該当区分からの線になっていますか。
111
- - 図の題は業務の言葉で付けていますか。図の説明は、図から読み取れることを 1 文で書き、作図の約束は凡例に任せていますか。
103
+ - 線のラベルから、何がどこからどこへ渡るかが分かるか。
104
+ - 対象範囲の外にいるのは誰か。
112
105
 
113
- 系統の関係を描く方式では、例えば「PDCA のプロセスとデータの関係」「プロセスを実行する設定・構成情報の流れ」「Orchestrator による PDCA の調整」の 3 図にします。実行要求をトランザクションの図だけに限定する規則は設けず、調整役の指示は指示の図に描きます。グループや区分の内部は詳細 CDFD へ委ねます。物の流れがある場合は物理保管も図の要素として扱い、線種は採用した記法の凡例に従います。
106
+ コツ:
107
+
108
+ - 冒頭文で採用方式と示す関係を宣言してから描くと、分割の切り口がぶれない。
109
+ - 店主など対象範囲内の参加者を外部主体に描きやすい。参加者は領域の担当とし、参加者から直接受け取る入力を図から省いたときは、図の直後に省いたことを一文で書く。
110
+ - ノードが多くなったら、今の方式はストアの区分か使い方の流れで、系統の関係を描く方式はデータの種類で分ける。調整役(Orchestrator)の指示はデータの図に混ぜず、別の図にする。
111
+ - 図の説明に作図の約束を書き始めたら、凡例へ移す。
114
112
 
115
113
  ### 4.6. 詳細 CDFD 一覧
116
114
 
117
115
  問い:
118
116
 
119
- - 選択した方式に応じた詳細 CDFD の役割分担を示していますか。状態の定義と遷移は STSD を正本にしていますか。
120
- - 今の方式では、プロセスグループ別 CDFD の表に全グループが 1 行ずつあり、各領域がちょうど一つの行に属していますか。ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件だけを扱っていますか。
121
- - 系統の関係を描く方式では、各系統の流れをユースケース別 CDFD でプロセス領域の単位に詳細化していますか。プロセスグループ別 CDFD の表は省略するか、移行期・非推奨の記録として扱っていますか。
122
- - 「未作成」などの作成状況を本文に書いていませんか。
117
+ - 各領域の内部は、どの詳細 CDFD が扱うのか。
118
+ - 複数グループをまたぐ業務、または各系統の流れは、どこで詳細化するのか。
119
+
120
+ コツ:
123
121
 
124
- 作成状況は登録簿で追跡し、本文には ID だけを書きます。今の方式で単一グループに閉じる業務はグループ別 CDFD で扱い、ユースケース別 CDFD は横断業務が必要になった時点で追加します。
122
+ - 単一グループに閉じる業務はグループ別の詳細 CDFD に任せ、横断のユースケース別 CDFD は必要になってから足す。
123
+ - 「未作成」などの作成状況を書きたくなったら、登録簿で追跡し、本文には ID だけを書く。
125
124
 
126
125
  ### 4.7. 凡例(本プロダクト共通)(任意)
127
126
 
128
127
  問い:
129
128
 
130
- - 本プロダクトに複数の詳細 CDFD があり、共通のノード形状・色・絵文字を使いますか。
131
- - 全体概要と詳細 CDFD の各図が、この章の定義を再掲せず参照する形になっていますか。
132
- - サンプル図には、採用する記法(Mermaid または D2)の rulebook が定義する全ノード種別が一つずつ含まれていますか。
129
+ - 複数の詳細 CDFD が、同じ形状・色・絵文字を使うか。
130
+ - 各図は、凡例を再掲せずに参照できるか。
131
+
132
+ コツ:
133
133
 
134
- 詳細 CDFD が複数あり、色・絵文字の割り当てを毎回説明し直すと負担になる場合に設けます。単一の CDFD しかない場合は省略します。
134
+ - 詳細 CDFD が一つだけなら章を設けない。
135
135
 
136
136
  ### 4.8. 未決事項(条件付き)
137
137
 
138
138
  問い:
139
139
 
140
- - 境界、名称、責務、判断者、保管先のいずれかに未確定の論点がありますか。
141
- - 本文中の `_UNDECIDED_` は、表の論点と対応していますか。
140
+ - 境界、名称、責務、判断者、保管先のうち、決めきれないものはどれか。
141
+ - 決まると、どの領域・ストア・図・詳細化先が変わるか。
142
142
 
143
- 未決事項がある場合だけ最終章として設け、論点、影響、決定者、決定時期、状態の表にします。確定した論点は本文へ反映して表から削除します。
143
+ コツ:
144
+
145
+ - 本文の `_UNDECIDED_` から論点を拾うと、表との対応が漏れない。決まった論点は本文へ反映して表から外す。
144
146
 
145
147
  ## 5. 深掘り手順
146
148
 
147
- 1. 各領域の目的から逆向きにたどり、その領域が応える利用者の判断または業務課題を確認します。
148
- 2. 各領域の起点イベントを見て、定義系の領域が実行の契機で書かれていないか、同じグループ内で同文になっていないかを確認します。
149
- 3. 図の出力の線から順向きにたどり、他グループ・区分または外部主体が利用するか、データストアに残るかを確認します。
150
- 4. 同じデータストアを更新する複数グループを並べ、更新責務が重複していないか確認します。
151
- 5. 図の線を一本ずつたどり、領域表の業務目的とストアの主な内容に照らして、欠けた受け渡しや不要な線を修正します。
152
- 6. 「データストア」の各行がいずれかの図に登場し、再掲時も名称が一致するか確認します。保管先が重なる場合は論理境界と共有相手の注記を確認します。
153
- 7. コマンド名、画面名、ファイル名を隠しても目的と受け渡しを説明できるか確認し、説明できない行を概念粒度へ戻します。
154
- 8. 補助操作を除外したことで必要な検証入力が失われていないか確認し、独立領域ではなく支援先の入力として残します。
149
+ 内容が浅いときは、次の順で対応のない主張を探す。
150
+
151
+ 1. 各領域の業務目的から逆にたどり、応える利用者の判断または業務課題がない領域を外すかまとめる。
152
+ 2. 図の出力の線を順にたどり、他のグループ・区分・外部主体が使うか、ストアに残るかを確かめる。行き先のない線を外す。
153
+ 3. 同じストアを更新するグループを並べ、更新の責務が重なっていないかを確かめる。
154
+ 4. ストア一覧のうち、図のどの線にも現れない行を探し、受け渡しの欠けか不要なストアかを決める。
155
+ 5. コマンド名・画面名・ファイル名を隠しても目的と受け渡しを説明できるかを確かめ、説明できない行を概念の粒度へ戻す。
156
+ 6. 補助操作を外したことで、必要な検証の入力が消えていないかを確かめ、支援先の入力として残す。
155
157
 
156
158
  ## 6. 良い例 / 悪い例
157
159
 
@@ -159,11 +161,9 @@ Conceptual Data Flow Diagram Overview Writing Recipe
159
161
  | ------------ | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
160
162
  | 業務目的 | 現金販売を記録し、商品を顧客へ渡す | 販売登録画面を実行する |
161
163
  | 起点イベント | 定期実行定義は「定期的に確認・実行する事項が判明した」 | 定期実行定義に「指定された時期が到来した」(実行の契機) |
162
- | グループ粒度 | 店頭販売とつけ販売を「販売」グループにまとめ、値引きや取消の手順は詳細 CDFD へ委ねる | 全体概要に値引き、取消、再入力を別ノードで並べる |
163
- | 入出力 | 入力は購入依頼と支払、売価、つけ上限。出力は販売記録とつけ販売の記録 | 入力はフォーム、出力は JSON |
164
- | データストア | 販売取引の正本である「販売記録」と、その生成物である「日次締め記録」を分ける | `sales-table`。または販売記録と締め記録を一つにまとめる |
165
- | 区分 | 定期実行定義(定義)はマスタ・構成、実行記録(活動の記録)はトランザクション | 定義と記録を同じ区分にする |
166
- | 保管先 | 実装があるのでパスを書く。設計中は `_UNDECIDED_`。概念段階は列を省略 | 未定なのに推測でパスを書く |
164
+ | グループ粒度 | 店頭販売とつけ販売を「販売」グループにまとめ、値引きや取消の手順は詳細 CDFD へ任せる | 全体概要に値引き、取消、再入力を別ノードで並べる |
165
+ | 受け渡し | 購入依頼と支払、売価、つけ上限を受け、販売記録とつけ販売の記録を残す | 入力はフォーム、出力は JSON |
166
+ | データストア | 販売取引の正本「販売記録」と、その生成物「日次締め記録」を分ける | `sales-table`。または販売記録と締め記録を一つにまとめる |
167
167
  | 補助操作 | 商品検索は販売の入力確認として扱う | 商品検索を独立したプロセス領域にする |
168
168
  | 図の要素 | 顧客と仕入先を外部主体、店主を各領域の担当として内側に置く | 店主を外部主体として描く |
169
169
  | ノード数 | 代表ノード 6 とデータストア 15 の計 21 なのでデータの種類で分け、調整役がいれば指示を別図にする | 21 ノードを 1 図に並べる |
@@ -171,30 +171,18 @@ Conceptual Data Flow Diagram Overview Writing Recipe
171
171
 
172
172
  ## 7. レビュー観点
173
173
 
174
- | 観点 | 確認内容 | 主な確認者 |
175
- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
176
- | 業務価値 | 各領域の目的が、対象者の課題、判断、期待する業務成果のどれに応えるか説明できる | BA |
177
- | 対象境界 | 領域、プロセスグループ、補助操作、領域内部、人間の最終判断、外部主体の境界を承認できる | PO |
178
- | 詳細化入力 | 各グループまたは区分の受け渡し、データストア、詳細化先を識別できる | ARC |
179
- | 網羅性 | 各領域が一つのグループまたは区分に属し、選択した方式の詳細 CDFD へ対応し、受け渡しに欠落がない | QE |
180
- | 用語整合 | 領域、グループ、データストアの名称が表、一覧、図、詳細 CDFD 一覧で一致する | BA、QE |
181
- | 粒度 | 全体概要がグループまたは区分単位の受け渡しに留まり、領域単位の入出力、手順、状態、例外、実装詳細を詳細化先へ委譲する | BA、ARC |
182
- | 可読性 | グループまたは区分が 8 以下で、16 ノードを超える場合は選択した方式で分割され、系統の関係を描く方式では区分の位置と指示の別図が適切である | BA、ARC |
174
+ | 観点 | 確認内容 |
175
+ | ---------- | ---------------------------------------------------------------------------------------- |
176
+ | 業務価値 | 各領域の目的が、対象者のどの課題・判断・業務成果に応えるかを説明できるか |
177
+ | 対象境界 | 領域、補助操作、領域内部、人間の最終判断、外部主体の境界を、業務の責任者が判断できるか |
178
+ | 詳細化入力 | 各グループまたは区分の受け渡し、ストア、詳細化先を、詳細 CDFD の書き手が引き継げるか |
179
+ | 用語整合 | 領域、グループ・区分、ストアの名称が、領域表・ストア一覧・図・詳細 CDFD 一覧で一致するか |
180
+ | 粒度 | 領域単位の入出力、手順、状態、例外、実装の詳細を書きすぎていないか |
183
181
 
184
182
  ## 8. 仕上げチェック
185
183
 
186
- 最終的な完成判定は [[specdojo:cdfd-overview-rulebook|作成ルール]] の完成判定を正本とし、ここでは作成中の整合を確かめます。
187
-
188
- - 目的は全体像として何を示すかを 1〜2 文で書き、対象範囲、対象外、責任分担は適用範囲に書いた。
189
- - 各領域に ID、業務目的、担当、起点イベントがあり、各グループまたは区分の節は領域表だけにした。PDCA 列は必要な場合だけ追加した。
190
- - グループまたは区分が 8 以下である。
191
- - データストアをマスタ・構成とトランザクションに分け、保管先列を確定度に合った扱いにした。
192
- - 代表ノード、領域表、データストア、詳細 CDFD 一覧の名称と ID が対応し、`subgraph` を使っていない。
193
- - 受け渡しの全線に名詞のラベルがあり、区分間の実行要求も内容を読み取れる。
194
- - 16 ノードを超える場合は選択した方式で分割した。系統の関係を描く方式ではデータの図で区分の位置をそろえ、線のない区分を省き、各区分はいずれかの図に出した。
195
- - 系統の関係を描く方式では、調整役はデータの図に置かず、必要な指示の図に置いた。直接読み書きするストアだけにつなぎ、CLI 経由の読み書きはデータの図の該当区分から描いた。
196
- - 図の題は業務の言葉で、図の説明は読み取れることを 1 文で書き、作図の約束を凡例にまとめた。
197
- - 対象範囲内の参加者を外部主体にせず、補助操作を独立領域にしていない。
198
- - 詳細 CDFD 一覧は選択した方式に従い、作成状況を書いていない。領域内部の詳細と状態定義はそれぞれの正本へ委ねた。
199
- - 未決事項は `_UNDECIDED_` で区別し、影響、決定者、決定時期、状態を記載した。未決事項がなければ章を設けていない。
200
- - 作業メモを HTML コメントで本文に残していない。
184
+ - 各章の冒頭文の数・区分・方式が、表と図の実際と一致している。
185
+ - 各領域が一つのグループまたは区分に属し、詳細 CDFD 一覧のいずれかの詳細化先へたどれる。
186
+ - ストア一覧の各行が、いずれかの図に同じ名称で現れる。
187
+ - 対象範囲内の参加者を外部主体にしておらず、参加者からの入力を省いた図には注記がある。
188
+ - 決めきれない論点は `_UNDECIDED_` のまま残し、確定したと書いていない。