specdojo 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (284) hide show
  1. package/.github/agents/specdojo-orchestrator.md +4 -1
  2. package/CHANGELOG.md +64 -0
  3. package/dist/catalog/catalog.js +16 -14
  4. package/dist/commands/agent.js +5 -3
  5. package/dist/commands/build.js +69 -10
  6. package/dist/commands/git.js +206 -0
  7. package/dist/commands/init.js +4 -2
  8. package/dist/commands/where.js +25 -0
  9. package/dist/dashboard/dashboard.js +5 -3
  10. package/dist/dashboard/routines.js +4 -7
  11. package/dist/dashboard/timeline.js +14 -14
  12. package/dist/docs/index-command.js +2 -2
  13. package/dist/docs/yaml-business-tables.js +243 -0
  14. package/dist/docs/yaml-interface-tables.js +106 -0
  15. package/dist/docs/yaml-pages-command.js +5 -3
  16. package/dist/docs/yaml-pages.js +146 -3
  17. package/dist/docs/yaml-table-shared.js +70 -0
  18. package/dist/docs/yaml-tables.js +39 -0
  19. package/dist/exec/agent-config.js +9 -0
  20. package/dist/exec/agent-protected-config.js +2 -0
  21. package/dist/exec/commands.js +31 -18
  22. package/dist/exec/events.js +34 -14
  23. package/dist/exec/evidence.js +13 -3
  24. package/dist/exec/parent-validation.js +56 -3
  25. package/dist/exec/plans-core.js +21 -2
  26. package/dist/exec/plans-generation.js +6 -7
  27. package/dist/exec/post-integration.js +162 -0
  28. package/dist/exec/queue-command.js +166 -0
  29. package/dist/exec/queue.js +285 -0
  30. package/dist/exec/register-foreign-wait.js +84 -0
  31. package/dist/exec/repo-integration-sync.js +17 -5
  32. package/dist/exec/reporter.js +2 -2
  33. package/dist/exec/results.js +24 -4
  34. package/dist/exec/review-kata.js +4 -1
  35. package/dist/exec/run/agent-pipeline.js +3 -2
  36. package/dist/exec/run/agent.js +12 -6
  37. package/dist/exec/run/change-scope.js +365 -0
  38. package/dist/exec/run/deferred-cleanup.js +31 -0
  39. package/dist/exec/run/in-place.js +4 -1
  40. package/dist/exec/run/job-lock.js +66 -0
  41. package/dist/exec/run/job-sequence.js +137 -0
  42. package/dist/exec/run/job.js +56 -19
  43. package/dist/exec/run/lifecycle-commands.js +1 -1
  44. package/dist/exec/run/lock.js +22 -1
  45. package/dist/exec/run/register-command.js +8 -5
  46. package/dist/exec/run/register-mode.js +68 -8
  47. package/dist/exec/run/register-resume.js +68 -14
  48. package/dist/exec/run/register-state.js +13 -8
  49. package/dist/exec/run/register-worktree.js +140 -125
  50. package/dist/exec/run/schedule-mode.js +75 -14
  51. package/dist/exec/run/schedule-prepare.js +3 -0
  52. package/dist/exec/run/schedule-task.js +88 -38
  53. package/dist/exec/run/shared.js +5 -0
  54. package/dist/exec/schedule/schedule.js +116 -4
  55. package/dist/exec/shared.js +1 -1
  56. package/dist/exec/smoke.js +190 -0
  57. package/dist/exec/strategy.js +13 -3
  58. package/dist/exec/task-view.js +6 -4
  59. package/dist/exec/trial-commands.js +5 -2
  60. package/dist/exec/trial-core.js +6 -1
  61. package/dist/exec/validation-metrics.js +181 -0
  62. package/dist/exec/worktree-cleanup-lock.js +26 -0
  63. package/dist/exec/worktree-command.js +9 -1
  64. package/dist/exec/worktree-ops-commit.js +2 -2
  65. package/dist/exec/worktree.js +13 -2
  66. package/dist/grade/command-apply.js +3 -3
  67. package/dist/grade/command-inspect.js +5 -3
  68. package/dist/grade/command-plan.js +1 -1
  69. package/dist/grade/command-run.js +5 -1
  70. package/dist/grade/run.js +64 -8
  71. package/dist/job/definition.js +84 -8
  72. package/dist/job/job.js +79 -23
  73. package/dist/register/authoring-sources.js +22 -16
  74. package/dist/register/maintenance-commands.js +2 -2
  75. package/dist/register/register.js +31 -7
  76. package/dist/routine/definition.js +9 -0
  77. package/dist/routine/routine.js +137 -43
  78. package/dist/routine/status.js +62 -0
  79. package/dist/schedule/schedule.js +38 -39
  80. package/dist/shared/agent-types.js +5 -0
  81. package/dist/shared/cross-process-lock.js +9 -1
  82. package/dist/shared/dist-freshness.js +8 -2
  83. package/dist/shared/git-environment.js +2 -1
  84. package/dist/shared/git.js +44 -1
  85. package/dist/shared/lefthook-scaffold.js +3 -0
  86. package/dist/shared/local-config.js +244 -0
  87. package/dist/shared/specdojo-config.js +34 -20
  88. package/dist/shared/specdojo-gitignore.js +1 -0
  89. package/dist/shared/text.js +9 -1
  90. package/dist/shared/where-alias.js +13 -0
  91. package/dist/specdojo.js +4 -0
  92. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  93. package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
  94. package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
  95. package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
  96. package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
  97. package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
  98. package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
  99. package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
  100. package/docs/ja/specdojo/guides/waza-guide.md +12 -8
  101. package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
  102. package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
  103. package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
  104. package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
  105. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
  106. package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
  107. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
  108. package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
  109. package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
  110. package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
  111. package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
  112. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
  113. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
  114. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
  115. package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
  116. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
  117. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
  118. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
  119. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
  120. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
  121. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
  122. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
  123. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
  124. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
  125. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
  126. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
  127. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
  128. package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
  129. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
  130. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
  131. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
  132. package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
  133. package/docs/ja/specdojo/references/command-reference.md +257 -117
  134. package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
  135. package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
  136. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
  137. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
  138. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
  139. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
  140. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
  141. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
  142. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
  143. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
  144. package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
  145. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
  146. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
  147. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
  148. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
  149. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
  150. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
  151. package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
  152. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
  153. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
  154. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
  155. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
  156. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
  157. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
  158. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
  159. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
  160. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
  161. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
  162. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
  163. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
  164. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
  165. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
  166. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
  167. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
  168. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
  169. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
  170. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
  171. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
  172. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
  173. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
  174. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
  175. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
  176. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
  177. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
  178. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
  179. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
  180. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
  181. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
  182. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
  183. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
  184. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
  185. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
  186. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
  187. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
  188. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
  189. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
  190. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
  191. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
  192. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
  193. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
  194. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
  195. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
  196. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
  197. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
  198. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
  199. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
  200. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
  201. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
  202. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
  203. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
  204. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
  205. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
  206. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
  207. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
  208. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
  209. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
  210. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
  211. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
  212. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
  213. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
  214. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
  215. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
  216. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
  217. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
  218. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
  219. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
  220. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
  221. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
  222. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
  223. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
  224. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
  225. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
  226. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
  227. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
  228. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
  229. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
  230. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
  231. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
  232. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
  233. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
  234. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
  235. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
  236. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
  237. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
  238. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
  239. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
  240. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
  241. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
  242. package/docs/ja/specdojo/samples/bds-sample.md +58 -71
  243. package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
  244. package/docs/ja/specdojo/samples/bes-sample.md +43 -53
  245. package/docs/ja/specdojo/samples/bps-sample.md +42 -54
  246. package/docs/ja/specdojo/samples/br-sample.md +40 -52
  247. package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
  248. package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
  249. package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
  250. package/docs/ja/specdojo/samples/clis-sample.md +70 -77
  251. package/docs/ja/specdojo/samples/dec-sample.md +2 -3
  252. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
  253. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
  254. package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
  255. package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
  256. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
  257. package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
  258. package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
  259. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
  260. package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
  261. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
  262. package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
  263. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
  264. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
  265. package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
  266. package/docs/ja/specdojo/samples/sf-sample.md +73 -85
  267. package/docs/ja/specdojo/samples/sld-sample.md +60 -79
  268. package/docs/ja/specdojo/samples/uis-sample.md +98 -121
  269. package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
  270. package/docs/ja/specdojo/templates/cdr-template.md +58 -0
  271. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
  272. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
  273. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
  274. package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
  275. package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
  276. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
  277. package/package.json +9 -6
  278. package/templates/antigravity/orchestrator.md +4 -1
  279. package/templates/claude/agents/specdojo-orchestrator.md +4 -1
  280. package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
  281. package/templates/codex/orchestrator.md +4 -1
  282. package/templates/init-exec-defaults.yaml +13 -0
  283. package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
  284. package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
