specdojo 0.8.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 (284) hide show
  1. package/.github/agents/specdojo-orchestrator.md +4 -1
  2. package/CHANGELOG.md +64 -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/where.js +25 -0
  9. package/dist/dashboard/dashboard.js +5 -3
  10. package/dist/dashboard/routines.js +4 -7
  11. package/dist/dashboard/timeline.js +14 -14
  12. package/dist/docs/index-command.js +2 -2
  13. package/dist/docs/yaml-business-tables.js +243 -0
  14. package/dist/docs/yaml-interface-tables.js +106 -0
  15. package/dist/docs/yaml-pages-command.js +5 -3
  16. package/dist/docs/yaml-pages.js +146 -3
  17. package/dist/docs/yaml-table-shared.js +70 -0
  18. package/dist/docs/yaml-tables.js +39 -0
  19. package/dist/exec/agent-config.js +9 -0
  20. package/dist/exec/agent-protected-config.js +2 -0
  21. package/dist/exec/commands.js +31 -18
  22. package/dist/exec/events.js +34 -14
  23. package/dist/exec/evidence.js +13 -3
  24. package/dist/exec/parent-validation.js +56 -3
  25. package/dist/exec/plans-core.js +21 -2
  26. package/dist/exec/plans-generation.js +6 -7
  27. package/dist/exec/post-integration.js +162 -0
  28. package/dist/exec/queue-command.js +166 -0
  29. package/dist/exec/queue.js +285 -0
  30. package/dist/exec/register-foreign-wait.js +84 -0
  31. package/dist/exec/repo-integration-sync.js +17 -5
  32. package/dist/exec/reporter.js +2 -2
  33. package/dist/exec/results.js +24 -4
  34. package/dist/exec/review-kata.js +4 -1
  35. package/dist/exec/run/agent-pipeline.js +3 -2
  36. package/dist/exec/run/agent.js +12 -6
  37. package/dist/exec/run/change-scope.js +365 -0
  38. package/dist/exec/run/deferred-cleanup.js +31 -0
  39. package/dist/exec/run/in-place.js +4 -1
  40. package/dist/exec/run/job-lock.js +66 -0
  41. package/dist/exec/run/job-sequence.js +137 -0
  42. package/dist/exec/run/job.js +56 -19
  43. package/dist/exec/run/lifecycle-commands.js +1 -1
  44. package/dist/exec/run/lock.js +22 -1
  45. package/dist/exec/run/register-command.js +8 -5
  46. package/dist/exec/run/register-mode.js +68 -8
  47. package/dist/exec/run/register-resume.js +68 -14
  48. package/dist/exec/run/register-state.js +13 -8
  49. package/dist/exec/run/register-worktree.js +140 -125
  50. package/dist/exec/run/schedule-mode.js +75 -14
  51. package/dist/exec/run/schedule-prepare.js +3 -0
  52. package/dist/exec/run/schedule-task.js +88 -38
  53. package/dist/exec/run/shared.js +5 -0
  54. package/dist/exec/schedule/schedule.js +116 -4
  55. package/dist/exec/shared.js +1 -1
  56. package/dist/exec/smoke.js +190 -0
  57. package/dist/exec/strategy.js +13 -3
  58. package/dist/exec/task-view.js +6 -4
  59. package/dist/exec/trial-commands.js +5 -2
  60. package/dist/exec/trial-core.js +6 -1
  61. package/dist/exec/validation-metrics.js +181 -0
  62. package/dist/exec/worktree-cleanup-lock.js +26 -0
  63. package/dist/exec/worktree-command.js +9 -1
  64. package/dist/exec/worktree-ops-commit.js +2 -2
  65. package/dist/exec/worktree.js +13 -2
  66. package/dist/grade/command-apply.js +3 -3
  67. package/dist/grade/command-inspect.js +5 -3
  68. package/dist/grade/command-plan.js +1 -1
  69. package/dist/grade/command-run.js +5 -1
  70. package/dist/grade/run.js +64 -8
  71. package/dist/job/definition.js +84 -8
  72. package/dist/job/job.js +79 -23
  73. package/dist/register/authoring-sources.js +22 -16
  74. package/dist/register/maintenance-commands.js +2 -2
  75. package/dist/register/register.js +31 -7
  76. package/dist/routine/definition.js +9 -0
  77. package/dist/routine/routine.js +137 -43
  78. package/dist/routine/status.js +62 -0
  79. package/dist/schedule/schedule.js +38 -39
  80. package/dist/shared/agent-types.js +5 -0
  81. package/dist/shared/cross-process-lock.js +9 -1
  82. package/dist/shared/dist-freshness.js +8 -2
  83. package/dist/shared/git-environment.js +2 -1
  84. package/dist/shared/git.js +44 -1
  85. package/dist/shared/lefthook-scaffold.js +3 -0
  86. package/dist/shared/local-config.js +244 -0
  87. package/dist/shared/specdojo-config.js +34 -20
  88. package/dist/shared/specdojo-gitignore.js +1 -0
  89. package/dist/shared/text.js +9 -1
  90. package/dist/shared/where-alias.js +13 -0
  91. package/dist/specdojo.js +4 -0
  92. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  93. package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
  94. package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
  95. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  96. package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
  97. package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
  98. package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
  99. package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
  100. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  101. package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
  102. package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
  103. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  104. package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
  105. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  106. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  107. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
  108. package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
  109. package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
  110. package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
  111. package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
  112. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
  113. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
  114. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  115. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  116. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
  117. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
  118. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
  119. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
  120. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
  121. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
  122. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  123. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
  124. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  125. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  126. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  127. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  128. package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
  129. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
  130. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
  131. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
  132. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  133. package/docs/ja/specdojo/references/command-reference.md +257 -117
  134. package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
  135. package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
  136. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  137. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  138. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
  139. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
  140. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
  141. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
  142. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
  143. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  144. package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
  145. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
  146. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  147. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  148. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  149. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  150. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
  151. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  152. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
  153. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
  154. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
  155. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  156. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
  157. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  158. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  159. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  160. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
  161. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  162. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
  163. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
  164. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
  165. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
  166. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  167. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  168. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
  169. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  170. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  171. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
  172. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
  173. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  174. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
  175. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
  176. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
  177. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  178. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
  179. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  180. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
  181. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  182. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  183. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  184. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  185. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  186. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
  187. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  188. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  189. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  190. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  191. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  192. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  193. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  194. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  195. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  196. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  197. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  198. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  199. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  200. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  201. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  202. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  203. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
  204. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  205. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  206. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  207. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  208. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
  209. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
  210. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
  211. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
  212. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  213. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
  214. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
  215. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
  216. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  217. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
  218. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  219. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  220. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  221. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  222. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  223. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
  224. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
  225. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
  226. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  227. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  228. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
  229. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
  230. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
  231. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
  232. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
  233. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  234. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
  235. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  236. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  237. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  238. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  239. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
  240. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  241. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  242. package/docs/ja/specdojo/samples/bds-sample.md +58 -71
  243. package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
  244. package/docs/ja/specdojo/samples/bes-sample.md +43 -53
  245. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  246. package/docs/ja/specdojo/samples/br-sample.md +40 -52
  247. package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
  248. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  249. package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
  250. package/docs/ja/specdojo/samples/clis-sample.md +70 -77
  251. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  252. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  253. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  254. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  255. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  256. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  257. package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
  258. package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
  259. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
  260. package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
  261. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
  262. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  263. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
  264. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  265. package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
  266. package/docs/ja/specdojo/samples/sf-sample.md +73 -85
  267. package/docs/ja/specdojo/samples/sld-sample.md +60 -79
  268. package/docs/ja/specdojo/samples/uis-sample.md +98 -121
  269. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  270. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  271. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
  272. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
  273. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
  274. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  275. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  276. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  277. package/package.json +9 -6
  278. package/templates/antigravity/orchestrator.md +4 -1
  279. package/templates/claude/agents/specdojo-orchestrator.md +4 -1
  280. package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
  281. package/templates/codex/orchestrator.md +4 -1
  282. package/templates/init-exec-defaults.yaml +13 -0
  283. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  284. package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
