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
@@ -4,290 +4,120 @@ specdojo:
4
4
  type: rulebook
5
5
  deliverable_type: architecture
6
6
  status: draft
7
- recipe: undecided
7
+ target_format: markdown
8
+ includes:
9
+ - specdojo:cnd-mermaid-rulebook
10
+ recipe: specdojo:cnd-recipe
8
11
  sample: specdojo:cnd-sample
9
- template: undecided
12
+ template: specdojo:cnd-template
13
+ based_on:
14
+ - specdojo:rulebook-authoring-standard
10
15
  ---
11
16
 
12
- # C4コンテナ図 ドキュメント作成ルール
17
+ # C4コンテナ図(CND)作成ルール
13
18
 
14
- C4 Container Diagram (CND) Documentation Rules
19
+ C4 Container Diagram (CND) Authoring Rule
15
20
 
16
- 本ドキュメントは、アーキテクチャ設計のために **C4コンテナ図と、その図を説明する文章**を、統一した粒度・表現で作成するためのルールです。
17
-
18
- この章の成果物は、次の2つをセットで扱います。
19
-
20
- - **C4コンテナ図(Mermaid)**: 対象システムを主要コンテナ(実行/配備単位)に分割し、利用者・外部システム・データストアとの関係を俯瞰で合意する
21
- - **説明(Markdown)**: 図の要素(人/境界/コンテナ/DB/外部/関係)の意味を文章で合意する
22
-
23
- Mermaid 記法そのもののルールは [cnd-mermaid-rulebook.md](cnd-mermaid-rulebook.md) を参照してください。
21
+ 対象システムを主要な実行・配備単位とデータストアに分け、責務、接続、配置上の前提を定義する規約です。インフラ設計と結合テストへ渡す境界を扱い、内部実装や連携構文は各正本へ委ねます。
24
22
 
25
23
  ## 1. 全体方針
26
24
 
27
- - CND は「対象システムが、どの実行/配備単位(コンテナ)で構成され、何とやり取りするか」を合意するための図である。
28
- - 図に入れるのは **コンテナ粒度**までとし、コンポーネント/クラス等の内部構造や実装詳細は含めない。
29
- - 1つの図には **対象システムを1つ**だけ置く(複数対象がある場合は図を分ける)。
30
- - 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
31
-
32
- ## 2. ファイル命名・ID規則
33
-
34
- - ファイル名: `cnd-<番号>-<短い日本語名>.md`
35
- - 例: `cnd-010-駄菓子屋きぬや販売管理システム-コンテナ.md`
36
- - Frontmatter:
37
- - `id`: 小文字ハイフン形式(例: `cnd-candy-shop-sales-container`)
38
- - `title`: 「〇〇のC4コンテナ図」のように対象が分かる表現
39
-
40
- ## 3. 推奨 Frontmatter 項目
41
-
42
- Frontmatter の共通ルールは [document-metadata-standard.md](../standards/document-metadata-standard.md) に従います。
43
-
44
- | 項目 | 説明 | 必須 |
45
- | ---------- | ---------------------------------------------- | ---- |
46
- | id | ドキュメントID(小文字ハイフン) | ○ |
47
- | type | `architecture` 固定 | ○ |
48
- | title | ドキュメント名 | ○ |
49
- | status | `draft`/`ready`/`deprecated` | ○ |
50
- | part_of | 上位ドキュメントID(分割している場合) | 任意 |
51
- | based_on | 根拠となる定義(用語集、外部IF、上位方針など) | 任意 |
52
- | supersedes | 置き換え関係(古い図→新しい図) | 任意 |
53
-
54
- ### 3.1. `based_on` の考え方(例)
55
-
56
- - 用語集(`gl-...`)や業務データ辞書(`bdd-...`)
57
- - 外部システムIFの仕様(IF章のドキュメント)
58
- - 参照する上位の方針(DEC、非機能要件など)
59
-
60
- ## 4. CNDで合意すること(スコープ)
61
-
62
- ### 4.1. 合意したいこと
63
-
64
- - 対象システムの境界(System Boundary)と、責務の一言(何をするシステムか)
65
- - 主要コンテナ(Container)の一覧と、それぞれの責務(1〜2文)
66
- - 主要DB(Database)がある場合、その役割(何を永続化するか)
67
- - 外部システム(External Software System)と、連携の意図(何をやり取りするか)
68
- - 関係(Relationship)の向きと意味(誰が主に呼び出す/依存するか)
69
-
70
- ### 4.2. 合意しないこと(この図で扱わない)
71
-
72
- - コンテナ内部の分解(コンポーネント/クラス、内部モジュール構成)
73
- - APIエンドポイント、HTTPメソッド、リクエスト/レスポンスJSONなどのIF詳細
74
- - 物理テーブル名・物理カラム名・SQL全文
75
- - 実装クラス/関数名、ライブラリ名、具体的な技術選定の列挙
76
- - 画面遷移やクリック手順の逐語列挙
77
-
78
- ## 5. CNDの要素定義(図と文章の両方で説明する)
79
-
80
- この章では、図に描いた要素について **最低限の説明**を併記し、レビュー可能にします。
81
-
82
- ### 5.1. Person(人/ロール)
83
-
84
- Personは、対象システムに対して目的をもって関わる主体(人/役割/組織)です。
85
-
86
- - 書くこと(推奨):
87
- - ロール名(例: 店員、店主、経理担当)
88
- - どのコンテナを、何のために利用するか(例: Webアプリで売上登録を行う)
89
-
90
- - 書かないこと:
91
- - 個人名、UI操作手順の逐語列挙
92
-
93
- ### 5.2. System Boundary(システム境界)
94
-
95
- 境界は「対象システムが責任を持つ範囲」を表します。
96
-
97
- - 書くこと(推奨):
98
- - 境界に含めるもの
99
- - 境界に含めないもの(外部システム/外部サービス等)
100
-
101
- ### 5.3. Container(コンテナ)
102
-
103
- コンテナは、実行/配備単位(例: Webアプリ、API、バッチ)です。
104
-
105
- - 書くこと(必須):
106
- - コンテナ名
107
- - 責務(1〜2文)
108
- - 書くこと(推奨):
109
- - 主な入出力の種類(例: 売上登録、在庫照会)
110
- - 関係するデータストア(例: 販売DBを更新する)
111
- - 書かないこと:
112
- - 内部クラス/関数、モジュール階層の列挙
25
+ - 一つの対象システムを扱い、上位の C4 コンテキスト図の利用者・外部依存・責任分界を引き継ぎます。範囲の拡張や仮定は明示します。
26
+ - コンテナは実行・配備単位として分け、機能名やソースディレクトリだけを理由に分割しません。データストアはファイル群やリポジトリでもよく、DB 製品の導入を前提にしません。
27
+ - 図は主要経路を、本文は責務・利用条件・技術制約を説明します。図の矢印を文章でなぞる説明は置きません。
28
+ - 記法は `includes` の [[specdojo:cnd-mermaid-rulebook|CND Mermaid 記法ルール]] に従います。形状・色・構文は本書で再定義しません。
29
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
113
30
 
