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
@@ -19,158 +19,130 @@ specdojo:
19
19
 
20
20
  Conceptual Data Flow Diagram Process Group Documentation Rulebook
21
21
 
22
- 全体概要で定めた一つのプロセスグループを引き継ぎ、グループに属する全領域の内部プロセス、領域間の受け渡し、主要例外、グループ外への委譲を、表と概念データフロー図(Mermaid または D2)で合意可能にするためのルールです。状態を変えるプロセスと起動条件は示しますが、状態の定義と遷移は STSD を参照します。
22
+ 全体概要の一つのプロセスグループについて、全領域の内部プロセス、領域間の受け渡し、主要例外、グループ外委譲を、表と概念データフロー図(Mermaid または D2)で合意するためのルールです。
23
23
 
24
24
  ## 1. 全体方針
25
25
 
26
- - 一文書は、全体概要で定めた一つのプロセスグループと、そのグループに属する一つ以上のプロセス領域を詳細化します。各領域はちょうど一つのプロセスグループ別 CDFD に属します。単一領域のグループも、その領域だけを含む一つのプロセスグループ別 CDFD として扱います。
27
- - 「プロセス領域」をプロセスの業務目的・担当・起動条件・完了条件・必須性の表の正本とし、主要入力・主要出力の箇条書きは設けず、受け渡しは概念データフロー図を正本とします。「データストア」を本グループが読み書きする上位一覧の部分集合、「個別プロセス主要入出力」をプロセス単位の入出力の正本とします。
28
- - 一つのプロセスノードは、一つの業務目的と完了条件を持つ処理だけを表します。コマンドや画面の一操作を無条件に一プロセスへ分割せず、複数の判断・更新・生成を一ノードに詰め込みません。
29
- - 同一グループ内の領域間の受け渡しは内部フローとして図に描きます。他グループの内部処理は展開せず、プロセスグループ別 CDFD またはユースケース別 CDFD へ委譲します。
30
- - 状態を変えるプロセスとその起点イベントは記載しますが、状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とし、本書では参照関係だけを示します。
31
- - 正常系だけでなく、業務結果を変える主要例外を、検出条件、扱い、継続・再開条件で定義します。ログや内部エラーの全列挙は行いません。
32
- - 目的は 1〜2 文、適用範囲は対象と対象外を 1 行ずつとし、人間と AI Agent の責任分担などの共通原則は全体概要を参照します。凡例は全体概要の凡例を参照し、本書で再定義しません。
26
+ - 一文書で一つのプロセスグループに属する全領域を詳細化し、各領域をちょうど一文書に所属させます。単一領域のグループも同じ構成とします。
27
+ - プロセスの業務目的・担当・起動条件・完了条件・必須性は「プロセス領域」、受け渡しは図、プロセス単位の入出力は「個別プロセス主要入出力」を正本とします。
28
+ - 一ノードは一つの業務目的と完了条件を持つ処理とします。一操作ごとの機械的な分割や、複数の判断・更新・生成の詰め込みを避けます。
29
+ - 同一グループ内の領域間は内部フローとして描き、他グループの内部処理と横断順序は対応する CDFD へ委譲します。
30
+ - 状態を変えるプロセスと起点イベントだけを示し、状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。
31
+ - 業務結果を変える主要例外を扱い、ログや内部エラーの全列挙は行いません。
32
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
33
33
 
34
34
  ## 2. 位置づけと用語定義
35
35
 
36
- | 用語 | 定義 |
37
- | ---------------------- | ------------------------------------------------------------------------------------------------------------ |
38
- | 全体概要 | プロセス領域、プロセスグループ、データストア、グループ間の受け渡しを定める最上位 CDFD |
39
- | プロセスグループ | 業務の性質が近いプロセス領域をまとめた集合。本 rulebook が扱う一文書の単位 |
40
- | プロセス領域 | 全体概要で ID、名称、業務目的、担当、起点イベントが定義され、一つのプロセスグループに属する責務のまとまり |
41
- | プロセス | 起動条件と入力を受け、業務上意味のある出力または状態変化を一つ生む処理単位 |
42
- | 起点イベント | 対象領域または内部プロセスを開始させる、発生を判定できる出来事 |
43
- | データストア | 全体概要で名称と区分が定義された、情報の正本または継続的な保管先 |
44
- | 主要例外 | 正常系と異なる業務判断、生成結果、引き渡し可否を生じさせ、再開条件の合意が必要な分岐 |
45
- | グループ外委譲 | 他グループの内部処理を作り込まず、委譲先 CDFD、引き渡す情報、戻す条件によって責任境界を示すこと |
46
- | 状態遷移の参照 | 状態を変えるプロセスから、状態一覧と状態遷移図を統合した STSD をたどる対応。状態名や遷移表そのものは含めない |
47
- | 個別プロセス主要入出力 | プロセスごとの主要入力・主要出力・データストアを示す章。「プロセス領域」の表と項目を重複させない |
48
-
49
- 全体概要は領域とグループの分割、およびグループとデータストアの間の受け渡しを定義します。プロセスグループ別 CDFD は一グループの内部を詳細化し、ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件だけを定義します。
36
+ 全体概要は領域・グループの分割とグループ・データストア間の受け渡し、本書は一グループの内部、ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件を定義します。
37
+
38
+ | 用語 | 区別する意味 |
39
+ | ---------------- | ----------------------------------------------------------------------- |
40
+ | プロセスグループ | 業務の性質が近い領域の集合。一文書の単位 |
41
+ | プロセス領域 | 全体概要で ID・名称・業務目的・担当・起点イベントを定めた責務のまとまり |
42
+ | プロセス | 起動条件と入力を受け、一つの業務上の出力または状態変化を生む処理単位 |
50
43
 
51
44
  ## 3. ファイル命名・ID規則
52
45
 
