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,62 +3,133 @@ specdojo:
3
3
  id: specdojo:ifx-index-rulebook
4
4
  type: rulebook
5
5
  deliverable_type: api
6
- status: draft
6
+ status: ready
7
7
  target_format: yaml
8
- recipe: not-needed
8
+ recipe: specdojo:ifx-index-recipe
9
9
  sample: specdojo:ifx-index-sample
10
- template: not-needed
10
+ template: specdojo:ifx-index-template
11
11
  ---
12
12
 
13
- # 外部システムIF一覧(External System Interface List: ESIL)作成ルール
13
+ # 外部システムI/F一覧 作成ルール
14
14
 
15
- External System Interface List (ESIL) Documentation Rules
15
+ External System Interface List Documentation Rules
16
16
 
17
- 外部システム(仕入先、会計、物流、決済など)との連携を、**一覧(インベントリ)**として定義します。
17
+ 外部システムI/F一覧は、システム境界を越える連携の目的、相手、方式、発生条件を YAML で整理する入口である。詳細な接続・認証・障害回復の設計と、外部結合テストの対象を特定できる粒度を定める。
18
18
 
19
- ESIL は「どの外部システムと」「何を」「どの方向で」「どの形式で」「いつ連携し」「異常時にどう扱うか」を、関係者間で合意するための入口です。
19
+ ## 1. 全体方針
20
20
 
21
- 詳細なAPI仕様、ファイル/メッセージの項目定義、外部コマンドの起動契約は、別ドキュメント(外部API仕様、外部ファイル連携仕様、外部メッセージ仕様、外部コマンド連携仕様など)に分離し、ESIL から参照できるようにします。
21
+ - 一覧の対象範囲を冒頭コメントに示し、その範囲の連携を一つの正本で管理する。外部サービスだけでなく、境界を越えて起動する CLI や受け渡すファイルも候補にする。
22
+ - 連携目的と成功後に得る結果を `name` とコメントで示す。目的、相手、タイミング、失敗の影響が異なる契約は別要素にする。
23
+ - 一覧には連携境界と異常時の判断を残す。引数、データ項目、接続先、認証値、終了コード表、再試行の数値は詳細仕様・設定・リファレンスへ委譲する。
24
+ - 未決の方式や仮置きの範囲を合意済みとして記さない。未決事項・合意・計画への引き継ぎはコメントで扱い、schema にない管理用キーを追加しない。
25
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
22
26
 
23
- この章では **表ではなく YAML 1ファイル**で ESIL を管理します。
27
+ ## 2. 位置づけ
24
28
 
25
- ## 1. 参照スキーマ
29
+ 連携境界は、対象システムと別システム・外部プロセス・外部管理データの間の受け渡しを指す。一覧は上位の要求を受けて詳細 I/F 仕様へ接続し、連携名と詳細仕様から正常・失敗時の結合テスト対象を選ぶ入口とする。内部の関数・全依存パッケージやテスト手順の一覧にはしない。
26
30
 
27
- - 参照スキーマ: [docs/specdojo/schemas/v1/esil.schema.yaml](../../../specdojo/schemas/v1/esil.schema.yaml)
28
- - ESIL は `docs/**/ifx-*.yaml` のような YAML ファイルとして作成し、スキーマに従って記述します。
31
+ ## 3. ファイル命名・ID規則
29
32
 
30
- ## 2. ファイル規約
33
+ - 全体一覧は `ifx-index.yaml` とし、外部 I/F 仕様の文書群へ配置する。分割時は領域を表す接尾辞を付け、同じ対象範囲の一覧を複製しない。
34
+ - `id` は修飾 ID とし、ローカル ID は `ifx-index` を基準に対象範囲内で一意にする。許容形式は `docs/specdojo/schemas/v1/ifx-index.schema.yaml` を正本とし、独自の正規表現で制限しない。
35
+ - 連携名は一覧内で一意にし、改称・分割時は旧名との対応をコメントへ残す。位置番号を連携の識別子として使用しない。
36
+ - 連携の追加・廃止・方式変更では、影響する詳細仕様、実装範囲、結合テスト対象と、連携スコープの変化を特定する。
31
37
 
32
- - ファイル名: `ifx-<短い英小文字ハイフン>.yaml`
33
- - `id`: `^ifx-[a-z0-9-]+$` に合致する一意ID
34
- - `type`: `api` 固定
38
+ ## 4. 先頭メタ項目
35
39
 
36
- ## 3. ルート要素
40
+ YAML のトップレベルへメタ情報を置く。必須キー、値域、型、参照形式は `docs/specdojo/schemas/v1/ifx-index.schema.yaml` を正本とし、ファイル先頭の modeline で参照する。
37
41
 
