specdojo 0.7.0 → 0.8.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 (337) hide show
  1. package/.github/agents/specdojo-orchestrator.md +3 -2
  2. package/CHANGELOG.md +153 -0
  3. package/dist/catalog/build.js +24 -1
  4. package/dist/catalog/plan.js +1 -1
  5. package/dist/catalog/scaffold.js +4 -1
  6. package/dist/commands/init.js +5 -1
  7. package/dist/commands/night-orchestrator.js +6 -4
  8. package/dist/dashboard/dashboard-timeline.js +18 -16
  9. package/dist/dashboard/dashboard.js +612 -259
  10. package/dist/dashboard/epic-plan.js +81 -0
  11. package/dist/dashboard/exec-records.js +16 -20
  12. package/dist/dashboard/routines.js +8 -6
  13. package/dist/dashboard/timeline-build.js +5 -9
  14. package/dist/dashboard/timeline.js +9 -4
  15. package/dist/devcontainer/scaffold.js +18 -0
  16. package/dist/docs/frontmatter-namespace.js +1 -48
  17. package/dist/docs/yaml-pages.js +125 -3
  18. package/dist/exec/agent-config.js +22 -0
  19. package/dist/exec/agent-plan.js +3 -2
  20. package/dist/exec/commands.js +69 -21
  21. package/dist/exec/commit-hook-skips.js +78 -0
  22. package/dist/exec/core.js +19 -7
  23. package/dist/exec/events.js +159 -8
  24. package/dist/exec/evidence.js +64 -16
  25. package/dist/exec/handoff.js +9 -13
  26. package/dist/exec/limit.js +1 -1
  27. package/dist/exec/mechanical-result.js +45 -0
  28. package/dist/exec/migrate-records.js +249 -0
  29. package/dist/exec/parent-validation.js +153 -12
  30. package/dist/exec/pipeline-state.js +27 -5
  31. package/dist/exec/plans-condense-findings.js +89 -0
  32. package/dist/exec/plans-core.js +24 -17
  33. package/dist/exec/plans-generation.js +48 -25
  34. package/dist/exec/plans-grade-findings.js +8 -3
  35. package/dist/exec/plans-kata-findings.js +61 -0
  36. package/dist/exec/plans-planning.js +3 -3
  37. package/dist/exec/plans-storage.js +12 -24
  38. package/dist/exec/register-resume.js +55 -56
  39. package/dist/exec/register.js +26 -22
  40. package/dist/exec/repo-integration-sync.js +8 -4
  41. package/dist/exec/repo-integration.js +21 -1
  42. package/dist/exec/reporter.js +121 -23
  43. package/dist/exec/results.js +85 -24
  44. package/dist/exec/review-completion.js +47 -0
  45. package/dist/exec/review-kata.js +109 -0
  46. package/dist/exec/run/agent-pipeline.js +75 -6
  47. package/dist/exec/run/agent.js +20 -7
  48. package/dist/exec/run/in-place.js +69 -32
  49. package/dist/exec/run/job.js +81 -24
  50. package/dist/exec/run/lifecycle-commands.js +188 -36
  51. package/dist/exec/run/mode-shared.js +11 -3
  52. package/dist/exec/run/register-command.js +6 -10
  53. package/dist/exec/run/register-core.js +20 -13
  54. package/dist/exec/run/register-mode.js +12 -12
  55. package/dist/exec/run/register-post-review.js +21 -9
  56. package/dist/exec/run/register-resume.js +28 -18
  57. package/dist/exec/run/register-state.js +10 -7
  58. package/dist/exec/run/register-worktree.js +60 -30
  59. package/dist/exec/run/schedule-mode.js +4 -4
  60. package/dist/exec/run/schedule-prepare.js +201 -59
  61. package/dist/exec/run/schedule-task.js +129 -25
  62. package/dist/exec/run/shared.js +4 -3
  63. package/dist/exec/run/trailing-records.js +35 -0
  64. package/dist/exec/run-records.js +2 -0
  65. package/dist/exec/strategy.js +1 -0
  66. package/dist/exec/trailing-records.js +242 -0
  67. package/dist/exec/trial-commands.js +3 -2
  68. package/dist/exec/validate-records-commit.js +110 -0
  69. package/dist/exec/validate-records.js +148 -0
  70. package/dist/exec/worktree-command.js +29 -16
  71. package/dist/exec/worktree-ops-commit.js +119 -48
  72. package/dist/exec/worktree-ops-lifecycle.js +77 -48
  73. package/dist/exec/worktree-ops-merge.js +13 -2
  74. package/dist/exec/worktree-ops.js +2 -2
  75. package/dist/exec/worktree.js +19 -2
  76. package/dist/grade/apply.js +32 -6
  77. package/dist/grade/command-inspect.js +2 -2
  78. package/dist/grade/command-run.js +2 -0
  79. package/dist/grade/command-shared.js +1 -1
  80. package/dist/grade/core.js +18 -5
  81. package/dist/grade/markdown.js +3 -3
  82. package/dist/grade/pipeline-state.js +15 -11
  83. package/dist/grade/plan.js +37 -17
  84. package/dist/grade/result.js +3 -3
  85. package/dist/grade/run.js +23 -3
  86. package/dist/grade/target-discovery.js +17 -4
  87. package/dist/grade/targets.js +12 -11
  88. package/dist/job/job.js +31 -17
  89. package/dist/job/noop.js +104 -0
  90. package/dist/register/core.js +2 -0
  91. package/dist/register/create-commands.js +28 -3
  92. package/dist/register/deliverable-target.js +9 -1
  93. package/dist/register/epic.js +104 -26
  94. package/dist/register/event-merge.js +3 -0
  95. package/dist/register/events.js +4 -0
  96. package/dist/register/external-project.js +3 -0
  97. package/dist/register/item.js +6 -0
  98. package/dist/register/maintenance-commands.js +4 -1
  99. package/dist/register/planning.js +7 -14
  100. package/dist/register/register.js +43 -9
  101. package/dist/register/track-domains.js +34 -0
  102. package/dist/register/track-plan.js +78 -0
  103. package/dist/register/transition-commands.js +8 -0
  104. package/dist/register/work-table.js +64 -0
  105. package/dist/review/grade.js +35 -13
  106. package/dist/routine/definition.js +4 -3
  107. package/dist/routine/failure.js +30 -0
  108. package/dist/routine/routine.js +56 -32
  109. package/dist/routine/storage.js +33 -0
  110. package/dist/schedule/schedule.js +1 -0
  111. package/dist/schedule/strategy-generate-document.js +26 -14
  112. package/dist/schedule/strategy-generate-scope.js +17 -45
  113. package/dist/schedule/strategy-generate.js +33 -3
  114. package/dist/schedule/strategy-profiles.js +86 -12
  115. package/dist/shared/agent-types.js +2 -0
  116. package/dist/shared/condense-records.js +25 -0
  117. package/dist/shared/deprecation.js +8 -0
  118. package/dist/shared/document-metadata.js +20 -0
  119. package/dist/shared/finding-cause.js +20 -0
  120. package/dist/shared/frontmatter-namespace.js +48 -0
  121. package/dist/shared/git.js +142 -15
  122. package/dist/shared/grade-result.js +17 -1
  123. package/dist/shared/local-state.js +20 -0
  124. package/dist/shared/markdownlint-config.js +8 -3
  125. package/dist/shared/plan-conventions.js +129 -0
  126. package/dist/shared/plan-templates.js +57 -41
  127. package/dist/shared/run-records.js +224 -0
  128. package/dist/shared/specdojo-config.js +39 -21
  129. package/dist/shared/text.js +65 -5
  130. package/dist/shared/timeline-index.js +2 -0
  131. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -2
  132. package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
  133. package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
  134. package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
  135. package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
  136. package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
  137. package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
  138. package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
  139. package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
  140. package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
  141. package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
  142. package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
  143. package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
  144. package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
  145. package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
  146. package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
  147. package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
  148. package/docs/ja/specdojo/guides/exec-config-guide.md +47 -16
  149. package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
  150. package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
  151. package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
  152. package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
  153. package/docs/ja/specdojo/guides/quick-start-guide.md +70 -14
  154. package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
  155. package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
  156. package/docs/ja/specdojo/guides/review-guide.md +22 -19
  157. package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
  158. package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
  159. package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
  160. package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
  161. package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
  162. package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
  163. package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
  164. package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
  165. package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
  166. package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
  167. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +36 -24
  168. package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
  169. package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
  170. package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
  171. package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
  172. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
  173. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
  174. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
  175. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
  176. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
  177. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
  178. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
  179. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
  180. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
  181. package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
  182. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
  183. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
  184. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
  185. package/docs/ja/specdojo/references/command-reference.md +79 -64
  186. package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
  187. package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
  188. package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
  189. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
  190. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
  191. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
  192. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
  193. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
  194. package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
  195. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
  196. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +56 -35
  197. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
  198. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
  199. package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
  200. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
  201. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
  202. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
  203. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
  204. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
  205. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
  206. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
  207. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
  208. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
  209. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
  210. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
  211. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
  212. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
  213. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
  214. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
  215. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
  216. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
  217. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
  218. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
  219. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
  220. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
  221. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
  222. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
  223. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
  224. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
  225. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
  226. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
  227. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
  228. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
  229. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
  230. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
  231. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
  232. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
  233. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
  234. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
  235. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
  236. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
  237. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
  238. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
  239. package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
  240. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
  241. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
  242. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
  243. package/docs/ja/specdojo/samples/bac-sample.md +106 -21
  244. package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
  245. package/docs/ja/specdojo/samples/bds-sample.md +100 -21
  246. package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
  247. package/docs/ja/specdojo/samples/bes-sample.md +80 -21
  248. package/docs/ja/specdojo/samples/br-sample.md +68 -14
  249. package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
  250. package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
  251. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
  252. package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
  253. package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
  254. package/docs/ja/specdojo/samples/cld-sample.md +3 -30
  255. package/docs/ja/specdojo/samples/clis-sample.md +132 -0
  256. package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
  257. package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
  258. package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
  259. package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
  260. package/docs/ja/specdojo/samples/dss-sample.md +175 -0
  261. package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
  262. package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
  263. package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
  264. package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
  265. package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
  266. package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
  267. package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
  268. package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
  269. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
  270. package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
  271. package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
  272. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
  273. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
  274. package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
  275. package/docs/ja/specdojo/samples/sf-sample.md +121 -21
  276. package/docs/ja/specdojo/samples/sld-sample.md +107 -21
  277. package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
  278. package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
  279. package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
  280. package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
  281. package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
  282. package/docs/ja/specdojo/samples/uis-sample.md +164 -20
  283. package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
  284. package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
  285. package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
  286. package/docs/ja/specdojo/templates/bac-template.md +76 -0
  287. package/docs/ja/specdojo/templates/bes-template.md +56 -0
  288. package/docs/ja/specdojo/templates/br-template.md +64 -0
  289. package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
  290. package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
  291. package/docs/ja/specdojo/templates/cnd-template.md +137 -0
  292. package/docs/ja/specdojo/templates/cpd-template.md +129 -0
  293. package/docs/ja/specdojo/templates/cxd-template.md +105 -0
  294. package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
  295. package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
  296. package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
  297. package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
  298. package/docs/ja/specdojo/templates/ifd-template.md +86 -0
  299. package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
  300. package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
  301. package/docs/ja/specdojo/templates/opr-template.md +2 -4
  302. package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
  303. package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
  304. package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
  305. package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
  306. package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
  307. package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
  308. package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
  309. package/docs/ja/specdojo/templates/stsd-template.md +46 -21
  310. package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
  311. package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
  312. package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
  313. package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
  314. package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
  315. package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
  316. package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
  317. package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
  318. package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
  319. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
  320. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +53 -3
  321. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
  322. package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
  323. package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
  324. package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
  325. package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
  326. package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
  327. package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
  328. package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
  329. package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
  330. package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
  331. package/package.json +2 -2
  332. package/templates/antigravity/orchestrator.md +3 -2
  333. package/templates/claude/agents/specdojo-orchestrator.md +3 -2
  334. package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
  335. package/templates/codex/orchestrator.md +3 -2
  336. package/templates/devcontainer/tmux.conf +6 -0
  337. package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
