specdojo 0.8.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (292) hide show
  1. package/.github/agents/specdojo-orchestrator.md +4 -1
  2. package/CHANGELOG.md +77 -0
  3. package/dist/catalog/catalog.js +16 -14
  4. package/dist/commands/agent.js +5 -3
  5. package/dist/commands/build.js +69 -10
  6. package/dist/commands/git.js +206 -0
  7. package/dist/commands/init.js +4 -2
  8. package/dist/commands/orchestrator.js +5 -77
  9. package/dist/commands/where.js +25 -0
  10. package/dist/dashboard/dashboard.js +5 -3
  11. package/dist/dashboard/routines.js +4 -7
  12. package/dist/dashboard/shared.js +2 -2
  13. package/dist/dashboard/timeline.js +14 -14
  14. package/dist/deliverable/trash.js +2 -1
  15. package/dist/docs/index-command.js +2 -2
  16. package/dist/docs/yaml-business-tables.js +243 -0
  17. package/dist/docs/yaml-interface-tables.js +106 -0
  18. package/dist/docs/yaml-pages-command.js +5 -3
  19. package/dist/docs/yaml-pages.js +146 -3
  20. package/dist/docs/yaml-table-shared.js +70 -0
  21. package/dist/docs/yaml-tables.js +39 -0
  22. package/dist/exec/agent-config.js +9 -0
  23. package/dist/exec/agent-protected-config.js +2 -0
  24. package/dist/exec/commands.js +31 -18
  25. package/dist/exec/events.js +34 -14
  26. package/dist/exec/evidence.js +13 -3
  27. package/dist/exec/opencode-permissions.js +117 -0
  28. package/dist/exec/parent-validation.js +56 -3
  29. package/dist/exec/plans-core.js +21 -2
  30. package/dist/exec/plans-generation.js +6 -7
  31. package/dist/exec/post-integration.js +162 -0
  32. package/dist/exec/queue-command.js +166 -0
  33. package/dist/exec/queue.js +285 -0
  34. package/dist/exec/register-foreign-wait.js +82 -0
  35. package/dist/exec/repo-integration-sync.js +17 -5
  36. package/dist/exec/repo-trace.js +2 -1
  37. package/dist/exec/reporter.js +2 -2
  38. package/dist/exec/results.js +24 -4
  39. package/dist/exec/review-kata.js +4 -1
  40. package/dist/exec/run/agent-pipeline.js +3 -2
  41. package/dist/exec/run/agent.js +12 -6
  42. package/dist/exec/run/change-scope.js +365 -0
  43. package/dist/exec/run/deferred-cleanup.js +31 -0
  44. package/dist/exec/run/in-place.js +5 -2
  45. package/dist/exec/run/job-lock.js +66 -0
  46. package/dist/exec/run/job-sequence.js +137 -0
  47. package/dist/exec/run/job.js +56 -19
  48. package/dist/exec/run/lifecycle-commands.js +1 -1
  49. package/dist/exec/run/lock.js +22 -1
  50. package/dist/exec/run/register-command.js +8 -5
  51. package/dist/exec/run/register-mode.js +68 -8
  52. package/dist/exec/run/register-resume.js +68 -14
  53. package/dist/exec/run/register-state.js +13 -8
  54. package/dist/exec/run/register-worktree.js +140 -125
  55. package/dist/exec/run/schedule-mode.js +75 -14
  56. package/dist/exec/run/schedule-prepare.js +3 -0
  57. package/dist/exec/run/schedule-task.js +88 -38
  58. package/dist/exec/run/shared.js +5 -0
  59. package/dist/exec/schedule/schedule.js +116 -4
  60. package/dist/exec/shared.js +2 -2
  61. package/dist/exec/smoke.js +190 -0
  62. package/dist/exec/strategy.js +13 -3
  63. package/dist/exec/task-repos.js +19 -4
  64. package/dist/exec/task-view.js +6 -4
  65. package/dist/exec/trial-commands.js +5 -2
  66. package/dist/exec/trial-core.js +6 -1
  67. package/dist/exec/validation-metrics.js +181 -0
  68. package/dist/exec/worktree-cleanup-lock.js +26 -0
  69. package/dist/exec/worktree-command.js +12 -2
  70. package/dist/exec/worktree-ops-commit.js +2 -2
  71. package/dist/exec/worktree.js +13 -2
  72. package/dist/grade/command-apply.js +3 -3
  73. package/dist/grade/command-inspect.js +5 -3
  74. package/dist/grade/command-plan.js +1 -1
  75. package/dist/grade/command-run.js +5 -1
  76. package/dist/grade/run.js +64 -8
  77. package/dist/job/definition.js +84 -8
  78. package/dist/job/job.js +79 -23
  79. package/dist/register/authoring-sources.js +22 -16
  80. package/dist/register/maintenance-commands.js +2 -2
  81. package/dist/register/register.js +31 -7
  82. package/dist/register/renumber.js +1 -3
  83. package/dist/routine/definition.js +9 -0
  84. package/dist/routine/routine.js +137 -43
  85. package/dist/routine/status.js +62 -0
  86. package/dist/schedule/schedule.js +38 -39
  87. package/dist/shared/agent-types.js +5 -0
  88. package/dist/shared/cross-process-lock.js +9 -1
  89. package/dist/shared/dist-freshness.js +8 -2
  90. package/dist/shared/git-environment.js +2 -1
  91. package/dist/shared/git.js +44 -1
  92. package/dist/shared/lefthook-scaffold.js +3 -0
  93. package/dist/shared/local-config.js +244 -0
  94. package/dist/shared/specdojo-config.js +34 -20
  95. package/dist/shared/specdojo-gitignore.js +1 -0
  96. package/dist/shared/text.js +17 -1
  97. package/dist/shared/where-alias.js +13 -0
  98. package/dist/specdojo.js +4 -0
  99. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  100. package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
  101. package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
  102. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  103. package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +1 -1
  104. package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
  105. package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
  106. package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
  107. package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
  108. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  109. package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
  110. package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
  111. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  112. package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
  113. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  114. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  115. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
  116. package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
  117. package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
  118. package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
  119. package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
  120. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
  121. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
  122. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  123. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  124. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
  125. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
  126. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
  127. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
  128. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
  129. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
  130. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  131. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
  132. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  133. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  134. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  135. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  136. package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
  137. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
  138. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
  139. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
  140. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  141. package/docs/ja/specdojo/references/command-reference.md +258 -118
  142. package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
  143. package/docs/ja/specdojo/references/specdojo-config-reference.md +47 -10
  144. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  145. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  146. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
  147. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
  148. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
  149. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
  150. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
  151. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  152. package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
  153. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
  154. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  155. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  156. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  157. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  158. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
  159. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  160. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
  161. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
  162. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
  163. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  164. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
  165. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  166. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  167. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  168. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
  169. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  170. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
  171. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
  172. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
  173. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
  174. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  175. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  176. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
  177. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  178. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  179. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
  180. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
  181. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  182. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
  183. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
  184. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
  185. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  186. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
  187. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  188. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
  189. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  190. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  191. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  192. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  193. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  194. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
  195. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  196. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  197. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  198. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  199. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  200. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  201. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  202. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  203. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  204. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  205. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  206. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  207. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  208. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  209. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  210. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  211. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
  212. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  213. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  214. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  215. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  216. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
  217. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
  218. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
  219. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
  220. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  221. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
  222. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
  223. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
  224. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  225. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
  226. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  227. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  228. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  229. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  230. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  231. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
  232. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
  233. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
  234. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  235. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  236. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
  237. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
  238. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
  239. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
  240. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
  241. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  242. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
  243. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  244. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  245. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  246. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  247. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
  248. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  249. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  250. package/docs/ja/specdojo/samples/bds-sample.md +58 -71
  251. package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
  252. package/docs/ja/specdojo/samples/bes-sample.md +43 -53
  253. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  254. package/docs/ja/specdojo/samples/br-sample.md +40 -52
  255. package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
  256. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  257. package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
  258. package/docs/ja/specdojo/samples/clis-sample.md +70 -77
  259. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  260. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  261. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  262. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  263. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  264. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  265. package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
  266. package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
  267. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
  268. package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
  269. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
  270. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  271. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
  272. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  273. package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
  274. package/docs/ja/specdojo/samples/sf-sample.md +73 -85
  275. package/docs/ja/specdojo/samples/sld-sample.md +60 -79
  276. package/docs/ja/specdojo/samples/uis-sample.md +98 -121
  277. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  278. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  279. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
  280. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
  281. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
  282. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  283. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  284. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  285. package/package.json +9 -6
  286. package/templates/antigravity/orchestrator.md +4 -1
  287. package/templates/claude/agents/specdojo-orchestrator.md +4 -1
  288. package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
  289. package/templates/codex/orchestrator.md +4 -1
  290. package/templates/init-exec-defaults.yaml +13 -0
  291. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  292. package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