@@ -5,6 +5,8 @@ specdojo:
5
5
  deliverable_type: architecture
6
6
  status: draft
7
7
  target_format: markdown
8
+ recipe: not-needed
9
+ sample: undecided
8
10
  template: not-needed
9
11
  based_on:
10
12
  - specdojo:rulebook-authoring-standard
@@ -15,53 +17,41 @@ specdojo:
15
17
 
16
18
  System Design Topic Documentation Rulebook
17
19
 
18
- `sysd-<term>.md` を、システム設計の個別トピックまたは複数の子設計を束ねる hub として記述するためのルールです。`sysd-index` が設計 SSOT 全体への入口であるのに対し、本 rulebook は一つの設計関心事に絞った構造、責務、制約、検証観点を定義します。
20
+ `sysd-<term>.md` の構造・責務・制約・検証観点を定める。実装・検証・運用判断に使う個別設計と、子設計を束ねる hub を対象とする。
19
21
 
20
22
  ## 1. 全体方針
21
23
 
22
- - 一つの `sysd-<term>` は、一つの設計関心事、または同じ関心事に属する子設計群への導線だけを扱います。
23
- - 設計判断、責務境界、構成、主要フロー、制約、検証観点を記述し、実装コードや設定ファイルの全文は一次情報への参照に留めます。
24
- - 複数 provider や実装方式を同じ共通設計の下で管理する場合は、親を薄い hub、方式別の詳細を子 `sysd-<term>` として分冊できます。
25
- - 複数トピックへ適用する必須・禁止ルールは `sysd-cross-cutting-policy`、事故予防に必要な難所フローは `sysd-critical-flows` を SSOT とします。
26
- - 運用判断は `opd-*`、再現可能な操作手順は `opr-*` に委ね、個別システム設計へ混在させません。
24
+ - 一冊は一つの設計関心事に絞る。同じ共通設計に属する複数 provider・方式は、hub と子設計に分冊できる。
25
+ - コード・設定全文は一次情報、運用判断は `opd-*`、操作手順は `opr-*` を参照する。
26
+ - **共通の運用**: 役割は適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の検証に含めない。
27
27
 
28
- ## 2. 位置づけと用語定義
28
+ ## 2. 位置づけ
29
29
 
30
- | ドキュメント | 役割 | 記載しないもの |
31
- | --------------------------- | ------------------------------------ | ---------------------- |
32
- | `sysd-index` | システム設計 SSOT の全体入口 | 個別設計の本文 |
33
- | `sysd-cross-cutting-policy` | 複数トピックへ適用する横断ルール | 個別 provider の詳細 |
34
- | `sysd-critical-flows` | 最大5件の事故予防フロー | 通常系の網羅的な手順 |
35
- | `sysd-<term>`(hub) | 共通の目的・境界と子設計への導線 | 子設計の設定全文 |
36
- | `sysd-<term>`(子設計) | 一つの方式・provider・機能の詳細設計 | 親と同じ共通方針の再掲 |
37
-
38
- hub は内容の薄さを目的とするのではなく、共通事項の SSOT と子設計の選択条件を一箇所に保つための構成です。
30
+ | 文書 | 正本とする内容 |
31
+ | --------------------------- | ------------------------------------ |
32
+ | `sysd-index` | システム設計全体への入口 |
33
+ | `sysd-cross-cutting-policy` | 複数トピックの必須・禁止ルール |
34
+ | `sysd-critical-flows` | 最大5件の事故予防フロー |
35
+ | `sysd-<term>`(hub) | 共通の目的・境界、子設計の選択条件 |
36
+ | `sysd-<term>`(子設計) | 一つの方式・provider・機能の詳細設計 |
39
37
 