38
- | キー | 説明 | 必須 |
39
- | ---------- | ----------------------------- | ---- |
40
- | id | ESIL ID(`ifx-...`) | ○ |
41
- | type | `api` 固定 | ○ |
42
- | title | 外部システムIF一覧名 | ○ |
43
- | status | `draft`/`ready`/`deprecated` | ○ |
44
- | rulebook | `specdojo:ifx-index-rulebook` | ○ |
45
- | interfaces | 外部連携の配列(1件以上) | ○ |
46
- | supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
42
+ - `id`・`title` は一覧と対象システムを識別できる内容にし、`type` は本系統の成果物種別、`rulebook` は本書の ID とする。
43
+ - `status` の値は `draft`・`ready`・`deprecated` とする。個々の連携の採否・進捗はコメントで区別する。
44
+ - `based_on` は実際の依存関係に含まれる直接の根拠だけを記す。プロジェクト共通文脈や詳細仕様を機械的に転記しない。
47
45
 
48
- ※ ルートは `additionalProperties: false` です。上記以外のキーは追加しません。
46
+ ## 5. 本文要件
49
47
 
50
- ## 4. interfaces(外部連携)
48
+ キーの骨組みは宣言された雛形に置く。本章は各記入領域の目的と判断条件を定め、キーの型・構文は schema へ委譲する。列挙値は選び方に関わるものだけを本章で示す。
51
49
 
52
- 1要素が「1つの外部連携(IF)」を表します。
50
+ | 記入領域 | 必須性 | 目的・記述要件 |
51
+ | ------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------- |
52
+ | 冒頭コメント | 必須 | 対象範囲・境界・主要な対象外を示す。仮定や未決のスコープはラベルで区別する |
53
+ | `interfaces` の目的と両端 | 必須 | `name`・`source`・`target` で連携目的と両端を特定する。抽象名だけなら目的をコメントで補う |
54
+ | 方向と方式 | 必須 | `direction`・`kind`・`format` で境界上の受け渡しを示す。サービス内部の方式と呼び出し側の方式を混同しない |
55
+ | 発生条件 | 必須 | `timing` で業務イベント・操作・周期と、起動する条件を示す。周期が不明なら仮の時刻を固定しない |
56
+ | 異常時の判断 | 必須 | `error_handling` に未完了・結果不明になる結果、停止・保留の条件、確認対象と担当を示す。副作用の確認前に再送できると断定しない |
57
+ | 詳細への導線 | 必須 | `spec_ref` に実在する対応仕様 ID を置く。未整備・対応未確認なら `TBD` とし、「詳細参照と未決事項」の情報をコメントに残す |
58
+ | 合意・管理への導線 | 必須 | IF ごとの確認者・合意対象をコメントで対応づける。未決事項がある場合は、影響する連携と後続作業、当面の保留範囲を示す |
53
59
 