@@ -11,316 +11,110 @@ specdojo:
11
11
 
12
12
  Cutover Plan (COP) Documentation Rules
13
13
 
14
- 本ドキュメントは、カットオーバー計画(本番切替手順)の対象別ドキュメント `cop-<term>` を統一形式で記述するためのルールです。
15
-
16
- 全体方針と判断体系は `cop-index` を正とし、本書では対象固有の実行手順を定義します。
14
+ 対象別のカットオーバー計画 `cop-<term>` を、当日の切替を分単位で実行でき、対象固有の判定・ロールバック・連絡が明確な Runbook として記述する基準を定めます。
17
15
 
18
16
  ## 1. 全体方針
19
17
 
20
- `cop-<term>` は、当日の切替を分単位で実行可能にし、対象固有の判断と責任を明確にするための詳細Runbookとする。
21
-
22
- - 対象固有の当日タイムラインと作業手順を時系列で定義する
23
- - 対象固有の切替判定ポイント(GO/NO-GO)を明記する
24
- - ロールバック手順を具体的かつ実行可能に記述する
25
- - 担当者、連絡系統、エスカレーションを明確にする
26
- - 周知(ユーザ通知、停止告知)の手順を必須で含める
27
-
28
- 運用方針:
29
-
30
- - `cop-<term>` は、対象が複数(ウェーブ、領域、拠点、システム群)に分かれる場合に作成する
31
- - `cop-index` の前提、共通ルール、判断体系(GO/NO-GO)と矛盾させない
32
- - 「関連ドキュメント」セクションは必須とし、`cop-index` への導線を必ず記載する
18
+ - **目的と適用範囲**: 対象が複数(ウェーブ、領域、拠点、システム群)に分かれる場合に、対象ごとに `cop-<term>` を作成する。当日タイムライン、作業手順、判定ポイント(GO/NO-GO)、ロールバック、連絡系統、周知を対象固有の粒度で定義する。
19
+ - **正本参照と責務境界**: 全体前提・共通ルール・判断体系は `cop-index`、成功条件と GO/NO-GO の最低条件は `mip-index` を正とし、`cop-<term>` は再掲せず矛盾させない。
20
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項と当日の課題の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint・スキーマ検証はリポジトリの検証で扱います。
33
21
 