@@ -0,0 +1,84 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:br-recipe
4
+ type: recipe
5
+ status: ready
6
+ rulebook: specdojo:br-rulebook
7
+ sample: specdojo:br-sample
8
+ ---
9
+
10
+ # ビジネスルール 作成レシピ
11
+
12
+ Business Rule Writing Recipe
13
+
14
+ 業務担当者の判断を、実装と検証へ引き継げる条件・結果に具体化するための作成手順です。特に境界、欠損、競合する条件と未決事項を掘り下げます。
15
+
16
+ ## 1. このレシピの使い方
17
+
18
+ - 上位の業務目的から、この判断が誤った場合に誰が何に困るかを確認する。
19
+ - 入力と期待する結果を対にして書き、判断の仕方を業務用語で説明する。画面操作や保存方式は、それを定める後続成果物へ渡す。
20
+ - 根拠文書・規則・判定例を結び、判断が変わったときに影響箇所を追えるようにする。不足する根拠は業務担当者への問いに戻す。
21
+
22
+ ## 2. 作成前に集める情報
23
+
24
+ | 項目 | 集める情報・問い |
25
+ | -------- | ---------------------------------------------------------- |
26
+ | 利用場面 | 誰がどの業務の途中で判断し、誤判定で何が起きるか |
27
+ | 境界 | 直前までに何が確定し、直後にどの業務へ結果を渡すか |
28
+ | 判断材料 | 必要な概念項目、単位、比較時点、入力の出所 |
29
+ | 結果 | 正常な結果、対象なし、判定できない場合をどう見分けるか |
30
+ | 根拠 | 決定済みの条件、参照文書とその作成状況、承認が要る変更 |
31
+ | 未決事項 | 誰へ何を判断してもらい、いつまでに決まらないと何が止まるか |
32
+
33
+ ## 3. 全体の作成手順
34
+
35
+ 1. 概要で「どの場面で何を判断するか」を一文にし、守る価値と対象外を添える。
36
+ 2. 入力で、最初の具体例に必要な項目を書き出す。単位と比較時点をそろえる。
37
+ 3. ルール(判定/計算)で、その例の結果になる理由を条件に変換する。等号・同順位・未設定の例へ広げ、適用順を決める。
38
+ 4. 出力で、結果を受け取る相手が次の業務を選べる意味を添える。
39
+ 5. 例外 / 異常系で、入力不備と参照失敗を通したときに、業務が続くかを確かめる。
40
+ 6. メモ / 将来課題へ根拠不足と未決の判断を集め、依頼先、判断時点、下流の制約を残す。
41
+
42
+ ## 4. 各章の書き方
43
+
44
+ | 章 | 書き手が答える問い | 具体化のコツ |
45
+ | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------ |
46
+ | 概要 | この判断は誰のどの困りごとを減らすか。前後の手順と重複しないか | 実際の利用場面を一つ選び、開始条件と対象外を切り分ける |
47
+ | 入力 | その材料が一つ欠けても判断できるか。どの時点の数値を使うか | 項目を一つずつ隠して、仮のゼロで代用していないか調べる |
48
+ | ルール(判定/計算) | なぜその結果になるか。条件が同時成立したらどちらを優先するか | 境界の直前・一致・直後を並べ、期待値の異なる理由を説明する |
49
+ | 出力 | 結果を受け取る人は何を判断できるか。対象なしと失敗を区別できるか | 結果の意味を言葉にし、利用先に不要な内部計算値を除く |
50
+ | 例外 / 異常系 | 間違った値を使い続けた場合の業務影響は何か | 停止・代替・対象外のそれぞれで、結果の有効性と回復の行動を確認する |
51
+ | メモ / 将来課題 | どの証拠または誰の判断があれば確定できるか | 現行範囲を変える論点と、確認作業だけの不足を分けて依頼する |
52
+
53
+ ## 5. 深掘り手順
54
+
55
+ 1. 代表例を業務担当者へ説明し、根拠のない条件や、業務価値へつながらない計算を見つける。
56
+ 2. 境界値、欠損、競合する条件で結果が変わる箇所を探す。文字列比較なら大小文字や数字を含む例で同順位の決着が変わらないかを問う。
57
+ 3. 順位規則なら一つの項目だけが欠ける場合と、全件で計算できない場合を分ける。両者を同じ代替規則にしてよい根拠を確かめる。
58
+ 4. 決められない期待値を作らず、選択肢によって変わる下流の作業とともに判断依頼へ戻す。
59
+
60
+ ## 6. 良い例 / 悪い例
61
+
62
+ | 観点 | 良い例 | 悪い例 | 良し悪しを分ける点 |
63
+ | ---------- | ---------------------------------------------------------------------------------- | ------------------------ | ---------------------------------- |
64
+ | 境界 | 「発注点と等しければ不足なし」 | 「少なければ不足」 | 等号で結果を確定できるか |
65
+ | 入力の不足 | 「予約数がないと販売可能数を算出できない」 | 「空欄はたぶんゼロ」 | 業務根拠のある扱いか |
66
+ | 利用先 | 「不足判定を在庫確認担当へ返す。発注確定は担当者が行う」 | 「不足なら自動発注する」 | 判断から別の責務へ飛躍していないか |
67
+ | 未決事項 | 「閾値変更は店主代表に導入承認前の判断を依頼する。未決なら新閾値の実装を保留する」 | 「閾値は後で考える」 | 次の判断と影響が追えるか |
68
+
69
+ ## 7. レビュー観点
70
+
71
+ | 観点 | 確認する問い |
72
+ | ------------ | ------------------------------------------------------------------ |
73
+ | 業務的な理由 | 主要な条件がどの課題・価値・決定に由来するか説明できるか |
74
+ | 再現性 | 二人が同じ具体例に別の期待値を付ける余地はないか |
75
+ | 引継ぎ | 正常結果と例外から、利用者が次に行う業務を選べるか |
76
+ | 責務境界 | 手順、構文、保存構造を、それを定める成果物へ委譲できているか |
77
+ | 判断待ち | 未決事項の影響する規則・例と、判断を依頼する相手を結び付けられるか |
78
+
79
+ ## 8. 仕上げチェック
80
+
81
+ - 概要から入力、判定、出力、例外、残る判断へ読み進めて、参照していない材料や使われない結果がない。
82
+ - 判定例は本文で説明した条件から導け、未決の期待値を確定済みの値として示していない。
83
+ - 同じ条件を表・文章・擬似コードで繰り返さず、変更する箇所を一つに絞れている。
84
+ - 上位の目的の再掲と実装の詳細を整理し、必要な根拠の参照と未決事項の引継ぎが残っている。
@@ -17,7 +17,7 @@ Conceptual Data Flow Diagram Use Case Writing Recipe
17
17
 
