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
@@ -3,312 +3,119 @@ specdojo:
3
3
  id: specdojo:sysd-cross-cutting-policy-rulebook
4
4
  type: rulebook
5
5
  deliverable_type: architecture
6
- status: draft
6
+ status: ready
7
+ recipe: specdojo:sysd-cross-cutting-policy-recipe
7
8
  sample: specdojo:sysd-cross-cutting-policy-sample
9
+ template: specdojo:sysd-cross-cutting-policy-template
8
10
  ---
9
11
 
10
12
  # システム設計 / 横断ルール 作成ルール
11
13
 
12
- System Design Cross-cutting Policy (SYSD-CCP) Documentation Rules
14
+ System Design Cross-cutting Policy Documentation Rules
13
15
 
14
- 本ドキュメントは、システム設計情報を **コード(定義ファイル)へ寄せる運用(Code as Spec)** を前提に、
15
-
16
- 実装全体に影響する共通ルールを最小限でSSOT化する **System Design Cross-cutting Policy (SYSD-CCP)** の記述ルールを定義する。
17
-
18
- SYSD-CCP は「詳細実装の手順書」ではない。
19
- **全体に共通する“前提”と“禁止事項”と“例外時の扱い”** を明確にし、実装ブレと事故を防ぐ。
16
+ 複数の実装領域で守る制約、例外、検証条件を一つの正本にまとめるための規定である。値・構文・構造の詳細は実装・schema・リファレンスに委ねる。
20
17
 
21
18
  ## 1. 全体方針
22
19
 
23
- SYSD-CCP は、以下を目的とする。
24
-
25
- - 横断的な実装判断(エラー形式、冪等、リトライ、ログ、認証/認可、トランザクション等)を統一する
26
- - チーム内の暗黙知を減らし、レビュー観点を安定させる
27
- - テスト(ITS/ETS/STC)と運用(OPD/OPR)に必要な共通前提を提供する
28
- - 詳細をコードへ寄せつつ、**“コードから自動生成できない意図”** を残す
29
-
30
- 基本方針:
31
-
32
- - ルールは「最小限」かつ「強い」を原則とし、禁止・必須・例外条件を明確にする
33
- - ルールは可能な限り測定可能/検証可能(CI/lint/テスト)な形で定義する
34
- - 例外は SYSD-CCP 本文に散らさず、DECで理由と影響範囲を管理する
35
-
36
- ## 2. 位置づけと用語定義(必要に応じて)
37
-
38
- ### 2.1. 位置づけ
20
+ - 複数モジュールに共通する必須・禁止条件を扱い、個別機能の手順や一時作業の計画は持ち込まない。
21
+ - 各ルールを入力条件と観測可能な期待結果で判定できるようにし、規定の存在と実装済みの証拠を区別する。未確定の値は推測しない。
22
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、文書の改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、ルールの適合確認に含めない。
39
23
 
40
- - `sysd-cross-cutting-policy`:実装全体に適用する横断ルールのSSOT
41
- - `sysd-index`:実体定義(OpenAPI/AsyncAPI/schema/workflow など)への導線
42
- - `sysd-critical-flows`:事故予防のための重要フロー(難所)
43
- - `nfr-*`:非機能要件の基準値
44
- - `opd-*` / `opr-*`:運用方針・運用手順
45
- - `dec-*`:例外や設計判断の根拠
24
+ ## 2. 位置づけと用語定義
46
25
 
47
- ### 2.2. 用語定義
26
+ | 情報 | 責務 |
27
+ | -------------------------- | ------------------------------------------------------ |
28
+ | システム設計索引 | 実装・設定・schema・生成物の所在と変更の入口 |
29
+ | 横断ルール | 複数領域に共通する不変条件、適用範囲、例外、検証の正本 |
30
+ | 個別設計・非機能要件・運用 | 個別の構成、目標値、通知・保持・回復手順の詳細 |
31
+ | 決定記録・登録簿 | 例外承認、課題・リスク・変更の正本 |
48
32
 