34
22
  ## 2. 位置づけ
35
23
 
36
- `cop-<term>` と他ドキュメントの関係を示す。必要に応じて Mermaid を使用してよい。
37
-
38
- - `cop-index`: 全体方針、共通判断、導線のSSOT
39
- - `mip-index`: 移行の合意、判断のSSOT(成功条件、カットオーバー骨格)
40
- - `dmd-index`, `dmd-<term>`: データ移行の詳細設計(マッピング、変換、検証)
41
- - `mtp-index`, `mtp-<term>`: リハーサル計画、検証設計(観点、手順、証跡)
42
- - `cop-<term>`: 当日実行の対象別詳細手順(Runbook)
43
- - `otp-index`, `otp-<term>`: 運用切替の詳細(監視設定、運用手順、窓口)
24
+ | 成果物 | `cop-<term>` との関係 |
25
+ | ------------------------- | -------------------------------------------------------- |
26
+ | `cop-index` | 全体方針・共通判断を受け、対象固有の手順だけを定義する |
27
+ | `mip-index` | 成功条件・カットオーバー骨格・ロールバック方針を受ける |
28
+ | `dmd-index`, `dmd-<term>` | 抽出・投入・照合の手順と所要時間を受ける |
29
+ | `mtp-index`, `mtp-<term>` | リハーサルの合格を実施条件とし、時刻と判定条件を確かめる |
30
+ | `otp-index`, `otp-<term>` | 切替後の監視・運用窓口へ引き渡す |
44
31
 
45
32
  ## 3. ファイル命名・ID規則
46
33
 
47
- - `id` は `cop-<term>`(kebab-case。例: `cop-cutover-day`, `cop-wave1`)。
48
- - ファイル名は `cop-020-カットオーバー計画-<term>.md` 等、プロジェクト内で一意になるように命名する。
49
- - `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
34
+ - `id` は `cop-<term>`(プロジェクト固有の成果物は `<project-id>:cop-<term>`)とし、成果物カタログの宣言と一致させる(例: `cop-cutover-day`、`cop-wave1`)。
35
+ - ファイル名は `cop-<term>.md` 等、プロジェクト内で一意にする。`<term>` は用語集の論理名キー(英小文字 kebab-case)とする。
50
36
 
51
37
  ## 4. 推奨 Frontmatter 項目
52
38
 
53
- ### 4.1. 設定内容
39
+ 許可キー・必須項目は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
54
40
 
55
- Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
41
+ - `specdojo.type` は `operations`、`specdojo.rulebook` は `specdojo:cop-rulebook` とし、`title` は置かない。
42
+ - `specdojo.based_on` には切替判断に直接使った作成済み成果物(`cop-index`、`mip-index`、`dmd-*` 等)だけを記載する。
56
43
 
57
- | 項目 | 説明 | 必須 |
58
- | ---------- | -------------------------------------------- | ---- |
59
- | id | COP ID(`cop-<term>`) | ○ |
60
- | type | `operations` 固定 | ○ |
61
- | title | カットオーバー計画: `<対象名>` | ○ |
62
- | status | `draft` / `ready` / `deprecated` | ○ |
63
- | based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
64
- | supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
44
+ ## 5. 本文要件
65
45
 
66
- ### 4.2. 推奨ルール
46
+ 本文は次の10章をこの順序で置き、すべて必須とします。
67
47
 
68
- - `based_on` には切替判断に直接利用した成果物(例: `mip-index` / `mtp-index` / `dmd-*` / `issue-*`)のみ列挙する
69
- - `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
70
-
71
- ## 5. 本文構成(標準テンプレ)
72
-
73
- `cop-<term>` は以下の見出し構成を順序固定で配置する。
74
-
75
- | 番号 | 見出し | 必須 |
76
- | ---- | ---------------------------- | ---- |
77
- | 1 | 概要(`<term>`) | ○ |
78
- | 2 | 当日タイムライン | ○ |
79
- | 3 | 作業手順チェックリスト | ○ |
80
- | 4 | 担当者/連絡系統 | ○ |
81
- | 5 | 実施条件(事前完了条件) | ○ |
82
- | 6 | 切替判定ポイント(GO/NO-GO) | ○ |
83
- | 7 | ロールバック手順 | ○ |
84
- | 8 | 障害時判断・エスカレーション | ○ |
85
- | 9 | 周知(ユーザ通知/停止告知) | ○ |
86
- | 10 | 関連ドキュメント | ○ |
48
+ | 章 | 内容・受入条件 |
49
+ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
50
+ | 概要(`<term>`) | 切替対象・目的と、対象外・責務境界を1〜3行で示す。未決の論点があれば `_UNDECIDED_` で論点と影響を書く |
51
+ | 当日タイムライン | 列は「時刻(相対) / イベント / 完了条件 / 判定点」。分単位で書く |
52
+ | 作業手順チェックリスト | 列は「手順 / 作業内容 / 実施者 / 証跡 / 備考」。順序付きで書き、実施者はメンバー定義の役割で書く |
53
+ | 担当者/連絡系統 | 列は「役割 / 担当 / 連絡先 / 備考」。エスカレーション先を含める。連絡先はチャネルや当番表で書く |
54
+ | 実施条件(事前完了条件) | 事前に完了している条件、他チームの作業や後続予定への依存、未達時の扱い(延期、代替手順)と判断者 |
55
+ | 切替判定ポイント(GO/NO-GO) | 列は「判定点 / 条件 / 判断者 / 失敗時の扱い」。条件は照合対象・閾値・証跡で書き、失敗時はロールバック・延期・代替手順のいずれか |
56
+ | ロールバック手順 | 発動条件(判定点と事象)、復旧方針(旧系復帰、接続戻し、投入データ無効化など)、手順ごとの実施者・証跡・完了条件 |
57
+ | 障害時判断・エスカレーション | 重大度・SLO逸脱・復旧見込みの判断基準と、連絡経路 |
58
+ | 周知(ユーザ通知/停止告知) | 通知対象・手段・時期、停止時間・影響範囲・問い合わせ先、配信の証跡 |
59
+ | 関連ドキュメント | `cop-index` への導線と、本書で使う `mip-index`・`mtp-index`・`dmd-*`・`otp-*` |
87
60
 