114
- ### 5.4. Database(データベース)
31
+ ## 2. 位置づけと用語定義
115
32
 
116
- Database は、対象システム内の主要な永続データストアです。
33
+ コンテナは Docker の利用を意味せず、システム境界は同一端末・同一ネットワークという物理配置とは区別します。
117
34
 
118
- - 書くこと(推奨):
119
- - DBの論理名(例: 販売DB、在庫DB)
120
- - 何を永続化するか(例: 売上・在庫・仕入の記録)
121
- - 書かないこと:
122
- - 物理テーブル名・物理カラム名・SQL
35
+ 上位コンテキスト図は対象システムと外部との境界、本図はその内部構成、コンポーネント図は各コンテナ内部、インフラ構成図は物理配置・ネットワークを扱います。バージョン、コマンド構文、データ構造は技術スタック・リファレンス・schema・外部 IF 仕様を正本とします。
123
36
 
124
- ### 5.5. External Software System(外部システム)
37
+ ## 3. ファイル命名・ID規則
125
38
 
126
- 対象システムの外側にあり、対象システムが連携する相手(既存の別システム、SaaS、決済、会計など)です。
39
+ - 共通規則は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] と [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
40
+ - ファイル名は `cnd-<context>.md` とし、対象を表す英小文字・数字・ハイフンで識別します。プロダクト文書は原則 `docs/<lang>/product/030-architecture/010-c4/` に置きます。
41
+ - プロダクト文書の ID は `cnd-<context>`、プロジェクト文書は `<project-id>:cnd-<context>` とします。H1 に対象名と C4 コンテナ図であることを示します。
42
+ - 関係には文書内で一意な `REL-01` 形式の ID を付け、図の端点名・ラベルと定義表を対応付けます。名称変更だけでは関係 ID を振り直しません。
127
43
 
128
- - 書くこと(推奨):
129
- - 外部システム名(一般名でよい)
130
- - 連携の目的(例: 決済を依頼する、仕訳を送る)
131
- - 連携の方向性(誰が主に呼び出す/依存するか)
132
- - 書かないこと:
133
- - API仕様の詳細、データ項目一覧(それらはIF仕様へ)
134
-
135
- ### 5.6. Relationship(関係)
136
-
137
- 関係は「やり取りの意味」を合意するための線です。CNDでは **すべての関係にラベル**を付けます。
138
-
139
- - 書くこと(必須):
140
- - 方向(誰が主に利用/依存/送信するか)
141
- - ラベル(短い日本語。名詞句または短い動詞句)
142
- - 書かないこと:
143
- - HTTP詳細、データ項目列挙、SQL、実装条件式
144
-
145
- ## 6. 本文構成(標準テンプレ)
146
-
147
- 各 CND 成果物は、以下見出しを順番に並べます。
148
-
149
- 1. 概要
150
- 2. C4コンテナ図(Mermaid)
151
- 3. 要素の説明
152
- 4. 補足
153
-
154
- ## 7. 記述ガイド詳細
155
-
156
- ### 7.1. 概要
157
-
158
- - 「この図が何を表すか」「対象システム」「前提」を1〜3文で書きます。
159
-
160
- ### 7.2. C4コンテナ図(Mermaid)
161
-
162
- - Mermaid のコードブロックで図を記述します。
163
- - Mermaid 記法ルールは [cnd-mermaid-rulebook.md](cnd-mermaid-rulebook.md) に従います。
164
- - 図には、少なくとも以下を含めます。
165
- - Person(いる場合)
166
- - 境界(System Boundary)
167
- - 主要コンテナ(2〜7個程度を目安)
168
- - 主要DB(ある場合)
169
- - 外部システム(ある場合)
170
- - 関係(Relationship。全矢印にラベル)
171
-
172
- ### 7.3. 要素の説明
173
-
174
- - 図に登場する要素を、レビューしやすい粒度で説明します。
175
- - 推奨スタイル:
176
- - `###` レベルの小見出しで要素名(境界/人/コンテナ/DB/外部/関係)
177
- - 1〜3文で意味・前提・境界条件(含む/含まない)を説明
178
-
179
- ### 7.4. 補足
180
-
181
- - 未確定な外部連携、境界が揺れている論点、図を分ける必要がありそうな論点を列挙します。
182
-
183
- ## 8. 命名・記述スタイル
184
-
185
- - 用語はこの図の中で揺らさない(同じコンテナ/外部を別名で呼ばない)。
186
- - ラベルは短くし、長い場合は改行(`<br>`)で読みやすくする(詳細はIF仕様へ)。
187
- - コンテナは「責務が読める短い名前」を優先し、実装都合の命名(内部モジュール名など)に寄せすぎない。
188
-
189
- ## 9. 禁止事項
190
-
191
- 次の記述は、CNDの粒度を超えるため避けます。
192
-
193
- | 項目 | 理由 |
194
- | --------------------------------------- | -------------------------------- |
195
- | 物理テーブル名・物理カラム名・SQL全文 | 図の粒度を超える(DB設計に記述) |
196
- | APIエンドポイント/HTTP/JSON等の詳細 | IF仕様に記述する |
197
- | 実装クラス/関数名、内部モジュールの列挙 | 変更に弱い・合意の対象がずれる |
198
- | 画面遷移やクリック手順の逐語列挙 | UI変更に弱い・図の目的から逸脱 |
199
- | コンポーネント/クラス等の内部構造の詳細 | コンポーネント図/実装設計で表す |
200
- | 矢印ラベルなしの関係 | 何の関係か合意できない |
201
-
202
- ## 10. レビュー観点(チェックリスト)
203
-
204
- - 対象システムは1つに絞れているか
205
- - 境界の内外が説明され、責任分界が曖昧でないか
206
- - 主要コンテナが多すぎず(目安: 2〜7)、過不足なく俯瞰できるか
207
- - Person/外部システム/DBがある場合、必要十分に含まれているか
208
- - すべての関係にラベルがあり、意味が解釈一致するか
209
- - 図が「コンポーネント/実装詳細」や「IF詳細」に踏み込んでいないか
210
-
211
- ## 11. サンプル(簡易)
212
-
213
- ```yaml
214
- ---
215
- id: cnd-candy-shop-sales-container
216
- type: architecture
217
- title: 駄菓子屋きぬや販売管理システムのC4コンテナ図
218
- status: draft
219
- part_of: []
220
- based_on: []
221
- ---
222
- ```
44
+ ## 4. 推奨 Frontmatter 項目
223
45
 
224
- ### 11.1. 概要
46
+ 共通項目の配置・必須条件・型・値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
225
47
 
226
- この図は「駄菓子屋きぬや販売管理システム」を主要コンテナに分割し、利用者・外部システム・DBとの関係を俯瞰します。
48
+ - `type` は `architecture`、主 `rulebook` は `specdojo:cnd-rulebook` とします。記法部品を主 rulebook にしません。
49
+ - `based_on` は上位コンテキスト図など、カタログの `depends_on` の推移閉包にある直接の内容根拠に限ります。共通のプロジェクト文脈は本文で参照します。
50
+ - 仮定は本文で説明し、メタ項目の追加で代用しません。
227
51
 
228
- ### 11.2. C4コンテナ図(Mermaid)
52
+ ## 5. 本文要件
229
53
 
230
- ```mermaid
231
- flowchart LR
232
- %% Person
233
- 店員["👤店員"]
54
+ 見出し順、表の列、記入欄の骨組みは template を正本とし、ここでは各章の意味要件を定めます。
234
55
 
235
- %% External Systems
236
- 会計システム["会計システム"]
237
- 決済サービス["決済サービス"]
56
+ | 章の役割 | 必須 | 満たす内容 |
57
+ | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
58
+ | 概要 | 必須 | 対象、上位図との対応、利用目的、対象外を示す |
59
+ | 構成図 | 必須 | 一つのシステム境界に主要コンテナとストアを置き、直接利用者と外部依存を結ぶ。全関係にラベルを付ける |
60
+ | 要素・境界の定義 | 必須 | 境界内外、利用者の接点、コンテナの責務・技術区分・配置前提、ストアの正本と生成物、外部依存の利用条件・失敗影響、関係の方式と詳細の正本を説明する |
61
+ | 技術前提・検証対象 | 必須 | 実行時と構築時、ローカルとリモート、読み書きの境界を区別する。結合確認の対象を関係 ID または要素名で識別する |
62
+ | 未確定事項の引き継ぎ | 条件付き | 仮定・未確定の経路・配置がある場合、論点、影響する要素・関係、当面の扱いと解消条件を残す |
238
63
 
239
- %% Target System Boundary
240
- subgraph 境界["対象システム"]
241
- Webアプリ("Webアプリ<br>(レジ/管理画面)")
242
- API("API<br>(販売/在庫)")
243
- 販売DB[("販売DB")]
244
- end
64
+ Person・外部システム・ストアが該当しない場合は、その旨と理由を定義欄へ記載します。主要コンテナは 2〜7 個程度を目安としますが、数に合わせて未根拠の実行単位を追加しません。
245
65
 
246
- %% Relationships
247
- 店員 -->|"売上登録"| Webアプリ
248
- Webアプリ -->|"API呼び出し"| API
249
- API -->|"売上データ"| 販売DB
66
+ ## 6. 記述ガイド
250
67
 
251
- API -->|"会計仕訳連携"| 会計システム
252
- API -->|"決済依頼"| 決済サービス
253
- 決済サービス -->|"決済結果"| API
68
+ 共通のメタ情報・用語は上位標準を参照し、本章では CND 固有の判断だけを扱います。
254
69
 
255
- %% Styles
256
- classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
257
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
258
- classDef external fill:#e9ecef,stroke:#495057,color:#000;
259
- class 店員 person;
260
- class Webアプリ,API,販売DB system;
261
- class 会計システム,決済サービス external;
262
- style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
263
- ```
70
+ ### 6.1. 概要
264
71
 
265
- ### 11.3. 要素の説明
72
+ - 上位図のどの対象を分解し、誰がどの利用場面で配置・結合の何を判断するかを示します。
73
+ - 上位図が扱わない閲覧経路などを加える場合は、中核責務を変えるのか、派生した提供経路なのかを説明します。
74
+ - 図中の Person はシステムの利用接点を表し、設計の確認者一覧とは区別します。
75
+ - 良い例: 「販売システムを画面、処理サービス、記録ストアへ分け、店頭入力から保存までを示す」。悪い例: 「便利なシステムの全体像」。後者は対象と分割の目的を判定できません。
266
76
 
267
- #### 11.3.1. 境界(System Boundary)
77
+ ### 6.2. C4コンテナ図(Mermaid)
268
78
 
269
- 境界には販売管理システム本体(Webアプリ/API/販売DB)を含みます。会計や決済の処理そのものは境界の外側です。
79
+ - 責務と実行・配備単位で候補を選びます。構築時だけ成立する線や任意の外部依存は、ラベルまたは注記で条件を示します。
80
+ - 良い例: 「サイト → 文書ストア: 公開対象文書の参照(構築時)」。悪い例: 「サイト → 文書ストア: 連携」。後者では稼働中にストアへアクセスする必要があるか判断できません。
81
+ - 矢印が依頼の方向か情報移動の方向かを注記し、応答を省略する場合も意味が通るようにします。
82
+ - 「主要経路」は上位図の各利用目的・外部依存を実現する経路とします。各経路の担当コンテナを特定し、描かない経路は対象外の理由を示します。数の目安だけで要素や関係を省きません。
270
83
 
271
- #### 11.3.2. Person(人/ロール)
84
+ ### 6.3. 要素と境界の定義
272
85
 
273
- 店員が売上登録などの業務のために Webアプリを利用します。
86
+ - 境界、Person、Container、Data Store、External Software System、Relationship に分けて説明します。名称と関係ラベルは図と一致させます。
87
+ - コンテナごとに責務、実行・配備形態、既知の技術区分を示します。未確認の技術名やホストは仮定とし、内部モジュールは列挙しません。
88
+ - 推奨する関係表の列は「関係 ID」「起点 → 終点」「図中ラベル」「方式・条件と情報の要点」「詳細の正本」です。構文やフィールド一覧は参照先へ委ねます。
89
+ - 良い例: 「文書リポジトリは仕様の正本を保持し、閲覧用サイトはその生成物を配る」。悪い例: 「GitHub DB に全データを保存」。後者はファイル、版管理機構、共有サービスを混同しています。
90
+ - 外部依存は常時必須か、機能選択時だけ必要かを示します。ストアの直接更新者が複数ある場合、線の省略を単独書込の保証にしません。
91
+ - 図の全ノードに定義を、全関係に一意な関係 ID と定義行を対応付けます。図と表の起点・終点・ラベル・境界内外が一致することを合格条件とし、表だけに残った要素・関係も解消します。
274
92
 
275
- #### 11.3.3. Container(コンテナ)
93
+ ### 6.4. 技術前提・制約と検証観点
276
94
 
277
- Webアプリは店舗業務の入力・参照を担い、APIは販売/在庫の主要ロジックと外部連携の窓口を担います。
95
+ - 配置設計に必要な入力と、決まっていない入力を分けます。ホスト台数・ポート・製品バージョンを埋めて合意済みと扱いません。
96
+ - 関係 ID を使い、保存・生成・外部呼び出しなどの結合対象と観測する結果を示します。テストケースや復旧手順の詳細までは定義しません。
97
+ - 下流の結合検証へ渡す各経路には正常時の結果を、外部依存・保存先には不在・失敗・結果不明時に区別する状態を記します。未確定の期待結果は検証済みの保証にせず、引き継ぐ論点にします。
98
+ - 良い例: 「構築時の読取不能と公開済みサイトの参照を分けて確認する」。悪い例: 「結合テストを実施する」。後者は対象と失敗の影響を識別できません。
278
99
 
279
- #### 11.3.4. Database(データベース)
100
+ ### 6.5. メモ / 将来課題
280
101
 
281
- 販売DBは売上などの主要記録を永続化します(詳細な物理設計はDB設計に記載)。
102
+ - `_ASSUMPTION_` と確定事項を分離し、論点、影響する要素・関係、当面の扱いと解消条件を記録します。
103
+ - 境界・コンテナ・接続の変更が、上位図、下位コンポーネント図、インフラ構成図、連携契約、結合検証のどこへ影響するかを示します。
104
+ - 良い例: 「配信先と公開範囲は未確定。サイトの配備と閲覧経路を確定できないため、候補が公開範囲を満たすか確認し、配置と接続条件へ反映する。それまではローカル構築だけを扱う」。悪い例: 「配信は後で考える」。後者は影響と解消条件が分かりません。
282
105
 
283
- #### 11.3.5. 外部システム(External Software System)
106
+ ### 6.6. 検証・承認前の確認
284
107
 
285
- APIは会計システムへ仕訳相当情報を連携し、決済サービスへ決済を依頼して結果を受信します(詳細はIF仕様に記載)。
108
+ 配置設計・結合検証へ渡す内容を次の順に確認します。
286
109
 
287
- ### 11.4. 補足
110
+ | 確認 | 手順 | 合格条件 |
111
+ | ---------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
112
+ | 範囲と経路 | 上位図の利用目的・外部依存から、担当コンテナと経路をたどる | 各経路が図に対応し、描かない経路には対象外の理由がある |
113
+ | 要素と境界 | 図の文字・矢印・境界を読み取り、定義表と双方向に照合する | 「要素と境界の定義」の対応条件を満たし、境界内外と関係の向きを判読できる |
114
+ | 結合対象 | 関係 ID ごとに正常時と不在・失敗・結果不明時の観測結果を「技術前提・制約と検証観点」と照合する | 下流へ渡す全経路に正常時の結果があり、保存先・外部依存では異常時の状態と保持される記録を区別できる |
288
115
 
289
- - 会計連携の頻度(リアルタイム/日次)を確定する。
116
+ 未確認の期待結果は検証済みと扱わず、論点と影響を「メモ / 将来課題」に残します。不一致は修正し、確認できない経路は理由と後続作業の制限を記して未判定とします。
290
117
 
291
- ## 12. 参照
118
+ ## 7. 禁止事項
292
119
 
293
- - Mermaid 記法(CND): [cnd-mermaid-rulebook.md](../rulebooks/cnd-mermaid-rulebook.md)
120
+ - 機能一覧・クラス・関数・ソース階層を、そのままコンテナとして描くこと。
121
+ - ストアのファイル群と、Git の履歴操作、リモート共有サービスを一つの実行単位として混同すること。
122
+ - IF の引数・ペイロード、schema の項目一覧、SQL、技術スタックのバージョン一覧を転載すること。
123
+ - 構築時だけの関係を常時接続として示すこと、または根拠のない配置・再試行・保存保証を確定事項として書くこと。
@@ -13,160 +13,74 @@ specdojo:
13
13
 
14
14
  Cutover Plan Index Documentation Rules
15
15
 
16
- 本ドキュメントは、カットオーバー計画(本番切替手順)の全体SSOTである `cop-index` を統一形式で記述するためのルールです。
17
- 当日の切替を分単位で実行できる状態にし、責任分界とロールバックを明確にするための内容を定義します。
16
+ カットオーバー計画の全体SSOT `cop-index` を、当日の切替を分単位で実行でき、判断・責任・ロールバックが明確な形で記述する基準を定めます。
18
17
 
19
18
  ## 1. 全体方針
20
19
 
21
- `cop-index` は、当日の切替を分単位で実行可能にし、判断と責任の所在を明確にするためのSSOTとする。
20
+ - **分冊との関係**: 分冊(`cop-<term>`)がある場合も、全体前提と判断体系は `cop-index` を正とし、分冊は対象固有の手順に限る。
21
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項と当日の課題の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint・スキーマ検証はリポジトリの検証で扱います。
22
22
 
23
- - 当日タイムラインと作業手順を時系列で定義する。
24
- - 切替判定ポイント(GO/NO-GO)を明記する。
25
- - ロールバック手順を具体的かつ実行可能に記述する。
26
- - 担当者、連絡系統、エスカレーションを明確にする。
27
- - 周知(ユーザ通知、停止告知)の手順を必須で含める。
28
- - 分冊(`cop-<term>`)がある場合でも、全体前提と判断体系は `cop-index` を正とする。
23
+ ## 2. 位置づけ
29
24
 
30
- ## 2. 位置づけと用語定義(必要に応じて)
25
+ | 成果物 | `cop-index` との関係 |
26
+ | ------------------------- | ------------------------------------------------ |
27
+ | `mip-index` | 成功条件・骨格・判定点・ロールバック方針を受ける |
28
+ | `dmd-index`, `dmd-<term>` | データ移行の手順と所要時間を受ける |
29
+ | `mtp-index`, `mtp-<term>` | リハーサルの結果で時刻と判定条件を確かめる |
30
+ | `otp-index`, `otp-<term>` | 切替後の監視・運用窓口へ引き渡す |
31
31
 
32
- `cop-index` と他ドキュメントの関係を示す。
33
-
34
- - `mip-index`: 移行の合意、判断のSSOT(成功条件、カットオーバー骨格)。
35
- - `dmd-index`, `dmd-<term>`: データ移行の詳細設計(マッピング、変換、検証)。
36
- - `mtp-index`, `mtp-<term>`: リハーサル計画、検証設計(観点、手順、証跡)。
37
- - `cop-index`: 当日実行の詳細手順(Runbook)。
38
- - `otp-index`, `otp-<term>`: 運用切替の詳細(監視設定、運用手順、窓口)。
39
-
40
- 必要に応じて用語を定義し、命名ゆれを防ぐ。
32
+ 関係先が変わったとき、または本書の判定点・時刻・手順を変えたときは、影響を受ける側を「関連ドキュメント」に挙げて見直す。
41
33
 
42
34
  ## 3. ファイル命名・ID規則
43
35
 
44
- - `id` は `cop-index` とする。
45
- - 推奨ファイル名は `cop-index` とする。
46
- - プロジェクト内の実ファイル名は一意になるよう命名する。
36
+ - `id` は `cop-index`(プロジェクト固有の成果物は `<project-id>:cop-index`)とし、成果物カタログの宣言と一致させる。
37
+ - ファイル名は `cop-index.md` とする。
47
38
 
48
39
  ## 4. 推奨 Frontmatter 項目
49
40
 
50
- ### 4.1. 設定内容
51
-
52
- Frontmatter は共通スキーマに従う。
53
-
54
- - 参照: `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
55
- - 参照: [document-metadata-standard.md](../standards/document-metadata-standard.md)
41
+ 許可キー・必須項目は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
56
42
 
57
- | 項目 | 説明 | 必須 |
58
- | ---------- | -------------------------------- | ---- |
59
- | id | `cop-index` | ○ |
60
- | type | `operations` 固定 | ○ |
61
- | title | カットオーバー計画: 全体 | ○ |
62
- | status | `draft` / `ready` / `deprecated` | ○ |
63
- | based_on | 根拠となる仕様ID(配列) | 任意 |
64
- | supersedes | 置き換え関係(配列) | 任意 |
43
+ - `specdojo.type` は `operations`、`specdojo.rulebook` は `specdojo:cop-index-rulebook` とし、`title` は置かない。
44
+ - `specdojo.based_on` には切替判断に直接使った作成済み成果物だけを記載する。
65
45
 
66
- ### 4.2. 推奨ルール
46
+ ## 5. 本文要件
67
47
 
68
- - `based_on` には切替判断に直接利用した成果物のみを列挙する。
69
- - `based_on` と `supersedes` は配列で記載する。
48
+ 本文は次の10章をこの順序で置き、すべて必須とします。
70
49
 
71
- ## 5. 本文構成(標準テンプレ)
72
-
73
- `cop-index` は以下の見出し構成を順序固定で配置する。
74
-
75
- | 番号 | 見出し | 必須 |
76
- | ---- | ---------------------------- | ---- |
77
- | 1 | 概要(index) | ○ |
78
- | 2 | 当日タイムライン | ○ |
79
- | 3 | 作業手順チェックリスト | ○ |
80
- | 4 | 担当者、連絡系統 | ○ |
81
- | 5 | 実施条件(事前完了条件) | ○ |
82
- | 6 | 切替判定ポイント(GO/NO-GO) | ○ |
83
- | 7 | ロールバック手順 | ○ |
84
- | 8 | 障害時判断、エスカレーション | ○ |
85
- | 9 | 周知(ユーザ通知、停止告知) | ○ |
86
- | 10 | 関連ドキュメント | ○ |
50
+ | 章 | 内容・受入条件 |
51
+ | ---------------------------- | --------------------------------------------------------------------------------------------- |
52
+ | 概要(index) | 切替対象・目的と、対象外のシステム・業務・作業を1〜3行で示す |
53
+ | 当日タイムライン | 列は「時刻(相対) / イベント / 完了条件 / 判定点」。分単位で書く |
54
+ | 作業手順チェックリスト | 列は「手順 / 作業内容 / 実施者 / 証跡 / 備考」。順序付きで書く |
55
+ | 担当者、連絡系統 | 列は「役割 / 担当 / 連絡先 / 備考」。エスカレーション先を含める。個人名に代えてロールでもよい |
56
+ | 実施条件(事前完了条件) | 事前に完了している条件と、未達時の扱い(延期、代替手順)と判断者 |
57
+ | 切替判定ポイント(GO/NO-GO) | 列は「判定点 / 条件 / 判断者 / 失敗時の扱い」。失敗時はロールバック・延期・代替手順のいずれか |
58
+ | ロールバック手順 | 発動条件、復旧方針(旧系復帰、接続戻しなど)、手順ごとの実施者・証跡・完了条件 |
59
+ | 障害時判断、エスカレーション | 重大度・SLO逸脱・復旧見込みの判断基準と、連絡経路 |
60
+ | 周知(ユーザ通知、停止告知) | 通知対象・手段・時期、停止時間・影響範囲・問い合わせ先、配信の証跡、計画変更時の再周知 |
61
+ | 関連ドキュメント | 分冊と見直し対象への導線。分冊がなければ `(本書のみ)` と書く |
87
62
 
88
63
  ## 6. 記述ガイド
89
64
 
90
- ### 6.1. 概要(index)
91
-
92
- - 切替対象と目的を1〜3行で示す。
93
- - `mip-index` の骨格、判定点、ロールバック方針と整合させる。
94
-
95
- ### 6.2. 当日タイムライン
96
-
97
- - 分単位で時刻を記述する(相対時刻を推奨)。
98
- - 完了条件と判定点(GO1, GO2...)を明記する。
99
-
100
- 推奨フォーマット:
101
-
102
- | 時刻(相対) | イベント | 完了条件 | 判定点 |
103
- | ------------ | -------- | -------- | ------ |
104
-
105
- ### 6.3. 作業手順チェックリスト
106
-
107
- - 作業を順序付きで列挙する。
108
- - 実施者と証跡(ログ、チケット、チェック欄)を含める。
109
-
110
- 推奨フォーマット:
111
-
112
- | 手順 | 作業内容 | 実施者 | 証跡 | 備考 |
113
- | ---- | -------- | ------ | ---- | ---- |
114
-
115
- ### 6.4. 担当者、連絡系統
116
-
117
- - 担当、責務、連絡経路、エスカレーション先を明記する。
118
- - 個人名を出せない場合はロール名と窓口で表現する。
119
-
120
- 推奨フォーマット:
121
-
122
- | 役割 | 担当 | 連絡先 | 備考 |
123
- | ---- | ---- | ------ | ---- |
124
-
125
- ### 6.5. 実施条件(事前完了条件)
126
-
127
- - 実施前に完了している条件を列挙する。
128
- - 未達の場合の扱い(延期、代替手順、判断者)を明記する。
129
-
130
- ### 6.6. 切替判定ポイント(GO/NO-GO)
131
-
132
- - 判定点、判断基準、判断者を列挙する。
133
- - 失敗時の扱いは「ロールバック、延期、代替手順」のいずれかを明記する。
134
- - `mip-index` の成功条件、GO/NO-GO条件と矛盾させない。
135
-
136
- 推奨フォーマット:
137
-
138
- | 判定点 | 条件 | 判断者 | 失敗時の扱い(ロールバック、延期、代替手順) |
139
- | ------ | ---- | ------ | -------------------------------------------- |
140
-
141
- ### 6.7. ロールバック手順
142
-
143
- - 発動条件を明記する。
144
- - 復旧方針(旧系復帰、接続戻し、投入データ無効化など)を明記する。
145
- - 責務、証跡、完了条件の粒度で実行手順を書く。
146
-
147
- ### 6.8. 障害時判断、エスカレーション
148
-
149
- - 障害時の判断フローと連絡経路を明記する。
150
- - 重大度、SLO逸脱、復旧見込みなどの判断基準を明記する。
65
+ 完成例は Frontmatter の `sample` で宣言された sample を参照してください。
151
66
 
152
- ### 6.9. 周知(ユーザ通知、停止告知)
67
+ ### 6.1. 当日タイムラインと判定点
153
68
 
154
- - 通知対象、通知手段、通知タイミングを明記する。
155
- - 停止時間、影響範囲、問い合わせ先を必ず含める。
156
- - 配信ログ、掲載URL、チケットなどの証跡を残す。
69
+ - **判断基準**: 判定点の時刻・条件・失敗時の扱いが、タイムラインと判定ポイントの表で一致していること。
70
+ - **良い例**: 「T+30分 / 旧系の受付停止 / 未処理の注文が0件 / GO1」と「GO1 / 未処理の注文が0件 / 店主 / 延期(旧系の受付を再開)」。
71
+ - **悪い例**: 「午前中 / 切替作業 / 完了したら次へ」(分単位でなく、判定点もない)。
157
72
 
158
- ### 6.10. 関連ドキュメント
73
+ ### 6.2. 周知
159
74
 
160
- - 分冊がある場合は `cop-<term>` への導線を必ず記載する。
161
- - 分冊がない場合でも `(本書のみ)` を明記する。
75
+ - **判断基準**: 利用者が停止時間・影響・問い合わせ先を判断でき、個人の連絡先などの内部限定情報は「担当者、連絡系統」に閉じていること。
76
+ - **良い例**: 「前日18時に店頭掲示で告知。停止は翌日9時〜10時、その間は現金のみ。問い合わせは店頭窓口」。
77
+ - **悪い例**: 担当者の個人電話番号や内部の作業手順を告知文に書く。
162
78
 
163
79
  ## 7. 禁止事項
164
80
 
165
- | 禁止事項 | 理由 |
166
- | ------------------------------------------ | ---------------------------------- |
167
- | 当日タイムラインが分単位で記載されていない | 実行性が担保できないため |
168
- | ロールバック条件や手順を省略する | 失敗時の判断ができないため |
169
- | 担当者や連絡系統が不明確 | 判断と責任が曖昧になるため |
170
- | 周知(ユーザ通知、停止告知)を未記載にする | 利用者混乱と事故につながるため |
171
- | `cop-index` と分冊の方針に矛盾を作る | SSOTが崩れ、当日参照が割れるため |
172
- | 関連ドキュメントを省略する | 導線が失われ、参照先が分散するため |
81
+ | 禁止事項 | 理由 |
82
+ | ------------------------------------------------ | -------------------------------------- |
83
+ | 当日タイムラインを分単位で書かない | 実行性が担保できないため |
84
+ | ロールバックの発動条件や手順を省略する | 失敗時の判断ができないため |
85
+ | 周知を書かない、または内部限定情報を周知に混ぜる | 利用者の混乱と情報漏えいにつながるため |
86
+ | 判定条件を `mip-index` や分冊と矛盾させる | SSOTが崩れ、当日参照が割れるため |