@@ -16,75 +16,57 @@ specdojo:
16
16
 
17
17
  C4 Container Diagram (CND) Documentation Rules using Mermaid
18
18
 
19
- 本ドキュメントは、アーキテクチャ設計のために、**Mermaid の `flowchart` 構文を使って C4 コンテナ図を描く際の標準ルール**です。
20
-
21
- C4 コンテナ図は「対象システム」を、**実行/配備単位(コンテナ)** に分割して俯瞰し、利用者(人)・外部システム・データストアとの関係(やり取り)を、概念レベルで合意するために用います。
22
-
23
- ---
19
+ C4 コンテナ図を Mermaid の `flowchart` で表す記法を定めます。文書の命名・メタ情報・本文要件と要素の選定は [[specdojo:cnd-rulebook|C4コンテナ図作成ルール]] に従います。
24
20
 
25
21
  ## 1. 全体方針
26
22
 
27
- - Mermaid の **`flowchart` を C4 コンテナ図風に利用**する。
28
- - 対象は「対象システム内の主要コンテナ」と「境界外(人/外部システム)との関係」であり、コンポーネント/クラス等の内部構造は含めない。
29
- - 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
30
- - 1つの図には **対象システムを1つ**だけ置く(複数対象は図を分ける)。
31
-
32
- ---
23
+ - 一つの図には一つの対象システムを置き、コンポーネント・クラスなどの内部構造は描きません。
24
+ - 図は詳細の量より、境界・接続の解釈が割れないことを優先します。
25
+ - **共通の運用**: 役割は適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱います。
33
26
 