88
61
  ## 6. 記述ガイド
89
62
 
90
- ### 6.1. 概要(`<term>`)
91
-
92
- 生成する本文の見出しは **## 1. 概要(`<term>`)**
93
-
94
- - 当日の切替対象と目的を 1〜3 行で示す
95
- - `mip-index` のカットオーバー概要(骨格、判定点、ロールバック方針)と整合させる
96
- - 対象範囲(何を含み、何を含まないか)と責務境界を明記する
97
-
98
- ### 6.2. 当日タイムライン
99
-
100
- 生成する本文の見出しは **## 2. 当日タイムライン**
101
-
102
- - **分単位**の時刻で並べる(相対時刻を推奨)
103
- - 完了条件と判定点(GO1/GO2...)を明記する
104
- - 実作業に必要な粒度で記載する
105
-
106
- 推奨フォーマット(表):
107
-
108
- | 時刻(相対) | イベント | 完了条件 | 判定点 |
109
- | ------------ | -------- | -------- | ------ |
110
-
111
- ### 6.3. 作業手順チェックリスト
112
-
113
- 生成する本文の見出しは **## 3. 作業手順チェックリスト**
114
-
115
- - 作業を順序付きで列挙する
116
- - 実施者と証跡(ログ/チケット/チェック欄)を含める
117
- - 可能なら「実行コマンド/手順書リンク」を備考に置いてよい(本文に長大なコマンド列を貼らない)
118
-
119
- 推奨フォーマット(表):
120
-
121
- | 手順 | 作業内容 | 実施者 | 証跡 | 備考 |
122
- | ---- | -------- | ------ | ---- | ---- |
123
-
124
- ### 6.4. 担当者/連絡系統
125
-
126
- 生成する本文の見出しは **## 4. 担当者/連絡系統**
127
-
128
- - 担当者、責務、連絡経路、エスカレーション先を明記する
129
- - 個人名が出せない場合は「ロール名+窓口(チャネル/電話/当番表)」で表現する
130
-
131
- 推奨フォーマット(表):
132
-
133
- | 役割 | 担当 | 連絡先 | 備考 |
134
- | ---- | ---- | ------ | ---- |
135
-
136
- ### 6.5. 実施条件(事前完了条件)
137
-
138
- 生成する本文の見出しは **## 5. 実施条件(事前完了条件)**
139
-
140
- - 実施前に完了しているべき条件を列挙する(例:リハーサル合格、バックアップ完了、監視準備完了)
141
- - 未達の場合の扱い(延期/代替手順/判断者)を明記する
142
-
143
- ### 6.6. 切替判定ポイント(GO/NO-GO)
144
-
145
- 生成する本文の見出しは **## 6. 切替判定ポイント(GO/NO-GO)**
146
-
147
- - 判定点、判断基準、判断者を列挙する
148
- - 失敗時の扱いは **ロールバック / 延期(Go-Live中止)/ 代替手順** のいずれかを明記する
149
- - `mip-index` の成功条件・GO/NO-GO最低条件と矛盾させない
150
-
151
- 推奨フォーマット(表):
152
-
153
- | 判定点 | 条件 | 判断者 | 失敗時の扱い(ロールバック/延期/代替手順) |
154
- | ------ | ---- | ------ | ------------------------------------------ |
155
-
156
- ### 6.7. ロールバック手順
63
+ 完成例は Frontmatter の `sample` で宣言された sample を参照してください。
157
64
 
158
- 生成する本文の見出しは **## 7. ロールバック手順**
65
+ ### 6.1. 当日タイムラインと判定点
159
66
 
160
- - 発動条件(どの判定点で何が起きたら)を明記する
161
- - 復旧方針(旧系復帰/接続戻し/投入データ無効化/再切替は行わない等)を明記する
162
- - 作業手順は実行可能な粒度(責務・証跡・完了条件)で書く
67
+ - **判断基準**: 判定点の時刻・条件・失敗時の扱いが、タイムラインと判定ポイントの表で一致し、条件を誰が見ても pass/fail を同じに判定できること。
68
+ - **良い例**: 「T-60m / 新DB投入 / 投入ログOK / GO3」と「GO3 / 投入件数と抽出件数が一致し、照合レポートの不一致が0件 / PO / ロールバック(投入無効化、旧系継続)」。
69
+ - **悪い例**: 「午前中 / 切替作業 / 完了したら次へ」「GO3 / 投入が問題ない」(分単位でなく、判定の根拠もない)。
163
70
 
164
- ### 6.8. 障害時判断・エスカレーション
71
+ ### 6.2. 担当者と周知
165
72
 
