specdojo 0.8.0 → 0.9.1

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 (292) hide show
  1. package/.github/agents/specdojo-orchestrator.md +4 -1
  2. package/CHANGELOG.md +77 -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/orchestrator.js +5 -77
  9. package/dist/commands/where.js +25 -0
  10. package/dist/dashboard/dashboard.js +5 -3
  11. package/dist/dashboard/routines.js +4 -7
  12. package/dist/dashboard/shared.js +2 -2
  13. package/dist/dashboard/timeline.js +14 -14
  14. package/dist/deliverable/trash.js +2 -1
  15. package/dist/docs/index-command.js +2 -2
  16. package/dist/docs/yaml-business-tables.js +243 -0
  17. package/dist/docs/yaml-interface-tables.js +106 -0
  18. package/dist/docs/yaml-pages-command.js +5 -3
  19. package/dist/docs/yaml-pages.js +146 -3
  20. package/dist/docs/yaml-table-shared.js +70 -0
  21. package/dist/docs/yaml-tables.js +39 -0
  22. package/dist/exec/agent-config.js +9 -0
  23. package/dist/exec/agent-protected-config.js +2 -0
  24. package/dist/exec/commands.js +31 -18
  25. package/dist/exec/events.js +34 -14
  26. package/dist/exec/evidence.js +13 -3
  27. package/dist/exec/opencode-permissions.js +117 -0
  28. package/dist/exec/parent-validation.js +56 -3
  29. package/dist/exec/plans-core.js +21 -2
  30. package/dist/exec/plans-generation.js +6 -7
  31. package/dist/exec/post-integration.js +162 -0
  32. package/dist/exec/queue-command.js +166 -0
  33. package/dist/exec/queue.js +285 -0
  34. package/dist/exec/register-foreign-wait.js +82 -0
  35. package/dist/exec/repo-integration-sync.js +17 -5
  36. package/dist/exec/repo-trace.js +2 -1
  37. package/dist/exec/reporter.js +2 -2
  38. package/dist/exec/results.js +24 -4
  39. package/dist/exec/review-kata.js +4 -1
  40. package/dist/exec/run/agent-pipeline.js +3 -2
  41. package/dist/exec/run/agent.js +12 -6
  42. package/dist/exec/run/change-scope.js +365 -0
  43. package/dist/exec/run/deferred-cleanup.js +31 -0
  44. package/dist/exec/run/in-place.js +5 -2
  45. package/dist/exec/run/job-lock.js +66 -0
  46. package/dist/exec/run/job-sequence.js +137 -0
  47. package/dist/exec/run/job.js +56 -19
  48. package/dist/exec/run/lifecycle-commands.js +1 -1
  49. package/dist/exec/run/lock.js +22 -1
  50. package/dist/exec/run/register-command.js +8 -5
  51. package/dist/exec/run/register-mode.js +68 -8
  52. package/dist/exec/run/register-resume.js +68 -14
  53. package/dist/exec/run/register-state.js +13 -8
  54. package/dist/exec/run/register-worktree.js +140 -125
  55. package/dist/exec/run/schedule-mode.js +75 -14
  56. package/dist/exec/run/schedule-prepare.js +3 -0
  57. package/dist/exec/run/schedule-task.js +88 -38
  58. package/dist/exec/run/shared.js +5 -0
  59. package/dist/exec/schedule/schedule.js +116 -4
  60. package/dist/exec/shared.js +2 -2
  61. package/dist/exec/smoke.js +190 -0
  62. package/dist/exec/strategy.js +13 -3
  63. package/dist/exec/task-repos.js +19 -4
  64. package/dist/exec/task-view.js +6 -4
  65. package/dist/exec/trial-commands.js +5 -2
  66. package/dist/exec/trial-core.js +6 -1
  67. package/dist/exec/validation-metrics.js +181 -0
  68. package/dist/exec/worktree-cleanup-lock.js +26 -0
  69. package/dist/exec/worktree-command.js +12 -2
  70. package/dist/exec/worktree-ops-commit.js +2 -2
  71. package/dist/exec/worktree.js +13 -2
  72. package/dist/grade/command-apply.js +3 -3
  73. package/dist/grade/command-inspect.js +5 -3
  74. package/dist/grade/command-plan.js +1 -1
  75. package/dist/grade/command-run.js +5 -1
  76. package/dist/grade/run.js +64 -8
  77. package/dist/job/definition.js +84 -8
  78. package/dist/job/job.js +79 -23
  79. package/dist/register/authoring-sources.js +22 -16
  80. package/dist/register/maintenance-commands.js +2 -2
  81. package/dist/register/register.js +31 -7
  82. package/dist/register/renumber.js +1 -3
  83. package/dist/routine/definition.js +9 -0
  84. package/dist/routine/routine.js +137 -43
  85. package/dist/routine/status.js +62 -0
  86. package/dist/schedule/schedule.js +38 -39
  87. package/dist/shared/agent-types.js +5 -0
  88. package/dist/shared/cross-process-lock.js +9 -1
  89. package/dist/shared/dist-freshness.js +8 -2
  90. package/dist/shared/git-environment.js +2 -1
  91. package/dist/shared/git.js +44 -1
  92. package/dist/shared/lefthook-scaffold.js +3 -0
  93. package/dist/shared/local-config.js +244 -0
  94. package/dist/shared/specdojo-config.js +34 -20
  95. package/dist/shared/specdojo-gitignore.js +1 -0
  96. package/dist/shared/text.js +17 -1
  97. package/dist/shared/where-alias.js +13 -0
  98. package/dist/specdojo.js +4 -0
  99. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  100. package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
  101. package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
  102. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  103. package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +1 -1
  104. package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
  105. package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
  106. package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
  107. package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
  108. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  109. package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
  110. package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
  111. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  112. package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
  113. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  114. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  115. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
  116. package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
  117. package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
  118. package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
  119. package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
  120. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
  121. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
  122. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  123. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  124. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
  125. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
  126. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
  127. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
  128. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
  129. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
  130. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  131. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
  132. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  133. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  134. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  135. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  136. package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
  137. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
  138. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
  139. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
  140. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  141. package/docs/ja/specdojo/references/command-reference.md +258 -118
  142. package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
  143. package/docs/ja/specdojo/references/specdojo-config-reference.md +47 -10
  144. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  145. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  146. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
  147. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
  148. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
  149. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
  150. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
  151. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  152. package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
  153. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
  154. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  155. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  156. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  157. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  158. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
  159. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  160. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
  161. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
  162. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
  163. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  164. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
  165. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  166. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  167. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  168. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
  169. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  170. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
  171. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
  172. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
  173. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
  174. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  175. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  176. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
  177. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  178. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  179. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
  180. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
  181. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  182. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
  183. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
  184. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
  185. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  186. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
  187. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  188. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
  189. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  190. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  191. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  192. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  193. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  194. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
  195. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  196. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  197. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  198. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  199. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  200. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  201. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  202. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  203. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  204. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  205. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  206. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  207. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  208. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  209. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  210. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  211. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
  212. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  213. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  214. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  215. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  216. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
  217. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
  218. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
  219. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
  220. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  221. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
  222. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
  223. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
  224. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  225. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
  226. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  227. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  228. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  229. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  230. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  231. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
  232. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
  233. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
  234. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  235. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  236. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
  237. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
  238. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
  239. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
  240. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
  241. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  242. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
  243. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  244. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  245. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  246. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  247. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
  248. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  249. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  250. package/docs/ja/specdojo/samples/bds-sample.md +58 -71
  251. package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
  252. package/docs/ja/specdojo/samples/bes-sample.md +43 -53
  253. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  254. package/docs/ja/specdojo/samples/br-sample.md +40 -52
  255. package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
  256. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  257. package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
  258. package/docs/ja/specdojo/samples/clis-sample.md +70 -77
  259. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  260. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  261. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  262. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  263. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  264. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  265. package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
  266. package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
  267. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
  268. package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
  269. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
  270. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  271. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
  272. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  273. package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
  274. package/docs/ja/specdojo/samples/sf-sample.md +73 -85
  275. package/docs/ja/specdojo/samples/sld-sample.md +60 -79
  276. package/docs/ja/specdojo/samples/uis-sample.md +98 -121
  277. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  278. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  279. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
  280. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
  281. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
  282. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  283. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  284. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  285. package/package.json +9 -6
  286. package/templates/antigravity/orchestrator.md +4 -1
  287. package/templates/claude/agents/specdojo-orchestrator.md +4 -1
  288. package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
  289. package/templates/codex/orchestrator.md +4 -1
  290. package/templates/init-exec-defaults.yaml +13 -0
  291. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  292. package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