40
38
  ## 3. ファイル命名・ID規則
41
39
 
42
- - ファイル名は `sysd-<term>.md`、ID は `sysd-<term>` とします。
43
- - `<term>` は英小文字・数字・ハイフンで、設計関心事を一意に表します。
44
- - hub と子設計は同じディレクトリへ配置し、子設計の `part_of` から hub の ID を参照します。
45
- - provider 別に分冊する場合は、`sysd-<provider>-<topic>.md` のように選択軸を名前へ含めます。
46
- - `sysd-index`、`sysd-critical-flows`、`sysd-cross-cutting-policy` は専用 rulebook の対象であり、本 rulebook の対象外です。
40
+ - ファイル名は `sysd-<term>.md`、ID は `sysd-<term>`。`<term>` は英小文字・数字・ハイフンで設計関心事を表す。
41
+ - hub と子設計は同じディレクトリに置く。provider 別なら `sysd-<provider>-<topic>.md` のように選択軸を含める。
42
+ - 索引・横断ルール・重要フローは本書の対象外とする。
47
43
 
48
44
  ## 4. 推奨 Frontmatter 項目
49
45
 
50
- | 項目 | 説明 | 必須 |
51
- | ------------ | -------------------------------- | ----------- |
52
- | `id` | `sysd-<term>` | ○ |
53
- | `type` | `architecture` | ○ |
54
- | `status` | `draft` / `ready` / `deprecated` | ○ |
55
- | `rulebook` | `specdojo:sysd-rulebook` | ○ |
56
- | `part_of` | hub または `sysd-index` の ID | 子設計では○ |
57
- | `based_on` | 設計判断へ直接利用した成果物 ID | 任意 |
58
- | `supersedes` | 置き換える旧設計 ID | 任意 |
46
+ 共通項目の必須性・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
59
47
 
60
- hub の子設計一覧と `part_of` の参照は一致させます。作成途中は `status: draft` とし、実装・検証との整合を確認してから昇格します。
48
+ - `type` は `architecture`、`rulebook` は `specdojo:sysd-rulebook`。
49
+ - 子設計の `part_of` は必須とし、hub の ID を参照して子設計一覧と一致させる。
50
+ - `based_on` は設計判断へ直接利用した成果物 ID を任意で示す。
61
51
 
62
- ## 5. 本文構成(標準テンプレ)
52
+ ## 5. 本文要件
63
53
 
64
- 章構成はトピックに応じて柔軟に決められます。ただし、次の観点を本文から追跡できるようにします。
54
+ 章構成は任意だが、次の観点を追跡可能にする。観点表と記述ガイドで作成判断ができるため、recipe・template は不要とする。
65
55
 
66
56
  | 観点 | hub | 子設計・単独設計 | 内容 |
67
57
  | ---------------------------- | -------- | ---------------- | -------------------------------------- |
@@ -71,50 +61,47 @@ hub の子設計一覧と `part_of` の参照は一致させます。作成途
71
61
  | 全体構成・主要フロー | 推奨 | ○ | 構成要素、データ・制御の流れ、永続化点 |
72
62
  | 設定・インターフェース | 導線のみ | 必要時○ | SSOT の所在、解決規則、互換性 |
73
63
  | 失敗時・再実行・セキュリティ | 導線のみ | 必要時○ | 失敗境界、復旧条件、権限制約 |
74
-
75
- | 子設計一覧 | ○ | - | 選択条件、責務、参照先 |
76
-
77
- | 検証観点・関連文書 | ○ | ○ | テスト、運用、横断ルールへの導線 |
64
+ | 子設計一覧 | ○ | - | 選択条件、責務、参照先 |
65
+ | 検証観点・関連文書 | ○ | ○ | テスト、運用、横断ルールへの導線 |
78
66
 
79
67
  ## 6. 記述ガイド
80
68
 
81
69
  ### 6.1. 目的・適用範囲
82
70
 
83
- - 何を設計し、誰が実装・検証・運用判断に利用するかを1〜3段落で示します。
84
- - 対象外を明示し、横断ルール、運用方針、運用手順へ委譲する事項を区別します。
85
- - 現在の実装境界と将来構想を混在させず、未確定事項には共通ラベルを付けます。
71
+ - 対象・対象外と利用者を1〜3段落で示す。
72
+ - 横断ルール・運用方針・手順への委譲先を区別する。
73
+ - 現行と将来構想を分け、未確定事項は共通ラベルで論点と影響を示す。
86
74
 
87
75
  ### 6.2. 設計方針・責務境界
88
76
 
89
- - 採用理由、守るべき制約、責務外を判定可能な表現で記載します。
90
- - 責務表を置く場合は、構成要素、責務、責務外、参照する SSOT を列に含めます。
91
- - 複数トピック共通の MUST / MUST NOT は本文へ複製せず、Rule ID を付けて `sysd-cross-cutting-policy` を参照します。
77
+ - 採用理由・制約・責務外を判定可能にする。
78
+ - 責務表の列は構成要素、責務、責務外、参照する SSOT とする。
79
+ - 横断の MUST / MUST NOT は `sysd-cross-cutting-policy` の Rule ID を参照する。
92
80
 
93
81
  ### 6.3. hub と子設計
94
82
 
95
- - hub は共通の目的、責務境界、選択軸、子設計一覧、横断ルールへの導線を保持します。
96
- - 子設計一覧には、子設計 ID、対象、固有責務、選択条件を記載します。
97
- - provider 固有の認証、モデル、設定、制限シグナルは子設計へ置き、hub に詳細を再掲しません。
83
+ - 子設計一覧の列は子設計 ID、対象、固有責務、選択条件とする。
84
+ - provider 固有の認証・モデル・設定・制限シグナルは子設計に置く。
85
+ - 良い例: 「Codex 利用時は Codex 子設計を参照」。悪い例: hub に全 provider の設定全文を並べる。
98
86
 
99
87
  ### 6.4. 構成・フロー・設定
100
88
 
101
- - 図は主要コンポーネントと境界が変わる場合に使い、クラスや関数単位へ展開しません。
102
- - 設定は項目の意味、解決順序、検証条件を記述し、設定全文や秘密情報を掲載しません。
103
- - 事故時に再実行性、順序、補償、監査が問題になるフローは `sysd-critical-flows` へ切り出します。
89
+ - 図は主要コンポーネントと境界に用い、クラス・関数単位へ展開しない。
90
+ - 設定は項目の意味・解決順序・検証条件を示す。
91
+ - 再実行性・順序・補償・監査が事故時に問題になるフローは `sysd-critical-flows` に切り出す。
104
92
 
