specdojo 0.1.0 → 0.2.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 (540) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +142 -35
  3. package/dist/agent-response.js +27 -0
  4. package/dist/agent.js +124 -0
  5. package/dist/build-command.js +149 -0
  6. package/dist/build-if-stale.js +35 -0
  7. package/dist/catalog-build.js +1079 -0
  8. package/dist/catalog-generate.js +226 -0
  9. package/dist/catalog-paths.js +31 -0
  10. package/dist/catalog-plan-generate.js +301 -0
  11. package/dist/catalog-plan-prompt.js +73 -0
  12. package/dist/catalog-plan.js +471 -0
  13. package/dist/catalog-scaffold.js +255 -0
  14. package/dist/catalog-types.js +4 -0
  15. package/dist/catalog.js +606 -0
  16. package/dist/dashboard.js +990 -0
  17. package/dist/deliverable-trash.js +148 -0
  18. package/dist/deliverable.js +97 -0
  19. package/dist/dist-freshness.js +150 -0
  20. package/dist/doc-index.js +424 -0
  21. package/dist/exec-agent-config.js +172 -0
  22. package/dist/exec-agent-git-state.js +136 -0
  23. package/dist/exec-agent-protected-config.js +276 -0
  24. package/dist/exec-events.js +250 -112
  25. package/dist/exec-evidence.js +317 -0
  26. package/dist/exec-format.js +54 -0
  27. package/dist/exec-limit.js +202 -0
  28. package/dist/exec-parent-validation.js +169 -0
  29. package/dist/exec-pipeline-state.js +160 -0
  30. package/dist/exec-plans.js +1016 -0
  31. package/dist/exec-project.js +25 -11
  32. package/dist/exec-protection-handoff.js +169 -0
  33. package/dist/exec-provider-scaffold.js +99 -0
  34. package/dist/exec-register-resume.js +196 -0
  35. package/dist/exec-register.js +281 -0
  36. package/dist/exec-reporter.js +329 -0
  37. package/dist/exec-results.js +510 -0
  38. package/dist/exec-run-lock.js +149 -0
  39. package/dist/exec-run.js +4953 -0
  40. package/dist/exec-schedule-calendar.js +86 -9
  41. package/dist/exec-schedule-cpm.js +30 -12
  42. package/dist/exec-schedule-gantt-chart-render.js +428 -0
  43. package/dist/exec-schedule-gantt-chart-scope.js +111 -0
  44. package/dist/exec-schedule-gantt-chart.js +2 -0
  45. package/dist/exec-schedule-hash.js +34 -25
  46. package/dist/exec-schedule-index.js +200 -67
  47. package/dist/exec-schedule-initial.js +100 -0
  48. package/dist/exec-schedule-progress.js +51 -26
  49. package/dist/exec-schedule-ready.js +71 -27
  50. package/dist/exec-schedule.js +171 -93
  51. package/dist/exec-shared.js +146 -25
  52. package/dist/exec-strategy.js +547 -0
  53. package/dist/exec-task-view.js +64 -0
  54. package/dist/exec-trial.js +895 -0
  55. package/dist/exec-worktree-command.js +426 -0
  56. package/dist/exec-worktree-ops.js +847 -0
  57. package/dist/exec-worktree.js +359 -0
  58. package/dist/exec.js +744 -192
  59. package/dist/frontmatter-namespace.js +48 -0
  60. package/dist/git-environment.js +23 -0
  61. package/dist/grade-result.js +137 -0
  62. package/dist/grade.js +2456 -0
  63. package/dist/index-command.js +103 -0
  64. package/dist/job.js +1081 -0
  65. package/dist/kata-command.js +303 -0
  66. package/dist/kata.js +187 -0
  67. package/dist/package-paths.js +33 -0
  68. package/dist/practice-id.js +24 -0
  69. package/dist/register-date.js +122 -0
  70. package/dist/register-events.js +363 -0
  71. package/dist/register-history.js +323 -0
  72. package/dist/register-item.js +455 -0
  73. package/dist/register-migrate-timestamps.js +176 -0
  74. package/dist/register.js +2199 -0
  75. package/dist/review-plan.js +199 -0
  76. package/dist/review-types.js +1 -0
  77. package/dist/role-types.js +1 -0
  78. package/dist/routine.js +814 -0
  79. package/dist/schedule-approach.js +252 -0
  80. package/dist/schedule-build.js +552 -0
  81. package/dist/schedule-phase-sets.js +73 -0
  82. package/dist/schedule-strategy-generate.js +812 -0
  83. package/dist/schedule-strategy-profiles.js +276 -0
  84. package/dist/schedule.js +420 -0
  85. package/dist/spawn-self.js +28 -0
  86. package/dist/specdojo-config.js +133 -39
  87. package/dist/specdojo.js +56 -7
  88. package/dist/template-frontmatter.js +89 -0
  89. package/dist/template-resolution.js +92 -0
  90. package/dist/timeline-build.js +334 -0
  91. package/dist/timeline.js +107 -0
  92. package/dist/watch.js +313 -0
  93. package/dist/yaml-pages-command.js +28 -0
  94. package/dist/yaml-pages.js +180 -0
  95. package/dist/yaml-schema-modeline.js +49 -0
  96. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
  97. package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
  98. package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
  99. package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
  100. package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
  101. package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
  102. package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
  103. package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
  104. package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
  105. package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
  106. package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
  107. package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
  108. package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
  109. package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
  110. package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
  111. package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
  112. package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
  113. package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
  114. package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
  115. package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
  116. package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
  117. package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
  118. package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
  119. package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
  120. package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
  121. package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
  122. package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
  123. package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
  124. package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
  125. package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
  126. package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
  127. package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
  128. package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
  129. package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
  130. package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
  131. package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
  132. package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
  133. package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
  134. package/docs/ja/specdojo/guides/kata-guide.md +89 -0
  135. package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
  136. package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
  137. package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
  138. package/docs/ja/specdojo/guides/quick-start-guide.md +472 -0
  139. package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
  140. package/docs/ja/specdojo/guides/remote-host-development-guide.md +163 -0
  141. package/docs/ja/specdojo/guides/review-guide.md +428 -0
  142. package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
  143. package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
  144. package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
  145. package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
  146. package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
  147. package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
  148. package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
  149. package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
  150. package/docs/ja/specdojo/guides/waza-guide.md +224 -0
  151. package/docs/ja/specdojo/index.md +33 -0
  152. package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
  153. package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
  154. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
  155. package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
  156. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
  157. package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
  158. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
  159. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
  160. package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
  161. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
  162. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
  163. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
  164. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
  165. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
  166. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
  167. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
  168. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
  169. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
  170. package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
  171. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
  172. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
  173. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
  174. package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
  175. package/docs/ja/specdojo/references/command-reference.md +718 -0
  176. package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
  177. package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
  178. package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
  179. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
  180. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
  181. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
  182. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
  183. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
  184. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
  185. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
  186. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
  187. package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
  188. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
  189. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
  190. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
  191. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
  192. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
  193. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
  194. package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
  195. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
  196. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
  197. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
  198. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
  199. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
  200. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
  201. package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
  202. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
  203. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
  204. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
  205. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
  206. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
  207. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
  208. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
  209. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
  210. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
  211. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
  212. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
  213. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
  214. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
  215. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
  216. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
  217. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
  218. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
  219. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
  220. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
  221. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
  222. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
  223. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
  224. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
  225. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
  226. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
  227. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
  228. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
  229. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
  230. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
  231. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
  232. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
  233. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
  234. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
  235. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
  236. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
  237. package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
  238. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
  239. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
  240. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
  241. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
  242. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
  243. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
  244. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
  245. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
  246. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
  247. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
  248. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
  249. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
  250. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
  251. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
  252. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
  253. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
  254. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
  255. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
  256. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
  257. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
  258. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
  259. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
  260. package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
  261. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
  262. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
  263. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
  264. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
  265. package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
  266. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
  267. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
  268. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
  269. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
  270. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
  271. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
  272. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
  273. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
  274. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
  275. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
  276. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
  277. package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
  278. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
  279. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
  280. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
  281. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
  282. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
  283. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
  284. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
  285. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
  286. package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
  287. package/docs/ja/specdojo/samples/atc-sample.md +41 -0
  288. package/docs/ja/specdojo/samples/bac-sample.md +38 -0
  289. package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
  290. package/docs/ja/specdojo/samples/bds-sample.md +38 -0
  291. package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
  292. package/docs/ja/specdojo/samples/bes-sample.md +38 -0
  293. package/docs/ja/specdojo/samples/bps-sample.md +38 -0
  294. package/docs/ja/specdojo/samples/br-sample.md +40 -0
  295. package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
  296. package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
  297. package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
  298. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
  299. package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
  300. package/docs/ja/specdojo/samples/cld-sample.md +38 -0
  301. package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
  302. package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
  303. package/docs/ja/specdojo/samples/cop-sample.md +38 -0
  304. package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
  305. package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
  306. package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
  307. package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
  308. package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
  309. package/docs/ja/specdojo/samples/dec-sample.md +39 -0
  310. package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
  311. package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
  312. package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
  313. package/docs/ja/specdojo/samples/etc-sample.md +38 -0
  314. package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
  315. package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
  316. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
  317. package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
  318. package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
  319. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
  320. package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
  321. package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
  322. package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
  323. package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
  324. package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
  325. package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
  326. package/docs/ja/specdojo/samples/itc-sample.md +38 -0
  327. package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
  328. package/docs/ja/specdojo/samples/mm-sample.md +35 -0
  329. package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
  330. package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
  331. package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
  332. package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
  333. package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
  334. package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
  335. package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
  336. package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
  337. package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
  338. package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
  339. package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
  340. package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
  341. package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
  342. package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
  343. package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
  344. package/docs/ja/specdojo/samples/opd-sample.md +38 -0
  345. package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
  346. package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
  347. package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
  348. package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
  349. package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
  350. package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
  351. package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
  352. package/docs/ja/specdojo/samples/opr-sample.md +38 -0
  353. package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
  354. package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
  355. package/docs/ja/specdojo/samples/otp-sample.md +68 -0
  356. package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
  357. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
  358. package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
  359. package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
  360. package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
  361. package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
  362. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
  363. package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
  364. package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
  365. package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
  366. package/docs/ja/specdojo/samples/pr-sample.md +39 -0
  367. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
  368. package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
  369. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
  370. package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
  371. package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
  372. package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
  373. package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
  374. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
  375. package/docs/ja/specdojo/samples/sac-sample.md +38 -0
  376. package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
  377. package/docs/ja/specdojo/samples/sf-sample.md +38 -0
  378. package/docs/ja/specdojo/samples/sld-sample.md +38 -0
  379. package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
  380. package/docs/ja/specdojo/samples/stc-sample.md +38 -0
  381. package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
  382. package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
  383. package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
  384. package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
  385. package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
  386. package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
  387. package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
  388. package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
  389. package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
  390. package/docs/ja/specdojo/samples/uis-sample.md +38 -0
  391. package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
  392. package/docs/ja/specdojo/samples/utc-sample.md +38 -0
  393. package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
  394. package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
  395. package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
  396. package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
  397. package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
  398. package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
  399. package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
  400. package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
  401. package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
  402. package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
  403. package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
  404. package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
  405. package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
  406. package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
  407. package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
  408. package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
  409. package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
  410. package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
  411. package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
  412. package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
  413. package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
  414. package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
  415. package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
  416. package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
  417. package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
  418. package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
  419. package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
  420. package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
  421. package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
  422. package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
  423. package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
  424. package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
  425. package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
  426. package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
  427. package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
  428. package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
  429. package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
  430. package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
  431. package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
  432. package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
  433. package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
  434. package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
  435. package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
  436. package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
  437. package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
  438. package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
  439. package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
  440. package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
  441. package/docs/ja/specdojo/templates/opr-template.md +85 -0
  442. package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
  443. package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
  444. package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
  445. package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
  446. package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
  447. package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
  448. package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
  449. package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
  450. package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
  451. package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
  452. package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
  453. package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
  454. package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
  455. package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
  456. package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
  457. package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
  458. package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
  459. package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
  460. package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
  461. package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
  462. package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
  463. package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
  464. package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
  465. package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
  466. package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
  467. package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
  468. package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
  469. package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
  470. package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
  471. package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
  472. package/docs/ja/specdojo/templates/stsd-template.md +57 -0
  473. package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
  474. package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
  475. package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
  476. package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
  477. package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
  478. package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
  479. package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
  480. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
  481. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
  482. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
  483. package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
  484. package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
  485. package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
  486. package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
  487. package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
  488. package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
  489. package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
  490. package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
  491. package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
  492. package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
  493. package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
  494. package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
  495. package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
  496. package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
  497. package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
  498. package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
  499. package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
  500. package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
  501. package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
  502. package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
  503. package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
  504. package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
  505. package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
  506. package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
  507. package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
  508. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
  509. package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
  510. package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
  511. package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
  512. package/package.json +121 -24
  513. package/templates/antigravity/README.md +35 -0
  514. package/templates/antigravity/exec-defaults-snippet.yaml +38 -0
  515. package/templates/antigravity/orchestrator.md +146 -0
  516. package/templates/antigravity/pm-members-snippet.yaml +55 -0
  517. package/templates/claude/README.md +46 -0
  518. package/templates/claude/agents/claude-expert-review-executor.md +14 -0
  519. package/templates/claude/agents/claude-review-executor.md +14 -0
  520. package/templates/claude/agents/specdojo-orchestrator.md +153 -0
  521. package/templates/claude/settings.edit.json +6 -0
  522. package/templates/claude/settings.report.json +6 -0
  523. package/templates/claude/settings.review.json +7 -0
  524. package/templates/codex/README.md +61 -0
  525. package/templates/codex/agents/codex-executor.toml +12 -0
  526. package/templates/codex/agents/codex-expert-executor.toml +12 -0
  527. package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
  528. package/templates/codex/agents/codex-review-executor.toml +10 -0
  529. package/templates/codex/agents/specdojo-orchestrator.toml +154 -0
  530. package/templates/codex/orchestrator.md +146 -0
  531. package/templates/copilot/README.md +41 -0
  532. package/templates/copilot/exec-defaults-snippet.yaml +28 -0
  533. package/templates/copilot/pm-members-snippet.yaml +44 -0
  534. package/templates/opencode/README.md +41 -0
  535. package/templates/opencode/agents/opencode-executor.md +59 -0
  536. package/templates/opencode/agents/opencode-reporter.md +26 -0
  537. package/templates/opencode/agents/opencode-review-executor.md +48 -0
  538. package/templates/opencode/agents/specdojo-orchestrator.md +193 -0
  539. package/dist/exec-schedule-timeline-render.js +0 -201
  540. package/dist/exec-schedule-timeline.js +0 -2