34
27
  ## 2. C4要素と Mermaid 記号の対応
35
28
 
36
- C4 の要素を、以下のように Mermaid の記号にマッピングする。
29
+ | C4要素 | Mermaid での表現例 |
30
+ | ---------------------------------------- | --------------------------------------- |
31
+ | Person(人/ロール) | `店員["店員"]` |
32
+ | Container(コンテナ) | `Webアプリ("Webアプリ<br>(React)")` |
33
+ | Database(データベース) | `販売DB[("販売DB")]` |
34
+ | External Software System(外部システム) | `会計システム["会計システム"]` |
35
+ | System Boundary(境界) | `subgraph 境界["対象システム"] ... end` |
36
+ | Relationship(関係) | `店員 -->\|"売上登録"\| Webアプリ` |
37
37
 
38
- | C4要素 | 意味 | Mermaid での表現例 |
39
- | ---------------------------------------- | ---------------------------------- | -------------------------------------------------------------------- |
40
- | Person(人/ロール) | 利用者・関係者 | `店員["店員"]` |
41
- | Container(コンテナ) | 実行/配備単位(Web/API/バッチ等) | `Webアプリ("Webアプリ<br>(React)")` |
42
- | Database(データベース) | 永続データストア | `販売DB[("販売DB")]` |
43
- | External Software System(外部システム) | 連携先システム | `会計システム["会計システム"]` |
44
- | System Boundary(境界) | 対象システムの範囲 | `subgraph 境界["対象システム"] ... end` |
45
- | Relationship(関係) | 利用・連携・参照・データ入出力概念 | `店員 -->\|"売上登録"\| Webアプリ`/`API --> \|"売上データ"\| 販売DB` |
38
+ ### 2.1. 標準の色分け(推奨)
46
39
 
47
- ---
48
-
49
- ## 2.1 標準の色分け(推奨)
50
-
51
- C4コンテナ図は色が必須ではありませんが、読み手が「人 / 対象システム内の要素 / 外部システム」を一目で区別できるよう、以下の色分けを推奨します。
40
+ 色は任意で、次の区分を推奨します。
52
41
 
53
42
  - Person(人/ロール): 暖色系
54
43
  - 対象システム内(Container / Database): 寒色系(主役)
55
44
  - 外部システム(External System): 無彩色系(脇役)
56
45
  - 境界(System Boundary): 破線枠
57
46
 
