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
@@ -18,15 +18,15 @@ specdojo:
18
18
 
19
19
  Status Definition Documentation Rulebook
20
20
 
21
- 業務上の一つの対象が取り得る状態と、その状態間の遷移を一文書で定義するためのルールです。状態一覧、状態遷移図、遷移の説明を STSD に集約し、状態の意味とライフサイクルの二重管理を防ぎます。
21
+ 業務上の一つの対象が取り得る状態と状態間の遷移を、一文書で定義するためのルールです。
22
22
 
23
23
  ## 1. 全体方針
24
24
 
25
- - 一文書は一つの対象(エンティティまたは業務概念)だけを扱います。対象が異なる場合は `stsd-<term>` を分けます。
26
- - 状態一覧を状態名・意味・成立条件の正本、「遷移の説明」を遷移元・遷移先・イベント・条件の正本として同じ文書で管理します。状態遷移図は「遷移の説明」の全行を俯瞰する投影であり、不一致時は遷移の説明へ合わせたうえで両者を同じ変更で更新します。
27
- - 状態一覧の全状態を状態遷移図と遷移の説明へ対応付け、図だけ、表だけで意味が決まる状態を残しません。
28
- - AS-IS と TO-BE を同じ図に混在させません。両方が必要な場合は `<term>` にスコープを含めて文書を分けます。
29
- - 実装上の enum、フラグ、物理テーブル、API、画面操作ではなく、業務で合意する状態とイベントを記述します。
25
+ - 一文書は一つの対象(エンティティまたは業務概念)だけを扱います。
26
+ - 状態一覧を状態の意味・成立条件の正本、「状態遷移」の遷移表を遷移の正本とし、同じ文書で管理します。状態遷移図は遷移表の全行の投影であり、不一致時は遷移表へ合わせて両者を同じ変更で更新します。
27
+ - スコープは現行を既定とし、同じ対象の TO-BE 文書と並ぶ場合だけ AS-IS / TO-BE を明記して文書を分けます。両者を同じ図に混在させません。
28
+ - 状態値や記録形式に schema・型定義・リファレンスがある場合は、構文・構造の詳細を正本に委ね、STSD には状態を識別する値と業務上の判定に必要な意味・条件だけを残します。
29
+ - 共通の運用: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、成果物の完成判定に含めません。
30
30
 
31
31
  ## 2. 位置づけと用語定義
32
32
 
@@ -34,59 +34,75 @@ Status Definition Documentation Rulebook
34
34
  | ---------- | ----------------------------------------------------------------------------------- |
35
35
  | 対象 | 状態を持つ一つの業務上のエンティティまたは概念 |
36
36
  | 状態 | 対象について、意味と成立条件を業務上判定できる時点の区分 |
37
- | 管理場所 | 現在状態を確認する正本の帳簿、台帳、記録、または概念上の保管先 |
38
37
  | 遷移 | イベントと条件により、対象が遷移元の状態から遷移先の状態へ変わること |
39
- | イベント | 遷移の契機となる業務上の出来事または操作 |
40
- | 遷移条件 | イベント発生時に遷移を成立させる、業務上判定可能な条件 |
41
38
  | 初期・終了 | Mermaid の `[*]` で表すライフサイクルの開始点・終了点。業務上の状態一覧には含めない |
42
39
 
43
40
  ## 3. ファイル命名・ID規則
44
41
 
45
42
  - ファイル名は `stsd-<term>.md`、成果物 ID は拡張子を除いた `stsd-<term>` とします。