53
- - 対象プロダクトの業務仕様配下にあるデータフローディレクトリへ配置します。
54
- - ファイル名と成果物 ID は `cdfd-<group>` とし、ファイル名だけ `.md` を付けます。`<group>` は全体概要のプロセスグループ名を表す英小文字・数字・ハイフンのスラッグです。
55
- - product 成果物の ID にプロジェクト ID や authority は付けません。例: ファイル名 `cdfd-sales.md`、ID `cdfd-sales`。
56
- - `cdfd-overview` は全体概要、`cdfd-uc-<topic>` はユースケース別 CDFD の ID であり、本 rulebook の対象外です。
57
- - プロセス ID は、全体概要の領域 ID `P-<nn>` に二桁の枝番を付けた `P-<nn>-<nn>` 形式とします。例: 領域 `P-03` の二番目のプロセスは `P-03-02`。文書内一意の `P-01` 形式は使用しません。
58
- - 主要例外 ID は、対象領域の番号に二桁の枝番を付けた `E-<nn>-<nn>` 形式とします。複数領域にまたがる例外は、最初に検出するプロセスの領域番号を使います。
59
- - プロセス ID と例外 ID は名称変更後も同じ対象を示す限り維持し、一覧、図、入出力表、例外表で同じ値を使います。
46
+ - 対象プロダクトの業務仕様のデータフローディレクトリに `cdfd-<group>.md` を置きます。`<group>` は全体概要のグループ名を表す英小文字・数字・ハイフンのスラッグです。
47
+ - product 成果物 ID は修飾なしの `cdfd-<group>`(例: `cdfd-sales`)とします。全体概要の `cdfd-overview` とユースケース別の `cdfd-uc-<topic>` は対象外です。
48
+ - プロセス ID は領域 ID `P-<nn>` に二桁の枝番を付けた `P-<nn>-<nn>`(例: `P-03-02`)とし、文書内一意の `P-01` 形式は使いません。
49
+ - 例外 ID は `E-<nn>-<nn>` とし、複数領域にまたがる場合は最初に検出する領域の番号を使います。
50
+ - 同じプロセス・例外の ID は名称変更後も維持し、表・図で一致させます。
60
51
 
61
52
  ## 4. 推奨 Frontmatter 項目
62
53
 
63
- | 項目 | 説明 | 必須 |
64
- | ---------- | ----------------------------------------------------- | ---- |
65
- | id | `cdfd-<group>` | ○ |
66
- | type | `flow` | ○ |
67
- | status | `draft` / `ready` / `deprecated` | ○ |
68
- | rulebook | `specdojo:cdfd-rulebook` | ○ |
69
- | based_on | 全体概要など、依存関係上許可された直接の内容根拠の ID | 任意 |
70
- | supersedes | 置き換える旧 CDFD の ID | 任意 |
54
+ 共通の必須項目・許可キー・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従います。
71
55
 
72
- - product 成果物の `id` はプロジェクト修飾なしとし、`based_on` に全体概要を記載する場合も product 成果物 ID を使用します。
73
- - `based_on` は成果物カタログの `depends_on` の推移閉包に含まれる直接の内容根拠だけを列挙します。
74
- - 文書のタイトルと利用目的は本文 H1 と「目的」で示し、未定義の Frontmatter 項目を追加しません。
75
- - 作成途中の `status` は `draft` とします。`ready` へ昇格できるのは、「完成判定」の全項目を満たし、対象プロジェクトのロール定義または責任分担文書で特定した承認者による業務境界・主要例外・委譲境界の承認記録を、登録簿の決定記録またはレビュー結果から特定できる場合です。
56
+ - `id` は「ファイル命名・ID規則」、`type` は `flow`、`rulebook` は `specdojo:cdfd-rulebook` とします。
57
+ - `based_on` は、全体概要など実際に直接の根拠とした文書の ID とし、成果物カタログの `depends_on` の推移閉包内に限ります。product 文書は参照先も修飾なしの ID を使います。
58
+ - タイトルと利用目的は H1 と「目的」に記載します。
76
59
 
77
60
  ## 5. 本文要件
78
61
 
79
- | 番号 | 見出し | 必須 | 内容 |
80
- | ---- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------- |
81
- | 1 | 目的 | ○ | 対象者と利用場面(1〜2 文) |
82
- | 2 | 適用範囲 | ○ | 対象と対象外を 1 行ずつ。共通の原則(人間と AI Agent の責任分担など)は全体概要を参照 |
83
- | 3 | プロセス領域 | ○ | 領域ごとの節。各節はプロセスの表のみ(主要入力・主要出力・データストアの箇条書きは不要) |
84
- | 4 | データストア | ○ | 全体概要と同じ名称・区分を持つ、本グループが読み書きするデータストアの部分集合と読み書きの別 |
85
- | 5 | 概念データフロー | ○ | 一ノード一プロセスの図(Mermaid または D2)。図の説明は 1〜2 文。凡例は全体概要を参照 |
86
- | 6 | 個別プロセス主要入出力 | ○ | プロセスごとの主要入力・主要出力・データストア。図を分割した場合は同じ単位で節を設ける |
87
- | 7 | 状態遷移の参照 | ○ | 状態を変えるプロセスと STSD の対応。該当プロセスがない場合はその事実と確認根拠 |
88
- | 8 | 主要例外とグループ外への委譲 | ○ | 主要例外の検出・停止範囲・扱い・再開、および他の CDFD への委譲。各区分が 0 件でも該当なしの事実と確認根拠を記録する |
89
- | 9 | 未決事項 | 任意 | 未決論点、影響、決定者、決定時期 |
62
+ 章の順序・骨組みは Frontmatter で宣言した template を使い、各章を次の条件で受け入れます。
63
+
64
+ | 見出し | 必須 | 内容 |
65
+ | ---------------------------- | ---- | --------------------------------------------------------------------------- |
66
+ | 目的 | ○ | 対象者と利用場面を 1〜2 文で示す |
67
+ | 適用範囲 | ○ | 対象と対象外を各 1 行で示す |
68
+ | プロセス領域 | ○ | 領域ごとにプロセス表だけを置く |
69
+ | データストア | ○ | 全体概要の部分集合を同名・同区分で示し、読み書きを区別する |
70
+ | 概念データフロー | ○ | 一ノード一プロセスの図と、1〜2 文の説明・注記 |
71
+ | 個別プロセス主要入出力 | ○ | 図の分割単位に対応するプロセス単位の入出力表 |
72
+ | 状態遷移の参照 | ○ | 状態を変えるプロセスと STSD の対応。該当なしでも事実と確認根拠を記載 |
73
+ | 主要例外とグループ外への委譲 | ○ | 検出・停止範囲・扱い・再開と委譲境界。各区分が 0 件でも事実と確認根拠を記載 |
74
+ | 未決事項 | 任意 | 未決論点と影響する領域・プロセス・例外・委譲 |
90
75
 