54
- | キー | 説明 | 必須 |
55
- | -------------- | ---------------------------------------------------------------------------------------- | ---- |
56
- | name | 連携名(短い日本語) | ○ |
57
- | source | 連携元(システム/コンテナ/コンポーネントなど) | ○ |
58
- | target | 連携先(外部システムの一般名) | ○ |
59
- | direction | `source_to_target` / `target_to_source` / `bidirectional` | ○ |
60
- | kind | `API` / `ファイル` / `メッセージ` / `コマンド` | ○ |
61
- | format | `CSV` / `JSON` / `XML` / `その他` / `TBD` | ○ |
62
- | timing | 連携タイミング(例: 発注確定時、日次集計後) | ○ |
63
- | error_handling | エラー処理・備考(簡潔に) | 任意 |
64
- | spec_ref | 詳細仕様ID(`ifx-api-...` / `ifx-file-...` / `ifx-msg-...` / `ifx-cmd-...`)または `TBD` | 任意 |
60
+ `direction` は指定した `source` と `target` に対して読み、`source` から送るなら `source_to_target`、`target` から受けるなら `target_to_source` とする。要求と応答の両方を一契約として扱う場合は `bidirectional` とし、送信データと受付結果の意味をコメントで区別する。`kind` は境界で受け渡す手段を `API`・`ファイル`・`メッセージ`・`コマンド` から選ぶ。`format` は `CSV`・`JSON`・`XML` から選び、どれにも当たらなければ `その他`、未決なら `TBD` としてコメントで内訳や論点を補う。schema で任意の項目でも、本一覧から下流へ判断を渡すために本章が要求する項目は記入する。
61
+
62
+ ## 6. 記述ガイド
63
+
64
+ ### 6.1. メタ情報と対象範囲
65
+
66
+ - 判断基準: どのシステム・利用場面の境界を管理するか、対象外と仮定を含めて識別できること。
67
+ - 良い例: 「店舗端末から本部への商品照会・売上登録を対象とする。仕入先連携は対象外」と冒頭に記す。
68
+ - 悪い例: タイトルを「外部連携」とだけ書いて将来候補を現在の対象へ混ぜる。
69
+
70
+ ### 6.2. 連携単位・目的・両端
71
+
72
+ - 判断基準: 同じ詳細契約と完了条件で追える単位に分け、相手を一意に識別できること。同じ相手でも参照と更新の失敗影響が異なれば分ける。
73
+ - 良い例: 「商品照会」と「売上登録」を別要素にし、それぞれ取得結果と受付結果を示す。
74
+ - 悪い例: 「本部連携」に照会・登録・夜間転送をまとめ、どの操作が失敗したか追えない。
75
+
76
+ ### 6.3. 方向・方式・形式
77
+
78
+ - 判断基準: この境界で渡す形式を選ぶ。外部 CLI の背後に API があっても、呼び出し側がプロセスを起動する契約ならコマンドとして扱う。
79
+ - 良い例: CLI へ印字を依頼し結果を受け取る契約を双方向・コマンドとし、テキストと結果報告が混在するなら形式の内訳をコメントで補う。
80
+ - 悪い例: SaaS を使うという理由だけで API に分類する、または stdout の一部が JSON だから全ストリームを JSON と断定する。
81
+
82
+ ### 6.4. 発生条件
83
+
84
+ - 判断基準: 誰の操作・どのイベントで、何が整ったら連携するかを読み取れること。
85
+ - 良い例: 「会計確定と控え保存の後、レシート印字を要求した時」とする。
86
+ - 悪い例: 「随時」「必要時」だけで終え、実行条件を実装者へ任せる。
87
+
88
+ ### 6.5. 異常時の判断
89
+
90
+ - 判断基準: 失敗で何が未完了・結果不明になるか、誰が確認して次へ進むかが分かること。
91
+ - 良い例: 「印字結果不明なら会計は維持し、控えを保持して店番担当が紙面確認する」とする。
92
+ - 悪い例: 「失敗したらリトライ」とだけ書き、二重登録・二重印字の可能性を扱わない。
93
+
94
+ ### 6.6. 詳細参照と未決事項
95
+
96
+ - 判断基準: 実在する契約へ到達できること。`TBD` や未決の方式には、論点、解消条件、影響する連携・業務・後続作業、当面の扱いをコメントで残す。
97
+ - 良い例: `spec_ref: TBD` に「`_UNDECIDED_:` 売上受付の照合方式が未決。詳細契約と結果不明時の期待結果がそろうまで、売上登録の受入を保留する」と添える。
98
+ - 悪い例: 説明なしの `TBD`、未作成の文書 ID を完成した契約として扱う参照、影響する連携を区別せず一覧全体を完了扱いにする記述。
99
+
100
+ 共通条件は一覧冒頭、契約固有条件は詳細仕様を正本とする。詳細仕様が存在しても未決事項があれば `spec_ref` だけで解決済みとせず、残る論点と影響を一覧に残す。
101
+
102
+ ### 6.7. 合意・計画・課題への引き継ぎ
103
+
104
+ - 判断基準: 連携名から利用場面・業務影響、契約、期待結果それぞれの確認者と合意対象を特定できること。外部側との調整が必要なら確認窓口も示す。複数 IF で共通なら、連携名を明示してコメントを冒頭または末尾にまとめてよい。
105
+ - 良い例: 「売上登録は店番担当と本部運用窓口が保留時の店頭対応、契約の確認者が受付・回復条件、テストの確認者が結果照合を確認する。認証方式が未合意のため外部結合テストの着手は保留」と記す。
106
+ - 悪い例: 「関係者確認済み」「進捗は順調」だけで合意対象や残る論点を隠す、または一覧に計画・管理簿の期日・進捗表を複製する。
107
+
108
+ ### 6.8. 検証と引き渡しの判定
109
+
110
+ - 対象と方法: 対象範囲の利用場面と各連携を突き合わせ、正常時・失敗時の受け渡しをたどる。「本文要件」の必須領域、連携名の一意性、方向と両端の一致、詳細仕様との対応を照合し、IF ごとの確認者と合意対象を確かめる。
111
+ - 合格条件: 対象内の連携に抜けがなく、目的・発生条件・成功後の結果と、失敗時に止める操作・確認対象・担当を特定できること。詳細仕様が対象操作に対応し、結果不明時に無条件の再送を要求していないこと。
112
+ - 未解消事項の扱い: 詳細仕様が未整備、または方式・期待結果が未合意なら、該当連携の論点と影響、保留する業務・後続作業を明示して引き渡す。ほかの連携と分けて判定し、一覧全体を解消済みとしない。
113
+
114
+ ### 6.9. 表示ページでのレビュー
115
+
116
+ YAML を正本とし、`specdojo yaml-pages build` が同階層の `generated/` へ表形式の表示ページを生成する。レビューは表示ページで行い、修正は YAML へ戻す。
117
+
118
+ | ページの部分 | YAML からの取り出し方 |
119
+ | -------------- | -------------------------------------------------------------------------------------------------------------------------------- |
120
+ | 要約の表 | `id`・`status`・`interfaces` の件数・`spec_ref` が `TBD` の件数 |
121
+ | 連携の一覧 | `interfaces` の順に、連携名・`target`・`direction`・`kind`・`format`・`spec_ref`・注記の件数と目印(`_TODO_` など)を 1 行に置く |
122
+ | 連携ごとの詳細 | 連携ごとに、schema の項目(`source`・`timing`・`error_handling` を含む)を表にし、その連携のコメントを注記として続ける |
123
+ | 一覧全体の注記 | `interfaces` の外にある冒頭・末尾のコメント |
124
+ | YAML の正本 | YAML 全文を折りたたんで添える |
125
+
126
+ - 連携のコメントは、連携の直前(`- name` と同じ字下げ)と連携の内側(より深い字下げ)に置いたものとする。行頭から始まるコメントは一覧全体の注記になる。連携に関わる未決事項・留保はこの位置に書く。
127
+ - `spec_ref` は詳細仕様への wikilink にし、プロジェクトの修飾がなければ一覧の `id` の修飾を補う。`TBD` は「未整備(TBD)」と表示する。
128
+ - `direction` は「連携元 → 連携先」「連携先 → 連携元」「双方向」と表示する。表示ページのために schema にないキーを YAML へ足さない。
129
+
130
+ ## 7. 禁止事項
131
+
132
+ - 連携の目的・失敗影響が異なる操作を、相手が同じという理由だけでまとめること。
133
+ - 引数、ペイロード構造、設定値、再試行回数、終了コード一覧を正本から転載すること。
134
+ - 対象操作との対応を確認していない詳細仕様 ID、説明のない `TBD` を残すこと。
135
+ - schema にない担当・期限・進捗・リスクのキーを追加したり、Schedule・管理簿・決定記録を一覧へ複製したりすること。
@@ -12,28 +12,24 @@ specdojo:
12
12
 