58
- Mermaid `flowchart` では `classDef` + `class`、境界は `style` を使用します。
59
-
60
- ### 2.1.1 標準スタイル定義(コピーして利用)
61
-
62
- ※ 既存の C4 コンテキスト図(CXD)と同じ色指定を利用します。
47
+ #### 2.1.1. 標準スタイル定義(コピーして利用)
63
48
 
64
49
  ```mermaid
65
50
  flowchart LR
66
- %% --- Standard styles (recommended) ---
67
51
  classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
68
52
  classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
69
53
  classDef external fill:#e9ecef,stroke:#495057,color:#000;
70
54
 
71
- %% System boundary style (subgraph)
72
- %% NOTE: '境界' は subgraph のID(名前)に合わせる
73
55
  style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
74
56
  ```
75
57
 
76
- ### 2.1.2 適用ルール
58
+ #### 2.1.2. 適用ルール
77
59
 
78
60
  - Personノードには `person` クラスを付ける
79
61
  - 対象システム内の Container / Database には `system` クラスを付ける
80
62
  - 外部システムノードには `external` クラスを付ける
81
- - 境界は `subgraph 境界[...]` として、`style 境界 ...` で枠線を指定する
82
-
83
- ---
63
+ - 境界は `subgraph 境界[...]` として、`style 境界 ...` で枠線を指定する。`境界` は実際のサブグラフ ID に合わせる
84
64
 
85
65
  ## 3. ノードのルール
86
66
 
87
- ### 3.1 Person(人/ロール)
67
+ 以下の例は形状とラベルを示します。色の適用は「標準の色分け(推奨)」に従います。
68
+
69
+ ### 3.1. Person(人/ロール)
88
70
 
89
71
  - **四角 `[]`** を使用する。
90
72
  - 表示ラベルは業務ロール/主体を短い日本語で表す。
@@ -95,12 +77,9 @@ flowchart LR
95
77
  flowchart LR
96
78
  店員["👤店員"]
97
79
  店主["👤店主"]
98
-
99
- classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
100
- class 店員,店主 person;
101
80
  ```
102
81
 
103
- ### 3.2 Container(コンテナ)
82
+ ### 3.2. Container(コンテナ)
104
83
 
105
84
  - **角丸長方形 `()`** を使用する。
106
85
  - 表示ラベルは「コンテナ名(+必要なら技術/役割の短い補足)」とする。
@@ -112,30 +91,24 @@ flowchart LR
112
91
  flowchart LR
113
92
  Webアプリ("Webアプリ<br>(レジ/管理画面)")
114
93
  API("API<br>(販売/在庫)")
115
-
116
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
117
- class Webアプリ,API system;
118
94
  ```
119
95
 
120
- ### 3.3 Database(データベース)
96
+ ### 3.3. Database(データベース)
121
97
 
122
98
  - **円柱ノード `[(...)]`** を使用する。
123
- - DBの論理名を短く書く(例: `販売DB`, `在庫DB`)。
99
+ - DBの論理名を短く書く。
124
100
 
125
101
  例:
126
102
 
127
103
  ```mermaid
128
104
  flowchart LR
129
105
  販売DB[("販売DB")]
130
-
131
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
132
- class 販売DB system;
133
106
  ```
134
107
 
135
- ### 3.4 External Software System(外部システム)
108
+ ### 3.4. External Software System(外部システム)
136
109
 
137
110
  - **四角 `[]`** を使用する。
138
- - 表示ラベルは外部システムの一般名(例: 会計、決済、EC、配送など)。
111
+ - 表示ラベルは外部システムの一般名とする。
139
112
 
140
113
  例:
141
114
 
@@ -143,16 +116,12 @@ flowchart LR
143
116
  flowchart LR
144
117
  会計システム["会計システム"]
145
118
  決済サービス["決済サービス"]