166
- 生成する本文の見出しは **## 8. 障害時判断・エスカレーション**
167
-
168
- - 障害時の判断フローと連絡経路を明記する
169
- - エスカレーション先と判断基準(重大度・SLO逸脱・復旧見込み等)を明記する
170
-
171
- ### 6.9. 周知(ユーザ通知/停止告知)
172
-
173
- 生成する本文の見出しは **## 9. 周知(ユーザ通知/停止告知)**
174
-
175
- - 通知対象、通知手段、通知タイミングを明記する
176
- - 周知内容に「停止時間」「影響範囲」「問い合わせ先」を含める
177
- - 通知の証跡(配信ログ/掲載URL/チケット)を残すこと
178
-
179
- ### 6.10. 関連ドキュメント(必須)
180
-
181
- 生成する本文の見出しは **## 10. 関連ドキュメント**
182
-
183
- - `cop-index` への導線(本体SSOT)を必ず記載する
184
- - 関連する `mip-index`, `mtp-index`, `dmd-*`, `otp-*` のうち、当該 `cop-<term>` で利用するものを記載する
185
-
186
- 推奨フォーマット(箇条書き):
187
-
188
- - `<doc-id>`:`<説明>`
189
- - `<doc-id>`:`<説明>`
73
+ - **判断基準**: 実施者・判断者が役割で一意に引け、個人の連絡先などの内部限定情報は「担当者/連絡系統」に閉じ、周知には利用者が判断に要る情報だけがあること。
74
+ - **良い例**: 「前日18時に店頭掲示で告知。停止は翌日9時〜10時、その間は現金のみ。問い合わせは店頭窓口」。
75
+ - **悪い例**: 担当者の個人電話番号や内部の作業手順を告知文に書く。
190
76
 
191
77
  ## 7. 禁止事項
192
78
 
193
- | 禁止事項 | 理由 |
194
- | -------------------------------------------------------- | ---------------------------------- |
195
- | 当日タイムラインが分単位で記載されていない | 実行性が担保できないため |
196
- | ロールバック条件や手順を省略する | 失敗時の判断ができないため |
197
- | 担当者や連絡系統が不明確 | 判断と責任が曖昧になるため |
198
- | 周知(ユーザ通知/停止告知)を未記載にする | 利用者混乱と事故につながるため |
199
- | `cop-index` の共通方針を複製し、`cop-index` と矛盾させる | SSOTが崩れ、当日参照が割れるため |
200
- | 「関連ドキュメント」セクションを省略する | 導線が失われ、参照先が分散するため |
79
+ | 禁止事項 | 理由 |
80
+ | ---------------------------------------------------------- | -------------------------------------- |
81
+ | 当日タイムラインを分単位で書かない | 実行性が担保できないため |
82
+ | ロールバックの発動条件や手順を省略する | 失敗時の判断ができないため |
83
+ | 判定条件を「問題ない」など照合対象のない言葉で書く | 判定者によって GO/NO-GO が変わるため |
84
+ | 周知を書かない、または内部限定情報を周知に混ぜる | 利用者の混乱と情報漏えいにつながるため |
85
+ | `cop-index` の共通方針を複製する、`mip-index` と矛盾させる | SSOTが崩れ、当日参照が割れるため |
201
86
 
202
87
  ## 8. サンプル(最小・整合版)
203
88
 
204
- 注: 以下は `cop-<term>` の例示。生成するドキュメントでは `## 1.` から開始する。
205
-
206
- ### 8.1. `cop-<term>`(個別例)
89
+ 形式の輪郭を示す最小例です。生成するドキュメントでは `## 1.` から開始します。
207
90
 
208
91
  ```yaml
209
92
  ---
210
- id: cop-cutover-day
211
- type: operations
212
- title: カットオーバー計画: 本番切替当日
213
- status: draft
214
- based_on:
215
- - cop-index
216
- - mip-index
217
- - dmd-order-data
218
- supersedes: []
93
+ specdojo:
94
+ id: cop-cutover-day
95
+ type: operations
96
+ status: draft
97
+ rulebook: specdojo:cop-rulebook
98
+ based_on:
99
+ - cop-index
100
+ - mip-index
219
101
  ---
220
102
  ```
221
103
 