105
93
  ### 6.5. 検証観点・関連文書
106
94
 
107
- - 設計制約ごとに、コード、設定検証、単体・統合テスト、レビューのどれで確認するかを示します。
108
- - `sysd-index`、`sysd-cross-cutting-policy`、必要な `sysd-critical-flows`、テスト設計、OPD / OPR への導線を置きます。
109
- - 参照先が存在しない場合は空欄にせず、`(なし)` または未確定ラベルを明記します。
95
+ - 設計制約ごとに、コード・設定検証・単体/統合テスト・レビューから確認方法を選び、手順と期待結果を示す。
96
+ - `sysd-index`、横断ルール、必要な重要フロー、テスト設計、OPD / OPR へ導く。
97
+ - 参照先がなければ `(なし)` または共通の未確定ラベルを記す。
110
98
 
111
99
  ## 7. 禁止事項
112
100
 
113
- | 禁止事項 | 理由 |
114
- | --------------------------------------------- | ------------------------------------------- |
115
- | hub に子設計の設定全文を再掲する | SSOT が分散するため |
116
- | 横断ルールを複数の `sysd-<term>` に複製する | 変更時に不整合となるため |
117
- | 運用コマンドを長い手順として記載する | OPR の責務を侵食するため |
118
- | コード、設定、schema の全文を貼り付ける | Code as Spec の一次情報と二重管理になるため |
119
- | 失敗・再実行・権限・検証観点を省略する | 実装とテストの判断材料が欠落するため |
120
- | 親子関係のない設計を便宜的に同じ hub へ束ねる | 選択軸と責務境界が不明になるため |
101
+ | 禁止事項 | 理由 |
102
+ | --------------------------------------------- | ------------------------------------ |
103
+ | hub に子設計の設定全文を再掲する | SSOT が分散するため |
104
+ | 横断ルールを複数の `sysd-<term>` に複製する | 変更時に不整合となるため |
105
+ | 運用コマンドを長い手順として記載する | OPR の責務を侵食するため |
106
+ | 失敗・再実行・権限・検証観点を省略する | 実装とテストの判断材料が欠落するため |
107
+ | 親子関係のない設計を便宜的に同じ hub へ束ねる | 選択軸と責務境界が不明になるため |
@@ -11,104 +11,103 @@ specdojo:
11
11
 
12
12
  Requirements Traceability (Requirements to Specs) Rulebook
13
13
 
14
- 本ドキュメントは、各成果物の型付きID参照から要求と仕様の対応関係を派生ビューとして表示する場合の形式を定義します。要求漏れ・仕様漏れを防ぎ、変更時の影響追跡とレビュー判断を容易にすることを目的とします。
14
+ 仕様成果物の型付き ID 参照から要求と仕様の対応を派生ビューとして示し、要求漏れ・仕様漏れを見つける形式を定めます。
15
15
 
16
16
  ## 1. 全体方針
17
17
 
18
- - 対象は「要求と仕様の対応関係の可視化」であり、仕様本文そのものの詳細記述は扱わない。
19
- - 対応関係の正本は仕様成果物の `relations.satisfies` とし、本ビューを手編集しない。
20
- - 1 行は 1 つの対応命題(要求IDと対応仕様IDの関係)を原則とし、判定可能な状態で記述する。
21
- - 記載の最小単位は `要求ID` とし、各要求が少なくとも 1 つ以上の仕様へトレースされる状態を維持する。
22
- - 充足状況とギャップは、レビュー時に即時判定できる語彙で統一する。
23
- - 本ビューは必要なプロジェクトで生成する任意の管理ビューとし、独立した成果物ドメインやトラックを持たない。
18
+ - **対象**: 要求と仕様の対応の可視化を扱い、要求・仕様の本文は扱いません。
19
+ - **正本と派生**: 対応の正本は仕様成果物の `relations.satisfies` とし、本ビューは派生ビューとして生成します。「目的と適用範囲」と「トレース対象の前提」は生成の条件として書き、「トレースマトリクス」「充足状況サマリ」「ギャップと対応方針」は生成元から導出します。
20
+ - **記載レベル**: 1 行は 1 つの要求 ID とその対応仕様 ID 群とします。
21
+ - **任意の管理ビュー**: 必要なプロジェクトだけが生成し、独自のドメインやトラックを持ちません。
22
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
24
23
 
25
- ## 2. 位置づけと用語定義(必要に応じて)
24
+ ## 2. 位置づけ
26
25
 
27
- | 用語 | 定義 |
28
- | ---------- | --------------------------------------------------------------- |
29
- | 要求ID | 要求を一意に識別する ID(例: `req-` 系) |
30
- | 対応仕様ID | 要求を実現する仕様を一意に識別する ID(例: `bac-` / `bes-` 系) |
31
-
32
- | 充足状況 | 要求に対する仕様整備の達成状態(未着手 / 一部充足 / 充足) |
33
- | ギャップ | 要求と仕様の間に残る不足・不整合・未確定事項 |
26
+ 本ビューは、要求(業務の受入基準 `bac-*` など)と、それを充足する仕様(システム化機能 `sf-*`、業務仕様 `bes-*` など)の作成後に生成し、仕様のレビュー時と要求・仕様の変更時に再生成します。要求→テストの対応は [[specdojo:trc-requirements-to-tests-rulebook|トレーサビリティ(要求→テスト)作成ルール]] が扱います。
34
27
 
35
28
  ## 3. ファイル命名・ID規則
36
29
 
37
- - 対象ドキュメント ID は `<project-id>:trc-requirements-to-specs` とする(例: `prj-0001:trc-requirements-to-specs`)。
38
- - 推奨ファイル名は `trc-requirements-to-specs.md` とする。
39
- - 本 rulebook の ID は `specdojo:trc-requirements-to-specs-rulebook` とする。
40
- - 追加分割が必要な場合は `<project-id>:trc-requirements-to-specs-<term>` 形式を用いる。
30
+ - **ファイル名**: `trc-requirements-to-specs.md` とします。分割する場合は `trc-requirements-to-specs-<term>.md` とします。
31
+ - **文書 ID**: 成果物カタログの宣言と一致させます。プロダクト仕様のカタログに置く場合は `trc-requirements-to-specs`、プロジェクト固有の場合は `<project-id>:trc-requirements-to-specs` とします(分割時は末尾に `-<term>`)。
41
32
 