146
-
147
- classDef external fill:#e9ecef,stroke:#495057,color:#000;
148
- class 会計システム,決済サービス external;
149
119
  ```
150
120
 
151
- ### 3.5 System Boundary(境界)
121
+ ### 3.5. System Boundary(境界)
152
122
 
153
123
  - 対象システムは **サブグラフ `subgraph ... end`** で囲う。
154
- - 境界内には、対象システムの **主要コンテナ**(2〜7個程度を目安)と、必要なら主要DBを置く。
155
- - 境界内の要素を増やしすぎない(詳細化はコンポーネント図へ)。
124
+ - 境界内に置く要素の選定基準は主 rulebook に従う。
156
125
 
157
126
  例:
158
127
 
@@ -163,17 +132,11 @@ flowchart LR
163
132
  API("API")
164
133
  販売DB[("販売DB")]
165
134
  end
166
-
167
- classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
168
- class Webアプリ,API,販売DB system;
169
- style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
170
135
  ```
171
136
 
172
- ---
173
-
174
137
  ## 4. エッジ(関係)のルール
175
138
 
176
- ### 4.1 方向
139
+ ### 4.1. 方向
177
140
 
178
141
  - `A --> B` を基本とする。
179
142
  - 方向は「主たる依存/利用/送信の向き」が分かるように統一する。
@@ -181,23 +144,19 @@ flowchart LR
181
144
  - 例: コンテナ間の呼び出し: `Webアプリ -->|"API呼び出し"| API`
182
145
  - 例: DBへの入出力: `API -->|"売上データ"| 販売DB`
183
146
 
184
- ### 4.2 ラベル
147
+ ### 4.2. ラベル
185
148
 
186
- - すべてのエッジにラベルを付ける(「何の関係か」を合意するため)。
149
+ - すべてのエッジにラベルを付ける。
187
150
  - ラベルは **短い名詞句**または **短い動詞句**で書く。
188
151
  - 例: `売上登録` / `在庫照会` / `会計仕訳連携` / `決済結果を受信`
189
152
  - 長い場合は `<br>` で改行してよい。
190
153
 
191
- ---
192
-
193
154
  ## 5. 命名・表記ルール
194
155
 
195
- - ノードIDは日本語でもよいが、記号や空白は避け、短い識別子にする(例: `Webアプリ`, `API`, `販売DB`, `会計システム`, `店員`)。
196
- - 表示ラベルは `"..."` で囲ってよい(混乱を避けるため、必要に応じて統一)。
156
+ - ノードIDは日本語でもよいが、記号や空白は避け、短い識別子にする。
157
+ - 表示ラベルは `"..."` で囲ってよい。
197
158
  - 同じ主体/システム/コンテナ/DBは、図の中で名称を揺らさない。
198
159
 
199
- ---
200
-
201
160
  ## 6. 禁止事項
202
161
 
203
162
  | 項目 | 理由 |
@@ -209,27 +168,21 @@ flowchart LR
209
168
  | コンポーネント/クラス等の内部構造の詳細 | コンポーネント図/実装設計で表す |
210
169
  | 矢印ラベルなしの関係 | 合意が取れない |
211
170
 
212
- ---
213
-
214
171
  ## 7. サンプル(最小)
215
172
 
216
173
  ```mermaid
217
174
  flowchart LR
218
- %% Person
219
175
  店員["👤店員"]
220
176
 
221
- %% External Systems
222
177
  会計システム["会計システム"]
223
178
  決済サービス["決済サービス"]
224
179
 
225
- %% Target System Boundary
226
180
  subgraph 境界["対象システム"]
227
181
  Webアプリ("Webアプリ<br>(レジ/管理画面)")
228
182
  API("API<br>(販売/在庫)")
229
183
  販売DB[("販売DB")]
230
184
  end
231
185
 
232
- %% Relationships
233
186
  店員 -->|"売上登録"| Webアプリ
234
187
  Webアプリ -->|"API呼び出し"| API
235
188
  API -->|"売上データ"| 販売DB
@@ -238,7 +191,6 @@ flowchart LR
238
191
  API -->|"決済依頼"| 決済サービス
239
192
  決済サービス -->|"決済結果"| API
240
193
 
241
- %% Styles
242
194
  classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
243
195
  classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
244
196
  classDef external fill:#e9ecef,stroke:#495057,color:#000;
@@ -248,11 +200,9 @@ flowchart LR
248
200
  style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
249
201
  ```
250
202
 
251
- ---
252
-
253
203
  ## 8. 凡例(推奨)
254
204
 