91
76
  ## 6. 記述ガイド
92
77
 
93
78
  ### 6.1. 目的と適用範囲
94
79
 
95
- - 目的は、誰がグループ内部のフロー、領域間の受け渡し、主要例外、グループ外への委譲を合意または設計入力とするかを、1〜2 文で簡潔に記述します。
96
- - 適用範囲は、対象(対象グループ・期間・境界)と対象外(領域内部の詳細化先、他グループの責務、横断ユースケース)をそれぞれ 1 行(1 文)で明記します。
97
- - 人間と AI Agent の責任分担などの共通原則は本文で再定義せず、全体概要(またはプロジェクト方針文書)を参照します。
80
+ - 目的は、誰が内部フロー・領域間の受け渡し・主要例外・委譲を合意または設計入力に使うかを示します。
81
+ - 適用範囲の対象はグループ・期間・組織・システム境界・開始と終了、対象外は他グループの責務・横断ユースケース・詳細化先を示します。
82
+ - 人間と AI Agent の責任分担などの共通原則は全体概要またはプロジェクト方針を参照します。
98
83
 
99
84
  ### 6.2. プロセス領域
100
85
 
101
- - 章の冒頭で、対象グループ名、含む領域数、全体概要との正本関係を簡潔に示します。全体概要の対象グループ名と、そこに属する全領域の ID・名称を引き継ぎ、領域を追加・削除・別グループへ移動しません。
102
- - 領域ごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「領域名(領域 ID)」とします。
103
- - 各節はプロセスの表のみで構成します。主要入力・主要出力・データストアの箇条書きは記載せず、受け渡しは概念データフロー図を正本とします。
104
- - 領域 ID、名称、業務目的、主な担当、起点イベントは全体概要を正本とします。本章では領域 ID と名称を見出しの対応キーとして使い、業務目的・担当・起点イベントを書き写しません。
105
- - 各節の表は一行を一つのプロセスノードへ対応させます。
106
-
107
- | 列 | 記載内容 | 判定基準 |
108
- | ----------- | ---------------------------------------------- | ----------------------------------------------------------- |
109
- | プロセス ID | 対応領域 ID に枝番を付けた `P-<nn>-<nn>` | プロセス領域のいずれかへ一意に属し、表と図で同じ ID を使う |
110
- | プロセス | 一つの業務目的が分かる短い名称 | 複数プロセスや操作列を一行へ詰め込まない |
111
- | 業務目的 | 対象者に生じる成果または維持する状態 | 手順や状態遷移の列挙にしない |
112
- | 主な担当 | 主担当となるロールまたは外部主体 | 個人名にせず、人間の最終判断を明示する |
113
- | 起動条件 | 開始を判断できるイベント、前段の完了、承認条件 | 「必要に応じて」で終わらせない |
114
- | 完了条件 | 業務目的を達成したと判定できる出力または事実 | yes / no で判定でき、主要出力または正本の確定と対応している |
115
- | 必須性 | 必須、条件付き、選択のいずれか | 条件付き・選択では起動条件と非起動時の正常な扱いを示す |
86
+ - 冒頭でグループ名・領域数・全体概要との正本関係を示します。所属する全領域の ID・名称を引き継ぎ、追加・削除・移動はしません。
87
+ - 領域ごとに「領域名(領域 ID)」の節を設け、プロセス表だけを置きます。領域の業務目的・担当・起点イベントは全体概要から書き写しません。
88
+ - 各領域に一つ以上のプロセスを置き、一行を一ノードに対応させます。
89
+
90
+ | 列 | 記載内容と判定基準 |
91
+ | ----------- | -------------------------------------------------------------------------- |
92
+ | プロセス ID | 所属領域の枝番。表と図で一致 |
93
+ | プロセス | 一つの業務目的が分かる短い名称。複数処理や操作列を詰め込まない |
94
+ | 業務目的 | 対象者に生じる成果または維持する状態。手順・遷移の列挙にしない |
95
+ | 主な担当 | 主担当ロールまたは外部主体。個人名を使わず、人間の最終判断を明示 |
96
+ | 起動条件 | 判定可能なイベント・前段完了・承認条件。「必要に応じて」で終わらせない |
97
+ | 完了条件 | 主要出力または正本の確定に対応し、yes / no で判定できる事実 |
98
+ | 必須性 | 必須/条件付き/選択。条件付き・選択は起動条件と非起動時の正常な扱いを示す |
116
99
 
117
100
  ### 6.3. データストア
118
101
 
119
- - 全体概要の「データストア」と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、本グループが読み書きする行だけを掲載します。該当する行がない区分は節ごと省略します。
120
- - 表の列は「データストア」「読み書き」「本グループでの利用」とします。「読み書き」は「参照」「更新」「参照・更新」のいずれかとし、物の保管先を扱う場合は利用内容に現物の受け渡しであることを示します。
121
- - 名称と区分は全体概要から変更しません。
122
- - 概念データフローを複数図に分けて同じデータストアを再掲する場合を除き、表の各行と図のデータストアノードを一対一に対応させ、名称を一致させます。
102
+ - 全体概要の「マスタ・構成データ」「トランザクションデータ」と同じ区分に、本グループが読み書きする行だけを置きます。該当行がない区分は節ごと省略します。
103
+ - 列は「データストア」「読み書き」「本グループでの利用」。読み書きは「参照」「更新」「参照・更新」とし、現物の保管先は利用内容に現物の受け渡しを示します。
104
+ - 名称・区分は上位と一致させ、表の行と図のノードを一対一に対応させます。分割図で同じノードを再掲する場合も名称を保ちます。
123
105
 
124
106
  ### 6.4. 概念データフロー
125
107
 