@@ -11,52 +11,37 @@ specdojo:
11
11
 
12
12
  Conceptual Data Flow Diagram Process Group Writing Recipe
13
13
 
14
- 全体概要から一つのプロセスグループとそれに属する領域群を引き継ぎ、領域内部と領域間のプロセス、主要例外、グループ外への委譲を、関係者が再現可能な形で具体化するための作成手順です。状態を変えるプロセスは STSD へ接続し、状態定義と遷移の二重管理を防ぎます。
14
+ 全体概要から一つのプロセスグループを引き継ぎ、領域内と領域間のプロセス、主要例外、グループ外への委譲を、関係者が再現できる形で具体化するための作り方を示す。
15
15
 
16
16
  ## 1. このレシピの使い方
17
17
 
18
- - 最初に、全体概要から対象グループ、含む全領域、グループ単位の主要入力・主要出力・データストアを抜き出し、領域ごとの節へ配分します。
19
- - 次に、各節を説明文、主要入力・主要出力・データストアの箇条書き、プロセス表の順で作り、全体概要の「データストア」から本グループが読み書きする部分集合を切り出します。
20
- - その後、概念データフロー、個別プロセス主要入出力、状態遷移の参照、主要例外とグループ外への委譲を具体化します。
21
- - 最後に、全領域と全プロセスの網羅性、データストア名称・区分・読み書き、同一グループ内の領域間フロー、STSD への参照、他グループとの責任境界を突き合わせます。
22
-
23
- この成果物は、上位の業務目的を Why、グループ内で成立させる出力と境界を What、プロセス・例外対応・委譲を How、領域 ID・プロセス ID・例外 ID・参照先の対応を Trace として整理します。上位目的、状態定義、状態遷移は複製しません。
18
+ - この CDFD は、全体概要のグループの目的(Why)を参照で引き継ぎ、グループ内でそろえる出力と境界(What)を定め、プロセス・例外対応・委譲(How)を決める。領域 ID・プロセス ID・例外 ID・データストア名でたどれるようにする(Trace)。
19
+ - 上位の目的、状態の定義と遷移は写さず参照に置き換える。全体概要が正の領域・データストアの名称も言い換えない。
20
+ - 「作成前に集める情報」をメモでそろえてから、「全体の作成手順」の順に書く。
24
21
 
25
22
  ## 2. 作成前に集める情報
26
23
 
27
- | 項目 | 集める情報 |
28
- | ------------------ | ------------------------------------------------------------------------------------ |
29
- | 対象グループ | 全体概要のプロセスグループ名と `cdfd-<group>` の英小文字スラッグ |
30
- | 対象領域 | グループに属する全領域の ID・名称。業務目的、担当、起点イベントは参照用に控える |
31
- | グループ入出力 | 全体概要にあるグループ単位の主要入力、主要出力、データストア |
32
- | 領域別入出力 | グループ入出力を各領域へ配分した主要入力、主要出力、データストア |
33
- | 利用者と判断 | 誰が内部フローを合意し、誰が境界を承認し、誰が設計・検証に使うか |
34
- | プロセス候補 | 異なる業務目的、担当、正本更新、完了条件を持つ処理候補 |
35
- | 起動条件と必須性 | 外部イベント、前段完了、承認、条件値、および非起動時の正常な扱い |
36
- | データストア | 全体概要の「データストア」にある名称と区分、および各領域・プロセスでの参照・更新の別 |
37
- | 状態定義・状態遷移 | 状態を変えるプロセスが参照する STSD の文書 ID |
38
- | 主要例外 | 入力不足、業務条件不成立、更新失敗など、結果または後続起動を変える分岐 |
39
- | グループ外委譲 | 他グループまたは横断ユースケースへ渡す責務、情報、戻す条件 |
40
- | 責任分担 | 人間と AI Agent の責任分担を定める対応文書 |
41
- | 未決事項 | 境界、起動条件、正本、判断者が未確定な論点と、影響・決定時期 |
24
+ | 項目 | 集める情報 | 取り出し元 |
25
+ | ------------------ | -------------------------------------------------------------- | ---------------------------- |
26
+ | 対象グループと領域 | グループ名、`cdfd-<group>` のスラッグ、属する全領域の ID・名称 | 全体概要 |
27
+ | グループの入出力 | グループ単位の主要入力・主要出力・データストアと区分 | 全体概要 |
28
+ | プロセス候補 | 業務目的・担当・更新する正本・完了条件が異なる処理 | 領域の担当者への聞き取り |
29
+ | 起動条件と非起動 | 起動のきっかけと、起動しないときに正常に終わる経路 | 領域の担当者への聞き取り |
30
+ | 状態を変える処理 | 状態を変えるプロセスと、その状態を扱う STSD の文書 ID | 状態を管理する担当者・文書群 |
31
+ | 主要例外 | 結果または後続の起動を変える分岐と、再開の位置 | 品質確認担当・過去の障害記録 |
32
+ | 他グループとの境界 | 他グループや横断ユースケースへ渡す責務、情報、戻す条件 | 他グループの担当者 |
42
33
 
43
34
  ## 3. 全体の作成手順
44
35
 