42
33
  ## 4. 推奨 Frontmatter 項目
43
34
 
44
- [document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
35
+ 許可キーと型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
45
36
 
46
- | 項目 | 説明 | 必須 |
47
- | ---------- | --------------------------------------------- | ---- |
48
- | id | `<project-id>:trc-requirements-to-specs` | ○ |
49
- | type | `project` | ○ |
50
- | status | `draft` / `ready` / `deprecated` | ○ |
51
- | rulebook | `specdojo:trc-requirements-to-specs-rulebook` | ○ |
52
- | based_on | 生成元となる要求・仕様の ID 配列 | 任意 |
53
- | supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
37
+ - `specdojo.rulebook` は `specdojo:trc-requirements-to-specs-rulebook` とします。
38
+ - `specdojo.based_on` には、生成元とした要求・仕様の文書 ID を記載します。
54
39
 
55
- ## 5. 本文構成(標準テンプレ)
40
+ ## 5. 本文要件
56
41
 
57
- | 章 | 見出し | 必須 | 目的 |
58
- | --- | -------------------- | ---- | -------------------------------------------- |
59
- | 1 | 目的と適用範囲 | ○ | トレース対象の境界と運用目的を明確化する |
60
- | 2 | トレース対象の前提 | ○ | 対象要求群・対象仕様群・除外範囲を明確化する |
61
- | 3 | トレースマトリクス | ○ | 要求IDと対応仕様IDの対応関係を一覧化する |
62
- | 4 | 充足状況サマリ | ○ | 充足状況を集計し、優先対応領域を可視化する |
63
- | 5 | ギャップと対応方針 | ○ | 不足・不整合の内容と解消方針を整理する |
64
- | 6 | 変更履歴と更新ルール | 任意 | 追記・更新時の追跡可能性を担保する |
42
+ | 章 | 必須 | 内容・受入条件 |
43
+ | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
44
+ | 目的と適用範囲 | 必須 | 対象の要求群・仕様群と対象外(理由付き)が分かること |
45
+ | トレース対象の前提 | 必須 | 生成元の ID 体系と範囲、トレース単位(1:1 / 1:N / N:1)、生成の手段(コマンドまたは手順)と生成日が分かること |
46
+ | トレースマトリクス | 必須 | 標準6列で全要求を並べ、対応仕様のない要求と、どの要求にも対応しない仕様が識別できること |
47
+ | 充足状況サマリ | 必須 | 充足状況ごとの件数と、優先して解消する要求 ID が分かること |
48
+ | ギャップと対応方針 | 必須 | ギャップごとに、直す生成元の成果物と解消の判定条件が分かること |
49
+ | 変更履歴と更新ルール | 条件付き | 再生成の契機や前回からの差分を残す必要があるときに置き、生成日と差分の要点を示す |
65
50
 
66
- ## 6. 記述ガイド
51
+ ### 5.1. トレースマトリクスの標準列
67
52
 
68
- ### 6.1. 目的と適用範囲
53
+ | 列名 | 内容・判断条件 |
54
+ | ---------- | ------------------------------------------------------------------------------------- |
55
+ | 要求ID | 追跡対象の要求 ID |
56
+ | 要求要約 | 要求の要点を 1 行で示す |
57
+ | 対応仕様ID | その要求 ID を `relations.satisfies` に持つ仕様 ID(複数可、なければ空とせず `なし`) |
58
+ | 充足状況 | `未着手` / `一部充足` / `充足`。判定は「充足状況の判定」に従う |
59
+ | ギャップ | 未対応点・不整合・未決事項。なければ `なし` |
60
+ | 備考 | 判定の根拠(参照先の `status`、review result など) |
69
61
 
70
- - どの要求群とどの仕様群の対応を管理するかを明記する。
71
- - 対象外(例: 廃止要求、移管済み要求)がある場合は理由付きで記載する。
62
+ どの要求にも対応しない仕様は、同じ表の末尾に要求ID を `なし` として並べるか、別の表で示します。
72
63
 
73
- ### 6.2. トレース対象の前提
64
+ ### 5.2. 充足状況の判定
74
65
 
75
- - 要求側と仕様側の参照元(ID体系、版、作成日)を明記する。
76
- - トレース単位(1:1 / 1:N / N:1)を先に定義する。
66
+ | 充足状況 | 条件 |
67
+ | ---------- | ------------------------------------------------------------------ |
68
+ | `未着手` | その要求を `relations.satisfies` に持つ仕様がない |
69
+ | `一部充足` | 対応仕様はあるが、参照先が未作成・`draft` であるか、ギャップが残る |
70
+ | `充足` | 対応仕様がすべて存在して `ready` であり、ギャップが `なし` |
77
71
 
78
- ### 6.3. トレースマトリクス
72
+ ## 6. 記述ガイド
79
73
 
80
- - 表形式で記載し、最低限次のカラムを含める。
74
+ 完成例は Frontmatter の `sample` で宣言された sample を参照してください。
81
75
 
82
- | カラム | 内容 |
83
- | ---------- | ------------------------------ |
84
- | 要求ID | 追跡対象の要求 ID |
85
- | 要求要約 | 要求内容の要点(1 行) |
86
- | 対応仕様ID | 対応する仕様 ID(複数可) |
87
- | 充足状況 | `未着手` / `一部充足` / `充足` |
88
- | ギャップ | 未対応点・不整合・要確認事項 |
89
- | 備考 | 根拠、判断日、関連チケットなど |
76
+ ### 6.1. 目的と適用範囲
90
77
 
91
- ### 6.4. 充足状況サマリ
78
+ - **判断基準**: 誰がどのレビュー・変更判断に使い、どのリリースや領域の要求を対象とするかが分かること。
79
+ - **良い例**: 「第 1 リリースの会計・在庫・値引き・監査の要求と、それを充足する仕様の対応を示し、仕様レビューで要求漏れを見つける。次期リリースの要求は対象外とする。」
80
+ - **悪い例**: 「要求と仕様の対応を管理する。」(対象範囲と使う場面が分からない)
92
81
 
93
- - 充足状況は件数で集計し、未着手と一部充足を優先管理対象として明示する。
94
- - 重大ギャップ(業務影響が大きい項目)は個別 ID を記載して強調する。
82
+ ### 6.2. トレース対象の前提
95
83
 
96
- ### 6.5. ギャップと対応方針
84
+ - **判断基準**: 別の人が同じ前提で再生成し、同じ表を得られること。
85
+ - **良い例**: 「生成元: `bac-*` と、`relations.satisfies` を持つ `sf-*`・`bes-*`。生成: `<生成コマンド>` で 2026-05-01 に生成。」
86
+ - **悪い例**: 「最新の仕様から作成した。」(生成元の範囲と手段が分からず、検証できない)
97
87
 
98
- - ギャップごとに「解消方針」「担当」「期限」「判定条件」を記載する。
99
- - 方針未確定の場合は _UNDECIDED_: ラベルで暫定状態を明示する。
88
+ ### 6.3. トレースマトリクスと充足状況サマリ
100
89
 
101
- ### 6.6. 変更履歴と更新ルール
90
+ - **判断基準**: 各行の充足状況が「充足状況の判定」の条件から説明でき、サマリの件数が表と一致すること。
91
+ - **良い例**: 「req-r1-002 / 在庫引当をリアルタイムで更新する / bes-stock-allocation, ifx-msg-stock / 一部充足 / 障害時の再送仕様が未確定 / `ifx-msg-stock` が `draft`」
92
+ - **悪い例**: 「req-r1-002 / … / ほぼ対応 / ― / ―」(曖昧語で判定できず、根拠がない)
102
93
 
103
- - 要求や仕様のID参照が更新された場合は、派生ビューを再生成する。
104
- - 充足状況やギャップをビューへ直接入力せず、生成元となる成果物または検証結果へ記録する。
94
+ ### 6.4. ギャップと対応方針
105
95
 
106
- ## 7. 禁止事項
96
+ - **判断基準**: 解消は本ビューでなく生成元の成果物で行うこととし、どの成果物をどう直せば解消と判定するかが分かること。担当・期限は登録簿で追跡し、本ビューに列を設けません。
97
+ - **良い例**: 「req-r1-004 / 監査ログの保持先が未決定 / `bes-audit-log` に保持方針を追記し `relations.satisfies` に req-r1-004 を持たせる / 再生成で `充足` になる」
98
+ - **悪い例**: 「監査ログは今後対応する。」(直す成果物も判定条件もない)
99
+
100
+ ### 6.5. 変更履歴と更新ルール
107
101
 
108
- - 要求本文・仕様本文の全文転記を行わない。
102
+ - **判断基準**: 再生成の契機(要求・仕様の追加、ID 参照の変更、仕様の `status` 変更)と、前回から充足状況が変わった要求 ID が分かること。
103
+
104
+ ## 7. 禁止事項
109
105
 
110
- - 要求IDまたは対応仕様IDが空の行を作成しない。
111
- - 充足状況に曖昧語(例: ほぼ対応、だいたい完了)を使用しない。
112
- - ギャップを「なし」としながら対応仕様IDが未記載の状態を許容しない。
113
- - 根拠リンクや判断履歴なしで充足状況を更新しない。
114
- - 生成したトレース表を手編集し、成果物の `relations.satisfies` と異なる関係を持たせない。
106
+ | 禁止パターン | 理由 |
107
+ | ------------------------------------------------------------------------ | -------------------------------------------------- |
108
+ | 生成した表を手編集し、`relations.satisfies` と異なる対応や充足状況を書く | 正本と派生ビューが食い違い、再生成で消えるため |
109
+ | 要求本文・仕様本文の全文転記 | 正本との二重管理になり、更新時に不整合が出るため |
110
+ | 要求 ID または対応仕様 ID の空欄 | 未対応なのか記入漏れなのか判別できないため |
111
+ | 充足状況に曖昧語(ほぼ対応、だいたい完了など)を使う | 「充足状況の判定」の条件で確かめられないため |
112
+ | 対応仕様 ID が `なし` の行でギャップを `なし` とする | 要求漏れが表から隠れるため |
113
+ | 「トレース対象の前提」に生成元と生成手段を書かずに表を示す | 再生成して照合できず、表が正しいか検証できないため |
@@ -11,108 +11,101 @@ specdojo:
11
11
 
12
12
  Requirements Traceability (Requirements to Tests) Rulebook
13
13
 
14
- 本ドキュメントは、各成果物の型付きID参照から要求とテストの対応関係を派生ビューとして表示する場合の形式を定義します。要求漏れ・テスト漏れを防ぎ、変更時の影響追跡と受入判断を容易にすることを目的とします。
14
+ テスト成果物の型付き ID 参照から要求とテストの対応を派生ビューとして示し、要求漏れ・テスト漏れを見つける形式を定めます。
15
15
 
16
16
  ## 1. 全体方針
17
17
 
18
- - 対象は「要求とテストの対応関係の可視化」であり、テスト手順本文の詳細記述は扱わない。
19
- - 対応関係の正本はテスト成果物の `relations.verifies` とし、本ビューを手編集しない。
20
- - 1 行は 1 つの対応命題(要求IDと対応テストIDの関係)を原則とし、判定可能な状態で記述する。
21
- - 記載の最小単位は `要求ID` とし、各要求が少なくとも 1 つ以上のテストへトレースされる状態を維持する。
22
- - 充足状況とギャップは、レビュー時に即時判定できる語彙で統一する。
23
- - 本ビューは必要なプロジェクトで生成する任意の管理ビューとし、独立した成果物ドメインやトラックを持たない。
18
+ - **対象**: 要求とテストの対応の可視化を扱い、要求本文・テスト手順は扱いません。テストの実行結果も扱わず、充足状況はテストの対応と作成状態で判定します。
19
+ - **正本と派生**: 対応の正本はテスト成果物の `relations.verifies` とし、本ビューは派生ビューとして生成します。「目的と適用範囲」と「トレース対象の前提」は生成の条件として書き、「トレースマトリクス」「充足状況サマリ」「ギャップと対応方針」は生成元から導出します。充足状況やギャップを直すときは生成元の成果物を直して再生成し、本ビューへ直接書きません。
20
+ - **記載レベル**: 1 行は 1 つの要求 ID とその対応テスト ID 群とします。
21
+ - **任意の管理ビュー**: 必要なプロジェクトだけが生成し、独自のドメインやトラックを持ちません。
22
+ - **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
24
23
 
25
- ## 2. 位置づけと用語定義(必要に応じて)
24
+ ## 2. 位置づけ
26
25
 
27
- | 用語 | 定義 |
28
- | ------------ | -------------------------------------------------------------------------- |
29
- | 要求ID | 要求を一意に識別する ID(例: `req-` 系) |
30
- | 対応テストID | 要求を検証するテストを一意に識別する ID(例: `utc-` / `itc-` / `atc-` 系) |
31
-
32
- | 充足状況 | 要求に対するテスト整備の達成状態(未着手 / 一部充足 / 充足) |
33
- | ギャップ | 要求とテストの間に残る不足・不整合・未確定事項 |
26
+ 本ビューは、要求(業務の受入基準 `bac-*` など)と、それを検証するテスト(受入テスト `atc-*`、総合テスト `stc-*` など)の作成後に生成し、テストのレビュー時と要求・テストの変更時に再生成します。要求→仕様の対応は [[specdojo:trc-requirements-to-specs-rulebook|トレーサビリティ(要求→仕様)作成ルール]] が扱います。
34
27
 
35
28
  ## 3. ファイル命名・ID規則
36
29
 
37
- - 対象ドキュメント ID は `<project-id>:trc-requirements-to-tests` とする(例: `prj-0001:trc-requirements-to-tests`)。
38
- - 推奨ファイル名は `trc-requirements-to-tests.md` とする。
39
- - 本 rulebook の ID は `specdojo:trc-requirements-to-tests-rulebook` とする。
40
- - 追加分割が必要な場合は `<project-id>:trc-requirements-to-tests-<term>` 形式を用いる。
30
+ - **ファイル名**: `trc-requirements-to-tests.md` とします。分割する場合は `trc-requirements-to-tests-<term>.md` とします。
31
+ - **文書 ID**: 成果物カタログの宣言と一致させます。プロダクト仕様のカタログに置く場合は `trc-requirements-to-tests`、プロジェクト固有の場合は `<project-id>:trc-requirements-to-tests` とします(分割時は末尾に `-<term>`)。
41
32
 
42
33
  ## 4. 推奨 Frontmatter 項目
43
34
 
44
- [document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
45
-
46
- | 項目 | 説明 | 必須 |
47
- | -------- | --------------------------------------------- | ---- |
48
- | id | `<project-id>:trc-requirements-to-tests` | ○ |
49
- | type | `project` | ○ |
50
- | status | `draft` / `ready` / `deprecated` | ○ |
51
- | rulebook | `specdojo:trc-requirements-to-tests-rulebook` | ○ |
35
+ 許可キーと型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
52
36
 
53
- | based_on | 生成元となる要求・テスト仕様の ID 配列 | 任意 |
54
- | supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
37
+ - `specdojo.rulebook` は `specdojo:trc-requirements-to-tests-rulebook` とします。
38
+ - `specdojo.based_on` は必須とし、生成元とした要求とテストの文書 ID をすべて記載します。索引だけを挙げて要求側を省きません。
55
39
 
56
- ## 5. 本文構成(標準テンプレ)
40
+ ## 5. 本文要件
57
41
 
58
- | 章 | 見出し | 必須 | 目的 |
59
- | --- | -------------------- | ---- | ---------------------------------------------- |
60
- | 1 | 目的と適用範囲 | ○ | トレース対象の境界と運用目的を明確化する |
61
- | 2 | トレース対象の前提 | ○ | 対象要求群・対象テスト群・除外範囲を明確化する |
62
- | 3 | トレースマトリクス | ○ | 要求IDと対応テストIDの対応関係を一覧化する |
63
- | 4 | 充足状況サマリ | ○ | 充足状況を集計し、優先対応領域を可視化する |
64
- | 5 | ギャップと対応方針 | ○ | 不足・不整合の内容と解消方針を整理する |
65
- | 6 | 変更履歴と更新ルール | 任意 | 追記・更新時の追跡可能性を担保する |
42
+ | 章 | 必須 | 内容・受入条件 |
43
+ | -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
44
+ | 目的と適用範囲 | 必須 | 対象の要求群・テスト群と対象外(理由付き)が分かること |
45
+ | トレース対象の前提 | 必須 | 要求の母集団(`based_on` の要求文書の全要求 ID)、テストの範囲、生成の手段(コマンドまたは手順)と生成日が分かること |
46
+ | トレースマトリクス | 必須 | 標準6列で母集団の全要求を並べ、テストのない要求と、母集団にない要求 ID を `relations.verifies` に持つテストが識別できること |
47
+ | 充足状況サマリ | 必須 | 充足状況ごとの要求 ID の件数(重複なし、合計が母集団の件数と一致)と、優先して解消する要求 ID が分かること |
48
+ | ギャップと対応方針 | 必須 | ギャップごとに、直す生成元の成果物と解消の判定条件が分かること |
49
+ | 変更履歴と更新ルール | 条件付き | 再生成の契機や前回からの差分を残す必要があるときに置き、生成日と差分の要点を示す |
66
50
 
67
- ## 6. 記述ガイド
68
-
69
- ### 6.1. 目的と適用範囲
51
+ ### 5.1. トレースマトリクスの標準列
70
52
 
71
- - どの要求群とどのテスト群の対応を管理するかを明記する。
72
- - 対象外(例: 廃止要求、次フェーズ対応要求)がある場合は理由付きで記載する。
53
+ | 列名 | 内容・判断条件 |
54
+ | ------------ | ----------------------------------------------------------------------------------------- |
55
+ | 要求ID | 母集団の要求 ID。母集団にない参照は `なし` とし、その参照を持つテストを対応テストIDに書く |
56
+ | 要求要約 | 要求文書の記述から要点を 1 行で示す |
57
+ | 対応テストID | その要求 ID を `relations.verifies` に持つテスト ID(複数可、なければ空とせず `なし`) |
58
+ | 充足状況 | `未着手` / `一部充足` / `充足`。判定は「充足状況の判定」に従う |
59
+ | ギャップ | 未対応点・不整合・未決事項。なければ `なし` |
60
+ | 備考 | 判定の根拠(参照先の `status`、review result など) |
73
61
 
74
- ### 6.2. トレース対象の前提
62
+ ### 5.2. 充足状況の判定
75
63
 
76
- - 要求側とテスト側の参照元(ID体系、版、作成日)を明記する。
77
- - トレース単位(1:1 / 1:N / N:1)を先に定義する。
64
+ | 充足状況 | 条件 |
65
+ | ---------- | -------------------------------------------------------------------- |
66
+ | `未着手` | その要求を `relations.verifies` に持つテストがない |
67
+ | `一部充足` | 対応テストはあるが、参照先が未作成・`draft` であるか、ギャップが残る |
68
+ | `充足` | 対応テストがすべて存在して `ready` であり、ギャップが `なし` |
78
69
 
79
- ### 6.3. トレースマトリクス
70
+ ## 6. 記述ガイド
80
71
 
81
- - 表形式で記載し、最低限次のカラムを含める。
72
+ 完成例は Frontmatter の `sample` で宣言された sample を参照してください。
82
73
 
83
- | カラム | 内容 |
84
- | -------- | ---------------------- |
85
- | 要求ID | 追跡対象の要求 ID |
86
- | 要求要約 | 要求内容の要点(1 行) |
74
+ ### 6.1. 目的と適用範囲
87
75
 
88
- | 対応テストID | 対応するテスト ID(複数可) |
76
+ - **判断基準**: 誰がどのレビュー・受入判断に使い、どのリリースや領域の要求を対象とするかが分かること。
77
+ - **良い例**: 「第 1 リリースの会計・在庫・値引き・監査の受入基準と、それを検証する受入テスト・総合テストの対応を示し、テストレビューでテスト漏れを見つける。性能試験は対象外とする。」
78
+ - **悪い例**: 「要求とテストの対応を管理する。」(対象範囲と使う場面が分からない)
89
79
 
90
- | 充足状況 | `未着手` / `一部充足` / `充足` |
91
- | ギャップ | 未対応点・不整合・要確認事項 |
92
- | 備考 | 根拠、判断日、関連チケットなど |
80
+ ### 6.2. トレース対象の前提
93
81
 
94
- ### 6.4. 充足状況サマリ
82
+ - **判断基準**: 別の人が同じ前提で再生成し、同じ表を得られること。
83
+ - **良い例**: 「要求の母集団: `bac-sales` の全受入基準。テスト: `relations.verifies` を持つ `atc-*`・`stc-*`。生成: `<生成コマンド>` で 2026-05-01 に生成。」
84
+ - **悪い例**: 「最新のテストから作成した。」(母集団と生成の手段が分からず、検証できない)
95
85
 
96
- - 充足状況は件数で集計し、未着手と一部充足を優先管理対象として明示する。
97
- - 重大ギャップ(受入判定に影響する項目)は個別 ID を記載して強調する。
86
+ ### 6.3. トレースマトリクスと充足状況サマリ
98
87
 
99
- ### 6.5. ギャップと対応方針
88
+ - **判断基準**: 各行の充足状況が「充足状況の判定」の条件から説明でき、サマリの件数が表の要求 ID 数と一致すること。
89
+ - **良い例**: 「req-r1-004 / 監査ログを 1 年保持する / なし / 未着手 / 保持期間を検証するテストがない / ―」
90
+ - **悪い例**: 「req-r1-002 / … / ほぼ対応 / ― / ―」(曖昧語で判定できず、根拠がない)
100
91
 
101
- - ギャップごとに「解消方針」「担当」「期限」「判定条件」を記載する。
102
- - 方針未確定の場合は _UNDECIDED_: ラベルで暫定状態を明示する。
92
+ ### 6.4. ギャップと対応方針
103
93
 
104
- ### 6.6. 変更履歴と更新ルール
94
+ - **判断基準**: どの生成元の成果物をどう直せば解消と判定するかが分かること。担当・期限は登録簿で追跡し、本ビューに列を設けません。
95
+ - **良い例**: 「req-r1-004 / 保持期間の受入テストがない / `atc-audit-retention` を作成し `relations.verifies` に req-r1-004 を持たせる / 再生成で `一部充足` 以上になる」
96
+ - **悪い例**: 「監査ログのテストは今後対応する。」(直す成果物も判定条件もない)
105
97
 
106
- - 要求やテストのID参照が更新された場合は、派生ビューを再生成する。
98
+ ### 6.5. 変更履歴と更新ルール
107
99
 
108
- - 充足状況やギャップをビューへ直接入力せず、生成元となる成果物または検証結果へ記録する。
100
+ - **判断基準**: 再生成の契機(要求・テストの追加、ID 参照の変更、テストの `status` 変更)と、前回から充足状況が変わった要求 ID が分かること。
109
101
 
110
102
  ## 7. 禁止事項
111
103
 
112
- - 要求本文・テスト本文の全文転記を行わない。
113
-
114
- - 要求IDまたは対応テストIDが空の行を作成しない。
115
- - 充足状況に曖昧語(例: ほぼ対応、だいたい完了)を使用しない。
116
- - ギャップを「なし」としながら対応テストIDが未記載の状態を許容しない。
117
- - 根拠リンクや判断履歴なしで充足状況を更新しない。
118
- - 生成したトレース表を手編集し、成果物の `relations.verifies` と異なる関係を持たせない。
104
+ | 禁止パターン | 理由 |
105
+ | ----------------------------------------------------------------------- | -------------------------------------------------- |
106
+ | 生成した表を手編集し、`relations.verifies` と異なる対応や充足状況を書く | 正本と派生ビューが食い違い、再生成で消えるため |
107
+ | 要求本文・テスト本文の全文転記 | 正本との二重管理になり、更新時に不整合が出るため |
108
+ | 要求 ID または対応テスト ID の空欄 | 未対応なのか記入漏れなのか判別できないため |
109
+ | 充足状況に曖昧語(ほぼ対応、だいたい完了など)を使う | 「充足状況の判定」の条件で確かめられないため |
110
+ | 対応テスト ID が `なし` の行でギャップを `なし` とする | テスト漏れが表から隠れるため |
111
+ | 「トレース対象の前提」に母集団と生成手段を書かずに表を示す | 再生成して照合できず、表が正しいか検証できないため |