126
- - ノード、エッジ、形状、線種は、全体概要の「凡例(本プロダクト共通)」で選択された記法ルール(`specdojo:cdfd-mermaid-rulebook` または `specdojo:cdfd-d2-rulebook`)に従います。全体概要で記法が宣言されていない場合は Mermaid 記法に従います。
127
- - 全体概要の各領域を一つの代表ノードとして再掲せず、「プロセス領域」の各表の行を一つずつ個別のプロセスノードとして配置します。
128
- - 同一グループ内の領域間の受け渡しは、双方のプロセスを同じ図または対応する分割図に置いて示します。他グループは内部プロセスを描かず、委譲先の代表ノードまたは起点・完了イベントだけを置きます。
129
- - 図は領域ごと、または業務の性質が近いプロセスごとに分けることを基本とします。
130
- - 各図の直後に、全体概要の「凡例(本プロダクト共通)」を参照する旨、および省略事項を 1〜2 文で簡潔に注記します(色・絵文字の割り当ては再掲しません)。
131
- - 状態名をノードとして並べたり、状態間の矢印を描いたりしません。状態を変える業務はプロセスと起点イベントだけを示し、「状態遷移の参照」から STSD へ接続します。
108
+ - 全体概要の「凡例(本プロダクト共通)」で選ばれた [[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]] を適用し、記法未宣言時は Mermaid とします。
109
+ - 「プロセス領域」の各行を個別ノードにし、全体概要の領域代表ノードを再掲しません。
110
+ - 領域間の受け渡しは双方のプロセスを同じ図または対応する分割図に置きます。他グループは委譲先代表ノードまたは起点・完了イベントだけを置きます。
111
+ - 領域ごと、または業務の性質が近いプロセスごとに分けます。条件付き・選択プロセスは、起動時と非起動でも正常完了する経路をたどれるようにします。
112
+ - 図直後の注記は、記法ルールの「凡例と可読性」に従い、凡例の適用元・使用線種・省略した入出力と理由・共有ノードを 1〜2 文で示します。色・絵文字の割り当ては再掲しません。
132
113
 
133
114
  ### 6.5. 個別プロセス主要入出力
134
115
 
135
- - 図を領域単位で分けた場合は領域ごと、業務の性質で分けた場合は同じまとまりごとに節を設けます。
136
- - プロセス ID ごとに、主要入力、主要出力、データストアを表で示します。業務目的、担当、起動条件、必須性は「プロセス領域」の表から重複させません。
137
- - データストアの名称と区分は「データストア」および全体概要と一致させます。
138
- - 全プロセスをちょうど一度掲載し、一プロセスだけのまとまりでも同じ表構成を省略しません。
116
+ - 図と同じ分割単位で節を設け、全プロセスをちょうど一度掲載します。一プロセスだけでも表を省略しません。
117
+ - 列は「プロセス ID」「プロセス」「主要入力」「主要出力」「データストア」。業務目的・担当・起動条件・必須性は重複させません。
118
+ - データストアの名称・区分は「データストア」と全体概要に一致させます。
139
119
 
140
120
  ### 6.6. 状態遷移の参照
141
121
 
142
- - 状態を変えるプロセスがある場合、表の列は「対象」「状態を変えるプロセス」「ステータス定義(STSD)」とします。該当プロセスがない場合は、その事実と確認根拠を一文で記載して表を省略します。
143
- - STSD は状態名・意味・成立条件と、遷移元・遷移先・イベント・遷移条件の単一正本として参照します。
144
- - CDFD には状態の一覧、遷移表、状態を頂点とする状態遷移図を複製しません。
122
+ 列は「対象」「状態を変えるプロセス」「ステータス定義(STSD)」とします。該当プロセスがない場合は、事実と確認根拠を一文で記載して表を省略します。
145
123
 
146
124
  ### 6.7. 主要例外とグループ外への委譲
147
125
 
148
- - 主要例外は「例外 ID」「対象プロセス」「検出条件」「停止範囲」「本グループでの扱い」「継続・再開条件」の表で示します。
149
- - グループ外委譲は「委譲先」「委譲する事項」「引き渡す情報」「本グループへ戻す条件」の表で示します。
150
- - 主要例外またはグループ外委譲が 0 件の場合も対応する節を残し、確認範囲と該当なしの結論を一文で記載して表を省略します。
126
+ - 主要例外の列は「例外 ID」「対象プロセス」「検出条件」「停止範囲」「本グループでの扱い」「継続・再開条件」。停止範囲には起動・確定してはならない後続プロセス・出力・委譲を示します。
127
+ - 委譲の列は「委譲先」「委譲する事項」「引き渡す情報」「本グループへ戻す条件」。
128
+ - 各区分が 0 件でも節を残し、確認範囲と該当なしの結論を一文で記載して表を省略します。
151
129
 
152
130
  ### 6.8. 完成判定
153
131
 
154
- 本節だけを `ready` 昇格のチェックリストの正本とします。次の全項目を満たす必要があります。
132
+ 「本文要件」と「記述ガイド」、選択した記法ルール、型固有の禁止事項を併用して全必須条件を照合します。確認者は次の順に表と図をたどり、条件ごとに pass / fail を判断します。条件付き要件が非該当なら、その根拠を確認します。必須条件に欠落・不一致があれば不合格です。
155
133
 
156
- - Frontmatter に必須の `id`、`type`、`status`、`rulebook` があり、`id` とファイル名が命名規則に一致します。
157
- - 「目的」が 1〜2 文で対象者と利用結果を定義し、「適用範囲」に対象と対象外が 1 行ずつ明記され、共通原則として全体概要が参照されています。
158
- - 全体概要で対象グループに属する全領域が「プロセス領域」にちょうど一つの節として登場し、各節がプロセスの表だけで構成されています(箇条書きを含まない)。
159
- - 各プロセスに業務目的、主な担当、起動条件、完了条件、必須性があり、完了条件は主要出力または正本の確定から yes / no で判定できます。
160
- - 全プロセスが領域ごとの表、図、個別プロセス主要入出力へ同じ ID と名称で登場し、ID が所属領域を示します。
161
- - 「データストア」が全体概要の部分集合であり、名称・区分が一致します。
162
- - 同一グループ内の領域間受け渡しを内部フローとしてたどれ、他グループの内部処理を作り込んでいません。
163
- - 図の説明・注記は 1〜2 文で簡潔に記載され、凡例は全体概要の凡例を参照しています。
164
- - 状態を変えるプロセスは STSD を参照し、CDFD 本文に状態の定義、遷移表、状態遷移図を重複記載していません。
165
- - 主要例外の検出、停止範囲、継続・再開条件と、グループ外への引き渡しを確認者が説明できます。
134
+ 1. 目的・適用範囲を読み、全体概要の全所属領域が一節ずつあることを照合します。
135
+ 2. 各プロセスの起動から主要出力・正本確定までを追い、完了条件と条件付き・選択の非起動時の正常完了を確認します。表・図・入出力表の ID・名称、入出力表への一度だけの掲載、データストアの名称・区分・読み書きを照合します。
136
+ 3. 領域間の内部フローと図直後の注記を確認し、状態を変える全プロセスから STSD を特定します。
137
+ 4. 各主要例外について検出から停止・対応・再開、各委譲について受け手・責務・情報・戻す条件を表の全列で確認します。0 件の区分も確認根拠を読みます。
166
138
 