45
- 1. 全体概要から一つのプロセスグループと、そこに属する全領域の ID・名称を転記します。
46
- 2. 全体概要のグループ単位の主要入力・主要出力・データストアを、領域ごとの節へ配分します。
47
- 3. 各領域について、役割と内部プロセスの連携を説明し、主要入力・主要出力・データストアを箇条書きにします。
48
- 4. 領域ごとの開始と最終出力から必要な処理をたどり、業務目的または完了条件が変わる箇所でプロセスを分けます。
49
- 5. 各プロセスへ所属領域 ID の枝番を付け、目的、担当、起動条件、必須性を同じ領域の表へ一行ずつ記入します。
50
- 6. 全体概要の「データストア」から、本グループが読み書きする行だけを同じ区分で転記し、参照・更新の別と利用内容を記入します。
51
- 7. 各プロセスの主要入力、主要出力、データストアを個別プロセス主要入出力へ整理します。
52
- 8. 一覧、検索、状態参照、検証など、独立した業務成果を持たない候補を支援先プロセスへ戻します。
53
- 9. 同一グループ内の領域間の受け渡しを特定し、領域ごと、または業務の性質が近いプロセスごとに図の分割単位を決めます。
54
- 10. 領域ごとの表の各行を一つずつプロセスノードへ置き、イベント、外部主体、データストアとラベル付きエッジでつなぎます。
55
- 11. 条件付き・選択プロセスの非起動経路を確認し、どの出力がそろえば各領域とグループが完了するかを図で示します。
56
- 12. 状態を変えるプロセスを抽出し、状態一覧と状態遷移図を統合した STSD を参照表へ記入します。状態一覧や遷移表は CDFD に書きません。
57
- 13. 業務結果または後続起動を変える主要例外を選び、検出条件、扱い、継続・再開条件を表にします。
58
- 14. 他グループの内部処理を委譲表へ移し、委譲先 `cdfd-<group>` または `cdfd-uc-<topic>`、引き渡す情報、戻す条件を記述します。
59
- 15. 領域 ID、プロセス ID、例外 ID、データストア名、参照先 ID を使って、表と図の重複・欠落・名称ゆれを解消します。
36
+ 1. 対象グループの全領域を書き出し、グループの入出力をどの領域が受け取り、どの領域が生み出すかを割り当てる。この割り当てがプロセスを切り出す手がかりになる。
37
+ 2. 領域ごとに、最初の入力から最終出力までをたどり、業務目的または完了条件が変わる箇所でプロセスを分ける。
38
+ 3. 一覧・検索・状態参照・検証など、独自の業務成果がない候補を支援先のプロセスへ戻す。
39
+ 4. 本グループが読み書きするデータストアを全体概要から切り出す。
40
+ 5. 領域間の受け渡しを特定してから図の分割単位を決め、概念データフローを描く。プロセスが固まる前に描くと、図と表の名称がずれる。
41
+ 6. 各プロセスの主要入出力を整理する。
42
+ 7. 状態を変えるプロセスを抽出し、STSD への参照を書く。
43
+ 8. 主要例外とグループ外への委譲を書く。正常の流れが固まってから書くと、停止範囲と再開位置を特定しやすい。
44
+ 9. 最後に目的と適用範囲を書く。境界が決まってから書くと、本文の言い直しにならない。
60
45
 
61
46
  ## 4. 各章の書き方
62
47
 
@@ -64,155 +49,109 @@ Conceptual Data Flow Diagram Process Group Writing Recipe
64
49
 
65
50
  問い:
66
51
 
67
- - この CDFD は全体概要のどのプロセスグループを詳細化しますか。
68
- - 誰が、グループ内部のフロー、領域間の受け渡し、主要例外、委譲境界を判断または利用しますか。
69
- - 上位の業務目的を書き写さず、このグループで得る成果と利用結果を説明できますか。
52
+ - 誰が、グループ内のフロー・受け渡し・例外・委譲を合意または設計に使うか。
53
+ - このグループの図から、どの判断ができるようになるか。
54
+
55
+ コツ:
70
56
 
71
- 「仕入を詳しくする」のような曖昧な表現ではなく、「店主代表が発注から売場補充までの責任境界を承認し、開発担当が領域間の入出力を設計へ使う」のように、対象者と利用結果を結び付けます。
57
+ - 「仕入を詳しくする」で止まったら、「承認する人」と「設計へ使う人」を一人ずつ聞くと、対象者と利用結果が結び付く。
58
+ - 上位の業務目的を書きたくなったら、全体概要への参照に置き換える。
72
59
 
73
60
  ### 4.2. 適用範囲
74
61
 
75
62
  問い:
76
63
 
77
- - 対象グループに属する全領域を含み、別グループの領域を混在させていませんか。
78
- - どのイベントから、どの出力がそろうまでを対象にしますか。
79
- - 対象となる期間、組織、システム境界を説明できますか。
80
- - 補助操作、実装詳細、他グループの責務、横断順序のどこから先を対象外にしますか。
81
- - 人間と AI Agent の責任分担を本文で再定義せず、対応文書を参照していますか。
64
+ - どのイベントから、どの出力がそろうまでを扱うか。
65
+ - 他グループの責務・横断の順序・実装詳細のどこから先を外すか。
66
+
67
+ コツ:
82
68
 
83
- 他グループへの委譲内容は「主要例外とグループ外への委譲」に集約し、本章では指し先だけを示します。対象プロダクトの現在の正本として読める業務語を使い、プロジェクトの実行フェーズ名や一時的な仮称を持ち込みません。
69
+ - 「この出力がそろったら、次は誰の仕事か」と聞くと、終了と対象外が一度に決まる。
70
+ - プロジェクトの実行フェーズ名や一時的な仮称が紛れやすい。対象プロダクトの業務語に置き換える。
84
71
 
85
72
  ### 4.3. プロセス領域
86
73
 
87
74
  問い:
88
75
 
89
- - 全体概要で対象グループに属する領域が、一つも欠けず、一節ずつ登場しますか。
90
- - 各節が、説明文、主要入力・主要出力・データストアの箇条書き、プロセス表の順になっていますか。
91
- - 各領域の箇条書きを合わせると、全体概要のグループ単位の箇条書きを説明できますか。
92
- - 領域 ID と名称は上位と一致し、業務目的・担当・起点イベントを書き写していませんか。
93
- - プロセス ID は所属領域を示す `P-<nn>-<nn>` 形式ですか。
94
- - 各領域に一つ以上の内部プロセスがあり、表の一行が一つの業務目的と完了条件を持ちますか。
95
- - 起動条件はイベント、前段完了、承認、条件値のいずれかで判定できますか。
96
- - 条件付きまたは選択のプロセスを起動しない場合、正常に領域完了へ進めますか。
76
+ - 各プロセスは、一つの業務目的と、yes / no で判定できる完了条件を持つか。
77
+ - 条件付き・選択のプロセスを起動しない場合も、領域を正常に終えられるか。
97
78
 
98
- 最初にグループ単位の入出力を付箋のように並べ、どの領域が受け取り、どの領域が生み出すかを一つずつ割り当てます。次に、領域の役割を 1〜3 文で要約し、箇条書きの後へプロセス表を置きます。処理を分けるか迷う場合は、業務目的、主担当、更新する正本、完了条件を比較します。
79
+ コツ:
99
80
 
100
- ### 4.4. データストア
101
-
102
- 問い:
81
+ - 処理を分けるか迷ったら、業務目的・主担当・更新する正本・完了条件を並べて比べる。どれも同じなら一つにまとめる。
82
+ - 「必要に応じて」と答えが返ってきたら、「何が起きたら始めるか」を聞き直す。
83
+ - 領域の入出力を領域の節に書きたくなるが、入出力は「個別プロセス主要入出力」にまとめる。手順 1 の割り当てはメモに残す。
103
84
 
104
- - 本グループが読み書きするデータストアだけを、全体概要と同じ名称・区分で掲載していますか。
105
- - 各行に参照・更新の別と、本グループでの利用内容がありますか。
106
- - プロセス領域の箇条書きと個別プロセス主要入出力にあるデータストアを過不足なく含んでいますか。
107
- - 各行が概念データフローの同名ノードに対応していますか。
108
-
109
- 全体概要の「データストア」から必要な行を切り出し、マスタ・構成データとトランザクションデータの区分を保ちます。新しい名称や区分が必要なら、先に全体概要を見直します。図を分割して同じノードを再掲する場合も、表の行とノードラベルの名称は変えません。
110
-
111
- ### 4.5. 概念データフロー
85
+ ### 4.4. データストアと個別プロセス主要入出力
112
86
 
113
87
  問い:
114
88
 