46
- - `<term>` は対象と、必要に応じて AS-IS / TO-BE などのスコープを表す英小文字・数字・ハイフンのスラッグにします。
47
- - 一つの対象に複数の STSD を作らず、例外状態も同じライフサイクルに属する限り同じ文書へ記載します。
48
- - 状態値を外部参照に使う場合は `lower-kebab-case` とし、状態名は業務で使う日本語の名詞句にします。
49
- - 外部参照に使う状態値は文書内で一意にし、一つの値を複数の状態へ割り当てません。コードを持たない状態で使う `-` は一意性確認の対象外です。
50
- - 遷移 ID は文書内で一意な `T-<nn>` 形式とし、遷移の説明とレビュー指摘で同じ ID を使います。
43
+ - `<term>` は対象を表す英小文字・数字・ハイフンのスラッグにし、同じ対象の TO-BE 文書と並ぶ場合だけ AS-IS / TO-BE を識別するスコープを含めます。
44
+ - 一つの対象・スコープに STSD は一つとし、同じライフサイクルの例外状態も同じ文書へ記載します。
45
+ - 状態名は業務で使う日本語の名詞句にします。外部参照に使う状態値は `lower-kebab-case` で文書内で一意にし、一つの値を複数の状態へ割り当てません(コードを持たない `-` は対象外)。
46
+ - 遷移 ID は文書内で一意な `T-<nn>` 形式とし、図のラベル・遷移表・レビュー指摘で同じ ID を使います。
47
+ - 初回の確定前(`status: draft`)は、図と表の順に `T-01` から文書全体の通し番号で振り直してかまいません。図のラベル・遷移表・本文中の参照を同じ変更で更新し、旧 ID・新 ID の対応は STSD 本文ではなく作業の記録へ残します。
48
+ - 確定(`status: ready`)後は既存 ID を振り直さず、削除した ID も再利用しません。新規遷移には未使用の ID を割り当てます。
51
49
 
52
50
  ## 4. 推奨 Frontmatter 項目
53
51
 
54
- | 項目 | 説明 | 必須 |
55
- | ------------ | ----------------------------------------------------- | ---- |
56
- | `id` | プロジェクト修飾なしの `stsd-<term>` | ○ |
57
- | `type` | `data` | ○ |
58
- | `status` | `draft` / `ready` / `deprecated` | ○ |
59
- | `rulebook` | `specdojo:stsd-rulebook` | ○ |
60
- | `based_on` | 依存関係上許可された対象定義・業務データ辞書などの ID | 任意 |
61
- | `supersedes` | 置き換える旧 STSD の ID | 任意 |
52
+ 共通の項目と値は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。STSD 固有の指定は次のとおりです。
62
53
 
63
- - `based_on` は成果物カタログの `depends_on` の推移閉包に含まれる先行成果物だけを記載します。
64
- - 作成途中は `status: draft` とし、`ready` への昇格は定められた人間の承認後に行います。
65
- - 対象名や文書タイトルの独自メタ項目は追加せず、H1 と「概要」で示します。
54
+ - `id` の文書名部分は「ファイル命名・ID規則」に従います。
55
+ - `type` は `data`、`rulebook` は `specdojo:stsd-rulebook` とします。
56
+ - `based_on` には、作成根拠にした対象定義・業務データ辞書などのうち、成果物カタログの `depends_on` の推移閉包に含まれる先行成果物だけを記載します。
57
+ - 対象名や文書タイトルの独自メタ項目は追加せず、H1 と「適用範囲」で示します。
66
58
 
67
59
  ## 5. 本文要件
68
60
 
69
- 見出し順、表、記入欄の骨組みは template を正本とし、本章では各章の目的と必須性を定めます。
61
+ 見出し順と表の骨組みは template を正本とし、本章では満たすべき内容と必須性を定めます。構造・必須項目・禁止事項が recipe / sample / template と異なる場合は本 rulebook を優先します。
70
62
 