18
18
  - 全体概要からケース ID、業務目的、参加単位、開始・終了を抜き出します。
19
19
  - 目的、適用範囲、役割表、データストアの部分集合を作り、上から下へ進む図で受け渡しを示します。
20
- - 最後に表と図の名称・順序、全体概要との境界、有効な参照先を確認します。業務上重要な戻りだけ、任意の図を追加します。
20
+ - 最後に表と図の名称・順序、全体概要との境界、有効な参照先を確認します。対象範囲の例外時の戻りを漏れなく図にし、線が多ければ図を分けます。
21
21
 
22
22
  ケース ID、参加単位の名称・領域 ID、データストア名を軸に、範囲・表・図を対応させます。引き渡し ID を追加せず、情報・物の名前を線のラベルにします。
23
23
 
@@ -27,27 +27,29 @@ Conceptual Data Flow Diagram Use Case Writing Recipe
27
27
  | ------------ | ---------------------------------------------------------------------------- |
28
28
  | 対象ケース | 全体概要にあるケース ID、業務名、業務目的 |
29
29
  | 描く単位 | rulebook の「描き方の選択」で決める参加単位と詳細化の境界 |
30
+ | 共通の領域 | 複数の系統が共通して通る領域と、内部を描く 1 か所の正本・その参照先 |
30
31
  | 開始と終了 | 開始する出来事と、最後に利用可能になる成果 |
31
32
  | 役割と順序 | 全体概要と同じグループ・区分、領域 ID、正常系の通過順、各参加単位の責務 |
32
33
  | 受け渡し | 隣接する参加単位やデータストアの間で渡す情報・物 |
33
34
  | データストア | 全体概要にある名称、マスタ・構成/トランザクションの区分、参照・更新する内容 |
34
- | 共通の約束 | 全体概要の責任分担、凡例、Orchestrator の指示の図 |
35
+ | 共通の約束 | 全体概要の責任分担、凡例(絵文字の有無・割り当て)、Orchestrator の指示の図 |
35
36
  | 参照先 | 有効な全体概要、必要な詳細文書と STSD。status が `deprecated` の文書は除く |