49
- | 用語 | 定義 |
50
- | ----------- | ------------------------------------------------------------- |
51
- | 横断ルール | 複数モジュール/サービスに共通して適用される実装・運用の規約 |
52
- | 例外 | SYSD-CCPの通常ルールから外れる運用。理由と期限をDECで明示する |
53
- | Enforcement | ルールを守らせる検証手段(CI、テスト、レビュー等) |
33
+ 「例外」は承認を得て通常規則から外れる条件、「不適合」は未承認の逸脱、「未確認」は適合証拠が未取得の状態とする。未確認を例外や実装済みへ読み替えない。
54
34
 
55
35
  ## 3. ファイル命名・ID規則
56
36
 
57
- - 生成対象ドキュメントIDは `sysd-cross-cutting-policy` を推奨する。
58
- - ルールIDは `scp-<カテゴリ>-<連番>` を推奨する(例: `scp-ERR-001`)。
59
- - カテゴリ例:`ERR`, `API`, `RET`, `IDM`, `TXN`, `LOG`, `SEC`, `CFG`, `MOD`, `JOB`。
60
- - 1ルール=1論点を原則とし、例外条件と意図は同一ルール内で簡潔に記述する。
37
+ - ファイル名は `sysd-cross-cutting-policy.md` を基本とする。
38
+ - ルール ID は `scp-<カテゴリ>-<連番>` とし、同じ適用範囲内で一意にする。
39
+ - カテゴリは `ERR`(エラー)、`IDM`(冪等)、`TIM`(時間制御)、`RET`(再試行)、`LOG`(ログ)、`TRC`(追跡)、`SEC`(保護)、`CFG`(設定)、`MOD`(境界)等を使う。カテゴリ追加で必須領域を隠さない。
40
+ - 置き換え・廃止した Rule ID は再利用せず、ルール一覧に後継 Rule ID または廃止理由を残す。その Rule の Owner が、「関連導線」の変更影響に挙げた参照先(システム設計索引・実装・テスト・運用文書)と検証の対応の更新を確かめる。
61
41
 
62
42
  ## 4. 推奨 Frontmatter 項目
63
43
 
64
- ### 4.1. 設定内容
44
+ - 共通の型・許容値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と成果物 Frontmatter schema を正とする。
45
+ - `type` は `architecture`、`rulebook` は `specdojo:sysd-cross-cutting-policy-rulebook` とし、設計索引へは `part_of` で接続する。`based_on` は判断に使った依存範囲内の文書だけにする。
65
46
 
66
- 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))。
47
+ ## 5. 本文要件
67
48
 
68
- | 項目 | 説明 | 必須 |
69
- | ---------- | ------------------------------------------------ | ---- |
70
- | id | SYSD-CCP ID(推奨: `sysd-cross-cutting-policy`) | ○ |
71
- | type | `architecture` 固定 | ○ |
72
- | title | システム設計: 横断ルール | ○ |
73
- | status | `draft` / `ready` / `deprecated` | ○ |
74
- | based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
75
- | supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
49
+ 見出し順・表の骨組みは template を正とし、ここでは意味要件を定める。
76
50
 
77
- ### 4.2. 推奨ルール
51
+ | 内容 | 必須 | 意味・判定に必要な情報 |
52
+ | ------------------ | ---- | ----------------------------------------------------------------------------------------------- |
53
+ | 概要 | ○ | 対象・対象外、競合時の優先判断、上位価値への寄与、誰がどの判断に使うか |
54
+ | ルール一覧 | ○ | ID・カテゴリ・要約・必須度・Owner。全詳細と対応し、実装状況または確認待ちと確認時機へ接続 |
55
+ | 各ルール詳細 | ○ | Rule、Rationale、Scope、Enforcement、Exception、References の六要素。条件・期待結果・正本・検証 |
56
+ | 例外 | ○ | 承認済み例外の対象 Rule ID・理由・影響・期限・判断者・復帰条件・決定参照。不適合との区別 |
57
+ | 関連導線 | ○ | 設計、非機能、運用、テスト、判断記録への入口。Rule 変更から schema・互換性・移行・回帰への影響 |
58
+ | 未決事項・公開条件 | ○ | 未確定の対象 Rule ID、論点と影響(当面の扱い)。実装の根拠にする前に済ませる適合確認 |
78
59
 