167
139
  ## 7. 禁止事項
168
140
 
169
- - プロセス領域に主要入力・主要出力・データストアの箇条書きを記載する、または図の受け渡しを文章でなぞる長文の注記を書く。
141
+ - プロセス領域に主要入力・主要出力・データストアの箇条書きを置く、図を文章でなぞる長文注記を書く。
170
142
  - 詳細 CDFD に独自の凡例を再掲・重複定義する。
171
- - 複数領域を持つグループから一部の領域だけを切り出して別文書にしたり、一つの領域を複数のプロセスグループ別 CDFD に重複配置したりする。
172
- - 全体概要と異なるデータストア名・区分を使用したり、物理テーブル名、物理カラム名、SQL、実装クラス、詳細 API を概念フローへ記載したりする。
173
- - 状態名・意味を CDFD で定義したり、遷移元・遷移先・遷移条件の表や状態遷移図を複製したりする。
174
- - 他グループの内部プロセスを展開したり、同一グループ内の領域間受け渡しをグループ外委譲として扱ったりする。
175
- - 一覧、検索、状態参照、検証、dry-run など、独自の業務成果を持たない補助操作を独立プロセスにする。
176
- - プロセス領域の表と個別プロセス主要入出力、図直後の注記、例外表の間で同じ事実を重複記載する。
143
+ - 所属領域の一部を別文書に切り出す、一領域を複数文書に重複配置する。
144
+ - 物理テーブル・カラム・SQL・実装クラス・詳細 API を概念フローに書く。
145
+ - 状態名・意味を CDFD で定義する、遷移元・遷移先・条件の表や状態を頂点とする遷移図を複製する。
146
+ - 他グループの内部処理を展開する、内部の領域間受け渡しをグループ外委譲として扱う。
147
+ - 一覧・検索・状態参照・検証・dry-run など、独自の業務成果がない補助操作を独立プロセスにする。
148
+ - プロセス表・入出力表・図直後注記・例外表の間で同じ事実を重複記載する。
@@ -24,23 +24,13 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
24
24
  ## 1. 全体方針
25
25
 
26
26
  - 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID と、そのユースケースまたは系統を詳細化します。描く単位と詳細化の境界は「描き方の選択」に従います。
27
- - 「プロセス領域」は順序と責務の正本、「データストア」は全体概要の一覧の部分集合、図は開始から終了までの順序と受け渡しの正本とします。主要入力・主要出力の箇条書きや、引き渡しを列挙する章は設けません。
28
- - 渡す情報・物は図の線のラベルで表します。引き渡し条件のイベントや引き渡し ID は使いません。業務上重要な戻りの流れだけ、任意の図で示します。
29
- - 詳細の図に Orchestrator(調整役)を置きません。調整は全体概要の「Orchestrator による PDCA の調整」などの指示の図へ委ねます。
30
- - 目的はその業務が何のためにあるかを 1〜2 文、適用範囲は対象と対象外を 1 行ずつとします。人間と AI Agent の責任分担などの共通原則と凡例は、全体概要を参照し、本書で再定義しません。
31
- - 状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。本書は状態の定義や遷移表を持ちません。
27
+ - 開始から終了までの横断順序と受け渡しは「概念データフロー」の図だけを正本とします。「プロセス領域」は責務の正本であり、順序欄と章冒頭の通過順は図に一致させる対応表現です。不一致時は図を根拠に表・通過順を修正し、順序を変えるときは図を先に改訂します。「データストア」は全体概要の一覧の部分集合とします。
28
+ - 人間と AI Agent の責任分担などの共通原則と凡例は全体概要、状態の定義と遷移は STSD を正本とし、本書で再定義しません。
29
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎ、`deprecated` の文書を参照しないことは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、「完成判定」に含めません。
32
30
 
33
- ## 2. 位置づけと用語定義
31
+ ## 2. 位置づけ
34
32
 
35
- | 用語 | 定義 |
36
- | ---------------- | -------------------------------------------------------------------------- |
37
- | 全体概要 | 領域のまとまり、データストア、詳細 CDFD の割り当てを定める `cdfd-overview` |
38
- | ケース ID | 全体概要でユースケースまたは系統に割り当てられた `C-<nn>` 形式の識別子 |
39
- | 起点イベント | 業務を始める、発生を判定できる出来事 |
40
- | 関連データストア | 対象ケースで参照・更新する、全体概要と同じ名称・区分を持つ正本 |
41
- | 例外時の戻り | 不足や不一致を、補完・再判断を担う参加単位へ返す業務上の流れ |
42
-
43
- 全体概要がケースの業務目的と対象範囲を選定し、本書がその流れを具体化します。領域の分割、名称、担当、起点イベントは全体概要を正本とします。
33
+ 全体概要(`cdfd-overview`)がケース ID(`C-<nn>`)と業務目的・対象範囲を選定し、本書がその流れを具体化します。領域の分割、名称、担当、起点イベントは全体概要を正本とします。構造・必須項目・禁止事項の判断は本 rulebook に従い、骨組みや作成手順と矛盾する場合もこの内容要件を優先します。
44
34
 
45
35
  ## 3. ファイル命名・ID規則
46
36
 
@@ -52,35 +42,20 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
52
42
 
53
43
  ## 4. 推奨 Frontmatter 項目
54
44
 