115
- - プロセス領域の各表の行が同じ ID と名称を持つ一つのプロセスノードとして登場しますか。
116
- - 同一グループ内の領域間の受け渡しを、起点イベントからグループ完了まで順方向にたどれますか。
117
- - 図を領域ごと、または業務の性質が近い単位へ分けていますか。一図が 15 プロセスを超えていませんか。
118
- - 条件付き・選択プロセスの起動条件と、非起動時の正常経路を区別できますか。
119
- - データストアの名称、区分、色クラスは全体概要と一致していますか。
120
- - 図直後の注記に、全体概要の凡例への参照、使用線種、省略した入出力と理由、別図と共有するノードを示していますか。
121
- - 状態をノードとして並べたり、状態間の遷移を描いたりしていませんか。
89
+ - 各プロセスの入出力は、隣のプロセス・外部主体・データストアとの受け渡しとして説明できるか。
90
+ - 図の同名ノードと、データストアの行が一対一に対応するか。
122
91
 
123
- 図は順序と分岐へ集中させます。他グループは委譲先の代表ノードまたは境界イベントだけを置き、内部処理を展開しません。状態変化が重要な箇所でも、CDFD にはプロセスと起動条件を残し、状態名と遷移条件は STSD へ委ねます。
92
+ コツ:
124
93
 
125
- ### 4.6. 個別プロセス主要入出力
94
+ - 新しい名称や区分が要ると気づいたら、この文書で作らず、先に全体概要の見直しを依頼する。
95
+ - 主要出力の概念名と、保存先のデータストア名を混同しやすい。「何ができたか」と「どこに残すか」を分けて聞く。
126
96
 
127
- 問い:
128
-
129
- - 図を領域単位で分けた場合、同じ領域単位で節と表を設けていますか。
130
- - 各プロセスの主要入力・主要出力は、隣接プロセス、外部主体、データストアとの受け渡しとして説明できますか。
131
- - データストアの名称と区分は「プロセス領域」「データストア」および全体概要と一致していますか。
132
- - 業務目的、担当、起動条件、必須性を「プロセス領域」の表から重複させていませんか。
133
-
134
- 全プロセスをちょうど一度、所属領域または図の分割単位に対応する表へ記載します。主要出力という概念名と、保存先であるデータストア名を別の列に保ちます。
135
-
136
- ### 4.7. 状態遷移の参照
97
+ ### 4.5. 概念データフロー
137
98
 
138
99
  問い:
139
100
 
140
- - 状態を変える全プロセスについて、状態一覧と状態遷移図を統合した STSD を特定できますか。
141
- - CDFD は状態を変えるプロセスと起動条件だけを示し、状態名、状態説明、遷移元・遷移先、遷移条件を再定義していませんか。
142
- - 参照先が未作成の場合、文書 ID をバッククォートで仮置きし、状態内容を CDFD へ代替記載していませんか。
101
+ - 起点イベントからグループの完了まで、領域間の受け渡しを順方向にたどれるか。
102
+ - 他グループのノードを隠しても、本グループの完了を説明できるか。
143
103
 
144
- 対象、状態を変えるプロセス、STSD の三点を一行で結びます。状態を変えるプロセスがない場合も章は残し、その事実と確認根拠を一文で記載して表だけを省略します。
104
+ コツ:
145
105
 
146
- ### 4.8. 主要例外とグループ外への委譲
106
+ - 状態の変化を描きたくなったら、プロセスと起動条件だけを残し、状態名と遷移は STSD へ委ねる。
107
+ - 図を説明する注記は長くなりやすい。省略した入出力と別図と共有するノードだけを書く。
147
108
 
148
- 問い:
109
+ ### 4.6. 状態遷移の参照、主要例外とグループ外への委譲
149
110
 
150
- - 例外 ID は最初に検出する領域の番号を含む `E-<nn>-<nn>` 形式ですか。
151
- - その例外は、成果の採否、正本の確定、後続起動、人間の判断のいずれかを変えますか。
152
- - どの条件で検出し、どのプロセスまで停止し、どこから再開しますか。
153
- - 同一グループ内の領域間受け渡しを委譲扱いにしていませんか。
154
- - 委譲先は他の `cdfd-<group>` または横断順序を扱う `cdfd-uc-<topic>` で、内部処理を書き写していませんか。
111
+ 問い:
155
112
 
156
- 主要例外は件数を増やすより、正常完了できない理由と再開条件を一意にすることを優先します。委譲先が未作成でも安定した文書 ID をバッククォートで示し、作成状況は成果物本文ではなく登録簿で追跡します。
113
+ - その例外は、成果の採否・正本の確定・後続の起動・人間の判断のどれを変えるか。
114
+ - 委譲先の担当者は、引き渡す情報だけで次の行動を始められるか。
157
115
 
158
- ### 4.9. 未決事項(任意)
116
+ コツ:
159
117
 
160
- - 調査で確定できる不足情報は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: とします。
161
- - 未決論点には、影響する領域・プロセス・例外・委譲、決定者、決定時期を添えます。
162
- - 未決事項がない場合は章を省略し、空表や「なし」だけの章を残しません。
118
+ - 例外の件数を増やすより、正常に終われない理由と再開の位置を一つに決める。
119
+ - 同じグループ内の領域間の受け渡しを委譲として書きやすい。委譲は他グループと横断ユースケースへ渡すものだけにする。
120
+ - STSD や委譲先がまだなくても、安定した文書 ID をバッククォートで示す。状態の内容や他グループの処理を代わりに書かない。
163
121
 
164
122
  ## 5. 深掘り手順
165
123
 
166
- 1. 全体概要のグループ入力から順方向にたどり、どの領域が受け取り、どの領域が次へ渡すかを確認します。
167
- 2. グループの最終出力から逆向きにたどり、各領域と各プロセスが必要な理由を確認します。
168
- 3. 各領域について、領域単位の主要入力・主要出力・データストアがグループ単位の箇条書きへ対応するか確認します。
169
- 4. 一覧にだけあるプロセスと図にだけあるノードを列挙し、追加、削除、名称統一のいずれかで解消します。
170
- 5. 条件付き・選択プロセスを一つずつ非起動にし、必須出力が欠ける場合は必須性または起動条件を見直します。
171
- 6. 状態を表す名詞や遷移条件を検索し、CDFD で定義している内容を STSD の参照へ置き換えます。
172
- 7. 各主要例外について、検出前に確定した正本、停止する後続、再開位置を順にたどります。
173
- 8. 他グループのノードを隠しても本グループの完了条件を説明でき、委譲表から次の責任者が行動できるか確認します。
174
- 9. データストア名を全体概要、プロセス領域、データストア、図、個別プロセス主要入出力で機械的に照合します。
124
+ 内容が浅いときは、次の順で対応のない主張を探す。
125
+
126
+ 1. グループの最終出力から逆向きにたどり、どの出力にもつながらないプロセスを外す。
127
+ 2. 条件付き・選択のプロセスを一つずつ止め、必須の出力が欠けるなら必須性か起動条件を見直す。
128
+ 3. 各主要例外について、検出の前に確定した正本と、止める後続をたどり、再開の位置が一つに決まるか確かめる。
129
+ 4. 状態を表す名詞や遷移の条件を本文から探し、CDFD で定義している箇所を STSD への参照に戻す。
175
130
 
176
131
  ## 6. 良い例 / 悪い例
177
132
 