79
- - `based_on` にはルール策定に直接利用した成果物のみ列挙する。
80
- - `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
81
-
82
- ## 5. 本文構成(標準テンプレ)
83
-
84
- `sysd-cross-cutting-policy` は以下の見出し構成を **順序固定** で配置する。
85
-
86
- | 番号 | 見出し | 必須 |
87
- | ---- | --------------------------------------------------------------- | ---- |
88
- | 1 | 概要(適用範囲・優先順位) | ○ |
89
- | 2 | ルール一覧(ID/カテゴリ/要約/必須度) | ○ |
90
- | 3 | 各ルール詳細(ID単位) | ○ |
91
- | 4 | 例外(DECリンク) | ○ |
92
- | 5 | 関連ドキュメント導線(SDI/SYSD Critical Flows/NFR/OPD/OPR/DEC) | ○ |
93
-
94
- 補足:
95
-
96
- - ルール一覧は「探しやすさ」を最優先し、カテゴリ単位で整理する。
97
- - 例外の詳細本文は書かず、例外条件の入口とDECリンクのみを置く。
60
+ - 共通エラー・冪等・時間上限と打切り・retry・診断ログと監査・トレーシング・秘密と権限・設定上書き・モジュール境界を必ず検討する。非該当は理由と代替手段(または代替不要の理由)を示す。
61
+ - HTTP API がなければ CLI 等のエラー契約、DB がなければファイル保存と途中状態の整合性を扱う。特定技術の不在を領域全体の対象外理由にしない。
62
+ - retry は冪等前提、signal 分類、回数の数え方、attempt・backoff 上限、上限到達時の処置を正本の値または設定キーへ接続する。未定義なら受入を保留する。
63
+ - timeout は経路別の設定・単位、終了対象、部分出力・保存状態、再開条件を結ぶ。ログ・監視は相関、秘匿化、保持、検知・通知・一次対応の範囲を示す。
64
+ - 完成例では架空の正本・検証コマンドを未同梱と明示し、検証計画を実行済み証跡として扱わない。
98
65
 
99
66
  ## 6. 記述ガイド
100
67
 
101
- ### 6.1. 概要(適用範囲・優先順位)
102
-
103
- 生成する本文の見出しは **## 1. 概要(適用範囲・優先順位)**
68
+ 以下は局所的な判断例であり、完成例は sample を参照する。
104
69
 
105
- - SYSD-CCP が対象とする範囲(横断ルールの適用境界)を 1〜3 段落で明記する。
106
- - 「ルールは最小限」「検証可能性を優先」「例外はDECで管理」の原則を明記する。
107
- - ルール間の優先順位(例: `SEC > ERR > RET > IDM > LOG > CFG > MOD > JOB`)を必要に応じて明示する。
70
+ ### 6.1. 概要
108
71
 
109
- ### 6.2. ルール一覧(ID/カテゴリ/要約/必須度)
72
+ 判断基準は、読む人が対象と適用しない境界、競合時の判断を説明できることである。
110
73
 
111
- 生成する本文の見出しは **## 2. ルール一覧(ID/カテゴリ/要約/必須度)**
74
+ - 良い例: 「CLI と日次処理を対象にし、無限再試行を防いで参加者の復旧負荷を減らす。外部連携の契約と競合した場合は契約を優先する」。
75
+ - 悪い例: 「全体に適切な規則を適用する」。対象と境界が判断できない。
112
76
 
113
- - ルールID、カテゴリ、要約、必須度(MUST/MUST NOT/SHOULD)、Owner を表形式で記載する。
114
- - 一覧は「探しやすさ」を優先し、カテゴリ順または重要度順で並べる。
115
- - ルール詳細本文に飛べる参照(IDの一致)を必ず担保する。
77
+ ### 6.2. ルール一覧
116
78
 
117
- ### 6.3. 各ルール詳細(ID単位)
79
+ 判断基準は、一覧・詳細・適合確認の Rule ID が対応し、要約と必須度の組合せで要求・禁止が同じ意味になることである。推奨列は `Rule ID / Category / Summary / Level / Owner` とし、適合状況・確認時機は別表へ分けてもよい。作業の進捗は本文で二重管理しない。
118
80
 
119
- 生成する本文の見出しは **## 3. 各ルール詳細(ID単位)**
81
+ - 良い例: 「`scp-CFG-001`、不正設定で起動しない、MUST、DEV、実装未照合、起動前に V2 で確認」。
82
+ - 悪い例: 「設定責務を分離する、MUST NOT」。必須度を組み合わせると意図と逆になる。
120
83
 
121
- 各ルールは以下を必ず含める。
84
+ ### 6.3. 各ルール詳細
122
85
 
123
- - **Rule(必須/禁止)**:何を守るか(MUST / MUST NOT / SHOULD)
124
- - **Rationale(意図)**:なぜ必要か(1〜3行)
125
- - **Scope(適用範囲)**:どこに適用するか(API/ジョブ/イベント等)
126
- - **Enforcement(検証)**:どう検証するか(CI/テスト/レビュー)
127
- - **Exception(例外)**:例外条件と参照すべきDEC(ある場合)
128
- - **References(参照)**:SDI/SYSD Critical Flows/NFR/OPD/OPR等への導線
86
+ 判断基準は、条件が同じなら期待動作と合否が一意になり、検証する正本へ到達できることである。Rule は不変条件に絞り、検証の入口は Enforcement、低レベル手順は実装・運用正本に置く。
129
87
 
130
- ### 6.4. 例外(DECリンク)
88
+ - 良い例: 「再送は保存済みの受付結果を照合した後だけ許可する。応答欠落では結果不明を保持し、自動再送しない。回帰対象と実行コマンドは検証表へ接続する」。
89
+ - 悪い例: 「criticality に応じて retry」。区分・signal 対応・上限の正本がなく判断不能。
131
90
 
132
- 生成する本文の見出しは **## 4. 例外(DECリンク)**
91
+ ### 6.4. 例外
133
92
 
134
- - 例外の詳細本文は書かず、例外条件・影響範囲・期限・DECリンクのみを記載する。
135
- - 例外が恒久化しそうな場合は、SYSD-CCP本体ルールへの取り込み可否を定期レビューする。
136
- - 例外未記載の実装差分は不適合として扱う。
93
+ 判断基準は、通常ルールへ復帰でき、未承認の不適合と承認済みの逸脱を区別できることである。
137
94
 
138
- ### 6.5. 関連ドキュメント導線
95
+ - 良い例: 「依存の暫定許可は対象 adapter のみ、移行完了日まで、decision と復帰条件を記録。違反は issue として報告する」。
96
+ - 悪い例: 「緊急時は担当判断で無期限に解除」。影響・期限・復帰が追跡できない。
139
97
 
140
- 生成する本文の見出しは **## 5. 関連ドキュメント導線(SYSD/SYSD-CF/NFR/OPD/OPR/DEC)**
98
+ ### 6.5. 関連導線
141
99
 
142
- - ルールごとに、SYSD(一次情報)、SYSD Critical Flows(重要フロー)、NFR、OPD/OPR、DEC への導線を明記する。
143
- - 参照先は「ID」または「リポジトリ相対パス」で一意に辿れる形にする。
144
- - 分冊が無い場合でも `(本書のみ)` または `(なし)` を明記し、空欄にしない。
100
+ 判断基準は、読み手が現行正本へ進み、変更時の追従先を選べることである。呼称は参照先の文書名に揃える。
145
101
 
146
- ### 6.6. SYSD-CCP が扱う対象(推奨カテゴリ)
102
+ - 良い例: 「保存形式変更は schema と移行を同期し、旧形式・再実行の回帰を確認する。運用索引は未作成のため整備後に接続する」。
103
+ - 悪い例: 「provider 別設計、運用一式、旧フロー参照」。実在する ID・相対パスがなく特定できない。
147
104
 
148
- - API契約の共通ルール(バージョニング、互換性、エラー形式)
105
+ ### 6.6. 未決事項と公開条件
149
106
 
150
- - 例外/エラー処理(分類、再試行可否、ユーザ通知)
151
- - タイムアウト/リトライ(回数、バックオフ、打ち切り、冪等前提)
152
- - 冪等(キー、重複排除、整合性)
153
- - トランザクション/整合性(境界、最終的整合性、補償)
154
- - ログ/監査ログ(必須項目、保持、PII取り扱い)
155
- - トレーシング(trace_id、propagation)
156
- - セキュリティ(認証・認可の実装原則、秘密情報、監査)
157
- - 設定(上書き階層、変更反映、デフォルト管理)
158
- - モジュール境界/依存方向(アーキ制約)
159
- - ジョブ運用の共通(再実行性、run_id、失敗時通知)
107
+ 判断基準は、未決の論点がどの Rule ID の受入を止めるかと当面の扱いが分かることである。未発行の作業 ID を発行済みとみなさない。
160
108
 
161
- ### 6.7. 必須で定義すべき最小ルールセット(推奨)
162
-
163
- 1. **共通エラー形式(API)**:error_code / message / detail / trace_id
164
- 2. **エラー分類**:再試行可否、ユーザ通知可否、監査要否
165
- 3. **タイムアウト既定値**:内部/外部の基準値
166
- 4. **リトライ規約**:回数、バックオフ、打ち切り、冪等前提
167
- 5. **冪等キー**:どこで必須か、重複時の挙動
168
- 6. **トランザクション境界**:commitの責務、跨ぎの扱い(非同期/補償)
169
- 7. **ログ必須項目**:trace_id / request_id / entity_id / result 等
170
- 8. **監査ログ**:who/when/what/before/after、保持期間、PII
171
- 9. **認証/認可の原則**:ポリシーの置き場、権限チェック責務
172
- 10. **設定上書き階層**:既定値・環境・テナント等、反映方法
173
- 11. **モジュール依存方向**:禁止依存、例外手続き
174
- 12. **ジョブ再実行性**:run_id、冪等、失敗時通知
175
-
176
- ### 6.8. SYSD-CCP に書かないもの
177
-
178
- - OpenAPI/AsyncAPI/DB schema の本文コピー(SSOTと二重管理)
179
- - 画面仕様の詳細(UISへ)
180
- - 低レベル実装手順(OPR/Runbookやコードコメントへ)
181
- - プロジェクト固有の一時対応の羅列(運用チケット/OPRへ)
109
+ - 良い例: 「`_UNDECIDED_`: 通知先。決まるまで `scp-LOG-001` の検知・通知は未確認とし、失敗注入での確認を受入の前提に残す」。
110
+ - 悪い例: 「NFR / OPD は後続で接続する」。何が未決でどのルールに効くか分からない。
182
111
 
183
112
  ## 7. 禁止事項
184
113
 
185
- | 禁止事項 | 理由 |
186
- | --------------------------------------------- | ---------------------------- |
187
- | ルールを増やし続け、インデックス管理しない | 探索性が落ちるため |
188
- | 努力目標表現のみで MUST / MUST NOT を示さない | 実装判断がぶれるため |
189
- | 例外をSYSD-CCP本文に散在させる | 例外管理が追跡不能になるため |
190
- | SSOT本文(OpenAPI/DDL等)を貼り付ける | 二重管理で不整合を招くため |
191
- | 検証方法(CI/テスト/レビュー)を書かない | ルールが形骸化するため |
192
-
193
- ## 8. サンプル
194
-
195
- 注:以下はルール文書内の例示です。生成する `sysd-cross-cutting-policy` では `## 1...` から始まります。
196
-
197
- ```yaml
198
- ---
199
- id: sysd-cross-cutting-policy
200
- type: architecture
201
- title: システム設計: 横断ルール
202
- status: draft
203
- based_on: []
204
- supersedes: []
205
- ---
206
- ```
207
-
208
- ### 8.1. 概要(適用範囲・優先順位)
209
-
210
- 本書は、実装全体に適用する横断ルールを統一し、レビュー判断と運用判断を一貫させるための基準である。
211
- 優先順位は `SEC > ERR > RET > IDM > LOG > CFG > MOD > JOB` を原則とする。
212
-
213
- ### 8.2. ルール一覧(ID/カテゴリ/要約/必須度)
214
-
215
- <!-- prettier-ignore -->
216
- | Rule ID | Category | Summary | Level | Owner |
217
- | --- | --- | --- | --- | --- |
218
- | scp-API-001 | API | 共通エラー応答形式を統一する | MUST | Dev |
219
- | scp-RET-001 | Retry/Timeout | 外部I/Fのタイムアウトとリトライ規約 | MUST | Dev/Ops |
220
- | scp-IDM-001 | Idempotency | 更新系APIは冪等キーを必須とする | MUST | Dev |
221
- | scp-LOG-001 | Logging | 共通ログ項目(trace_id等) | MUST | Dev |
222
- | scp-SEC-001 | Security | 認可チェック責務と境界 | MUST | Dev |
223
- | scp-CFG-001 | Config | 設定上書き階層と反映方法 | MUST | Dev/Ops |
224
- | scp-MOD-001 | Module | 依存方向(domain←app←interface) | MUST | Dev |
225
- | scp-JOB-001 | Job | run_id と再実行性 | MUST | Ops |
226
-
227
- ### 8.3. 各ルール詳細(ID単位)
228
-
229
- #### scp-API-001: 共通エラー応答形式
230
-
231
- - **Rule(MUST)**
232
- すべてのHTTP APIは、エラー時に共通フォーマットで応答する。
233
- 必須フィールド:`error_code`, `message`, `detail`, `trace_id`
234
-
235
- - **Rationale(意図)**
236
- クライアント実装の分岐を減らし、障害解析を高速化する。
237
-
238
- - **Scope(適用範囲)**
239
- 内部API・外部公開API(REST)すべて。
240
-
241
- - **Enforcement(検証)**
242
- OpenAPIにエラースキーマを共通定義し、CIでlintする。
243
- ITSで代表エラーケースを検証する。
244
-
245
- - **Exception(例外)**
246
- 例外が必要な場合はDECを起票し、影響範囲と移行方針を明記する。
247
-
248
- - **References(参照)**
249
- SDI:OpenAPI定義(`api/openapi.yaml`)
250
- テスト:ITC(エラー系) / 運用:OPD(アラート)
251
-
252
- #### scp-RET-001: 外部I/Fのタイムアウトとリトライ
253
-
254
- - **Rule(MUST)**
255
- 外部I/F呼び出しはタイムアウトを必ず設定し、最大3回まで指数バックオフでリトライする。
256
- リトライは **冪等が担保できる場合のみ** 実施する。
257
-
258
- - **Rationale(意図)**
259
- ハング/遅延の波及を防ぎ、外部障害時の影響を限定する。
260
-
261
- - **Scope(適用範囲)**
262
- 外部API、外部メッセージ送信、外部ファイル転送。
263
-
264
- - **Enforcement(検証)**
265
- ETSでタイムアウト/リトライ/二重送信防止を検証する。
266
- リトライ回数・待機は設定で制御し、既定値をconfig schemaで固定する。
267
-
268
- - **Exception(例外)**
269
- 課金など二重実行が致命的な場合は、DECで別方式(補償/確認照会)を定義する。
270
-
271
- - **References(参照)**
272
- SDI:外部I/F仕様(OpenAPI/AsyncAPI/EFES)
273
- SYSD Critical Flows:外部決済フロー(存在する場合)
274
- OPD:外部I/Fの監視指標(エラー率/レイテンシ)
275
-
276
- #### scp-MOD-001: モジュール依存方向
277
-
278
- - **Rule(MUST NOT / MUST)**
279
- `domain` は `application` / `interface` に依存してはならない。
280
- 依存方向は **domain ← application ← interface** を守る。
281
-
282
- - **Rationale(意図)**
283
- ドメインロジックを技術詳細から分離し、変更耐性とテスト容易性を高める。
284
-
285
- - **Scope(適用範囲)**
286
- 全コード(ビルド単位/パッケージ/ディレクトリ)。
287
-
288
- - **Enforcement(検証)**
289
- 静的解析/アーキテクチャテスト(例:依存ルールテスト)で検証する。
290
- PRレビューで違反をブロックする。
291
-
292
- - **Exception(例外)**
293
- 例外は原則認めない。やむを得ない場合はDECで期限付き例外とする。
294
-
295
- - **References(参照)**
296
- SDI:モジュール境界ドキュメント/規約へのリンク
297
- テスト:UTS(層別テスト方針)
298
-
299
- ### 8.4. 例外(DECリンク)
300
-
301
- | Rule ID | 例外条件 | 影響範囲 | 期限 | DEC |
302
- | ----------- | ------------------------ | ------------------- | ---------- | ----------------------------------- |
303
- | scp-RET-001 | 外部課金APIで再送が不可 | 決済機能のみ | 2026-12-31 | `dec-00xx-payment-retry-exception` |
304
- | scp-MOD-001 | 移行期間中の一時依存許容 | legacy adapter のみ | 2026-06-30 | `dec-00yy-legacy-dependency-waiver` |
305
-
306
- ### 8.5. 関連ドキュメント導線(SYSD/SYSD-CF/NFR/OPD/OPR/DEC)
307
-
308
- | 種別 | ドキュメントID/参照先 | 目的 | 備考 |
309
- | ---------- | ------------------------------------------------------ | ---------------------------- | ---- |
310
- | SSOT | sysd-index / `api/openapi.yaml` / `config/schema.yaml` | 一次情報参照 | 必須 |
311
- | 重要フロー | sysd-critical-flows | 難所フローでのルール適用確認 | 必須 |
312
- | 非機能 | nfr-index | タイムアウト/SLA/SLO整合 | 必須 |
313
- | 運用 | opd-index / opr-index | 監視・障害対応・証跡運用 | 必須 |
314
- | 判断記録 | dec-index | 例外・設計判断の追跡 | 必須 |
114
+ | 禁止事項 | 理由 |
115
+ | -------------------------------------------------------- | ------------------------------ |
116
+ | 実装・schema・リファレンスの値・構文・構造を全文転載する | 二重管理になる |
117
+ | 確認していない上限値・設定キー・実装状況を作る | 実装・検証の前提を誤らせる |
118
+ | 非該当と未整備を混同し必須領域を消す | 障害・回復・観測の責務が欠ける |
119
+ | 検査名だけで入力・期待結果・実行経路を示さない | 合否を再現できない |
120
+ | 例外を散在させ、期限・判断・復帰を省く | 通常規則へ戻せない |
121
+ | 置き換え・廃止した Rule ID を再利用する、後継を示さない | 実装・テストの参照が追えない |