55
- | 項目 | 説明 | 必須 |
56
- | ---------- | ---------------------------------------- | ---- |
57
- | id | プロジェクト修飾なしの `cdfd-uc-<topic>` | ○ |
58
- | type | `flow` | ○ |
59
- | status | `draft` / `ready` / `deprecated` | ○ |
60
- | rulebook | `specdojo:cdfd-uc-rulebook` | ○ |
61
- | `based_on` | 全体概要など、有効な直接の内容根拠の ID | 任意 |
62
- | supersedes | 置き換える旧ユースケース別 CDFD の ID | 任意 |
63
-
45
+ - 共通の必須項目、値・構文・構造は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と同標準が参照するスキーマに従い、本書では再定義しません。成果物種別は本 rulebook の `deliverable_type` に従います。
64
46
  - `based_on` に全体概要を記載する場合も product 成果物 ID を使用し、成果物カタログの `depends_on` の推移閉包に含まれる根拠だけを列挙します。
65
- - status が `deprecated` の文書を `based_on` と本文の参照先にしません。有効な全体概要や後継文書へ参照を更新します。
66
47
  - ケース ID、ユースケース名、開始・終了は本文で定義し、未定義の Frontmatter 項目を追加しません。
67
- - 作成途中の `status` は `draft` とし、完成判定と所定の承認を満たした後の昇格は定められた承認者が行います。
68
48
 
69
49
  ## 5. 本文要件
70
50
 
71
- 見出し順・表・記入欄の骨組みは template を正本とします。本章は各章の目的と必須・任意を定めます。
51
+ 見出し順・表・記入欄の骨組みは template を正本とし、本章では重複させず、必要な判断情報を定めます。
72
52
 
73
- | 番号 | 見出し | 必須 | 内容 |
74
- | ---- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------- |
75
- | 冒頭 | 導入文 | ○ | ケース ID とユースケースまたは系統を一文で定義 |
76
- | 1 | 目的 | ○ | その業務が何のためにあるか、開始からどの成果までを成立させるか(1〜2 文) |
77
- | 2 | 適用範囲 | ○ | 対象と対象外を 1 行ずつ。責任分担などの共通原則は全体概要を参照 |
78
- | 3 | プロセス領域 | ○ | 全体概要と同じまとまりごとの節。各節は順序と役割の表のみ |
79
- | 4 | データストア | ○ | 対象ケースで参照・更新する全体概要のデータストアの部分集合 |
80
- | 5 | 概念データフロー | ○ | 開始・終了のイベント、参加単位、関連データストア、情報・物の流れ。各図に業務の言葉による題と説明 1 文 |
81
- | 6 | 未決事項 | 条件付き | 境界、名称、責務、判断者が未確定な論点。ある場合だけ最終章に設ける |
53
+ - **業務の識別と境界(必須)**: 導入文でケース ID と業務名、目的で業務の存在理由と成果、適用範囲で対象と対象外を示します。
54
+ - **責務と正本の利用(必須)**: プロセス領域で参加単位の責務と詳細化の境界を、データストアで全体概要から選んだ正本の用途を示します。各節は役割表または利用の表とし、入出力の列挙に展開しません。
55
+ - **流れの合意(必須)**: 概念データフローで開始・終了、参加単位、関連データストア、情報・物の受け渡しを示します。各図に業務の言葉による題と説明 1 文を付けます。
56
+ - **判断待ちの可視化(条件付き)**: 境界、名称、責務、判断者に未確定の論点がある場合だけ、未決事項を最終章に置きます。
82
57
 
83
- 「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.` の節を設けます。「例外時の戻り」は業務上重要な場合だけ同章内に追加できる任意の図であり、必須の章や表にしません。
58
+ 「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.` の節を設け、例外時の戻りも同章内の図で示します。
84
59
 
85
60
  ## 6. 記述ガイド
86
61
 
@@ -96,74 +71,96 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
96
71
  | 詳細化の境界 | グループ内部の領域・プロセス・主要例外は有効な `cdfd-<group>` へ委ねる | 対象系統と共用領域の流れを領域単位で示し、非推奨のグループ別 CDFD へ依存しない |
97
72
  | 入口 | ケースの開始イベントを描く | 系統の入口の起点イベントを描き、文言を全体概要の「プロセス領域」の表と一致させる |
98
73
 
74
+ どちらの方式でも、複数の系統(ユースケース)が共通して通るプロセス領域(領域のまとまりを含む)の内部は、全体概要またはその領域の詳細文書の 1 か所だけで描きます。ほかの詳細文書では、その領域を 1 つのノードとして置き、領域との受け渡しの線だけを描きます。内部を描く文書を役割表の「参照先」に示し、内部のプロセス・データストアの読み書き・例外時の戻りを重複して展開しません。その領域から外へ返す例外の情報は、受け渡しとして省略せず描きます。
75
+
76
+ 良い例: 共用する実行・評価・完了を 1 ノードにまとめ、内部の正本を参照する。悪い例: 系統ごとに共用領域の内部を描き直す。
77
+
99
78
  ### 6.2. 導入文と目的
100
79
 
101
- - 導入文は「ケース `C-02` の欠品から補充まで」のように、ケース ID と業務名を明示します。
102
- - 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2 文で記述します。例: 「欠品した商品を補充し、売場で販売できるようにするために、在庫の補充判断から仕入・販売への流れを示す。」
80
+ - 導入文は、全体概要で選んだケース ID と業務名を一文で明示し、目的の前に置きます。
81
+ - 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2 文で記述します。
103
82
  - BA・QE・承認者など、読み手ごとの承認・設計・確認作業を目的に書きません。
104
83
 
84
+ 良い例: 導入文は「ケース `C-02`『欠品から補充まで』の流れを示す」、目的は「欠品した商品を補充し、売場で販売できるようにする」。悪い例: ケースを特定せず、目的を「BA が承認し、QE が検証するため」とする。
85
+
105
86
  ### 6.3. 適用範囲
106
87
 
107
88
  - 対象はケース ID、参加単位、開始イベント、終了時の成果、必要な組織・システム境界を 1 行(1 文)で示します。
108
- - 対象外は操作手順、補助操作、実装詳細などを 1 行(1 文)で示し、詳細化の境界は「描き方の選択」に従います。状態の定義と遷移は STSD を正本とします。
109
- - 人間と AI Agent の責任分担などの共通原則は、全体概要を参照します。
89
+ - 対象外は操作手順、補助操作、実装詳細などを 1 行(1 文)で示し、詳細化の境界は「描き方の選択」に従います。
90
+
91
+ 良い例: 対象を「在庫の補充基準割れから販売の商品引受けまで」、対象外を「内部の発注手順・状態遷移は各正本へ委ねる」と分ける。悪い例: 「補充に関する全業務」とだけ書き、内部処理との境界を決めない。
110
92
 