36
- | 重要な戻り | 補完・再判断を担う参加単位、返す不足情報や差異。業務上重要な場合だけ集める |
37
+ | 例外の戻り | 対象範囲のすべての戻り、補完・再判断を担う参加単位、返す不足情報や差異 |
37
38
  | 未決事項 | 境界、名称、責務、判断者が未確定な論点、影響、決定者、決定時期 |
38
39
 
39
40
  ## 3. 全体の作成手順
40
41
 
41
- 1. 全体概要の「詳細 CDFD 一覧」からケースを選び、rulebook の「描き方の選択」で参加単位を決めます。
42
+ 1. 全体概要の「詳細 CDFD 一覧」からケースを選び、rulebook の「描き方の選択」で参加単位を決めます。共通して通る領域の内部を描く正本を全体概要またはその領域の詳細文書の 1 か所に定め、ほかの詳細では 1 ノードと受け渡しの線だけにします。
42
43
  2. その業務が何のためにあるかを、開始からどの成果までを成立させるかという 1〜2 文で書きます。読み手の承認・設計・確認作業は含めません。
43
44
  3. 対象と対象外を 1 行ずつ書き、共通原則は全体概要を参照します。`based_on` と本文の参照先が有効な文書であることを確認します。
44
- 4. 全体概要と同じグループ・区分ごとに節を設け、正常系の順序と責務を役割表だけで示します。PDCA が必要なら独立した任意の列を追加します。
45
+ 4. 全体概要と同じグループ・区分ごとに節を設け、正常系の順序と責務を役割表だけで示します。共通して通る領域の内部の正本を「参照先」に示します。PDCA が必要なら独立した任意の列を追加します。
45
46
  5. 全体概要から、このケースで参照・更新するデータストアを同じ名称・区分で切り出し、関連する参加単位と利用内容を書きます。
46
47
  6. 開始イベント、参加単位、終了の出来事を上から下へ並べ、渡す情報・物の名前を線のラベルにします。D2 は `direction: down` とし、引き渡し条件のイベントや Orchestrator は置きません。
47
48
  7. データストアを同名ノードで加え、表の各行と図を対応させます。イベントは一ノード一出来事の短い文とし、長ければ原文を保って改行します。
48
- 8. 図に業務の言葉で題を付け、読み取れることを 1 文で説明します。凡例は全体概要への短い参照にします。
49
- 9. 業務上重要な戻りがある場合だけ、「概念データフロー」に「例外時の戻り」の図を追加し、返す情報を線にします。戻りの線は上側のノードを左辺にした `a <- b` で書きます。
50
- 10. ケース ID、名称、領域 ID で範囲・表・図を突き合わせ、内部処理や状態定義・遷移の重複を除きます。
49
+ 8. 図に業務の言葉で題を付け、読み取れることを 1 文で説明します。凡例は全体概要への短い参照にし、ノードの絵文字の有無・割り当てを文書内の全図と系統間でそろえます。
50
+ 9. 対象範囲に例外時の戻りがある場合は、「概念データフロー」に図を追加し、返す情報を重要度で絞らず線にします。戻りの線は上側のノードを左辺にした `a <- b` で書きます。共通して通る領域の内部はその正本へ委ね、外へ返す情報は描きます。
51
+ 10. rulebook の分割の目安(一図の線が 15 本超、または一ノードの入出力が合計 10 本以上)と読みやすさを確認し、正常系は連続する段、戻りは戻り先や段ごとに図を分けます。必要な線を削らず、同じ名称・領域 ID の共有ノードでつなぎます。
52
+ 11. ケース ID、名称、領域 ID で範囲・表・図を突き合わせ、内部処理や状態定義・遷移の重複を除きます。
51
53
 
52
54
  ## 4. 各章の書き方
53
55
 
@@ -78,6 +80,7 @@ Conceptual Data Flow Diagram Use Case Writing Recipe
78
80
  - rulebook の「描き方の選択」に従い、全体概要と同じまとまりの節にしていますか。
79
81
  - 各節は役割表だけですか。主要入力・主要出力・データストアの箇条書きが残っていませんか。
80
82
  - 順序、プロセスグループ・区分、含む領域、横断上の役割、参照先を示していますか。
83
+ - 共通して通る領域の内部を描く正本が 1 か所に定まり、ほかの詳細では 1 ノードと受け渡しの線だけにしていますか。内部の正本を「参照先」に示していますか。
81
84
  - PDCA を示す場合は独立した任意の列にし、全体概要の区分と混同していませんか。
82
85
 
83
86
  表の一行を図の一つのプロセスノードに対応させます。全体概要を名称と領域の正本とし、入力・出力の正本は図にします。
@@ -102,18 +105,21 @@ Conceptual Data Flow Diagram Use Case Writing Recipe
102
105
  - 渡す情報・物を線の名詞ラベルから読み取れますか。条件のイベントや引き渡し ID が残っていませんか。
103
106
  - Orchestrator と調整要求・応答を図から外していますか。
104
107
  - 図の題は業務の言葉ですか。説明は読み取れることの 1 文ですか。
108
+ - 絵文字の有無・割り当ては全体概要の凡例に合い、文書内の全図とほかの系統でそろっていますか。
109
+ - 線数・集中の目安や読みにくさに応じて図を分け、共有ノードから接続を追えますか。
105
110
 
106
111
  D2 は `direction: down` とします。必要な承認は「承認済みの補充依頼」など成果の性質として線に表し、条件の判定ノードは置きません。凡例は全体概要を参照します。
107
112
 
108
- ### 4.6. 例外時の戻りの図(任意)
113
+ ### 4.6. 例外時の戻りの図
109
114
 
110
115
  問い:
111
116
 
112
- - 先行する参加単位へ情報や判断を戻すことが、業務として重要ですか。
117
+ - 対象範囲の戻りをすべて集め、重要度や線の多さを理由に除いていませんか。
113
118
  - 戻す不足情報・差異と、補完・再判断を担う参加単位が線から分かりますか。
114
119
  - 再提示も「修正・承認済みの補充依頼」などの情報として描いていますか。
120
+ - 戻り先や段ごとに図を分けても、必要な戻りと再提示が共有ノードでつながっていますか。
115
121
 
116
- 必要な場合だけ「概念データフロー」の節に追加し、通常の図と名称・領域 ID をそろえます。「引き渡し」「例外時の戻り先」の章や、戻す条件・再開条件の表は作りません。
122
+ 戻りがある場合は「概念データフロー」の節に漏れなく描き、通常の図と名称・領域 ID をそろえます。戻りがない場合だけ図を省略します。共通して通る領域の内部は 1 か所の正本に委ねます。「引き渡し」「例外時の戻り先」の章や、戻す条件・再開条件の表は作りません。
117
123
 
118
124
  ### 4.7. 未決事項(任意)
119
125
 
@@ -128,21 +134,23 @@ D2 は `direction: down` とします。必要な承認は「承認済みの補
128
134
  3. 全体概要の区分と領域 ID を突き合わせ、PDCA の値で区分を置き換えた行を直します。