178
- | 観点 | 良い例 | 悪い例 |
179
- | ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------ |
180
- | グループ境界 | 仕入グループの仕入計画と入荷検品を一文書で扱う | 仕入計画だけを一つの CDFD に分割する |
181
- | 領域別入出力 | 補充依頼を仕入計画へ、納品と売場補充を入荷検品へ配分する | グループ単位の入出力を各領域へそのまま複製する |
182
- | プロセス ID | 領域 `P-02` の検品へ `P-02-02` を付ける | 文書内の順番だけで `P-01` を付ける |
183
- | 起動条件 | 仕入先から商品が納品され、対応する発注記録を特定できた | 必要に応じて検品する |
184
- | データストア | 「仕入記録」を全体概要と同じ名称・トランザクション区分で使う | 図だけ「発注 DB」と改名する |
185
- | 図の分割 | 仕入計画と入荷検品を領域単位の二図に分け、受け渡す発注内容を一致させる | 性質の異なる全プロセスを一図に詰め込む |
186
- | 状態遷移 | 検品を状態変更プロセスとして示し、商品状態の定義と遷移は STSD を参照する | 未入荷→検品中→販売可能の遷移表を CDFD に複製する |
187
- | 主要例外 | 発注記録を特定できない場合は入荷記録を確定せず、照合後に受入から再開する | エラーなら適切に対応する |
188
- | 委譲 | 補充判断を `cdfd-inventory`、グループ横断順序を `cdfd-uc-replenishment` へ委譲する | 在庫グループの補充判定手順を仕入 CDFD 内に描く |
133
+ | 観点 | 良い例 | 悪い例 |
134
+ | ------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------ |
135
+ | グループ境界 | 仕入グループの仕入計画と入荷検品を一文書で扱う | 仕入計画だけを一つの CDFD に分割する |
136
+ | 起動条件 | 仕入先から商品が納品され、対応する発注記録を特定できた | 必要に応じて検品する |
137
+ | データストア | 「仕入記録」を全体概要と同じ名称・区分で使う | 図だけ「発注 DB」と改名する |
138
+ | 状態遷移 | 検品を状態を変えるプロセスとして示し、商品状態の定義と遷移は STSD を参照する | 未入荷→検品中→販売可能の遷移表を CDFD に写す |
139
+ | 主要例外 | 発注記録を特定できない場合は入荷記録を確定せず、照合後に受入から再開する | エラーなら適切に対応する |
140
+ | 委譲 | 補充判断を `cdfd-inventory`、グループ横断の順序を `cdfd-uc-replenishment` へ委譲する | 在庫グループの補充判定の手順を仕入 CDFD 内に描く |
189
141
 
190
142
  ## 7. レビュー観点
191
143
 
192
- | 観点 | 確認内容 | 主な確認者 |
193
- | ------------ | ---------------------------------------------------------------------------- | -------------------------- |
194
- | 業務価値 | グループ内の各出力が、上位目的と対象者の利用場面のどちらを支えるか説明できる | 業務分析担当 |
195
- | 領域網羅 | 対象グループの全領域が一度ずつ登場し、各領域に内部プロセスがある | 業務分析担当、品質確認担当 |
196
- | 必須性境界 | 必須・条件付き・選択プロセスの起動条件と非起動時の扱いを承認できる | 店主代表 |
197
- | 設計入力 | 各プロセスの起動条件、入出力、データストア、委譲先を識別できる | 技術メンター |
198
- | 状態責務 | CDFD が状態を定義せず、状態変更プロセスから STSD をたどれる | 技術メンター、品質確認担当 |
199
- | 例外 | 主要例外の検出条件、停止範囲、再開条件が判定できる | 品質確認担当 |
200
- | 用語整合 | 領域、プロセス、イベント、入出力、データストアの名称が上位・表・図で一致する | 業務分析担当、品質確認担当 |
201
- | グループ境界 | 同一グループ内の領域間フローを描き、他グループの内部処理を作り込んでいない | 業務分析担当、アーキテクト |
202
-
203
- 「業務分析担当」「品質確認担当」「技術メンター」「アーキテクト」は、対象プロジェクトのロール定義または対応する責任分担文書で正式な担当へ対応付けます。
144
+ | 観点 | 確認内容 |
145
+ | ---------- | -------------------------------------------------------------------------------- |
146
+ | 業務価値 | グループ内の各出力が、上位の目的と対象者の利用場面のどちらを支えるか説明できるか |
147
+ | 必須性境界 | 店主代表が、条件付き・選択のプロセスを起動しない扱いを承認できるか |
148
+ | 設計入力 | 開発担当が、各プロセスの起動条件・入出力・委譲先を設計へ使えるか |
149
+ | 例外 | 品質確認担当が、例外ごとに止める範囲と再開の位置を判定できるか |
204
150
 
205
151
  ## 8. 仕上げチェック
206
152
 
207
- - 対象者、利用場面、対象グループ、開始・終了、組織・システム境界、対象外を明記した。
208
- - 全体概要の対象グループに属する全領域を一度ずつ掲載し、各領域に一つ以上のプロセスがある。
209
- - 領域単位の主要入力・主要出力・データストアが、全体概要のグループ単位の箇条書きと矛盾しない。
210
- - プロセス ID は所属領域 ID の枝番で、一覧・図・入出力表に同じ ID と名称を使用した。
211
- - 「データストア」が全体概要の部分集合で、名称・区分・読み書きの別が各表と図に一致する。
212
- - 図を領域または業務の性質ごとに分け、図直後に凡例の参照、線種、省略事項、共有ノードを記載した。
213
- - 条件付き・選択プロセスの起動条件と非起動時の正常な扱いを説明できる。
214
- - 状態を変えるプロセスから STSD を参照し、状態定義・遷移表・状態遷移図を CDFD に複製していない。
215
- - 主要例外に検出条件、扱い、継続・再開条件がある。
216
- - グループ外委譲の委譲先、引き渡す情報、戻す条件があり、同一グループ内の領域間受け渡しを委譲扱いにしていない。
217
- - 未決事項は共通ラベルで確定情報と区別し、ない場合は章を設けていない。
218
- - 個人情報、秘密情報、非公開の組織情報など、公開範囲に不適切な内容を含めていない。
153
+ - 各プロセスが、グループの最終出力のどれかにつながる。
154
+ - 条件付き・選択のプロセスを起動しなくても、領域を正常に終えられる。
155
+ - 状態の定義と遷移を CDFD で書かず、状態を変えるプロセスから STSD をたどれる。
156
+ - 他グループの内部処理を描かず、委譲先が引き渡す情報で次の行動を始められる。
157
+ - 個人名、秘密情報、非公開の組織情報を含めていない。
@@ -11,174 +11,155 @@ specdojo:
11
11
 
12
12
  Conceptual Data Flow Diagram Use Case Writing Recipe
13
13
 
14
- 全体概要で選定した一つのユースケースまたは系統について、開始から終了までの流れと、受け渡す情報・物を具体化するための作成手順です。参加単位と詳細化の境界は rulebook の「描き方の選択」に従います。
14
+ 全体概要で選んだ一つのユースケースまたは系統について、開始から終了までの流れと受け渡す情報・物を、読み手が図から追える内容に仕上げるための作り方を示す。
15
15
 
16
16
  ## 1. このレシピの使い方
17
17
 