111
93
  ### 6.4. プロセス領域
112
94
 
113
- - 章冒頭にケース ID、正常系の通過順、全体概要との正本関係を簡潔に示します。
95
+ - 章冒頭にケース ID、図に従う正常系の通過順、全体概要との正本関係を簡潔に示します。条件付きの計画連携・補完だけを担う参加単位は、常に通る主経路と区別し、順序欄に「計画連携時」「補完時」など図に対応する参加場面を示します。
114
96
  - 全体概要と同じまとまりごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名または区分名(含む領域 ID)」とします。各節には役割の表だけを置き、入力・出力やデータストアの箇条書きは置きません。
115
97
  - 表の列は次のとおりです。同じ参加単位が再登場する場合は別の行にして役割を区別します。
116
98
 
117
99
  | 列 | 記載内容 |
118
100
  | ---------------------- | ---------------------------------------------------------------------------------------------------- |
119
- | 順序 | 正常系で通過する順番 |
101
+ | 順序 | 図から転記する正常系の通過順または条件付きの参加場面。表の独自判断で順番を定めない |
120
102
  | プロセスグループ・区分 | 全体概要で領域をまとめている名称 |
121
103
  | 含む領域 | 全体概要と同じ領域 ID。領域単位の行では領域名も併記し、「プロセス領域」という列名にしてよい |
122
104
  | PDCA(任意) | 全体概要にある Plan、Do、Check、Action、全体などの位置付け。「プロセスグループ・区分」とは別の分類軸 |
123
105
  | 横断上の役割 | このケースで担う業務上の責務 |
124
106
  | 参照先 | 全体概要または有効な詳細文書。未作成の文書は ID をインラインコードで仮置き |
125
107
 
108
+ 良い例: 図の在庫→仕入→販売に合わせて順序欄を 1・2・3 とする。悪い例: 図が在庫→仕入→販売でも、表の節順だけで仕入を 1 とする。
109
+
126
110
  ### 6.5. データストア
127
111
 
128
112
  - 全体概要と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、対象ケースで参照・更新する行だけを同じ名称・区分で示します。該当行がない区分は節ごと省略します。
129
113
  - 表は「データストア」「関連する参加単位」「横断上の利用」の列とします。関連は参加単位の名称または領域 ID で示します。
130
114
  - 各行を図の同名ノードへ対応させます。物理保管は全体概要の区分に従い、保管先の詳細や物理項目へ展開しません。
131
115
 
116
+ 良い例: 全体概要の「商品台帳」を同じ区分で選び、「在庫が補充基準を参照する」と用途を示す。悪い例: 商品台帳の全カラムや保存パスを転載する。
117
+
132
118
  ### 6.6. 概念データフロー
133
119
 
134
120
  - ノード、線種、色、絵文字は全体概要の「凡例(本プロダクト共通)」で選択された記法ルール([[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]])に従います。記法の宣言がなければ Mermaid とし、sample と template は D2 の例とします。参加単位・方向・イベントの要件が記法部品と異なる場合は本書を優先し、Mermaid も `flowchart TB` で縦に描きます。
121
+ - ノードのラベルに絵文字を付けるか付けないかは、全体概要の凡例の方針に合わせ、文書内の全図と系統間でそろえます。付ける場合は凡例の割り当てに従い、同じ対象には同じ絵文字を使います。詳細文書だけで追加・削除・変更しません。
135
122
  - 正常系を上から下へ並べます。D2 は `direction: down` とし、戻りの線は上にあるノードを左辺にした `a <- b` で書きます。
136
- - プロセスノードを役割表の行へ対応させ、通常の流れ全体を通して開始イベントと終了の出来事を描きます。分割図や戻りの図へ開始・終了を再掲する必要はありません。イベントは一つのノードに一つの出来事とし、発生を判定できる短い文にします。長い場合は改行し、原文を言い換えません。全体概要の起点イベントが複数の出来事を列挙している場合は、各出来事の文言を保ってノードを分けます。
123
+ - プロセスノードを役割表の行へ対応させ、通常の流れ全体を通して開始イベントと終了の出来事を描きます(分割図・戻りの図へは再掲不要)。イベントは一つのノードに一つの出来事とし、発生を判定できる短い文にします。長い場合は改行し、原文を言い換えません。全体概要の起点イベントが複数の出来事を列挙している場合は、各出来事の文言を保ってノードを分けます。
137
124
  - 参加単位どうし、または参加単位とデータストアを直接結び、渡す情報・物を名詞のラベルにします。必要な承認は「承認済みの補充依頼」のように成果の性質として表し、引き渡し条件を判定するイベントは置きません。
138
125
  - Orchestrator とその調整要求・応答は描かず、全体概要の指示の図を参照します。対象範囲内の担当ロールを外部主体として追加しません。
139
126
  - 図の題は「欠品から売場補充まで」「起票から完了記録まで」のように業務の言葉で付けます。説明は、その図から読み取れる流れや関係を 1 文で書きます。凡例への参照は別の短い注記にし、凡例を再定義しません。
140
- - 一図で追いにくい場合は連続する業務の範囲で分け、接続する参加単位・データストアを同じ ID・名称で再掲します。図ごとに省略事項と共有ノードを短く注記します。
127
+ - 分割の目安は、一図の受け渡しの線が 15 本を超える場合、または一ノードに入出力の線が合計 10 本以上集まる場合とし、連続する業務の段ごとに図を分けます。線は情報・物・起動・完了・戻り・再提示を各 1 本として数え、配置制御用の非表示線や凡例の線は含めません。目安以内でも線の交差やラベルの密集で接続を追いにくければ分けます。
128
+ - 分割後も必要な線を省略せず、接続する参加単位・データストアを同じ ID・名称で再掲します。図ごとに共有ノードと、別図・参照先へ委ねる範囲を短く注記し、開始から終了までの接続を追えるようにします。
129
+
130
+ 良い例: 仕入から販売へ「入荷数量・受入結果」を渡す線を描き、題を「欠品から売場補充まで」とする。悪い例: 「処理フロー」とだけ題を付け、受け渡しの線に情報名を付けない。
141
131
 