129
135
  4. データストアを一つずつ確かめ、このケースの情報・物の受け渡しに不要なものを除きます。
130
136
  5. 状態定義・遷移や内部プロセスが残っていれば、責任を持つ有効な文書の参照へ移します。
131
- 6. 戻りの図がある場合だけ、不足情報や差異が補完責任のある参加単位へ届くか確認します。
137
+ 6. 収集した戻りと図を突き合わせ、すべての不足情報や差異が補完責任のある参加単位へ届くか確認します。共通して通る領域の内部は正本の参照で追います。
132
138
  7. D2 を `d2 --layout elk` で SVG に出力し、上下の順序、ノードとラベルの大きさを確認します。読みづらい場合はイベントの改行や図の分割を見直します。
133
139
 
134
140
  ## 6. 良い例 / 悪い例
135
141
 
136
- | 観点 | 良い例 | 悪い例 |
137
- | ----------- | ------------------------------------------------ | -------------------------------------------------- |
138
- | 目的 | 欠品した商品を補充し、売場で販売できるようにする | BA が承認し、QE が検証へ使う |
139
- | 区分と PDCA | 区分は実行サイクル、PDCA は別列で Do | 区分を Do に置き換える |
140
- | 渡す情報 | 在庫から仕入へ「承認済みの補充依頼」を直接つなぐ | 途中に「H-01 受理できる」というイベントを置く |
141
- | イベント | 「在庫が補充基準を下回った」を必要なら改行 | 複数の出来事を一つの長い六角形に詰める |
142
- | 戻り | 仕入から在庫へ「不足項目・商品候補」を返す線 | すべての受け渡しについて戻り先表を必須にする |
143
- | 参照先 | 有効な全体概要を参照する | `deprecated` のグループ別 CDFD を参照する |
144
- | 調整役 | Orchestrator の指示は全体概要の図に任せる | 詳細の図に Orchestrator と各段階への要求を再掲する |
145
- | 状態責務 | 商品状態は STSD を参照する | 未発注から販売可能への状態遷移を本書で定義する |
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 を参照する | 未発注から販売可能への状態遷移を本書で定義する |
146
154
 
147
155
  ## 7. レビュー観点
148
156
 
@@ -152,7 +160,9 @@ D2 は `direction: down` とします。必要な承認は「承認済みの補
152
160
  | 範囲と粒度 | rulebook の「描き方の選択」と全体概要に合う | 業務分析担当 |
153
161
  | 表と図 | 順序・名称・領域 ID が対応し、受け渡しを線から読み取れる | 品質確認担当 |
154
162
  | データ整合 | データストアの名称・区分と凡例が全体概要に合う | 技術メンター、品質確認担当 |
155
- | 戻り | 図が必要な場合だけあり、戻す情報と責任が分かる | 業務責任者、品質確認担当 |
163
+ | 戻り | 対象範囲の戻りに漏れがなく、分割後も戻す情報と責任が分かる | 業務責任者、品質確認担当 |
164
+ | 共通の領域 | 内部の正本が 1 か所に定まり、ほかでは 1 ノードで受け渡す | アーキテクト |
165
+ | 絵文字 | 全体概要の凡例に合わせ、文書内と系統間で有無をそろえる | 品質確認担当 |
156
166
  | 正本の境界 | 調整・状態遷移・内部処理を重複させず、有効な文書を参照する | アーキテクト |
157
167
 
158
168
  確認者の呼称は、対象プロジェクトのロール定義または責任分担文書で正式な担当へ対応付けます。
@@ -162,11 +172,13 @@ D2 は `direction: down` とします。必要な承認は「承認済みの補
162
172
  - 全体概要のケース ID、業務名、目的、名称・領域 ID を引き継いだ。
163
173
  - 目的は業務のための 1〜2 文、適用範囲は対象と対象外が 1 行ずつになっている。
164
174
  - 各節が役割表だけで、区分と任意の PDCA 列を分けた。
175
+ - 共通して通る領域の内部は 1 か所だけで描き、ほかの詳細では 1 ノードと受け渡しの線にして正本を参照した。
165
176
  - 表と図の参加単位、データストアが対応し、開始から終了まで縦に追える。
166
177
  - イベントは一ノード一出来事で短く、入口の原文を保っている。
167
178
  - 受け渡しは線のラベルにあり、引き渡し ID・条件イベント・旧来の引き渡し/戻り先の章がない。
168
179
  - Orchestrator を詳細の図に置かず、全体概要の指示の図へ委ねた。
169
180
  - 図の題は業務の言葉、説明は読み取れることの 1 文で、凡例は全体概要を参照している。
170
- - 戻りの図は業務上重要な場合だけ追加し、条件表や内部の再試行手順を置いていない。
181
+ - 絵文字の有無・割り当てが全体概要の凡例に合い、文書内の全図と系統間でそろっている。
182
+ - 対象範囲の例外時の戻りを省略せず描き、線数・集中の目安や読みやすさに応じて戻り先・段ごとに図を分け、共有ノードで追える。条件表や内部の再試行手順を置いていない。
171
183
  - `based_on` と本文に `deprecated` の参照先がなく、状態定義・遷移を複製していない。
172
184
  - 未決事項がない場合は章を省略し、公開範囲に不適切な情報を含めていない。