@@ -0,0 +1,376 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:sysd-critical-flows-rulebook
4
+ type: rulebook
5
+ status: draft
6
+ sample: specdojo:sysd-critical-flows-sample
7
+ ---
8
+
9
+ # システム設計 重要フロー 作成ルール
10
+
11
+ System Design Critical Flows (SYSD-CF) Documentation Rules
12
+
13
+ 本ドキュメントは、システム設計情報を **コード(定義ファイル)へ寄せる運用(Code as Spec)** を前提に、
14
+
15
+ 「読まないと事故る」重要フローだけを最小限で記述する **System Design Critical Flows (SYSD-CF)** の記述ルールを定義する。
16
+
17
+ SYSD Critical Flows は詳細設計書ではない。**実装・テスト・運用の共通理解が必要な“難所”** に限定して可視化する。
18
+
19
+ ## 1. 全体方針
20
+
21
+ SYSD-CF は、以下を目的とする。
22
+
23
+ - **誤解や事故が起きやすい処理**(冪等・非同期・補償・整合性・外部障害など)を最小限で共有する
24
+ - 実装が拡張されても崩れにくい **境界・永続化点・失敗時挙動** をSSOTとして残す
25
+
26
+ - テスト(ITS/ETS/STC)および運用(OPD/OPR)へ **観点と導線** を提供する
27
+
28
+ 基本方針:
29
+
30
+ - 重要フローは **最大5件** を原則とし、追加時は統合・削減で総数を維持する
31
+ - 詳細手順の逐語化は行わず、境界・永続化点・整合性・冪等・失敗時・観測性を明示する
32
+ - API/イベント/DB/ジョブ/設定の詳細はコード・定義ファイルをSSOTとし、SYSD-CFは導線を担う
33
+
34
+ ## 2. 位置づけと用語定義
35
+
36
+ ### 2.1. 位置づけ
37
+
38
+ - `sysd-critical-flows`:システム設計上の重要フローを集約する文書(本体)
39
+ - `sysd-index`:SSOTへのリンク集(SYSD-CFから必ず参照する)
40
+ - `itc-*` / `etc-*` / `stc-*`:SYSD-CFで示した観点を検証するテスト仕様
41
+ - `opd-*` / `opr-*`:失敗時運用・監視・手順の実行ルール
42
+ - `dec-*`:設計判断の背景・採否理由
43
+
44
+ ### 2.2. 用語定義
45
+
46
+ | 用語 | 定義 |
47
+ | ---------- | -------------------------------------------------------- |
48
+ | 重要フロー | 実装・運用事故に直結しやすく、共通理解が必須な処理フロー |
49
+
50
+ | 永続化点 | commit / outbox / enqueue など、状態確定や配送起点となる地点 |
51
+ | 補償 | 一部成功後の不整合を是正するための戻し・取り消し・代替処理 |
52
+
53
+ ## 3. ファイル命名・ID規則
54
+
55
+ - 生成対象ドキュメントIDは `sysd-critical-flows` を推奨する。
56
+ - フローIDは `scf-001` 形式の連番とし、1フロー=1IDとする。
57
+ - フロータイトルは業務結果が分かる表現を使う(例: `scf-001: 売上確定→在庫更新→発注候補生成`)。
58
+
59
+ ## 4. 推奨 Frontmatter 項目
60
+
61
+ ### 4.1. 設定内容
62
+
63
+ 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))。
64
+
65
+ | 項目 | 説明 | 必須 |
66
+
67
+ | ---------- | ----------------------------------------------- | ---- |
68
+ | id | SYSD-CF ID(推奨: `sysd-critical-flows`) | ○ |
69
+ | type | `architecture` など共通スキーマで許容される種別 | ○ |
70
+ | title | システム設計: 重要フロー | ○ |
71
+ | status | `draft` / `ready` / `deprecated` | ○ |
72
+ | based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
73
+ | supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
74
+
75
+ ### 4.2. 推奨ルール
76
+
77
+ - `based_on` には対象フローの判断に直接利用した成果物のみを列挙する。
78
+ - `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)。
79
+
80
+ ## 5. 本文構成(標準テンプレ)
81
+
82
+ `sysd-critical-flows` は以下の見出し構成を **順序固定** で配置する。
83
+
84
+ | 番号 | 見出し | 必須 |
85
+ | ---- | ------------------------------------------- | ---- |
86
+ | 1 | 概要(対象・運用方針) | ○ |
87
+ | 2 | 重要フロー一覧(最大5件) | ○ |
88
+ | 3 | フロー詳細(IDごと) | ○ |
89
+ | 4 | 観測性と運用連携 | ○ |
90
+ | 5 | 関連ドキュメント導線(SDI/テスト/運用/DEC) | ○ |
91
+
92
+ `3. フロー詳細` は、フローIDごとに以下の構成で記述する。
93
+
94
+ - ヘッダ:ID、フロー名、目的、トリガー、範囲(含む/含まない)
95
+ - フロー概要:図(推奨Mermaid)または箇条書き、登場要素、永続化点
96
+ - 整合性・冪等・再実行:整合性モデル、冪等キー、重複時挙動、再実行方針
97
+ - 失敗時:失敗分類、リトライ方針、補償/ロールバック、影響・通知
98
+ - 観測性:trace_id引き回し、必須ログ項目、監査ログ要件
99
+ - 参照:SDI、外部I/F、NFR、OPD/OPR、DEC、ITS/ETS/STC
100
+
101
+ 補足:
102
+
103
+ - フロー数が5件を超える場合は、分割前に統合・重複排除を検討する。
104
+
105
+ ## 6. 記述ガイド
106
+
107
+ ### 6.1. 概要(対象・運用方針)
108
+
109
+ 生成する本文の見出しは **## 1. 概要(対象・運用方針)**
110
+
111
+ - SYSD-CFの適用対象と「最大5件運用」の方針を1〜3段落で明記する。
112
+ - SYSD-CFが詳細実装書ではなく、事故予防のための重要フロー文書であることを明記する。
113
+ - SSOTはコード/定義ファイル側であること(SYSD-CFは導線)を明記する。
114
+
115
+ ### 6.2. 重要フロー一覧(最大5件)
116
+
117
+ 生成する本文の見出しは **## 2. 重要フロー一覧(最大5件)**
118
+
119
+ - フローID、フロー名、事故論点、優先度、備考を表形式で記載する。
120
+ - 一覧は最大5件までとし、6件目以降は統合・削減の検討結果を反映してから追加する。
121
+
122
+ - 事故論点は「冪等」「非同期整合性」「補償」「外部I/F障害」「再実行性」などで明示する。
123
+
124
+ 重要フロー選定の判断基準(いずれか該当):
125
+
126
+ - 冪等が必須(重複実行の現実的リスクがある)
127
+ - 非同期(順序・再実行・重複が絡む)
128
+ - 補償が必要(分散トランザクション、取り消し、戻し)
129
+ - 整合性が難しい(最終的整合性、二重書き込み、在庫/金額/残高)
130
+ - 外部I/F障害が業務影響に直結(タイムアウト、リトライ、部分失敗)
131
+ - 監査対象(改ざん/追跡が必要)
132
+ - 性能/可用性のボトルネック候補(ピーク処理、バッチ遅延)
133
+
134
+ ### 6.3. フロー詳細(IDごと)
135
+
136
+ 生成する本文の見出しは **## 3. フロー詳細(IDごと)**
137
+
138
+ 各フローは以下を順に記載する。
139
+
140
+ - ヘッダ:ID、フロー名、目的、トリガー、範囲(含む/含まない)
141
+ - フロー概要:図(推奨Mermaid)または箇条書き、登場要素、永続化点
142
+ - 図は原則として **C4ダイアグラムのコンポーネント図レベル相当**(コンテナ内の主要コンポーネント間連携)で記述する
143
+ - 整合性・冪等・再実行:整合性モデル、冪等キー、重複時挙動、再実行方針
144
+ - 失敗時:失敗分類、リトライ方針、補償/ロールバック、影響・通知
145
+ - 観測性:trace_id引き回し、必須ログ項目、監査ログ要件
146
+ - 参照:SDI、外部I/F、NFR、OPD/OPR、DEC、ITS/ETS/STC
147
+
148
+ 図の記法(推奨):
149
+
150
+ - Flowchart:境界と流れ(同期/非同期)を表現
151
+ - SequenceDiagram:時系列と呼び出し順(必要時のみ)
152
+ - 概要図の粒度は **C4コンポーネント図レベル相当** とし、実装クラス/メソッド詳細には踏み込まない
153
+
154
+ ```mermaid
155
+
156
+ flowchart LR
157
+ UI[UI] -->|POST /sales| API[Sales API]
158
+ API --> SVC[Sales Service]
159
+ SVC -->|commit| DB[(Sales DB)]
160
+ SVC -->|outbox enqueue| OB[(Outbox)]
161
+ OB -->|publish| MQ[(Event Bus)]
162
+ MQ --> INV[Inventory Service]
163
+ INV -->|commit| IDB[(Inventory DB)]
164
+ ```
165
+
166
+ 図に必ず入れる情報:
167
+
168
+ - 境界(システム内/外、サービス境界)
169
+ - 永続化点(commit/outbox/enqueue)
170
+ - 非同期点(queue/event)
171
+ - 主要識別子(冪等キー、entity_id)
172
+
173
+ ### 6.4. 観測性と運用連携
174
+
175
+ 生成する本文の見出しは **## 4. 観測性と運用連携**
176
+
177
+ - 各フローで trace_id 伝搬範囲を明記する。
178
+
179
+ - 必須ログ項目(`flow_id`, `request_id`, `entity_id`, `result` 等)を最低限定義する。
180
+ - 監視条件(アラート閾値)、手動介入条件、OPR手順への導線を明記する。
181
+ - 業務影響の大きい失敗は OPD の停止判断基準に接続する。
182
+
183
+ ### 6.5. 関連ドキュメント導線
184
+
185
+ 生成する本文の見出しは **## 5. 関連ドキュメント導線**
186
+
187
+ - 各フローごとに SDI(一次情報)、テスト仕様(ITS/ETS/STC)、運用(OPD/OPR)、DEC を明記する。
188
+ - 参照先は「ID」または「リポジトリ相対パス」で一意に辿れる形にする。
189
+ - 分冊が無い場合でも `(本書のみ)` または `(なし)` を明記し、空欄にしない。
190
+
191
+ ## 7. 禁止事項
192
+
193
+ | 禁止事項 | 理由 |
194
+ | ------------------------------------------- | ---------------------------------------- |
195
+ | 正常系を逐語で長文記述する | 重要論点が埋もれて参照性が落ちるため |
196
+ | 図を巨大化させ複数論点を混在させる | 1フロー1論点の原則が崩れるため |
197
+ | 実装クラス名/メソッド名/DBカラムを列挙する | コードSSOTと二重管理になるため |
198
+ | 冪等/整合性/失敗時の記述を省略する | SYSD-CFの主目的を満たせないため |
199
+ | SDI・運用・テスト・DECへの導線を置かない | 実行・検証・運用へ接続できないため |
200
+ | 重要フローを6件以上に増やす(無整理の追加) | 文書が肥大化し、合意形成が困難になるため |
201
+
202
+ ## 8. サンプル
203
+
204
+ 注:以下はルール文書内の例示です。生成する `sysd-critical-flows` では `## 1...` から始まります。
205
+
206
+ ```yaml
207
+
208
+ ---
209
+ id: sysd-critical-flows
210
+ type: architecture
211
+ title: システム設計: 重要フロー
212
+ status: draft
213
+ based_on: []
214
+ supersedes: []
215
+ ---
216
+ ```
217
+
218
+ ### 8.1. 概要(対象・運用方針)
219
+
220
+ 本書は、事故影響の大きい重要フローを最大5件まで整理し、
221
+ 設計・テスト・運用が同じ前提で判断できる状態を作る。
222
+
223
+ ### 8.2. 重要フロー一覧(最大5件)
224
+
225
+ | フローID | フロー名 | 事故論点 | 優先度 | 備考 |
226
+ | -------- | ------------------------------ | -------------------------------------- | ------ | ---------- |
227
+ | scf-001 | 売上確定→在庫更新→発注候補生成 | 非同期整合性 / 冪等 | 高 | outbox採用 |
228
+ | scf-002 | 外部決済作成 | タイムアウト / リトライ / 二重課金防止 | 高 | 補償あり |
229
+ | scf-003 | バッチ再実行(売上集計) | 再実行性 / run_id / 重複排除 | 中 | 日次ジョブ |
230
+
231
+ ### 8.3. フロー詳細(IDごと)
232
+
233
+ #### 8.3.1. scf-001: 売上確定→在庫更新→発注候補生成(非同期)
234
+
235
+ - **目的**:売上確定を起点に在庫を更新し、在庫不足時に発注候補を生成する
236
+ - **トリガー**:`POST /sales`(内部API)
237
+ - **範囲**:売上確定、在庫更新イベント発行、発注候補生成(外部仕入先送信は別フロー)
238
+
239
+ ##### 8.3.1.1. フロー概要
240
+
241
+ ```mermaid
242
+ flowchart LR
243
+ UI[UI] -->|POST /sales| API[Sales API]
244
+ API --> SVC[Sales Service]
245
+ SVC -->|commit| DB[(Sales DB)]
246
+ SVC -->|outbox enqueue| OB[(Outbox)]
247
+ OB -->|publish| MQ[(Event Bus)]
248
+ MQ --> INV[Inventory Service]
249
+ INV -->|commit| IDB[(Inventory DB)]
250
+ ```
251
+
252
+ ##### 8.3.1.2. 整合性・冪等・再実行
253
+
254
+ - 整合性:売上確定は同期で確定、在庫更新はイベントで最終的整合性
255
+ - 冪等キー:`sale_id`
256
+ - 重複時:同一 `sale_id` は二重計上しない(既処理判定)
257
+ - 再実行:イベントはリプレイ可能、`event_id` で重複排除
258
+
259
+ ##### 8.3.1.3. 失敗時
260
+
261
+ - イベント発行失敗:outbox再送(指数バックオフ、最大5回)
262
+ - 在庫更新失敗:メッセージをDLQへ退避し、Ops通知後に手動リプレイ
263
+
264
+ ##### 8.3.1.4. 観測性
265
+
266
+ - trace_id を API→イベント→在庫更新まで継承
267
+ - 必須ログ:`flow_id`, `sale_id`, `event_id`, `result`, `retry_count`
268
+ - 監査:売上確定は who/when/amount/before/after を記録
269
+
270
+ ##### 8.3.1.5. 参照
271
+
272
+ - SDI:`api/openapi.yaml`、`api/asyncapi.yaml`、`db/migrations/*`
273
+ - テスト:ITC(内部結合)、STC(E2E)
274
+ - 運用:OPD(監視/アラート)、OPR(DLQ対応)
275
+ - DEC:outbox採用理由
276
+
277
+ #### 8.3.2. scf-002: 外部決済作成(タイムアウト/リトライ/二重課金防止)
278
+
279
+ - **目的**:決済要求の成功率を担保しつつ、二重課金を防止する
280
+ - **トリガー**:`POST /payments`
281
+ - **範囲**:決済要求送信、結果確定、失敗時補償(返金)
282
+
283
+ ##### 8.3.2.1. フロー概要
284
+
285
+ ```mermaid
286
+ flowchart LR
287
+ UI[Client] -->|POST /payments| API[Payment API]
288
+ API --> APP[Payment Service]
289
+ APP -->|idempotency check| IDEM[(Idempotency Store)]
290
+ APP -->|request| PSP[External PSP]
291
+ PSP -->|result webhook| API
292
+ API -->|commit| PDB[(Payment DB)]
293
+ APP -->|on partial failure| CQ[(Compensation Queue)]
294
+ ```
295
+
296
+ ##### 8.3.2.2. 整合性・冪等・再実行
297
+
298
+ - 整合性:外部確定前は `pending`、確定通知で `confirmed` へ遷移
299
+ - 冪等キー:`payment_request_id`
300
+ - 重複時:同一キーは既存決済結果を返却し、新規作成しない
301
+ - 再実行:タイムアウト時のみ最大3回リトライ(指数バックオフ)
302
+
303
+ ##### 8.3.2.3. 失敗時
304
+
305
+ - 3回失敗で `manual_review` へ遷移
306
+ - 部分失敗(外部成功/内部失敗)は補償キューへ投入し、返金または再同期
307
+
308
+ ##### 8.3.2.4. 観測性
309
+
310
+ - 必須ログ:`flow_id`, `payment_request_id`, `provider_tx_id`, `result`, `error_code`
311
+ - アラート条件:外部失敗率 > 5% / 5分
312
+
313
+ ##### 8.3.2.5. 参照
314
+
315
+ - SDI:外部I/F仕様、決済API仕様
316
+ - テスト:ETC(外部I/F障害系)、STC(決済E2E)
317
+ - 運用:OPR(障害一次対応)、OPD(停止判断基準)
318
+ - DEC:補償方式(返金優先)
319
+
320
+ #### 8.3.3. scf-003: 売上集計バッチ再実行(run_id単位)
321
+
322
+ - **目的**:集計失敗時に重複計上なく安全に再実行する
323
+ - **トリガー**:日次スケジュール(`02:00 JST`)
324
+ - **範囲**:集計ジョブ実行、結果反映、失敗時再実行
325
+
326
+ ##### 8.3.3.1. フロー概要
327
+
328
+ ```mermaid
329
+ flowchart LR
330
+ SCH[Scheduler] -->|daily 02:00| JOB[Aggregation Job]
331
+ JOB -->|read| SRC[(Sales Source)]
332
+ JOB -->|calculate| TMP[(Result by run_id)]
333
+ TMP -->|validate| VAL{valid?}
334
+ VAL -->|yes| REP[(Aggregated Report)]
335
+ VAL -->|no| INV[(invalid mark)]
336
+ JOB -->|notify on failure| OPS[Ops Alert]
337
+ ```
338
+
339
+ ##### 8.3.3.2. 整合性・冪等・再実行
340
+
341
+ - 整合性:`run_id` 単位で結果を分離し、最新成功runのみ採用
342
+ - 冪等キー:`aggregation_date + run_id`
343
+ - 再実行上限:自動1回、以降はOps承認で手動再実行
344
+
345
+ ##### 8.3.3.3. 失敗時
346
+
347
+ - 失敗時は部分結果を `invalid` マークし採用対象から除外
348
+ - 2回連続失敗でP2アラートを発報し、OPRへエスカレーション
349
+
350
+ ##### 8.3.3.4. 観測性
351
+
352
+ - 必須ログ:`flow_id`, `job_name`, `run_id`, `input_count`, `output_count`, `result`
353
+
354
+ ##### 8.3.3.5. 参照
355
+
356
+ - SDI:ジョブ定義、DB migration
357
+ - テスト:ITC(再実行性)、STC(月次締め影響)
358
+ - 運用:OPR(バッチ再実行手順)、OPD(SLA)
359
+
360
+ ### 8.4. 観測性と運用連携
361
+
362
+ | 項目 | ルール | 監視/運用連携 |
363
+ | -------- | ------------------------------------------------------------ | -------------------------------------- |
364
+ | trace_id | API入口で採番し、イベント・ジョブまで必ず伝搬 | 監査調査時は trace_id を起点に横断追跡 |
365
+ | 必須ログ | `flow_id`, `request_id`, `entity_id`, `result`, `error_code` | 欠落時は開発品質アラート |
366
+ | 失敗通知 | P1/P2相当は即時通知、P3は定時集約可 | OPR の一次対応手順へ接続 |
367
+ | 手動介入 | DLQ滞留、再実行上限超過、補償失敗時に介入 | OPD の停止判断基準に従う |
368
+
369
+ ### 8.5. 関連ドキュメント導線
370
+
371
+ | 種別 | ドキュメントID/参照先 | 目的 | 備考 |
372
+ | -------- | ------------------------------------------------------------------------ | ---------------------- | ---- |
373
+ | SSOT | sysd-index / `api/openapi.yaml` / `api/asyncapi.yaml` / `db/migrations/` | 一次情報参照 | 必須 |
374
+ | テスト | its-index / ets-index / stc-index | 観点検証 | 必須 |
375
+ | 運用 | opd-index / opr-index | 監視・障害対応・再実行 | 必須 |
376
+ | 判断記録 | dec-index | 例外・設計判断の追跡 | 必須 |