222
- #### 8.1.1. 概要(cutover-day)
223
-
224
- 本番切替当日の実行手順を分単位で定義し、判定点ごとの失敗時対応(ロールバック/延期/代替手順)を実行可能な形で示す。
225
- 共通方針・判断体系は `cop-index` を正とし、本書は当日作業の詳細に限定する。
226
-
227
- #### 8.1.2. 当日タイムライン
228
-
229
- | 時刻(相対) | イベント | 完了条件 | 判定点 |
230
- | ------------ | --------------------------------------- | ------------------------ | ------ |
231
- | T-125m | 事前周知の最終確認 | 告知反映確認 | |
232
- | T-120m | 旧系受付停止・ジョブ停止確認 | 受付停止/停止ログOK | GO1 |
233
- | T-95m | バックアップ最終取得(旧/新) | バックアップID記録 | |
234
- | T-90m | 最終差分抽出 | 抽出ログOK | GO2 |
235
- | T-75m | 差分整合性(チェックサム/件数)事前確認 | 事前検証OK | |
236
- | T-60m | 新DB投入(run_id=CO-20260401) | 投入ログOK | GO3 |
237
- | T-35m | 投入後照合(件数/重要値) | 照合レポートOK | |
238
- | T-15m | 接続先切替・監視正常確認 | スモークOK/監視OK | GO4 |
239
- | T-5m | 周知(利用再開告知) | 告知反映確認 | |
240
- | T+0 | 利用開始・初回スモーク(ログイン/受注) | 初回業務完了(証跡採取) | GO5 |
241
-
242
- #### 8.1.3. 作業手順チェックリスト
243
-
244
- | 手順 | 作業内容 | 実施者 | 証跡 | 備考 |
245
- | ---- | -------------------------------------- | ------ | ------------------ | ---- |
246
- | 1 | 旧系受付停止とジョブ停止 | Ops | 作業ログ | |
247
- | 2 | バックアップ最終取得(旧/新) | Ops | バックアップID記録 | |
248
- | 3 | 差分抽出の実行と完了ログ確認 | Mig | 抽出ログ | |
249
- | 4 | 新DB投入の実行(run_id付与) | Mig | 投入ログ | |
250
- | 5 | 投入後照合(件数/重要値/チェックサム) | Mig | 照合レポート | |
251
- | 6 | 接続先切替(設定反映) | Ops | 設定差分/反映ログ | |
252
- | 7 | スモーク(ログイン/受注/請求) | Biz | 画面録画/操作ログ | |
253
- | 8 | 監視アラート確認 | Ops | 監視ログ | |
104
+ ```markdown
105
+ ## 2. 当日タイムライン
254
106
 
255
- #### 8.1.4. 担当者/連絡系統
107
+ | 時刻(相対) | イベント | 完了条件 | 判定点 |
108
+ | ------------ | ---------------------------- | ------------------- | ------ |
109
+ | T-120m | 旧系受付停止・ジョブ停止確認 | 受付停止/停止ログOK | GO1 |
110
+ | T-60m | 新DB投入 | 投入ログOK | GO3 |
111
+ | T-15m | 接続先切替・監視正常確認 | スモークOK/監視OK | GO4 |
256
112
 
257
- | 役割 | 担当 | 連絡先 | 備考 |
258
- | ---- | ----- | ------ | ------------------- |
259
- | 運用 | Ops | #ops | 監視・切替 |
260
- | 移行 | Mig | #mig | 抽出・投入・照合 |
261
- | 業務 | Biz | #biz | スモーク/業務確認 |
262
- | PO | PO | #po | GO/NO-GO最終判断 |
263
- | 連絡 | Comms | #comms | 通知文面/配信・掲示 |
113
+ ## 6. 切替判定ポイント(GO/NO-GO)
264
114
 
265
- #### 8.1.5. 実施条件(事前完了条件)
266
-
267
- - `mtp-index` で定義したリハーサルが合格している
268
- - 当日担当者がオンコール状態で連絡可能である
269
- - バックアップ取得が可能な状態である(容量・権限・手順確認済み)
270
- 未達の場合は原則延期(判断者: PO)。
271
-
272
- #### 8.1.6. 切替判定ポイント(GO/NO-GO)
273
-
274
- | 判定点 | 条件 | 判断者 | 失敗時の扱い(ロールバック/延期/代替手順) |
275
- | ------ | ------------------------------- | ------ | ------------------------------------------ |
276
- | GO1 | 受付停止/ジョブ停止が確認できる | Ops | 延期:旧系で継続 |
277
- | GO2 | 抽出ログOK | Mig | 代替手順:再抽出(最大1回)。失敗なら延期 |
278
- | GO3 | 投入ログOK/照合OK | PO | ロールバック:投入無効化→旧系継続 |
279
- | GO4 | 接続切替後スモーク/監視OK | PO | ロールバック:接続戻し→延期判断 |
280
- | GO5 | 初回業務完了 | Biz | 代替手順:限定運用。不可なら延期 |
281
-
282
- #### 8.1.7. ロールバック手順
283
-
284
- - 発動条件:
285
- - GO3で投入失敗または照合NG(重大)
286
- - GO4でスモークNGまたは重大アラート多発
287
-
288
- - 復旧方針:
289
- - 接続先を旧系へ戻す(設定差分を戻し、反映ログを採取)
290
- - 新系投入データは run_id 単位で無効化/隔離(対象一覧を出力して保全)
291
- - 利用再開は旧系で行い、延期(再スケジュール)を決定する
292
-
293
- - 完了条件:
294
- - 旧系でのログイン/受注スモークが成功
295
- - 監視が旧系を指し、重大アラートが収束
296
- - ロールバック証跡(ログ/一覧/判断記録)が保存されている
297
-
298
- #### 8.1.8. 障害時判断・エスカレーション
299
-
300
- - 連絡順:
301
- - Ops/Mig → 移行責任者 → PO(最終)
302
-
303
- - 判断基準(例):
304
- - 停止許容時間内に復旧見込みがない
305
- - ロールバック作業が成立しない(接続戻し不可、無効化不能等)
306
- - 重大障害(P1)が解消しない
307
-
308
- #### 8.1.9. 周知(ユーザ通知/停止告知)
309
-
310
- - 通知対象: 全ユーザ/社内
311
- - 手段: メール/掲示/アプリ内通知(該当するもの)
312
- - タイミング:
313
- - 事前: T-7d, T-1d
314
- - 当日停止開始: T-120m
315
- - 利用再開: T-5m(またはT+0直後)
316
-
317
- - 内容: 停止時間、影響範囲、問い合わせ先、延期時の扱い
318
- - 証跡: 配信ログ、掲示URL、チケット
319
-
320
- #### 8.1.10. 関連ドキュメント
321
-
322
- - `cop-index`:カットオーバー計画のSSOT(共通方針/判断体系/導線)
323
- - `mip-index`:移行計画(成功条件/GO/NO-GO最低条件)
324
- - `mtp-index`:移行リハーサル計画(事前合格条件)
325
- - `dmd-order-data`:データ移行設計(抽出/投入/検証)
326
- - (必要に応じて追加)`otp-index`:運用切替・ハイパーケア(監視/窓口)
115
+ | 判定点 | 条件 | 判断者 | 失敗時の扱い |
116
+ | ------ | ------------------------------------------ | ------ | --------------------------------- |
117
+ | GO1 | 未処理の受付が0件、停止ログに失敗ジョブ0件 | Ops | 延期:旧系で継続 |
118
+ | GO3 | 投入件数=抽出件数、照合の不一致0件 | PO | ロールバック:投入無効化→旧系継続 |
119
+ | GO4 | スモーク全件成功、重大アラート0件 | PO | ロールバック:接続戻し→延期判断 |
120
+ ```
@@ -16,21 +16,18 @@ specdojo:
16
16
 