255
- 凡例は下記のように表現する(必要な場合のみ)。
205
+ 必要な場合に置きます。
256
206
 
257
207
  ```mermaid
258
208
  flowchart LR
@@ -273,7 +223,6 @@ flowchart LR
273
223
  Web -->|"Relationship(関係)"| 外部
274
224
  end
275
225
 
276
- %% Styles
277
226
  classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
278
227
  classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
279
228
  classDef external fill:#e9ecef,stroke:#495057,color:#000;
@@ -282,5 +231,3 @@ flowchart LR
282
231
  class 外部 external;
283
232
  style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
284
233
  ```
285
-
286
- ---
@@ -26,21 +26,11 @@ C4 Container Diagram (CND) Authoring Rule
26
26
  - コンテナは実行・配備単位として分け、機能名やソースディレクトリだけを理由に分割しません。データストアはファイル群やリポジトリでもよく、DB 製品の導入を前提にしません。
27
27
  - 図は主要経路を、本文は責務・利用条件・技術制約を説明します。図の矢印を文章でなぞる説明は置きません。
28
28
  - 記法は `includes` の [[specdojo:cnd-mermaid-rulebook|CND Mermaid 記法ルール]] に従います。形状・色・構文は本書で再定義しません。
29
-
30
- ### 1.1. 作成・合意・保守の責任
31
-
32
- - ARC が作成と技術判断を担い、本 rulebook の継続更新・問い合わせ窓口となります。上位図の境界を確認した後に着手し、下位コンポーネント図・インフラ構成図の具体化と結合検証設計への引き渡し前に、利用する範囲をレビューします。
33
- - BA は業務側の利用者代表と対象範囲・利用場面を、DEV は実行単位と接続方式を、QE は境界ごとの観測結果を、OPS は配備・公開・運用の前提を確認します。図に描く Person と設計の確認者は区別します。
34
- - PO が対象範囲・残るリスク・公開可否を最終判断し、人間が承認または保留・差し戻しを記録します。ARC の技術確認や自動検査の成功だけでは承認完了としません。
35
- - PM は作成・レビュー・課題解消をタスクへ分け、担当 Role code と判断期限を計画します。兼務と実行主体は [[specdojo:people-and-organization-definition-standard|人と組織の定義標準]] および適用先のロール・メンバー定義に従います。
29
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
36
30
 
37
31
  ## 2. 位置づけと用語定義
38
32
 
39
- | 用語 | 本書での意味 |
40
- | ------------ | -------------------------------------------------------------------------- |
41
- | コンテナ | アプリケーションなどの実行・配備単位。Docker の利用を意味しない |
42
- | データストア | 永続記録の保持単位。コンテナと並べて描き、生成物と正本を区別する |
43
- | システム境界 | 対象が責務を持つ範囲。同一端末・同一ネットワークという物理配置とは区別する |
33
+ コンテナは Docker の利用を意味せず、システム境界は同一端末・同一ネットワークという物理配置とは区別します。
44
34
 
45
35
  上位コンテキスト図は対象システムと外部との境界、本図はその内部構成、コンポーネント図は各コンテナ内部、インフラ構成図は物理配置・ネットワークを扱います。バージョン、コマンド構文、データ構造は技術スタック・リファレンス・schema・外部 IF 仕様を正本とします。
46
36
 
@@ -55,10 +45,9 @@ C4 Container Diagram (CND) Authoring Rule
55
45
 
56
46
  共通項目の配置・必須条件・型・値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
57
47
 
58
- - SpecDojo のメタ情報は `specdojo:` 配下に置きます。文書名は本文先頭の H1 に記し、Frontmatter の `title` で代用しません。
59
48
  - `type` は `architecture`、主 `rulebook` は `specdojo:cnd-rulebook` とします。記法部品を主 rulebook にしません。
60
49
  - `based_on` は上位コンテキスト図など、カタログの `depends_on` の推移閉包にある直接の内容根拠に限ります。共通のプロジェクト文脈は本文で参照します。
61
- - 作成・編集時は `draft` を維持します。上位文書への所属や置き換えは共通規約に従い、仮定の説明をメタ項目の追加で代用しません。
50
+ - 仮定は本文で説明し、メタ項目の追加で代用しません。
62
51
 