71
- | 番号 | 見出し | 必須 | 内容 |
72
- | ---- | -------------- | -------- | ---------------------------------------------------------------------------------- |
73
- | 1 | 概要 | ○ | 対象、スコープ、状態を管理する目的、利用者 |
74
- | 2 | 状態一覧 | ○ | 値、状態名、通称、意味、成立条件、管理場所 |
75
- | 3 | 状態遷移図 | ○ | 状態一覧と一致する状態、初期・終了、イベント・条件を示す Mermaid `stateDiagram-v2` |
76
- | 4 | 遷移の説明 | ○ | 遷移 ID、遷移元、遷移先、イベント、条件、業務上の補足 |
77
- | 5 | 今後の検討メモ | 条件付き | 未決の例外状態、遷移、用語、責任境界。未決事項がある場合だけ設ける |
63
+ | 内容領域 | 必須 | 判断できること |
64
+ | ---------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
65
+ | 主題・目的・境界 | ○ | 一つの対象の何を状態で管理し、誰が何を判断するか。状態変更を起こす業務範囲と対象外、終了または継続管理の到達点 |
66
+ | 現在状態の根拠 | ○ | 状態の正本となる管理場所、現在状態を一意に決める規則、互換の扱い |
67
+ | 状態と遷移の定義 | ○ | 各状態の意味・成立条件・管理場所と、初期・終了または継続状態を含む全遷移 |
68
+ | 未決事項 | 条件付き | 未決の例外状態・遷移・用語・責任境界の論点と影響。未決事項がある場合だけ記載する |
78
69
 
79
- 状態が一つしかない対象も、状態変化がない根拠を「概要」に記載し、状態遷移図では初期点からその状態への遷移を示します。状態自体を持たない対象には STSD を作成しません。
70
+ 状態自体を持たない対象には STSD を作成しません。
80
71
 
81
72
  ## 6. 記述ガイド
82
73
 
83
- ### 6.1. 概要
74
+ ### 6.1. 頭書きと目的
84
75
 
85
- - 対象を一つの業務用語で特定し、AS-IS / TO-BE などのスコープを明示します。
86
- - 状態管理によって誰が何を判断するかを 1〜3 文で記述します。
87
- - 状態の正本となる管理場所と、状態変更を起こす業務範囲を示します。
76
+ - 頭書きは H1 直下に見出しなしで置き、何の状態と遷移を定義するかを 1〜2 行で示します。
77
+ - 「目的」には、状態で対象の何を管理し、誰がその状態で何を判断するかを 1〜3 文で示します。文書の読み手や使い方は書かず、境界は「適用範囲」、判定規則は「状態の判定」へ置きます。
88
78
 
89
- ### 6.2. 状態一覧
79
+ | 判断の基準 | 良い例 | 悪い例 |
80
+ | -------------------------------- | -------------------------------------------------------------- | ------------------------------------ |
81
+ | 頭書きで主題を識別できる | タスク実行の状態と状態遷移を定義する | 状態について説明する |
82
+ | 目的が利用者の業務判断に結び付く | 実行の進み具合を管理し、担当者が着手・引き継ぎの要否を判断する | 実装担当とテスト担当が読むために作る |
83
+
84
+ ### 6.2. 適用範囲
85
+
86
+ - 対象を一つの業務用語で特定し、状態変更を起こす業務の開始と対象外の境界を示します。
87
+ - 業務上の到達点を示します。終了点を置かない場合は、管理を続ける理由と、出力遷移のない継続状態を示します。
88
+
89
+ | 判断の基準 | 良い例 | 悪い例 |
90
+ | ------------------------------ | -------------------------------------------------------------------------- | ------------------------------ |
91
+ | 対象内外の境界を区別できる | 商品受領から販売・返品までを扱い、納品前の発注は対象外とする | 商品に関係する業務全般 |
92
+ | 終了点の要否を業務で説明できる | 完了後も差し戻しを受け付け、中止後も補足記録を更新するため終了点を置かない | 記録を保存するので終了点は不要 |
93
+
94
+ ### 6.3. 状態の判定
95
+
96
+ - 現在状態を確認する正本の管理場所を示し、履歴・集約記録を併用する場合は正本か派生物かを区別します。
97
+ - 現在状態を一意に判定する規則として、イベント再生の順序と初期値、導出状態の導出条件と再判定の契機、複数の成立条件を満たす場合の優先関係を該当する範囲で定めます。
98
+ - 旧状態値・旧イベント、未設定・欠損記録の読み取りや移行など互換の扱いを、過去の記録を読む規則と現在発行する遷移に分けて示します。不要な場合はその旨を明記します。
99
+
100
+ | 判断の基準 | 良い例 | 悪い例 |
101
+ | -------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------- |
102
+ | 同じ記録から同じ現在状態に至る | 個票の状態欄を正本とし、一覧はその派生物として再生成する | 個票か一覧の新しそうな方を見る |
103
+ | 過去の読み取りと現在の操作を区別できる | 旧イベントは読み取り時だけ読み替え、新規記録には現行イベントを使う | 古い記録もあるのでどちらの操作も許可する |
104
+
105
+ ### 6.4. 状態一覧
90
106
 