18
- - 全体概要からケース ID、業務目的、参加単位、開始・終了を抜き出します。
19
- - 目的、適用範囲、役割表、データストアの部分集合を作り、上から下へ進む図で受け渡しを示します。
20
- - 最後に表と図の名称・順序、全体概要との境界、有効な参照先を確認します。対象範囲の例外時の戻りを漏れなく図にし、線が多ければ図を分けます。
21
-
22
- ケース ID、参加単位の名称・領域 ID、データストア名を軸に、範囲・表・図を対応させます。引き渡し ID を追加せず、情報・物の名前を線のラベルにします。
18
+ - 全体概要のケース ID と業務目的(Why)を引き継ぎ、開始・終了と参加単位の範囲(What)を決め、参加単位の責務と受け渡しの線(How)で流れを示す。ケース ID・領域 ID・データストア名を表と図で同じにして、流れを全体概要までたどれるようにする(Trace)。
23
19
 
24
20
  ## 2. 作成前に集める情報
25
21
 
26
- | 項目 | 集める情報 |
27
- | ------------ | ---------------------------------------------------------------------------- |
28
- | 対象ケース | 全体概要にあるケース ID、業務名、業務目的 |
29
- | 描く単位 | rulebook の「描き方の選択」で決める参加単位と詳細化の境界 |
30
- | 共通の領域 | 複数の系統が共通して通る領域と、内部を描く 1 か所の正本・その参照先 |
31
- | 開始と終了 | 開始する出来事と、最後に利用可能になる成果 |
32
- | 役割と順序 | 全体概要と同じグループ・区分、領域 ID、正常系の通過順、各参加単位の責務 |
33
- | 受け渡し | 隣接する参加単位やデータストアの間で渡す情報・物 |
34
- | データストア | 全体概要にある名称、マスタ・構成/トランザクションの区分、参照・更新する内容 |
35
- | 共通の約束 | 全体概要の責任分担、凡例(絵文字の有無・割り当て)、Orchestrator の指示の図 |
36
- | 参照先 | 有効な全体概要、必要な詳細文書と STSD。status が `deprecated` の文書は除く |
37
- | 例外の戻り | 対象範囲のすべての戻り、補完・再判断を担う参加単位、返す不足情報や差異 |
38
- | 未決事項 | 境界、名称、責務、判断者が未確定な論点、影響、決定者、決定時期 |
22
+ | 項目 | 集める情報 | 取り出し元 |
23
+ | ---------------- | -------------------------------------------------------------------- | -------------------------------- |
24
+ | 対象ケース | ケース ID、業務名、業務目的、採用された描き方(横断・系統) | 全体概要の「詳細 CDFD 一覧」 |
25
+ | 開始と終了 | 開始する出来事の原文と、最後に利用できるようになる成果 | 全体概要の「プロセス領域」 |
26
+ | 参加単位と順序 | グループ・区分、領域 ID、正常系の通過順、条件付きでだけ通る領域 | 全体概要、各領域の担当者への確認 |
27
+ | 共用する領域 | 複数の系統が通る領域と、その内部を描く文書 | 全体概要、領域の詳細文書 |
28
+ | 受け渡し | 隣り合う参加単位・データストアの間で渡す情報・物の名前 | 各領域の担当者への確認 |
29
+ | データストア | このケースで参照・更新するものと、その名称・区分 | 全体概要の「データストア」 |
30
+ | 例外時の戻り | 不足や差異を返す先、返す情報、補完後に再提示する情報 | 各領域の担当者への確認、過去事例 |
31
+ | 状態・調整の正本 | 状態を定める STSD、Orchestrator の指示の図、凡例(絵文字の割り当て) | 全体概要、STSD |
39
32
 
40
33
  ## 3. 全体の作成手順
41
34
 
42
- 1. 全体概要の「詳細 CDFD 一覧」からケースを選び、rulebook の「描き方の選択」で参加単位を決めます。共通して通る領域の内部を描く正本を全体概要またはその領域の詳細文書の 1 か所に定め、ほかの詳細では 1 ノードと受け渡しの線だけにします。
43
- 2. その業務が何のためにあるかを、開始からどの成果までを成立させるかという 1〜2 文で書きます。読み手の承認・設計・確認作業は含めません。
44
- 3. 対象と対象外を 1 行ずつ書き、共通原則は全体概要を参照します。`based_on` と本文の参照先が有効な文書であることを確認します。
45
- 4. 全体概要と同じグループ・区分ごとに節を設け、正常系の順序と責務を役割表だけで示します。共通して通る領域の内部の正本を「参照先」に示します。PDCA が必要なら独立した任意の列を追加します。
46
- 5. 全体概要から、このケースで参照・更新するデータストアを同じ名称・区分で切り出し、関連する参加単位と利用内容を書きます。
47
- 6. 開始イベント、参加単位、終了の出来事を上から下へ並べ、渡す情報・物の名前を線のラベルにします。D2 は `direction: down` とし、引き渡し条件のイベントや Orchestrator は置きません。
48
- 7. データストアを同名ノードで加え、表の各行と図を対応させます。イベントは一ノード一出来事の短い文とし、長ければ原文を保って改行します。
49
- 8. 図に業務の言葉で題を付け、読み取れることを 1 文で説明します。凡例は全体概要への短い参照にし、ノードの絵文字の有無・割り当てを文書内の全図と系統間でそろえます。
50
- 9. 対象範囲に例外時の戻りがある場合は、「概念データフロー」に図を追加し、返す情報を重要度で絞らず線にします。戻りの線は上側のノードを左辺にした `a <- b` で書きます。共通して通る領域の内部はその正本へ委ね、外へ返す情報は描きます。
51
- 10. rulebook の分割の目安(一図の線が 15 本超、または一ノードの入出力が合計 10 本以上)と読みやすさを確認し、正常系は連続する段、戻りは戻り先や段ごとに図を分けます。必要な線を削らず、同じ名称・領域 ID の共有ノードでつなぎます。
52
- 11. ケース ID、名称、領域 ID で範囲・表・図を突き合わせ、内部処理や状態定義・遷移の重複を除きます。
35
+ 1. 概念データフローの正常系の図を最初に描く。順序の正本は図なので、表から書くと順序欄と図がずれる。
36
+ 2. 図の参加単位を 1 行ずつプロセス領域の役割表へ移し、順序欄を図から転記する。
37
+ 3. 図に出たデータストアだけをデータストアの表へ移す。
38
+ 4. 例外時の戻りを集め、戻りの図を描く。
39
+ 5. 目的と適用範囲を書く。図が決まってからだと、開始と終了を図と同じ言葉で書ける。
40
+ 6. 未決事項があれば最後の章にまとめ、最後に H1 直下の導入文を書く。
53
41
 
54
42
  ## 4. 各章の書き方
55
43
 
56
- ### 4.1. 目的
44
+ ### 4.1. 導入文と目的
57
45
 
58
46
  問い:
59
47
 
60
- - そのユースケースまたは系統は何のためにありますか。
61
- - どの出来事から、どの成果または判断までを成立させますか。
48
+ - どのケース ID と業務名の流れを示す文書か。
49
+ - その業務がないと、誰が何に困るのか。
50
+
51
+ コツ:
62
52
 
63
- 「欠品した商品を補充し、売場で販売できるようにする」のように業務の目的を 1〜2 文で書きます。BA・QE・承認者などの読み手の役割は書きません。
53
+ - 導入文はケース ID と業務名を全体概要から写し、言い換えない。ケースを特定しない導入文は、どの選定を詳細化したか分からなくなる。
54
+ - 目的に「BA が承認する」「QE が検証に使う」などの読み手の作業を書きそうになったら、業務が成り立たせる成果に言い直す。
64
55
 
65
56
  ### 4.2. 適用範囲
66
57
 