13
13
  # 外部メッセージ仕様(External Message Specification: EMS)作成ルール
14
14
 
15
- 外部システム(物流、決済、会計など)との非同期連携のために、**メッセージング仕様**を定義します。
15
+ 外部システム(物流、決済、会計など)との非同期連携のメッセージング仕様を、**AsyncAPI + CloudEvents**(YAML 1ファイル)で定義します。
16
16
 
17
- EMS は ESIL(外部システムIF一覧)から参照される「詳細仕様」です。
18
- ESIL 側の `spec_ref: ifx-msg-...` は、このEMSのID(およびファイル名)と対応させます。
17
+ EMS は ESIL(外部システムIF一覧)から参照される「詳細仕様」で、ESIL 側の `spec_ref: ifx-msg-...` をこの EMS の ID とファイル名に対応させます。
19
18
 
20
- この章では **表ではなく YAML 1ファイル**で EMS を管理します。
21
- フォーマットは **AsyncAPI + CloudEvents**(YAML)を正とします。
19
+ `status` の昇格と承認、改訂と廃止は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書では言い直しません。
22
20
 
23
21
  ## 1. ファイル規約
24
22
 
25
- - ファイル名: `ifx-msg-<短い英小文字ハイフン>.yaml`
26
- - ESILからの参照: `spec_ref: ifx-msg-...`(例: `ifx-msg-stock-changed`)
23
+ - ファイル名: `ifx-msg-<短い英小文字ハイフン>.yaml`(例: `ifx-msg-stock-changed`)
27
24
  - 1ファイル = 1つのメッセージング仕様(1つのイベント群/チャネル群)
28
25
 
29
26
  ## 2. バージョン
30
27
 
31
- - **AsyncAPI 2.6.0**(推奨)を第一候補とする(ツール互換性が高いため)
32
- - CloudEvents は **1.0** を前提とする
28
+ - ツール互換性のため **AsyncAPI 2.6.0** を第一候補とし、CloudEvents は **1.0** を前提とします。
33
29
 
34
30
  ## 3. 記載方針(必須)
35
31
 
36
- - **外部との合意に必要な最小十分**を記載する(内部実装の都合は書かない)
32
+ - **外部との合意に必要な最小十分**を記載する
37
33
  - メッセージのエンベロープは **CloudEvents** とし、イベント属性を明示する
38
34
  - チャネル(topic/queue)や方向(publish/subscribe)を明確にする
39
35
  - payload(`data`)のスキーマは `components/schemas` に集約し、参照で使い回す