17
17
  C4 Component Diagram (CPD) Documentation Rules using Mermaid
18
18
 
19
- 本ドキュメントは、アーキテクチャ設計のために、**Mermaid の `flowchart` 構文を使って C4 コンポーネント図(Component Diagram)を描く際の標準ルール**です。
20
-
21
- C4 コンポーネント図は、C4 コンテナ図で示した「コンテナ(実行/配備単位)」の内部を、**主要コンポーネント(責務のまとまり)** に分解して俯瞰し、コンポーネント間の依存やデータの流れを、概念レベルで合意するために用います。
19
+ Mermaid の `flowchart` で、一つのコンテナ内部の責務と境界外への依存を描く記法を定めます。分割・授受情報・受入条件は [[specdojo:cpd-rulebook|CPD 作成ルール]] に従います。
22
20
 
23
21
  ## 1. 全体方針
24
22
 
25
- - Mermaid の **`flowchart` を C4 コンポーネント図風に利用**する。
23
+ - Mermaid の `flowchart` を使い、形状・境界・ラベルで要素と関係を識別できるようにする。
26
24
  - 対象は「対象コンテナ内の主要コンポーネント」と「境界外(人/外部システム/外部データストア等)との関係」であり、クラス/関数等の実装詳細は含めない。
27
- - 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
25
+ - 全呼び出しの網羅ではなく、責務と依存方向を判断できる主要経路を描く。
28
26
  - 1つの図には **対象コンテナを1つ**だけ置く(複数対象は図を分ける)。
27
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
29
28
 
30
29
  ## 2. C4要素と Mermaid 記号の対応
31
30
 
32
- C4 の要素を、以下のように Mermaid の記号にマッピングする。
33
-
34
31
  | C4要素 | 意味 | Mermaid での表現例 |
35
32
  | ---------------------------------------- | --------------------------------------- | -------------------------------------------------------------------- |
36
33
  | Person(人/ロール) | 利用者・関係者 | `店員["店員"]` |
@@ -40,128 +37,51 @@ C4 の要素を、以下のように Mermaid の記号にマッピングする
40
37
  | Container Boundary(対象コンテナ境界) | 対象コンテナの範囲 | `subgraph 境界["対象コンテナ"] ... end` |
41
38
  | Relationship(関係) | 利用・連携・参照・データ入出力概念 | `UI -->\|"売上登録"\| 売上API`/`売上API --> \|"売上データ"\| 販売DB` |
42
39
 
43
- ## 2.1. 標準の色分け(推奨)
44
-
45
- C4コンポーネント図は色が必須ではありませんが、読み手が「人 / 対象コンテナ内の要素 / 外部システム」を一目で区別できるよう、以下の色分けを推奨します。
46
-
47
- - Person(人/ロール): 暖色系
48
- - 対象コンテナ内(Component / Database): 寒色系(主役)
49
- - 外部システム(External System): 無彩色系(脇役)
50
- - 境界(Container Boundary): 破線枠
40
+ ### 2.1. 標準の色分け(推奨)
51
41
 
52
- Mermaid `flowchart` では `classDef` + `class`、境界は `style` を使用します。
42
+ 色は任意とし、人・内部要素・外部依存の識別を補助するために使う。`classDef` と `class` で色、`style` で境界の破線枠を指定する。
53
43
 
54
- ### 2.1.1. 標準スタイル定義(コピーして利用)
44
+ #### 2.1.1. 標準スタイル定義(コピーして利用)
55
45
 
56
- ※ 既存の C4 コンテキスト図(CXD)/ C4 コンテナ図(CND)と同じ色指定を利用します。
46
+ CXD・CND と共通の配色を使う。
57
47
 
58
48
  ```mermaid
59
49
  flowchart LR
60
- %% --- Standard styles (recommended) ---
61
50
  classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
62
51
  classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
63
52
  classDef external fill:#e9ecef,stroke:#495057,color:#000;
64
53
 
65
- %% Container boundary style (subgraph)
66
- %% NOTE: '境界' は subgraph のID(名前)に合わせる
67
54
  style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
68
55
  ```
69
56
 
70
- ### 2.1.2. 適用ルール
57
+ #### 2.1.2. 適用ルール
71
58
 
72
- - Personノードには `person` クラスを付ける
73
- - 対象コンテナ内の Component / Database には `system` クラスを付ける
74
- - 外部システムノードには `external` クラスを付ける
59
+ - Person は暖色の `person` クラスを付ける
60
+ - 対象コンテナ内の Component / Database は寒色の `system` クラスを付ける
61
+ - 外部システムは無彩色の `external` クラスを付ける。境界外のストアも外部依存として扱う
75
62
  - 境界は `subgraph 境界[...]` として、`style 境界 ...` で枠線を指定する
76
63
 
77
64
  ## 3. ノードのルール
78
65
 
79
66
  ### 3.1. Person(人/ロール)
80
67
 