67
58
  問い:
68
59
 
69
- - ケース ID、参加単位、開始・終了は全体概要と一致していますか。
70
- - 対象と対象外がそれぞれ 1 行で分かりますか。
71
- - 共通原則と調整役の指示を全体概要に委ねていますか。
72
- - 本文と `based_on` に `deprecated` の文書が残っていませんか。
60
+ - 開始の出来事と、終了時に使えるようになる成果は何か。
61
+ - 内部の手順や状態遷移のうち、どれを別の文書へ委ねるか。
73
62
 
74
- 全体概要の選定を変える必要があれば先に全体概要を見直します。未作成の参照先は ID をインラインコードで仮置きします。
63
+ コツ:
64
+
65
+ - 全体概要の選定と食い違ったら、本書で範囲を変えず、先に全体概要を直す。
66
+ - 共通の責任分担や状態の定義は写さず、正本への参照に置き換える。
75
67
 
76
68
  ### 4.3. プロセス領域
77
69
 
78
70
  問い:
79
71
 
80
- - rulebook の「描き方の選択」に従い、全体概要と同じまとまりの節にしていますか。
81
- - 各節は役割表だけですか。主要入力・主要出力・データストアの箇条書きが残っていませんか。
82
- - 順序、プロセスグループ・区分、含む領域、横断上の役割、参照先を示していますか。
83
- - 共通して通る領域の内部を描く正本が 1 か所に定まり、ほかの詳細では 1 ノードと受け渡しの線だけにしていますか。内部の正本を「参照先」に示していますか。
84
- - PDCA を示す場合は独立した任意の列にし、全体概要の区分と混同していませんか。
72
+ - 各参加単位はこのケースで何を引き受けるか。
73
+ - 常に通る領域と、計画連携や補完のときだけ通る領域はどれか。
74
+
75
+ コツ:
85
76
 
86
- 表の一行を図の一つのプロセスノードに対応させます。全体概要を名称と領域の正本とし、入力・出力の正本は図にします。
77
+ - 条件付きで通る領域は、順序欄を「計画連携時」「補完時」などの参加場面にすると、主経路と混ざらない。
78
+ - 共用する領域の内部を描きたくなったら、内部を描く文書を参照先に書き、本書では 1 行に留める。
79
+ - PDCA の段階を区分の代わりに書きやすい。区分は全体概要の名前を使う。
87
80
 
88
81
  ### 4.4. データストア
89
82
 
90
83
  問い:
91
84
 
92
- - 対象ケースで参照・更新する正本だけですか。
93
- - 名称と区分は全体概要と一致していますか。
94
- - 関連する参加単位を名称・領域 ID で示し、利用内容を説明していますか。
95
- - 表の各行と図の同名ノードが対応していますか。
85
+ - このケースで参照・更新するのはどれか。
86
+ - 各データストアを、どの参加単位が何のために使うか。
96
87
 
97
- マスタ・構成データとトランザクションデータに分け、該当する行がない区分は節ごと省略します。
88
+ コツ:
89
+
90
+ - 全体概要の一覧を丸ごと写しやすい。図に線が引かれないものは外す。
91
+ - 保存先やカラムを書き始めたら、用途の 1 文に戻す。
98
92
 
99
93
  ### 4.5. 概念データフロー
100
94
 
101
95
  問い:
102
96
 
103
- - 正常系の参加単位を開始から終了まで上から下へ追えますか。
104
- - 一つのイベントに一つの出来事だけを書き、短い文または改行で読めますか。入口の文言は選んだ方式の規定に合っていますか。
105
- - 渡す情報・物を線の名詞ラベルから読み取れますか。条件のイベントや引き渡し ID が残っていませんか。
106
- - Orchestrator と調整要求・応答を図から外していますか。
107
- - 図の題は業務の言葉ですか。説明は読み取れることの 1 文ですか。
108
- - 絵文字の有無・割り当ては全体概要の凡例に合い、文書内の全図とほかの系統でそろっていますか。
109
- - 線数・集中の目安や読みにくさに応じて図を分け、共有ノードから接続を追えますか。
97
+ - 前段の成果は、どの情報・物として次段へ渡るか。
98
+ - 図の題と説明 1 文で、何を読み取ってほしいか。
99
+
100
+ コツ:
110
101
 
111
- D2 は `direction: down` とします。必要な承認は「承認済みの補充依頼」など成果の性質として線に表し、条件の判定ノードは置きません。凡例は全体概要を参照します。
102
+ - 線のラベルを担当者に聞くときは「次の人は何を受け取れば始められるか」と聞く。名詞で答えが返り、条件のイベントを置かずに済む。
103
+ - 承認が要る受け渡しは「承認済みの補充依頼」のように、渡す物の性質で表す。
104
+ - 線が込み入ったら、線を削らず業務の段ごとに図を分け、共有ノードで接続を示す。
112
105
 
113
106
  ### 4.6. 例外時の戻りの図
114
107
 
115
108
  問い:
116
109
 
117
- - 対象範囲の戻りをすべて集め、重要度や線の多さを理由に除いていませんか。
118
- - 戻す不足情報・差異と、補完・再判断を担う参加単位が線から分かりますか。
119
- - 再提示も「修正・承認済みの補充依頼」などの情報として描いていますか。
120
- - 戻り先や段ごとに図を分けても、必要な戻りと再提示が共有ノードでつながっていますか。
110
+ - どの不足や差異を、どの参加単位へ返すか。
111
+ - 補完した後に、何を再提示するか。
112
+
113
+ コツ:
121
114
 
122
- 戻りがある場合は「概念データフロー」の節に漏れなく描き、通常の図と名称・領域 ID をそろえます。戻りがない場合だけ図を省略します。共通して通る領域の内部は 1 か所の正本に委ねます。「引き渡し」「例外時の戻り先」の章や、戻す条件・再開条件の表は作りません。
115
+ - 担当者は重要な戻りだけを挙げやすい。「差し戻した事例をすべて」と聞いて集める。
116
+ - 共用する領域の内部の戻りは内部を描く文書に任せ、外へ返す情報だけを描く。
123
117
 
124
118
  ### 4.7. 未決事項(任意)
125
119
 
126
- - 調査で確定できる不足情報は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: とします。
127
- - 未決論点には影響するケース・参加単位、決定者、決定時期を添えます。
128
- - ない場合は章を省略し、空表や「なし」だけの章を残しません。
120
+ 問い:
121
+
122
+ - 境界、名称、責務、判断者のうち決まっていないものはどれか。
123
+ - その論点はどのケース・参加単位に影響するか。
124
+
125
+ コツ:
126
+
127
+ - 本文の `_UNDECIDED_` と 1 対 1 で対応させる。決着した論点は本文へ反映して消す。
129
128
 
130
129
  ## 5. 深掘り手順
131
130
 