@@ -51,22 +47,19 @@ ESIL 側の `spec_ref: ifx-msg-...` は、このEMSのID(およびファイル
51
47
 
52
48
  - `asyncapi`
53
49
  - `info`(`title`, `version` を含む)
54
-
55
50
  - `x-spec-meta`(`id`, `type`, `status`, `rulebook` を含む)
56
51
  - `channels`(少なくとも1つ)
57
52
  - `components/messages`(少なくとも1つ)
58
53
 
59
- ## 4.1 メタ情報(x-spec-meta)
60
-
61
- 仕様のトレーサビリティ管理のため、以下を `x-spec-meta` に含めます。
54
+ ### 4.1. メタ情報(x-spec-meta)
62
55
 
63
- | キー | 説明 | 必須 |
64
- | -------- | ----------------------------------------------------------- | ---- |
65
- | id | メッセージ仕様ID(`ifx-msg-...`)、ESILの `spec_ref` と対応 | ○ |
66
- | type | `api` 固定 | ○ |
67
- | rulebook | `specdojo:ifx-msg-rulebook` | ○ |
68
- | status | `draft` / `ready` / `deprecated` | ○ |
69
- | based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
56
+ | キー | 説明 | 必須 |
57
+ | -------- | ---------------------------------------------------- | ---- |
58
+ | id | メッセージ仕様ID(`ifx-msg-...`) | ○ |
59
+ | type | `api` 固定 | ○ |
60
+ | rulebook | `specdojo:ifx-msg-rulebook` | ○ |
61
+ | status | ドキュメントメタ情報標準の値 | ○ |
62
+ | based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
70
63
 
71
64
  ## 5. CloudEventsルール(必須)
72
65
 
@@ -79,5 +72,4 @@ CloudEventsの「属性」は仕様で名前が固定です(snake_caseに変
79
72
  - `time`: 発生時刻(RFC3339)
80
73
  - `datacontenttype`: `application/json`
81
74
  - `subject`: 任意(推奨。対象を識別できる文字列)
82
-
83
75
  - `data`: 業務ペイロード(この中のプロパティ名は snake_case 推奨)
@@ -13,50 +13,32 @@ specdojo:
13
13
 
14
14
  Impact Analysis (Business) Rulebook
15
15
 
16
- 本ドキュメントは、変更要求が業務へ与える影響を整理するための「影響調査(業務)」の記述ルールを定義します。プロジェクト関係者が変更要否・影響度・対応方針・未解決事項を同じ粒度で判断できる状態を目標とします。
16
+ 変更要求による業務への影響を整理し、変更要否・影響度・対応方針・未解決事項を判断するための記述基準を定めます。
17
17
 
18
18
  ## 1. 全体方針
19
19
 
20
- - 対象は「変更要求による業務影響の把握と判断」であり、実装設計の詳細化は扱わない。
21
- - 記載粒度は「業務担当者とプロジェクト管理者が合意形成できるレベル」とし、影響の有無だけでなく、判断根拠を簡潔に残す。
22
- - 1 ドキュメントで複数の業務領域を扱ってよいが、影響詳細は業務単位で分割して管理する。
23
- - プロセス仕様、データ仕様、テスト仕様への波及がある場合は、本書で概要と判断を記載し、詳細は各ドキュメントへ委譲する。
20
+ - 業務担当者とプロジェクト管理者が合意できる粒度で、業務影響と判断根拠を記載する。
21
+ - 複数領域を扱う場合も影響詳細は業務単位とする。プロセス・データ・テスト仕様への波及は概要と判断を示し、詳細は各仕様へ委ねる。
22
+ - **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱う。
24
23
 
25
- ## 2. 位置づけと用語定義(必要に応じて)
24
+ ## 2. 位置づけ
26
25
 
27
- | 用語 | 定義 |
28
- | ------------ | ------------------------------------------------------------------ |
29
- | 変更要求 | プロダクトまたは運用に対する変更の要望。起票済みの要求や課題を含む |
30
- | 影響対象業務 | 変更要求の影響を受ける業務プロセス、業務ルール、運用手順 |
31
- | 変更要否 | 影響対象に対して変更が必要かどうかの判定 |
32
- | 影響度 | 影響の強さ。業務継続性、手戻り、利用者影響を踏まえて評価する |
33
- | 対応方針 | 影響に対して採用する対処方針(実施、代替、見送りなど) |
34
- | 未解決事項 | 判断や実施に必要な情報が不足している課題 |
26
+ 起票済みの要求・課題を含む変更要求を受け、業務プロセス・ルール・運用手順への影響と対応を判断する。実装設計の詳細化は扱わない。
35
27
 
36
28
  ## 3. ファイル命名・ID規則
37
29
 
38
- - 対象ドキュメント ID は `imp-business` とする。
39
- - 対象ドキュメントの推奨ファイル名は `imp-business.md` とする。
40
- - `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
41
- - 関連する追補文書を分割する場合は `imp-business-<term>` 形式を用いる。
30
+ - 対象ドキュメント ID は `<project-id>:imp-business` とする(例: `prj-0001:imp-business`)。
31
+ - 推奨ファイル名は `imp-business.md` とする。
32
+ - 命名の共通規則は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] に従う。
33
+ - 関連する追補文書を分割する場合は `<project-id>:imp-business-<term>` 形式を用いる。
42
34
 
43
35
  ## 4. 推奨 Frontmatter 項目
44
36
 
45
- 影響調査(業務)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
46
-
47
- | 項目 | 説明 | 必須 |
48
- | ---------- | ------------------------------------- | ---- |
49
- | id | ドキュメント ID(例: `imp-business`) | ○ |
50
- | type | `project` | ○ |
51
- | status | `draft` / `ready` / `deprecated` | ○ |
52
- | rulebook | `specdojo:imp-business-rulebook` 固定 | ○ |
53
- | part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
54
- | based_on | 変更要求や根拠資料の ID 配列 | 任意 |
55
- | supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
37
+ 共通項目・必須性・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。`type` は `project`、`rulebook` は `specdojo:imp-business-rulebook` とする。
56
38
 
57
39
  ## 5. 本文構成(標準テンプレ)
58
40
 
59
- 影響調査(業務)の本文は、以下の構成を標準とする。
41
+ 本文は次の6章を標準とする。
60
42
 
61
43
  | 章 | 見出し | 必須 | 目的 |
62
44
  | --- | -------------- | ---- | -------------------------------------------- |
@@ -76,43 +58,38 @@ Impact Analysis (Business) Rulebook
76
58
 
77
59
  ### 6.2. 変更要求の概要
78
60
 
79
- - 変更の背景、狙い、成功条件を簡潔に記述する。
80
- - 要求詳細は原文を転記せず、判断に必要な要点のみを要約する。
61
+ - 変更の背景・狙い・成功条件を示す。要求詳細は判断に必要な要点に絞る。
81
62
 
82
63
  ### 6.3. 影響分析サマリ
83
64
 
84
- - 高・中・低の影響度で件数を整理し、優先対応対象を明記する。
85
- - サマリで使用した評価観点(例: 利用者影響、法令・契約影響、運用影響)を先に示す。
65
+ - 業務継続性、利用者影響、手戻りなどの評価観点と、高・中・低を分ける条件を先に定義する。複数観点で判定が分かれる場合の集約方法も示す。
66
+ - 尺度の例: 高=代替不能な業務停止、中=代替可能だが手順変更が必要、低=現行手順で継続可能。案件に合わせて条件を具体化する。
67
+ - 定義した尺度で件数を集計し、優先対応対象を明記する。
86
68
 
87
69
  ### 6.4. 影響詳細一覧
88
70
 
89
- - 影響詳細は表形式で記載し、最低限次のカラムを含める。
71
+ - 影響詳細は表形式で、次の6列を必須とする。
90
72
 
91
73
  | カラム | 内容 |
92
74
  | ------------ | ------------------------------------ |
93
75
  | 影響対象業務 | 影響を受ける業務名または業務プロセス |
94
76
  | 変更要否 | `要` / `否` |
95
-
96
- | 影響度 | `高` / `中` / `低` |
97
- | 対応方針 | 実施・代替・見送りなどの方針 |
98
- | 判断根拠 | 判定理由の要点 |
99
- | 備考 | 制約、前提、関連ドキュメント |
77
+ | 影響度 | `高` / `中` / `低` |
78
+ | 対応方針 | 実施・代替・見送りなどの方針 |
79
+ | 判断根拠 | 判定理由の要点 |
80
+ | 備考 | 制約、前提、関連ドキュメント |
100
81
 
101
82
  ### 6.5. 対応方針
102
83
 
103
- - 重要度が高い項目から順に、実施時期、担当、前提条件を記載する。
84
+ - 影響度が高い項目から順に、実施時期、担当、前提条件を記載する。
104
85
  - 見送りの場合は、再評価条件と時期を必ず記載する。
105
86
 
106
87
  ### 6.6. 未解決事項
107
88
 
108
- - 各項目に「論点」「不足情報」「決定期限」「担当」を記載する。
109
- - 未解決事項は放置せず、次回レビューでの処理方針を記録する。
89
+ - 論点、不足情報、判断・対応への影響と当面の扱いを記載する。未解決事項がなければ「なし」とする。
110
90
 
111
91
  ## 7. 禁止事項
112
92
 
113
93
  - 実装詳細(SQL 全文、クラス名、API リクエスト構造)を記載しない。
114
94
  - 「影響あり」「要対応」のみで根拠を記載しない。
115
-
116
95
  - 影響度の尺度を定義せずに高・中・低を混在させない。
117
- - 未解決事項に期限や担当を設定せずに放置しない。
118
- - 他ドキュメントの本文を重複転記し、参照元との不整合を生む記述をしない。
@@ -13,107 +13,84 @@ specdojo:
13
13
 
14
14
  Impact Analysis (Data) Rulebook
15
15
 
16
- 本ドキュメントは、変更要求がデータへ与える影響を整理するための「影響調査(データ)」の記述ルールを定義します。プロジェクト関係者が変更要否・影響度・対応方針・未解決事項を同じ粒度で判断できる状態を目標とします。
16
+ 変更要求によるデータへの影響を整理し、変更要否・影響度・対応方針を判断する基準を定めます。
17
17
 
18
18
  ## 1. 全体方針
19
19
 
20
- - 対象は「変更要求によるデータ影響の把握と判断」であり、実装設計の詳細化は扱わない。
21
- - 記載粒度は「データ責任者とプロジェクト管理者が合意形成できるレベル」とし、影響の有無だけでなく、判断根拠を簡潔に残す。
22
- - 1 ドキュメントで複数のデータ領域を扱ってよいが、影響詳細はデータ対象単位で分割して管理する。
20
+ - データ責任者とプロジェクト管理者が合意できる粒度で、影響と判断根拠を記載する。
21
+ - 複数領域を扱う場合も影響詳細はデータ対象単位とし、実装設計の詳細化は扱わない。
22
+ - **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱う。
23
23
 
24
- - インターフェース仕様、テスト仕様、運用設計への波及がある場合は、本書で概要と判断を記載し、詳細は各ドキュメントへ委譲する。
24
+ ## 2. 位置づけ
25
25
 
26
- ## 2. 位置づけと用語定義(必要に応じて)
27
-
28
- | 用語 | 定義 |
29
- | -------------- | ---------------------------------------------------------------------------- |
30
- | 変更要求 | プロダクトまたは運用に対する変更の要望。起票済みの要求や課題を含む |
31
- | 影響対象データ | 変更要求の影響を受けるデータ項目、データモデル、データストア、データ連携項目 |
32
- | 変更要否 | 影響対象に対して変更が必要かどうかの判定 |
33
- | 影響度 | 影響の強さ。整合性、可用性、移行難易度、利用者影響を踏まえて評価する |
34
- | 対応方針 | 影響に対して採用する対処方針(実施、代替、見送りなど) |
35
- | 未解決事項 | 判断や実施に必要な情報が不足している課題 |
26
+ 業務影響をデータ構造・整合性・移行への影響に具体化する。波及先の詳細は I/F 仕様(`ifx-*`)、テスト仕様(`itc-*` 等)、運用設計(`opd-*`)へ委ね、「備考」に適用先カタログの対応する成果物 ID を示す。
36
27
 
37
28
  ## 3. ファイル命名・ID規則
38
29
 
39
- - 対象ドキュメント ID は `imp-data` とする。
40
- - 対象ドキュメントの推奨ファイル名は `imp-data.md` とする。
41
- - `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
42
- - 関連する追補文書を分割する場合は `imp-data-<term>` 形式を用いる。
30
+ - `local_id` は `imp-data`、Frontmatter の `id` は `<project-id>:imp-data`、推奨ファイル名は `imp-data.md` とする。
31
+ - 追補は `<project-id>:imp-data-<term>` とし、共通規則は [[specdojo:id-and-file-naming-standard|ID・ファイル命名標準]] に従う。
43
32
 
44
33
  ## 4. 推奨 Frontmatter 項目
45
34
 
46
- 影響調査(データ)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
47
-
48
- | 項目 | 説明 | 必須 |
49
- | -------- | ----------------------------------- | ---- |
50
- | id | ドキュメント ID(例: `imp-data`) | ○ |
51
- | type | `project` | ○ |
52
- | status | `draft` / `ready` / `deprecated` | ○ |
53
- | rulebook | `specdojo:imp-data-rulebook` 固定 | ○ |
54
- | part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
55
-
56
- | based_on | 変更要求や根拠資料の ID 配列 | 任意 |
57
- | supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
35
+ 共通項目・必須性・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。`type` は `project`、`rulebook` は `specdojo:imp-data-rulebook` とする。`based_on` には直接の根拠とした作成済みの `<project-id>:imp-business` を必須とし、追加の根拠もカタログの `depends_on` の推移閉包内に限る。
58
36
 
59
37
  ## 5. 本文構成(標準テンプレ)
60
38
 
61
- 影響調査(データ)の本文は、以下の構成を標準とする。
39
+ 本文は次の6章を標準とする。
62
40
 
63
- | 章 | 見出し | 必須 | 目的 |
64
- | --- | -------------- | ---- | ---------------------------------------------- |
65
- | 1 | 目的と適用範囲 | ○ | 対象と判断対象範囲を明確化する |
66
- | 2 | 変更要求の概要 | ○ | 変更背景と要求内容を要約する |
67
- | 3 | 影響分析サマリ | ○ | 影響の全体像と優先順位を俯瞰する |
68
- | 4 | 影響詳細一覧 | ○ | 影響対象データごとの変更要否・影響度を記録する |
69
- | 5 | 対応方針 | ○ | 採用方針、実施条件、担当と期限を整理する |
70
- | 6 | 未解決事項 | ○ | 意思決定待ちや調査不足を明示する |
41
+ | 章 | 見出し | 必須 | 目的 |
42
+ | --- | -------------- | ---- | -------------------- |
43
+ | 1 | 目的と適用範囲 | ○ | 対象と判断範囲 |
44
+ | 2 | 変更要求の概要 | ○ | 背景・要求・成功条件 |
45
+ | 3 | 影響分析サマリ | ○ | 尺度・件数・優先対象 |
46
+ | 4 | 影響詳細一覧 | ○ | 対象別の判定と根拠 |
47
+ | 5 | 対応方針 | ○ | 実施条件と受入確認 |
48
+ | 6 | 未解決事項 | ○ | 論点と影響 |
71
49
 
72
50
  ## 6. 記述ガイド
73
51
 
74
52
  ### 6.1. 目的と適用範囲
75
53
 
76
- - 対象変更要求の識別子、対象データ領域、対象期間を明記する。
77
- - 「何を判断する文書か」を 2〜4 行で示す。
54
+ 変更要求の識別子、対象データ領域、対象期間、判断目的を示す。
78
55
 
79
56
  ### 6.2. 変更要求の概要
80
57
 
81
- - 変更の背景、狙い、成功条件を簡潔に記述する。
82
- - 要求詳細は原文を転記せず、判断に必要な要点のみを要約する。
58
+ 背景・要求・狙いと判定可能な成功条件を要約する(例: 移行前後の売上合計の差額0円)。
83
59
 
84
60
  ### 6.3. 影響分析サマリ
85
61
 
86
- - 高・中・低の影響度で件数を整理し、優先対応対象を明記する。
87
- - サマリで使用した評価観点(例: データ整合性、データ欠損リスク、移行影響、監査影響)を先に示す。
62
+ 整合性・可用性・移行難易度・利用者影響を次の尺度で評価し、最も高い判定を採る。許容停止時間など案件の境界値を先に示し、高・中・低の件数と優先対象をまとめる。
63
+
64
+ - 高: データ欠損・不整合、許容時間を超える停止、復旧不能な移行、代替不能な業務停止のいずれかがある。
65
+ - 中: 高に該当せず、補正・移行手順または利用者の操作変更が必要。
66
+ - 低: 高・中に該当せず、現行データと操作で継続可能。
88
67
 
89
68
  ### 6.4. 影響詳細一覧
90
69
 
91
- - 影響詳細は表形式で記載し、最低限次のカラムを含める。
70
+ 次の6列を必須とする。
71
+
72
+ | カラム | 内容 |
73
+ | -------------- | ---------------------------- |
74
+ | 影響対象データ | エンティティ、項目、格納先 |
75
+ | 変更要否 | `要` / `否` |
76
+ | 影響度 | `高` / `中` / `低` |
77
+ | 対応方針 | 実施・代替・見送りなどの方針 |
78
+ | 判断根拠 | 判定理由の要点 |
79
+ | 備考 | 制約、前提、関連ドキュメント |
92
80
 
93
- | カラム | 内容 |
94
- | -------------- | ---------------------------------------------------- |
95
- | 影響対象データ | 影響を受けるデータ対象(エンティティ、項目、格納先) |
96
- | 変更要否 | `要` / `否` |
97
- | 影響度 | `高` / `中` / `低` |
98
- | 対応方針 | 実施・代替・見送りなどの方針 |
99
- | 判断根拠 | 判定理由の要点 |
100
- | 備考 | 制約、前提、関連ドキュメント |
81
+ 「判断根拠」に構造・整合性、データ検証・移行テスト、実装変更への影響を必ず示す。影響なしも理由を残す。
101
82
 
102
83
  ### 6.5. 対応方針
103
84
 
104
- - 重要度が高い項目から順に、実施時期、担当、前提条件を記載する。
105
- - 見送りの場合は、再評価条件と時期を必ず記載する。
85
+ - 影響度順に実施時期・担当・前提条件を示す。見送りは再評価条件と時期を付す。
86
+ - 受入確認では業務影響の各対象を「影響詳細一覧」と照合し、欠落がなく、各判定の根拠・対応と、データ検証・移行テストの確認手順・合格条件が特定できることを確認する。
106
87
 
107
88
  ### 6.6. 未解決事項
108
89
 
109
- - 各項目に「論点」「不足情報」「決定期限」「担当」を記載する。
110
- - 未解決事項は放置せず、次回レビューでの処理方針を記録する。
90
+ 論点・不足情報・判断や対応への影響・当面の扱いを示す。なければ「なし」とする。
111
91
 
112
92
  ## 7. 禁止事項
113
93
 
114
94
  - 実装詳細(SQL 全文、クラス名、API リクエスト構造)を記載しない。
115
- - 「影響あり」「要対応」のみで根拠を記載しない。
116
-
117
- - 影響度の尺度を定義せずに高・中・低を混在させない。
118
- - 未解決事項に期限や担当を設定せずに放置しない。
119
- - 他ドキュメントの本文を重複転記し、参照元との不整合を生む記述をしない。
95
+ - 「影響あり」「要対応」だけで判定を済ませない。
96
+ - 「影響分析サマリ」の尺度と異なる判定を混在させない。