81
- - **四角 `[]`** を使用する。
82
- - 表示ラベルは業務ロール/主体を短い日本語で表す。
83
-
84
- 例:
85
-
86
- ```mermaid
87
- flowchart LR
88
- 店員["👤店員"]
89
- 店主["👤店主"]
90
-
91
- classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
92
- class 店員,店主 person;
93
- ```
68
+ 四角 `[]` を使い、業務ロール・主体を短い日本語で表示する(例: `店員["👤店員"]`)。
94
69
 
95
70
  ### 3.2. Component(コンポーネント)
96
71
 
97
- - **角丸長方形 `()`** を使用する。
98
- - 表示ラベルは「コンポーネント名(+必要なら責務の短い補足)」とする。
99
- - 改行は `<br>` を使用してよい(長文化防止)。
100
-
101
- 例:
102
-
103
- ```mermaid
104
- flowchart LR
105
- UI("UI<br>(画面ロジック)")
106
- 売上API("売上API<br>(販売ドメイン)")
107
- 在庫API("在庫API<br>(在庫ドメイン)")
108
-
109
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
110
- class UI,売上API,在庫API system;
111
- ```
72
+ 角丸長方形 `()` を使う。表示はコンポーネント名と必要な責務の補足に絞り、長いラベルは `<br>` で改行してよい(例: `売上API("売上API<br>(販売ドメイン)")`)。
112
73
 
113
74
  ### 3.3. Database(データベース)
114
75
 
115
- - **円柱ノード `[(...)]`** を使用する。
116
- - DBの論理名を短く書く(例: `販売DB`, `在庫DB`)。
117
-
118
- 例:
119
-
120
- ```mermaid
121
- flowchart LR
122
- 販売DB[("販売DB")]
123
-
124
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
125
- class 販売DB system;
126
- ```
76
+ 円柱 `[(...)]` を使い、DB の論理名を表示する(例: `販売DB[("販売DB")]`)。
127
77
 
128
78
  ### 3.4. External Software System(外部システム)
129
79
 
130
- - **四角 `[]`** を使用する。
131
- - 表示ラベルは外部システムの一般名(例: 会計、決済、EC、配送など)。
132
-
133
- 例:
134
-
135
- ```mermaid
136
- flowchart LR
137
- 会計システム["会計システム"]
138
- 決済サービス["決済サービス"]
139
-
140
- classDef external fill:#e9ecef,stroke:#495057,color:#000;
141
- class 会計システム,決済サービス external;
142
- ```
80
+ 四角 `[]` を使い、連携先の一般名を表示する(例: `会計システム["会計システム"]`)。
143
81
 
144
82
  ### 3.5. Container Boundary(対象コンテナ境界)
145
83
 
146
- - 対象コンテナは **サブグラフ `subgraph ... end`** で囲う。
147
- - 境界内には、対象コンテナ内の **主要コンポーネント**(5〜15個程度を目安)と、必要なら主要DBを置く。
148
- - 境界内の要素を増やしすぎない(詳細化は「実装設計/コード」へ)。
149
-
150
- 例:
151
-
152
- ```mermaid
153
- flowchart LR
154
- subgraph 境界["対象コンテナ(例: API)"]
155
- 売上API("売上API")
156
- 在庫API("在庫API")
157
- 認証("認証")
158
- 販売DB[("販売DB")]
159
- end
160
-
161
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
162
- class 売上API,在庫API,認証,販売DB system;
163
- style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
164
- ```
84
+ 対象コンテナは `subgraph ... end` で囲う。内部には主要コンポーネント(5〜15 個程度を目安)と、上位図で内部と定義されたストアだけを置く。詳細化は実装設計へ委ねる。境界の `style` は subgraph の ID に合わせる。
165
85
 
166
86
  ## 4. エッジ(関係)のルール
167
87
 
@@ -201,13 +121,10 @@ flowchart LR
201
121
 
202
122
  ```mermaid
203
123
  flowchart LR
204
- %% Person
205
124
  店員["👤店員"]
206
125
 
207
- %% External Systems
208
126
  会計システム["会計システム"]
209
127
 
210
- %% Target Container Boundary
211
128
  subgraph 境界["対象コンテナ(例: API)"]
212
129
  UI("UI<br>(画面ロジック)")
213
130
  売上API("売上API<br>(販売ドメイン)")
@@ -215,7 +132,6 @@ flowchart LR
215
132
  販売DB[("販売DB")]
216
133
  end
217
134
 
218
- %% Relationships
219
135
  店員 -->|"売上登録"| UI
220
136
  UI -->|"売上登録"| 売上API
221
137
  UI -->|"在庫照会"| 在庫API
@@ -223,7 +139,6 @@ flowchart LR
223
139
 
224
140
  売上API -->|"会計仕訳連携"| 会計システム
225
141
 
226
- %% Styles
227
142
  classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
228
143
  classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
229
144
  classDef external fill:#e9ecef,stroke:#495057,color:#000;
@@ -235,7 +150,7 @@ flowchart LR
235
150
 
236
151
  ## 8. 凡例(推奨)
237
152
 
238
- 凡例は下記のように表現する(必要な場合のみ)。
153
+ 必要な場合のみ、使った形状と境界を次のように示す。
239
154
 
240
155
  ```mermaid
241
156
  flowchart LR
@@ -255,13 +170,6 @@ flowchart LR
255
170
  C -->|"Relationship(関係)"| DB
256
171
  C -->|"Relationship(関係)"| 外部
257
172
  end
258
-
259
- %% Styles
260
- classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
261
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
262
- classDef external fill:#e9ecef,stroke:#495057,color:#000;
263
- class 人 person;
264
- class C,DB system;
265
- class 外部 external;
266
- style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
267
173
  ```
174
+
175
+ 配色を使う場合は「標準スタイル定義」と「適用ルール」を凡例にも適用する。