132
- 1. 最後の成果から逆にたどり、各参加単位と受け渡しが業務目的に必要か確認します。
133
- 2. 開始イベントから順にたどり、前段の成果が次段へ情報・物として渡っているか確認します。
134
- 3. 全体概要の区分と領域 ID を突き合わせ、PDCA の値で区分を置き換えた行を直します。
135
- 4. データストアを一つずつ確かめ、このケースの情報・物の受け渡しに不要なものを除きます。
136
- 5. 状態定義・遷移や内部プロセスが残っていれば、責任を持つ有効な文書の参照へ移します。
137
- 6. 収集した戻りと図を突き合わせ、すべての不足情報や差異が補完責任のある参加単位へ届くか確認します。共通して通る領域の内部は正本の参照で追います。
138
- 7. D2 を `d2 --layout elk` で SVG に出力し、上下の順序、ノードとラベルの大きさを確認します。読みづらい場合はイベントの改行や図の分割を見直します。
131
+ 内容が浅いときは、次の順で対応のない主張を探す。
132
+
133
+ 1. 終了の成果から逆にたどり、業務目的に寄与しない参加単位や線を外す。
134
+ 2. 役割表の各行が図のどのノードに当たるかを確かめ、図にない行を外す。
135
+ 3. データストアごとに、読み書きする線があるかを確かめる。
136
+ 4. 状態の定義・遷移や内部の処理が残っていれば、正本の参照に置き換える。
137
+ 5. 集めた戻りごとに、返す先の参加単位と再提示の線があるかを確かめる。
139
138
 
140
139
  ## 6. 良い例 / 悪い例
141
140
 
142
- | 観点 | 良い例 | 悪い例 |
143
- | ----------- | ------------------------------------------------- | -------------------------------------------------- |
144
- | 目的 | 欠品した商品を補充し、売場で販売できるようにする | BA が承認し、QE が検証へ使う |
145
- | 区分と PDCA | 区分は調達、PDCA は別列で Do | 区分を Do に置き換える |
146
- | 共通の領域 | 内部の正本を一つ決め、ほかでは 1 ノードで受け渡す | 各系統で同じ領域の内部を詳しく描く |
147
- | 絵文字 | 全体概要の凡例に合わせて全図・系統でそろえる | 正常系だけに付け、戻りや別系統では外す |
148
- | 渡す情報 | 在庫から仕入へ「承認済みの補充依頼」を直接つなぐ | 途中に「H-01 受理できる」というイベントを置く |
149
- | イベント | 「在庫が補充基準を下回った」を必要なら改行 | 複数の出来事を一つの長い六角形に詰める |
150
- | 戻り | 戻りをすべて描き、線が多ければ戻り先ごとに分ける | 重要な戻りだけを残し、ほかを図から削る |
151
- | 参照先 | 有効な全体概要を参照する | `deprecated` のグループ別 CDFD を参照する |
152
- | 調整役 | Orchestrator の指示は全体概要の図に任せる | 詳細の図に Orchestrator と各段階への要求を再掲する |
153
- | 状態責務 | 商品状態は STSD を参照する | 未発注から販売可能への状態遷移を本書で定義する |
141
+ | 観点 | 良い例 | 悪い例 |
142
+ | ---------- | ----------------------------------------------------- | --------------------------------------------- |
143
+ | 導入文 | 「ケース `C-02`『欠品から補充まで』の流れを示す」 | 「補充業務の流れを示す」とだけ書く |
144
+ | 区分 | 区分は全体概要の「調達」とし、PDCA は別の列で Do | 区分の欄に Do と書く |
145
+ | 共用領域 | 内部を描く文書を一つ決め、ほかでは 1 ノードで受け渡す | 系統ごとに同じ領域の内部を描き直す |
146
+ | 渡す情報 | 在庫から仕入へ「承認済みの補充依頼」を直接つなぐ | 途中に「H-01 受理できる」というイベントを置く |
147
+ | イベント | 「在庫が補充基準を下回った」を必要なら改行する | 複数の出来事を一つのノードに詰める |
148
+ | 戻り | すべての戻りを描き、多ければ戻り先ごとに図を分ける | 重要な戻りだけを残し、ほかを削る |
149
+ | 状態の責務 | 商品の状態は STSD を参照する | 未発注から販売可能までの遷移を本書で定める |
154
150
 
155
151
  ## 7. レビュー観点
156
152
 
157
- | 観点 | 確認内容 | 主な確認者 |
158
- | ---------- | ---------------------------------------------------------- | -------------------------- |
159
- | 業務価値 | 目的が業務の存在理由・成果を示し、終了時の成果と一致する | 業務分析担当、業務責任者 |
160
- | 範囲と粒度 | rulebook の「描き方の選択」と全体概要に合う | 業務分析担当 |
161
- | 表と図 | 順序・名称・領域 ID が対応し、受け渡しを線から読み取れる | 品質確認担当 |
162
- | データ整合 | データストアの名称・区分と凡例が全体概要に合う | 技術メンター、品質確認担当 |
163
- | 戻り | 対象範囲の戻りに漏れがなく、分割後も戻す情報と責任が分かる | 業務責任者、品質確認担当 |
164
- | 共通の領域 | 内部の正本が 1 か所に定まり、ほかでは 1 ノードで受け渡す | アーキテクト |
165
- | 絵文字 | 全体概要の凡例に合わせ、文書内と系統間で有無をそろえる | 品質確認担当 |
166
- | 正本の境界 | 調整・状態遷移・内部処理を重複させず、有効な文書を参照する | アーキテクト |
167
-
168
- 確認者の呼称は、対象プロジェクトのロール定義または責任分担文書で正式な担当へ対応付けます。
153
+ | 観点 | 確認内容 |
154
+ | -------------- | ---------------------------------------------------------------- |
155
+ | 業務価値 | 終了時の成果が目的に応え、目的に寄与しない参加単位や線がないか |
156
+ | 表と図の対応 | 役割表の順序と名称が図と一致し、条件付きの領域が主経路と分かるか |
157
+ | 受け渡しの具体 | 各線のラベルから、次の参加単位が受け取る情報・物を特定できるか |
158
+ | 戻りの網羅 | 集めた戻りがすべて、返す先と再提示の線とともに描かれているか |
159
+ | 正本の境界 | 共用領域の内部・状態遷移・Orchestrator の調整を写していないか |
169
160
 
170
161
  ## 8. 仕上げチェック
171
162
 
172
- - 全体概要のケース ID、業務名、目的、名称・領域 ID を引き継いだ。
173
- - 目的は業務のための 1〜2 文、適用範囲は対象と対象外が 1 行ずつになっている。
174
- - 各節が役割表だけで、区分と任意の PDCA 列を分けた。
175
- - 共通して通る領域の内部は 1 か所だけで描き、ほかの詳細では 1 ノードと受け渡しの線にして正本を参照した。
176
- - 表と図の参加単位、データストアが対応し、開始から終了まで縦に追える。
177
- - イベントは一ノード一出来事で短く、入口の原文を保っている。
178
- - 受け渡しは線のラベルにあり、引き渡し ID・条件イベント・旧来の引き渡し/戻り先の章がない。
179
- - Orchestrator を詳細の図に置かず、全体概要の指示の図へ委ねた。
180
- - 図の題は業務の言葉、説明は読み取れることの 1 文で、凡例は全体概要を参照している。
181
- - 絵文字の有無・割り当てが全体概要の凡例に合い、文書内の全図と系統間でそろっている。
182
- - 対象範囲の例外時の戻りを省略せず描き、線数・集中の目安や読みやすさに応じて戻り先・段ごとに図を分け、共有ノードで追える。条件表や内部の再試行手順を置いていない。
183
- - `based_on` と本文に `deprecated` の参照先がなく、状態定義・遷移を複製していない。
184
- - 未決事項がない場合は章を省略し、公開範囲に不適切な情報を含めていない。
163
+ - ケース ID、領域 ID、データストア名が、導入文・表・図・全体概要で同じ表記になっている。
164
+ - 図を分けた場合も、共有ノードをたどって開始から終了まで追える。
165
+ - 絵文字の有無と割り当てが、文書内の全図とほかの系統でそろっている。