142
- ### 6.7. 例外時の戻りの図(任意)
132
+ ### 6.7. 例外時の戻りの図
143
133
 
144
- - 不足や不一致を先行する参加単位へ返すことが業務上重要な場合だけ、「概念データフロー」に「例外時の戻り」の図を追加できます。すべての受け渡しを網羅する表は作りません。
134
+ - 対象範囲に、不足や不一致を補完・再判断する参加単位へ返す流れがある場合は、「概念データフロー」に「例外時の戻り」の図を追加し、重要度で絞らずにすべて描きます(共用領域の内部は「描き方の選択」に従う)。すべての受け渡しを網羅する表は作りません。
145
135
  - 補完・再判断を担う参加単位へ戻る線に「不足項目」「記録と受入品の差異」などの戻す情報を付けます。通常の図と同じ名称・領域 ID を使います。
146
136
  - 再提示を示す場合も「修正・承認済みの補充依頼」のような情報の線で表し、戻す条件・再開条件の列や条件イベントは設けません。内部の再試行、ログ、操作手順は描きません。
137
+ - 線が多い場合は「概念データフロー」の分割の目安に従い、戻り先または業務の段ごとに図を分け、題に「補充依頼の補完」のように戻す対象を示します。読みやすさのために必要な戻りを削りません。
138
+
139
+ 良い例: 仕入が不足項目を在庫へ返し、在庫が修正・再承認済みの補充依頼を再提示する。悪い例: 「エラー」を行き先なしで描く、または線が増えたので戻りを削る。
147
140
 
148
141
  ### 6.8. 未決事項
149
142
 
150
143
  - 境界、名称、責務、判断者のいずれかが未確定な場合だけ設け、ない場合は章ごと省略します。
151
- - 表は「論点」「影響するケース・参加単位」「決定者」「決定時期」の 4 列とし、本文中の `_UNDECIDED_` と対応させます。
144
+ - 各論点は本文中の `_UNDECIDED_` と対応させ、論点と、影響するケース・参加単位を示します。解決済みの論点や論点のない空表は残しません。
145
+
146
+ 良い例: 「共用領域の内部の正本が未確定。`C-01`〜`C-03` の共用領域のノードと参照先に影響」と示す。悪い例: 「詳細は後で検討」とだけ書く。
152
147
 
153
148
  ### 6.9. 完成判定
154
149
 
155
- 本節だけを `ready` 昇格のチェックリストの正本とします。次の全項目を満たす必要があります。
150
+ 内容の確認は次の全項目で行います。
156
151
 
157
152
  - ケース ID、業務名、目的、対象範囲、領域 ID・名称が全体概要と一致し、「描き方の選択」で決めた参加単位と詳細化の境界を守っています。
158
- - 「目的」が業務の存在理由・成果を 1〜2 文で示し、読み手の役割を含みません。「適用範囲」は対象と対象外が 1 行ずつで、共通原則は全体概要を参照しています。
153
+ - 共用領域の内部を描く文書が 1 か所に定まり、ほかの詳細文書では 1 ノードと受け渡しの線で示しています。
154
+ - 「目的」が業務の存在理由・成果を 1〜2 文で示し、読み手の役割を含みません。「適用範囲」は対象と対象外が 1 行ずつです。
159
155
  - 「プロセス領域」の各節は役割表だけで構成され、全体概要のグループ・区分と一致しています。PDCA の値を示す場合は独立した任意の列にしています。
160
- - 正常系の全参加単位が表と図で同じ順序・名称・領域 ID に対応し、開始から終了まで上から下へ追えます。開始・終了のイベントは一ノード一出来事の短い文で、入口の文言は選んだ方式の規定に従っています。
156
+ - 図を正本として、役割表の順序欄と章冒頭の通過順が一致しています。全参加単位の名称・領域 ID が表と図で対応し、主経路と条件付きの経路を区別して開始から終了まで上から下へ追えます。開始・終了のイベントは一ノード一出来事の短い文で、入口の文言は選んだ方式の規定に従っています。
161
157
  - 渡す情報・物を線のラベルから読み取れ、引き渡し ID や条件のイベント、「引き渡し」「例外時の戻り先」の章がありません。
162
158
  - Orchestrator は図に含まれず、その調整は全体概要の指示の図へ委ねられています。
163
- - 図には業務の言葉による題と、読み取れることを示す説明 1 文があり、凡例は全体概要を参照しています。図を分けた場合も共有ノードと接続が追えます。
159
+ - 図には業務の言葉による題と説明 1 文があり、凡例は全体概要を参照しています。図を分けた場合も共有ノードと接続が追えます。
160
+ - ノードの絵文字の有無・割り当てが全体概要の凡例に合い、文書内の全図と系統間でそろっています。
164
161
  - 関連データストアは全体概要と同じ名称・区分で、表の各行と図のノードが対応しています。
165
- - 例外時の戻りの図を設けた場合、戻す情報と補完・再判断の責任を持つ参加単位を読み取れます。戻りの図が不要な場合は省略されています。
166
- - `based_on` と本文に `deprecated` の文書への参照がありません。状態定義・遷移を複製せず、有効な STSD や詳細文書を参照しています。
162
+ - 対象範囲の例外時の戻りを重要度で省略せず、戻す情報と補完・再判断の責任を持つ参加単位を読み取れます。戻りがない場合だけ戻りの図を省略しています。
163
+ - 状態定義・遷移を複製せず、有効な STSD や詳細文書を参照しています。
167
164
 
168
165
  ## 7. 禁止事項
169
166
 
@@ -173,5 +170,4 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
173
170
  - 全体概要と異なるグループ名・区分名・領域 ID・データストア名を使う、または PDCA の値をグループ・区分の列に入れる。
174
171
  - 引き渡し ID を採番する、引き渡し条件のイベントを図に置く、引き渡し・戻す条件・再開条件の表を設ける。
175
172
  - Orchestrator の調整を詳細の図に複製する、または対象範囲内の担当者を外部主体にする。
176
- - `deprecated` の文書を `based_on` または本文から参照する。
177
173
  - 状態定義・遷移表・状態遷移図を複製する、または物理テーブル、カラム、SQL、実装クラス、詳細 API、画面操作を記載する。