63
52
  ## 5. 本文要件
64
53
 
@@ -70,7 +59,7 @@ C4 Container Diagram (CND) Authoring Rule
70
59
  | 構成図 | 必須 | 一つのシステム境界に主要コンテナとストアを置き、直接利用者と外部依存を結ぶ。全関係にラベルを付ける |
71
60
  | 要素・境界の定義 | 必須 | 境界内外、利用者の接点、コンテナの責務・技術区分・配置前提、ストアの正本と生成物、外部依存の利用条件・失敗影響、関係の方式と詳細の正本を説明する |
72
61
  | 技術前提・検証対象 | 必須 | 実行時と構築時、ローカルとリモート、読み書きの境界を区別する。結合確認の対象を関係 ID または要素名で識別する |
73
- | 未確定事項の引き継ぎ | 条件付き | 仮定・未確定の経路・配置がある場合、影響、担当ロール、解消条件、引き継ぎ先を残す |
62
+ | 未確定事項の引き継ぎ | 条件付き | 仮定・未確定の経路・配置がある場合、論点、影響する要素・関係、当面の扱いと解消条件を残す |
74
63
 
75
64
  Person・外部システム・ストアが該当しない場合は、その旨と理由を定義欄へ記載します。主要コンテナは 2〜7 個程度を目安としますが、数に合わせて未根拠の実行単位を追加しません。
76
65
 
@@ -80,9 +69,9 @@ Person・外部システム・ストアが該当しない場合は、その旨
80
69
 
81
70
  ### 6.1. 概要
82
71
 
83
- - 上位図のどの対象を分解するかと、読み手が配置・結合について何を判断するかを示します。
72
+ - 上位図のどの対象を分解し、誰がどの利用場面で配置・結合の何を判断するかを示します。
84
73
  - 上位図が扱わない閲覧経路などを加える場合は、中核責務を変えるのか、派生した提供経路なのかを説明します。
85
- - 承認対象と確認者を Role code で識別し、業務側の確認が必要な利用場面を対応付けます。実際の承認記録はプロジェクトの決定記録を参照し、図中の Person 名から承認者を推定しません。
74
+ - 図中の Person はシステムの利用接点を表し、設計の確認者一覧とは区別します。
86
75
  - 良い例: 「販売システムを画面、処理サービス、記録ストアへ分け、店頭入力から保存までを示す」。悪い例: 「便利なシステムの全体像」。後者は対象と分割の目的を判定できません。
87
76
 
88
77
  ### 6.2. C4コンテナ図(Mermaid)
@@ -110,25 +99,21 @@ Person・外部システム・ストアが該当しない場合は、その旨
110
99
 
111
100
  ### 6.5. メモ / 将来課題
112
101
 
113
- - _ASSUMPTION_ と確定事項を分離し、影響する要素・関係、担当、解消条件を記録します。
114
- - 配置・接続・公開の判断を妨げる論点は ARC が影響と対応案を PM へ報告し、PM が PJR の課題・リスク・変更要求・決定記録へ引き継ぎます。本図には転送先レコード、担当 Role code、判断期限または下流着手前などの判断時点を残し、解消後は ARC が図と参照先へ反映します。
115
- - 良い例: 「配信先未確定。ARC が公開範囲と配備方式を整理し、PM が課題登録する。転送先レコードを本図へ記録し、配備設計の着手前に PO が判断する」。悪い例: 「配信は後で考える」。後者は担当と判断時点を追跡できません。
116
- - 境界やコンテナを改訂・廃止したときは ARC が上位図・下位コンポーネント図・インフラ構成図の参照影響を確認し、DEV が連携実装、QE が該当する結合対象を追従させます。ライフサイクルの共通手続きはメタ情報標準を正本とします。
102
+ - `_ASSUMPTION_` と確定事項を分離し、論点、影響する要素・関係、当面の扱いと解消条件を記録します。
103
+ - 境界・コンテナ・接続の変更が、上位図、下位コンポーネント図、インフラ構成図、連携契約、結合検証のどこへ影響するかを示します。
104
+ - 良い例: 「配信先と公開範囲は未確定。サイトの配備と閲覧経路を確定できないため、候補が公開範囲を満たすか確認し、配置と接続条件へ反映する。それまではローカル構築だけを扱う」。悪い例: 「配信は後で考える」。後者は影響と解消条件が分かりません。
117
105
 