91
107
  | 列名 | 記述ルール |
92
108
  | -------- | --------------------------------------------------------------------- |
@@ -97,22 +113,37 @@ Status Definition Documentation Rulebook
97
113
  | 成立条件 | いつその状態と判定できるかを、確認可能な事実で記述 |
98
114
  | 管理場所 | 現在状態を確認する正本の帳簿、台帳、記録、または概念上の保管先 |
99
115
 
100
- - 状態名は用語集や業務データ辞書の名称と一致させます。
101
- - `値` は文書内で重複させず、外部参照から対応する状態を一意に特定できるようにします。`-` はコードを持たないことを表し、複数行で使用できます。
102
- - 終了条件は遷移の説明へ置き、状態一覧の成立条件と同じ説明を重複させません。
116
+ - `値` の形式と一意性は「ファイル命名・ID規則」に従い、`-` は複数行で使用できます。
117
+ - 終了条件は遷移表へ置き、成立条件と重複させません。
103
118
  - 同じ状態を管理場所ごとに別名で複製せず、意味または成立条件が異なる場合だけ別状態とします。
119
+ - 状態が一つしかない対象は、状態変化がない根拠を記載し、図では初期点からその状態への遷移を示します。
104
120
 
105
- ### 6.3. 状態遷移図
121
+ | 判断の基準 | 良い例 | 悪い例 |
122
+ | -------------------------------------- | -------------------------------------------------------- | ------------------------ |
123
+ | 意味と成立条件から隣接状態と区別できる | 販売可能: 検品合格を記録し、在庫を更新して売場へ配置済み | 販売可能: 販売できる状態 |
124
+ | 現在状態の根拠を確認できる | 管理場所を在庫記録とし、正本の対象行を確認する | 管理場所はシステム |
106
125
 
107
- - Mermaid の `stateDiagram-v2` を使用し、Frontmatter の `includes` で指定された記法ルールに従います。
108
- - 状態一覧の「状態名」を図の状態ラベルにそのまま使用します。
109
- - 遷移ラベルは `イベント / 条件` とし、条件がない場合も業務イベントを省略しません。
110
- - 分岐は同じ遷移元から出る複数の遷移として表し、各矢印へ同じイベントと相互排他的な条件を記載します。`<<choice>>` など、状態一覧にない疑似状態は使用しません。
111
- - 状態はすべて同じ階層へ置き、親状態と下位状態を持つ複合状態は使用しません。階層化が必要な場合は、状態を持つ対象を分けて別の STSD にします。
112
- - 初期点は必ず `[*]` で示します。終了点は業務上の終了がある場合に `[*]` で示し、初期点・終了点を業務上の状態として状態一覧へ追加しません。終了点を省略する継続的な状態管理では、「概要」に理由と継続状態を記載します。
113
- - 図の分割条件、分割単位、共有状態の扱いは Frontmatter の `includes` で指定した記法ルールに従います。
126
+ ### 6.5. 状態遷移
114
127
 