@@ -0,0 +1,125 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:cnd-recipe
4
+ type: recipe
5
+ status: draft
6
+ rulebook: specdojo:cnd-rulebook
7
+ sample: specdojo:cnd-sample
8
+ ---
9
+
10
+ # C4コンテナ図 作成レシピ
11
+
12
+ C4 Container Diagram Writing Recipe
13
+
14
+ 利用者が必要とする結果から、実行・配備単位、記録の保管単位、連携経路を選ぶ手順です。機能一覧を図に変換するだけで終わらせず、配置設計と結合検証へ渡せる境界を作ります。
15
+
16
+ ## 1. このレシピの使い方
17
+
18
+ - 上位のコンテキスト図から対象システムの目的と外部への委譲を引き継ぎ、内部のどの実行単位がその責務を担うかを書き出します。
19
+ - 実行単位ごとの入出力と記録先をつなぎ、配置上の前提までを扱います。内部のクラス、API 構文、ホスト構築手順は詳細設計へ渡します。
20
+ - 要素名と関係 ID を手掛かりに、図、定義、制約、未確定事項を対応させます。仮定は根拠のある仕様と分け、確認先を付けます。
21
+
22
+ ## 2. 作成前に集める情報
23
+
24
+ | 入力 | 集める情報・問い |
25
+ | -------------- | ------------------------------------------------------------------------------ |
26
+ | 利用目的・境界 | 誰が何を達成するか。上位図が対象に含める責務と外へ委ねる処理は何か |
27
+ | 実行単位候補 | 別に起動・配備するアプリは何か。一つのアプリ内の機能を別単位と誤認していないか |
28
+ | 記録と生成物 | どれが正本か。誰が更新し、誰がどの時点で読むか |
29
+ | 外部依存 | 常時必要か、特定の操作時だけか。同じ端末にある別ツールも含めたか |
30
+ | 配置前提 | ローカル・リモート、構築時・閲覧時を区別できるか。根拠のない配置案はどこか |
31
+ | 詳細の更新先 | 連携契約、データ構造、内部構成、インフラをどの文書へ渡すか |
32
+ | 合意と判断時点 | どの利用場面を誰と確認するか。下流が着手する前に、誰の判断を得る必要があるか |
33
+
34
+ ## 3. 全体の作成手順
35
+
36
+ 1. 「概要」に上位図の対象、分割の目的、本図の対象外を書きます。新たな提供経路を加える場合は中核責務との関係も説明し、今回合意したい範囲と確認者を整理します。
37
+ 2. 「要素と境界の定義」に実行単位候補を並べ、個別に起動・配備する理由を一言ずつ付けます。理由が機能名だけなら元のアプリへ戻します。
38
+ 3. 正本・生成物・共有先を区別し、保持する情報と直接アクセスする主体を整理します。ファイルを保存する場所と版管理ツールを分けます。
39
+ 4. 利用者の操作から保存・外部依頼・結果確認までをたどり、関係表を作ります。関係 ID、起点、終点、目的、方式、成立する時点、詳細の正本を整理し、上位図の利用目的・外部依存ごとに担当コンテナか対象外の理由を確認します。
40
+ 5. 「C4コンテナ図(Mermaid)」へ要素と関係を描きます。短いラベルにしても構築時だけの接続や任意依存の条件が残るか確かめます。
41
+ 6. 「技術前提・制約と検証観点」に配置設計の前提と結合対象を置きます。経路ごとの正常な結果を決めてから、読取不能・外部停止・応答欠落で区別する状態を関係 ID に結びます。
42
+ 7. 根拠不足の配置・経路は「メモ / 将来課題」へ移します。影響、担当、解消条件、引き継ぎ先を整理し、配置・接続・公開の判断を妨げる論点は ARC から PM へ渡して、PJR の転送先と判断時点を対応させます。
43
+ 8. BA・DEV・QE・OPS へ担当する利用場面や技術前提の確認を依頼し、結果と残る論点を集めます。ARC が PO の判断に必要な材料をまとめ、公開する範囲と承認対象の対応を OPS と確認します。
44
+
45
+ ## 4. 各章の書き方
46
+
47
+ ### 4.1. 概要
48
+
49
+ - 上位図のどのシステムを分解しますか。
50
+ - 分割により、配置や接続について誰が何を判断できますか。
51
+ - サイトなどの派生した提供経路を含める場合、上位図との範囲の違いを説明できますか。
52
+ - 合意したい範囲と利用場面を、どの Role code の確認者へ渡しますか。図を使う Person と設計の確認者を取り違えていませんか。
53
+
54
+ 「販売の入力、記録、印字の配備単位を示す」のように目的を絞ります。「業務に必要なすべての構成」では分割を止める基準がありません。
55
+
56
+ ### 4.2. C4コンテナ図(Mermaid)
57
+
58
+ - 各アプリは別に実行・配備されますか。内部処理を別コンテナにしていませんか。
59
+ - 読み手は線から依頼・参照の向きと情報の意味を説明できますか。
60
+ - 構築時の読取を、閲覧中のネットワーク接続と誤解しませんか。
61
+ - 上位図の各利用目的・外部依存から経路をたどれますか。描かなかった経路にはどのような対象外の理由がありますか。
62
+
63
+ 「公開文書の参照(構築時)」までラベルに残し、矢印が依頼と情報移動のどちらを表すか、応答を同じ線に含めるかを注記します。「データ連携」だけでは、必要なネットワークと実行時点を選べません。
64
+
65
+ ### 4.3. 要素と境界の定義
66
+
67
+ - 境界、Person、Container、Data Store、External Software System、Relationship の順に、図だけで決まらない条件を掘り下げます。
68
+ - コンテナの責務は誰の結果につながりますか。入力を受ける単位と、永続記録を持つ単位を説明できますか。
69
+ - ストアは正本ですか、生成物ですか。更新者は一人だけですか、複数ですか。不明な排他制御を保証していませんか。
70
+ - 同一端末にある外部ツールの管理主体と失敗影響は区別できますか。
71
+ - 図のノード・線と定義行を双方向にたどると、名前・端点・ラベル・境界内外が食い違う箇所はありませんか。関係 ID から詳細の正本へ進めますか。
72
+
73
+ 「販売処理は取引を記録し、印刷基盤は紙面への出力を担う」と責務を分けます。「同じ端末なので一つのアプリ」では境界の判断材料が不足します。
74
+
75
+ ### 4.4. 技術前提・制約と検証観点
76
+
77
+ - 配置設計者が必要とする、書込先、外部実行環境、閲覧先は識別できますか。
78
+ - 経路が正常に成立したとき、入力に対してどの保存内容・生成物・返却結果を照合できますか。
79
+ - 接続を止めたとき、失われる結果と残る記録を何で観測しますか。
80
+ - 実行成功と人間の承認を混同する経路はありませんか。
81
+
82
+ 関係 ID を添えて「保存した控えと紙面が一致するかを確認し、印字失敗でも販売の記録と印字結果を別々に確認する」と書きます。「結合テストをする」だけでは観測対象が決まりません。未確認の期待結果は検証設計への論点に分け、復旧保証や具体的な再試行回数を推測で埋めません。
83
+
84
+ ### 4.5. メモ / 将来課題
85
+
86
+ - 未確認の技術名、接続方式、配備先はどれですか。
87
+ - その不確実さで配置・テストの何が決められませんか。
88
+ - 誰が何を確認すれば仮定を更新でき、どの詳細文書へ反映しますか。
89
+ - 判断を妨げる論点を PM へ渡した後、PJR のどの記録で追えますか。誰が、いつまでに、またはどの下流作業の着手前に判断しますか。
90
+ - 境界を変更・廃止した場合、上位図・コンポーネント図・インフラ構成図と、DEV の連携実装・QE の結合対象のどこへ影響しますか。
91
+
92
+ _ASSUMPTION_: とした配備案には確認条件を付けます。「ARC が配備案を整理し、PM が登録した課題を配備設計の着手前に PO が判断する」まで具体化し、実際の転送先を残します。「配備先未定」だけでは、検討を引き継げません。
93
+
94
+ ## 5. 深掘り手順
95
+
96
+ 1. 一つの利用結果から逆にたどり、必要な処理と保持記録を探します。対応する結果のないコンテナ候補を除きます。
97
+ 2. 上位図の利用目的・外部依存から各関係を「いつ」「誰が起動」「何を渡す」で読み直し、取り残した経路を探します。不明な方式は線を増やして補わず、論点として分けます。
98
+ 3. 正本の更新から閲覧・共有までをたどり、正常な結果を照合する記録、再生成が必要な箇所、障害の影響が止まる境界を特定します。根拠へ戻れない期待結果は確認担当へ渡します。
99
+
100
+ ## 6. 良い例 / 悪い例
101
+
102
+ | 観点 | 良い例 | 悪い例・問題 |
103
+ | ---------- | -------------------------------------------------------- | -------------------------------------------------------------- |
104
+ | 分割理由 | 画面はブラウザで動き、処理サービスはサーバーで動く | 登録・検索・削除をそれぞれコンテナにする。機能と実行単位の混同 |
105
+ | ストア | 文書の正本はファイル群、閲覧用 HTML は生成物とする | すべてを「DB」とし、更新元と派生物を区別しない |
106
+ | 外部依存 | 印刷時だけ印刷基盤へ依頼する | 印刷基盤の停止で全参照も停止すると根拠なく断定する |
107
+ | 未確定配置 | ローカル構築を仮定し、配信先と公開範囲の確認を担当へ渡す | 候補のホストを既存構成のように描く |
108
+
109
+ ## 7. レビュー観点
110
+
111
+ | 観点 | 確認する内容 | 主な確認者 |
112
+ | ------------ | ------------------------------------------------------------ | ---------- |
113
+ | 価値・範囲 | 利用者が得る結果と上位図の境界を分割後も保っているか | BA / PO |
114
+ | 配置入力 | 各実行単位、保持単位、必要な接続と仮定を区別できるか | ARC / DEV |
115
+ | 結合入力 | 主要経路と外部失敗の観測対象を関係 ID で追えるか | QE |
116
+ | 詳細との分担 | 構文・schema・物理配置の更新先が識別できるか | ARC |
117
+ | 判断と公開 | 未決事項の影響・判断時点と、承認範囲・公開対象を照合できるか | PO / OPS |
118
+
119
+ ## 8. 仕上げチェック
120
+
121
+ - 図と表の要素名・関係ラベルをそろえ、説明を重複させず責務・条件を残しましたか。
122
+ - 正本、構築時の入力、閲覧用生成物を区別し、実行時点の違いを説明しましたか。
123
+ - 未確認の配置と経路を仮定として分け、影響・担当・解消条件・転送先・判断時点を追える形にしましたか。
124
+ - 記法・メタ情報の検査結果と描画の確認結果を集め、内容のレビュー結果と併せて残る指摘を識別しましたか。
125
+ - 主要判断と公開可否を、人間が判断する境界として残し、承認・保留の記録と公開対象を照合できるようにしましたか。
@@ -0,0 +1,126 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:cpd-recipe
4
+ type: recipe
5
+ status: ready
6
+ rulebook: specdojo:cpd-rulebook
7
+ sample: specdojo:cpd-sample
8
+ ---
9
+
10
+ # C4コンポーネント図 作成レシピ
11
+
12
+ C4 Component Diagram Writing Recipe
13
+
14
+ 上位コンテナの責務を内部のまとまりへ分け、依存方向と確認すべき境界を見つける手順です。機能名を並べただけの図から、実装と結合設計の判断に使える構成へ具体化します。
15
+
16
+ ## 1. このレシピの使い方
17
+
18
+ - 上位図から、対象コンテナの目的と利用者へ返す結果を取り出します。目的の全文は繰り返さず、分割の理由として使います。
19
+ - 内部の責務、利用者と外部依存への接点、保存する正本を整理し、責任が重なる箇所を分けます。別プロセス化やクラス設計はここで決めません。
20
+ - コンポーネント名と関係 ID を軸に、分割の理由、情報の受け渡し、失敗時の観測点をつなぎます。未確認の依存は確認先とともに引き継ぎます。
21
+
22
+ ## 2. 作成前に集める情報
23
+
24
+ | 情報 | 書き出す問い |
25
+ | ---------- | ---------------------------------------------------------------------------------------- |
26
+ | 上位の境界 | 分解する実行単位はどれか。外部のまま残す利用者・ストア・他システムは何か |
27
+ | 必要な成果 | 利用者は何に困り、どの結果を確認して次へ進むか。期待価値と成功基準の上位参照はどこか |
28
+ | 責務の候補 | 入力の解釈、判断の適用、記録、外部依頼のうち別々に変更・確認したいものは何か |
29
+ | 内容の根拠 | 設計上の決定と実装確認済みの事実を分けられるか。未確認なのに具体化した配置はないか |
30
+ | 結合の論点 | 相手が不在・拒否・応答欠落のとき、どの結果が不明になるか |
31
+ | 詳細化先 | 値・構文・構造・復旧条件を更新する正本と担当はどこか |
32
+ | 確認と合意 | 構成・実装・結合・業務を誰にいつ確認してもらうか。最終合意と公開可否の判断者は誰か |
33
+ | 公開と保守 | 誰にどの媒体で見せるか。公開前に確認する情報と、境界・契約が変わったときの相談先はどこか |
34
+
35
+ ## 3. 全体の作成手順
36
+
37
+ 1. 「概要」に対象コンテナと上位図との対応、分割が必要な理由、今回扱わない範囲を書きます。上位の業務課題・成功基準の参照先を選び、確認者・合意者と公開範囲を整理します。
38
+ 2. 一つの代表依頼について、入力から結果の確認までをたどり、誰が結果を作り、誰が記録するかをメモします。
39
+ 3. 責務の候補を比較し、異なる変更理由・失敗結果を持つまとまりを分けます。名前だけ違って入出力が同じ候補は統合します。
40
+ 4. 「要素と境界の定義」で各まとまりの責務と入出力、論理配置を言葉にし、利用先を決めます。分割・共通化の採用理由を上位の目的または技術制約へ結び付けます。
41
+ 5. 「C4コンポーネント図(Mermaid)」に主要な依頼・依存を描き、関係 ID で授受情報と詳細化先へ接続します。
42
+ 6. 「技術前提・制約と検証観点」で成功と失敗の観測点を選び、「メモ / 将来課題」に未確認箇所の担当・判断者、判断時点と解消条件を残します。
43
+ 7. 図の要素・関係を定義表から逆引きし、差異と省略理由を確かめます。リポジトリの検査設定から対象と期待結果を整理し、構文・描画・参照の確認結果を実行記録へ残します。
44
+ 8. 構成上の確認結果と業務・公開判断の材料を分けて合意者へ渡します。改訂なら、変更した関係から後続設計・実装・検証・作業順への影響をたどり、更新先を決めます。
45
+
46
+ ## 4. 各章の書き方
47
+
48
+ ### 4.1. 概要
49
+
50
+ 対象のコンテナ名を伏せても、分割によって何を判断したいか説明できますか。利用者の課題と成功基準をどの上位記述から引き継ぎますか。構成案と実装の確認済み構成を区別していますか。
51
+
52
+ 確認対象から逆に、構成・実装・結合・業務それぞれの確認者と時点を探します。最終合意者と公開する相手・媒体・範囲を概要にまとめ、役割割当てや合意記録の参照へつなぎます。上位に成功基準が見つからないときは、BA への確認事項にします。
53
+
54
+ 良い例は「交代時に未印字を引き継ぐという上位の成功基準に対応し、保存と印字の責任境界を結合設計へ渡す」です。「販売を管理する」だけでは分割の用途を判断できません。
55
+
56
+ ### 4.2. C4コンポーネント図(Mermaid)
57
+
58
+ 矢印は利用する側から利用される側へ向いていますか。応答を逆依存として足していませんか。上位で外側だった要素を内部へ移していませんか。
59
+
60
+ 一つの正常な依頼と外部応答が欠ける依頼をたどり、確認が必要な経路を選びます。全呼び出しを増やす前に、主要経路を省いて判断が変わるかを考え、選んだ理由と省いた範囲を短く添えます。
61
+
62
+ 良い例は「保存後の印字依頼を主要経路とし、画面内操作は別コンテナの責務として省く」です。「読みやすくするため矢印を減らした」だけでは、欠けた経路の影響を確かめられません。
63
+
64
+ ### 4.3. 要素と境界の定義
65
+
66
+ その責務を削ると誰が結果を作れなくなりますか。二つの要素が同じ記録の更新判断を持っていませんか。論理配置をソースパスと混同していませんか。
67
+
68
+ まず対象コンテナ境界と利用者の接点、次にコンポーネントと論理配置、ストアと外部依存、最後に関係と詳細の正本を整理します。Person・ストア・外部依存が見当たらない場合は、直接の接点が別要素なのか、本当に非該当なのかを上位図から確認します。
69
+
70
+ 入出力は「確認済み販売明細」「保存結果」のように意味で表し、判断する側と記録する側の分界を明らかにします。共通化の候補には、分けたままの場合と比べてどの判断の重複を減らせるかを問い、採用理由を残します。関係ごとに値・構文・構造を管理する正本を探し、未作成なら仮参照と確認先を残します。
71
+
72
+ 良い例は「商品参照と販売記録の保存接点を共通化し、販売可否の判断は会計側に残す」です。「共通処理がすべて判断する」では更新責任を追えません。
73
+
74
+ ### 4.4. 技術前提・制約と検証観点
75
+
76
+ 相手の失敗が起点の成功を取り消す条件は確認済みですか。応答欠落で成功・未実施のどちらかに即断していませんか。正本を変更せず再生成できる派生物は何ですか。
77
+
78
+ 各境界で「与える条件 → 観測する結果」を一組ずつ考え、確認できない期待値は詳細契約へ引き継ぎます。
79
+
80
+ 良い例は「`REL-08` の応答欠落時に、保存済み販売と印字の結果不明を別々に観測する」です。「異常系を確認する」では、どの関係で何を見ればよいか決まりません。
81
+
82
+ ### 4.5. メモ / 将来課題
83
+
84
+ 未確認事項を確定するにはどの根拠が必要ですか。調査する担当と採否を判断する人を分けられますか。いつまでに判断できなければ、どの後続作業や合意を保留しますか。
85
+
86
+ 未確認の主張を仮定・判断待ち・確認作業に分け、共通ラベルで確定事項と区別します。対象要素・関係から影響先をたどり、未発生の懸念か、発生済みの阻害か、変更提案か、決定済みかを整理します。継続追跡する論点は PM へ渡す PJR の参照、未起票なら登録候補の理由・起票担当・判断時点につなぎます。
87
+
88
+ 良い例は「印字応答欠落の回復条件を ARC が整理し QE が観測点を確認する。人間の PO が実装着手前に採否を判断し、未解消なら印字経路を保留する。PM へ PJR 登録候補として渡す」です。「保存を検討」では、次の作業と判断者が決まりません。
89
+
90
+ ## 5. 深掘り手順
91
+
92
+ 1. 出力から入力へ戻り、その出力が必要な利用場面と、作成する責務を確認します。利用されない出力のためだけの分割は見直します。
93
+ 2. 外部依頼の直前と直後で止まった場合を比べ、残る記録と結果不明を区別できるか考えます。
94
+ 3. 共通機構を外した場合に複数の責務へ同じ判断が散らばるかを確かめます。単に同名関数があるという理由では共通化しません。
95
+ 4. 分割・共通化の採用理由を上位の目的または技術制約まで戻って確かめます。根拠を辿れない候補は仮定と確認事項へ戻します。
96
+ 5. 一つの変更を仮定し、上位の境界、内部の責務、関係 ID、詳細契約、結合観測点、作業順のどこが変わるかたどります。更新または更新不要の理由と担当を変更記録へ残し、再描画・再検証する範囲を選びます。
97
+
98
+ ## 6. 良い例 / 悪い例
99
+
100
+ | 観点 | 良い例 | 悪い例 |
101
+ | ---------- | -------------------------------------------------------------------------------- | -------------------------------------- |
102
+ | 分割の理由 | 印字失敗と販売確定を分けて確認するため、印字連携を独立した責務にする | コマンドがあるので同じ数の部品を作る |
103
+ | 依存の意味 | 会計処理が保存済み控えの印字を依頼し、発行結果を受ける | 会計と印字が相互に処理する |
104
+ | 確定度 | 同一プロセス内の論理配置案。実装対応は DEV が確認する | 未調査のソースパスを実装済みとして書く |
105
+ | 障害の分界 | 印字応答欠落時は販売結果と紙面の確認を分ける | エラーなら全部やり直す |
106
+ | 公開判断 | OPS が公開先に応じて本文・図・ラベル・参照先を確認し、残る懸念を人間の PO へ渡す | lint が通ったので公開できる |
107
+ | 改訂の影響 | 保存責務の統合で変わる関係を起点に、データ設計と結合観測点の更新担当を決める | 図だけ差し替えて更新を終える |
108
+
109
+ ## 7. レビュー観点
110
+
111
+ | 観点 | 確認する問い |
112
+ | ------------ | -------------------------------------------------------------------------- |
113
+ | 目的と分割 | 各責務の必要性を上位コンテナの結果へ結び付けられるか |
114
+ | 更新責任 | 同じ結果を二つの部品が別々に確定しないか |
115
+ | 境界の観測 | 外部不在・拒否・応答欠落で、起点が確認すべき結果を区別できるか |
116
+ | 詳細への委譲 | 値や構文を変えたとき、本図にも同じ変更が必要な重複を作っていないか |
117
+ | 合意の材料 | 技術・業務の確認結果と残る論点から、判断者が承認・保留・差し戻しを選べるか |
118
+ | 追従の範囲 | 上位境界・外部契約の変更から、図・定義表と後続設計の更新先を辿れるか |
119
+
120
+ ## 8. 仕上げチェック
121
+
122
+ - 図から定義表、定義表から図へ照合し、全要素・関係 ID の対応と省略理由を確認したか。
123
+ - 実装未確認の配置、外部連携の保証、未決の業務判断を仮定や論点として区別したか。
124
+ - 引き継ぎ先・担当・判断者と判断時点が特定でき、未解消時に進められる作業と保留する作業を説明できるか。
125
+ - メタ情報・参照・構文と描画の確認記録を辿れ、ラベル欠け・重なり・境界の誤読を解消したか。
126
+ - 公開する本文・図・ラベル・参照先に残る非公開情報の懸念を OPS と確認し、人間の PO が公開先と可否を判断する材料を用意したか。