118
106
  ### 6.6. 検証・承認前の確認
119
107
 
120
- このリポジトリではルートから次を実行します。`<対象.md>` は作成・変更した CND 文書の相対パスへ置き換えます。利用先では導入済みツールと検証設定に合わせ、同じ確認を行います。
108
+ 配置設計・結合検証へ渡す内容を次の順に確認します。
121
109
 
122
- | 確認 | コマンド | 合格条件 |
123
- | ----------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
124
- | Markdown | `node packages/docs-lint/bin/specdojo-docs-lint.js markdownlint <対象.md>` | 終了コード 0、記法違反なし |
125
- | Frontmatter・本文 | `node packages/docs-lint/bin/specdojo-docs-lint.js remark <対象.md> --quiet --frail` | 終了コード 0、成果物 schema と主 rulebook の宣言に適合 |
126
- | Mermaid 構文 | `node tools/lint-mermaid.mjs <対象.md>` | 終了コード 0、対象の全図が passed、エラー・未検査なし |
127
- | Mermaid 描画 | `npm run docs:build:mermaid` | 終了コード 0、対象図の SVG が生成され、文字・矢印・境界を判読できる |
110
+ | 確認 | 手順 | 合格条件 |
111
+ | ---------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
112
+ | 範囲と経路 | 上位図の利用目的・外部依存から、担当コンテナと経路をたどる | 各経路が図に対応し、描かない経路には対象外の理由がある |
113
+ | 要素と境界 | 図の文字・矢印・境界を読み取り、定義表と双方向に照合する | 「要素と境界の定義」の対応条件を満たし、境界内外と関係の向きを判読できる |
114
+ | 結合対象 | 関係 ID ごとに正常時と不在・失敗・結果不明時の観測結果を「技術前提・制約と検証観点」と照合する | 下流へ渡す全経路に正常時の結果があり、保存先・外部依存では異常時の状態と保持される記録を区別できる |
128
115
 
129
- - QE は「C4コンテナ図(Mermaid)」「要素と境界の定義」「技術前提・制約と検証観点」の合格条件を照合し、コマンド結果と対象図の目視確認をレビュー記録へ残します。描画の成功だけでは内容の合格としません。失敗・未検査は原因を修正して再検査し、確認不能なら理由と次の確認者を記録して承認を保留します。
130
- - ARC は必須の内容要件、上位図との対応、各確認者のレビュー結果、未解決指摘と PJR の転送先をそろえて PO へ渡します。構成・接続・公開可否を左右する未決事項は解消するか、採用する前提・影響・後続作業の制限について PO の判断を記録します。
131
- - 人間の PO が承認を記録した後に、人間が `ready` への昇格を判断します。OPS は公開対象と承認対象が一致し、公開範囲の未決事項が解消していることを確認してから公開します。生成成功や `ready` の値だけを公開許可と扱いません。
116
+ 未確認の期待結果は検証済みと扱わず、論点と影響を「メモ / 将来課題」に残します。不一致は修正し、確認できない経路は理由と後続作業の制限を記して未判定とします。
132
117
 
133
118
  ## 7. 禁止事項
134
119
 
@@ -136,4 +121,3 @@ Person・外部システム・ストアが該当しない場合は、その旨
136
121
  - ストアのファイル群と、Git の履歴操作、リモート共有サービスを一つの実行単位として混同すること。
137
122
  - IF の引数・ペイロード、schema の項目一覧、SQL、技術スタックのバージョン一覧を転載すること。
138
123
  - 構築時だけの関係を常時接続として示すこと、または根拠のない配置・再試行・保存保証を確定事項として書くこと。
139
- - 人間が担う承認や公開判断を、作成・生成・外部処理の成功だけで代替すること。
@@ -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が崩れ、当日参照が割れるため |