115
- ### 6.4. 遷移の説明
128
+ - 図と遷移表を同じ「状態遷移」章へ置き、各図のすぐ下にその図の遷移表を置きます。図を分けた場合も図と表を一組として繰り返し、分割理由・遷移 ID の範囲・共有状態の置き方は stsd-mermaid-rulebook の「図の分割」に従います。
129
+ - 複数の遷移に共通する条件や補足は、適用する遷移 ID を示して章の冒頭などへ集約し、表から参照します。
130
+ - 図の矢印・表の行・分割図の共有状態の宣言は対応に必要なため削らず、冗長さは図表をなぞる本文から削ります。
131
+
132
+ | 判断の基準 | 良い例 | 悪い例 |
133
+ | -------------------------------------- | ------------------------------------------------------------ | -------------------------------------- |
134
+ | 図から直下の表で条件・補足を確認できる | 同じ遷移 ID で図の矢印と表の一行を対応付ける | 図の後に同じ経路を文章でも順に説明する |
135
+ | 分割しても経路を接続できる | 共有状態の表示名と内部 ID をそろえて各図で宣言する | 重複を避けるため後続図の共有状態を削る |
136
+ | 共通条件の適用範囲を判断できる | 対象の遷移 ID を挙げて操作権限を一度定義し、各行から参照する | 操作権限の説明全文を各行へ繰り返す |
137
+
138
+ #### 6.5.1. 図
139
+
140
+ - Mermaid の `stateDiagram-v2` を使い、表示名・`state_id`・遷移ラベル・図の分割の記法は [[specdojo:stsd-mermaid-rulebook|STSD の状態遷移図を Mermaid で記述するルール]] に委ねます。
141
+ - 同じ遷移元から同じイベントで分岐する場合は、遷移先ごとの矢印へ同じイベントと相互排他的な条件を記載します。異なるイベントで出る遷移は分岐として扱いません。
142
+ - 初期点は必ず `[*]` で示し、初期点・終了点を状態一覧へ追加しません。
143
+ - 終了点は、ライフサイクルを閉じる業務イベントと条件が定義されている場合だけ `[*]` で示します。完了・中止後も差し戻しや確認・記録更新のために状態管理が続く場合は置かず、省略理由を「適用範囲」に記載します。記録の保存だけでは継続とみなさず、終了点のためにイベントを作りません。
144
+ - 差し戻せる完了には戻りの遷移を示し、確認・記録更新だけを続ける中止は出力遷移のない継続状態とします。
145
+
146
+ #### 6.5.2. 遷移表
116
147
 
117
148
  | 列名 | 記述ルール |
118
149
  | -------- | ----------------------------------------------------------------- |
@@ -123,33 +154,38 @@ Status Definition Documentation Rulebook
123
154
  | 条件 | 遷移成立を yes / no で判定できる条件。無条件なら `イベント発生時` |
124
155
  | 補足 | 判断者、例外時の扱い、記録する証跡など、図だけでは伝わらない事項 |
125
156
 
126
- - 図にある全遷移を一行ずつ記載し、表にだけある遷移を残しません。
127
- - 同じイベントから複数の遷移先へ分岐する場合は、条件を相互排他的かつ判定可能にします。
157
+ - 直上の図にある全遷移を一行ずつ記載します。分割時も一つの遷移を複数の表へ重複させません。
128
158
  - 自己遷移は、状態の意味を変えずに記録更新や再確認を行う業務上の必要がある場合だけ使用します。
129
159
 
130
- ### 6.5. 今後の検討メモ
160
+ ### 6.6. 今後の検討メモ
131
161
 
132
- - 調査で確定できる不足は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: で区別します。
133
- - 各項目に影響する状態または遷移 ID、決定者、決定時期を記載します。
134
- - 未決事項がない場合は章を省略し、空欄や「なし」だけの章を残しません。
162
+ - 調査で確定できる不足は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: とし、論点・影響する状態または遷移 ID・決まるまでの扱いを記載します。
163
+ - 未決事項がない場合は章を省略します。
135
164
 
136
- ### 6.6. 完成判定
165
+ | 判断の基準 | 良い例 | 悪い例 |
166
+ | ------------------------------ | ---------------------------------------------------------------------------- | ------------------ |
167
+ | 未決の影響と当面の扱いが分かる | _UNDECIDED_: `T-07` の再開に承認を要するか。決まるまで再開は承認後だけとする | 再開は今後検討する |
137
168
 
138
- - 状態一覧の全状態が状態遷移図に登場し、図の業務状態がすべて状態一覧にあります。
139
- - 外部参照に使う `値` が文書内で一意で、各値から状態を一つに特定できます。
140
- - 状態一覧の成立条件だけで現在状態を判定でき、複数状態へ同時に該当する場合の扱いが明示されています。
141
- - 図の全遷移が遷移の説明へ一度ずつ対応し、遷移元・遷移先・イベント・条件が一致しています。
142
- - 初期点からすべての終了状態または継続状態まで到達でき、正常系・例外系の全遷移について終了、正常系への復帰、または人間の判断への引き渡しを説明できます。
143
- - 状態一覧の各業務状態が少なくとも一つの初期点から到達でき、到達不能な中間状態が残っていません。
169
+ ### 6.7. 完成判定
170
+
171
+ - 状態一覧の全状態が状態遷移図に登場し、図の業務状態がすべて状態一覧にあります。各 `値` から状態を一つに特定できます。
172
+ - 「状態の判定」の正本・判定規則・互換の扱いと「状態一覧」の成立条件から、現在状態を一意に判定できます。
173
+ - 各図の全遷移が直下の遷移表へ一度ずつ対応して内容が一致し、文書全体で遷移の重複や欠落がありません。
174
+ - 到達性が stsd-mermaid-rulebook の「完成判定」を満たし、例外系の全遷移について終了、正常系への復帰、または人間の判断への引き渡しを説明できます。
144
175
  - 状態名、通称、イベント名が用語集・業務データ辞書・関連 CDFD と矛盾していません。
145
176
 
177
+ ### 6.8. 改訂時の影響確認
178
+
179
+ - 状態値・状態名・遷移 ID を変えるときは、参照する業務データ辞書・CDFD・業務ルール、型・schema、状態遷移テスト・受入条件の追従を確認します。
180
+
146
181
  ## 7. 禁止事項
147
182
 
148
183
  - 同じ対象の状態一覧と状態遷移図を別文書へ分けません。
149
184
  - 状態名に `is_active`、`FLAG_01`、数値だけのコードなど、実装上の識別子を使いません。
150
- - 画面ページ、API 呼び出し、関数実行を業務状態または業務イベントとしてそのまま記載しません。
151
- - 遷移ラベルを空にしたり、条件を実装式だけで表したりしません。
152
- - 状態一覧にない状態を図へ追加したり、図にない遷移を遷移の説明へ追加したりしません。
153
- - `<<choice>>` など、状態一覧にない疑似状態を分岐のために追加しません。
185
+ - 物理テーブル、画面ページ、API 呼び出し、関数実行を業務状態または業務イベントとしてそのまま記載しません。
186
+ - 遷移ラベルから遷移 ID やイベントを省略したり、条件を実装式だけで表したりしません。
187
+ - 直上の図にない遷移を遷移表へ追加しません。
188
+ - 「状態遷移」の図と表を別章へ分けたり、分割図の表を一括して後置したりしません。
189
+ - `<<choice>>` など、状態一覧にない状態や疑似状態を図へ追加しません。
154
190
  - 親状態と下位状態を持つ複合状態を使用しません。階層化が必要な異なる対象を一つの STSD に混在させません。
155
191
  - CDFD、業務データ辞書、用語集に同じ状態一覧や遷移表を複製しません。