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
@@ -11,105 +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 は `trc-requirements-to-specs` とする。
38
-
39
- - 推奨ファイル名は `trc-requirements-to-specs.md` とする。
40
- - 本 rulebook の ID は `specdojo:trc-requirements-to-specs-rulebook` とする。
41
- - 追加分割が必要な場合は `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>`)。
42
32
 
43
33
  ## 4. 推奨 Frontmatter 項目
44
34
 
45
- [document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
35
+ 許可キーと型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
46
36
 
47
- | 項目 | 説明 | 必須 |
48
- | ---------- | --------------------------------------------- | ---- |
49
- | id | `trc-requirements-to-specs` | ○ |
50
- | type | `project` | ○ |
51
- | status | `draft` / `ready` / `deprecated` | ○ |
52
- | rulebook | `specdojo:trc-requirements-to-specs-rulebook` | ○ |
53
- | based_on | 生成元となる要求・仕様の ID 配列 | 任意 |
54
- | supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
37
+ - `specdojo.rulebook` は `specdojo:trc-requirements-to-specs-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
+ | トレース対象の前提 | 必須 | 生成元の ID 体系と範囲、トレース単位(1:1 / 1:N / N:1)、生成の手段(コマンドまたは手順)と生成日が分かること |
46
+ | トレースマトリクス | 必須 | 標準6列で全要求を並べ、対応仕様のない要求と、どの要求にも対応しない仕様が識別できること |
47
+ | 充足状況サマリ | 必須 | 充足状況ごとの件数と、優先して解消する要求 ID が分かること |
48
+ | ギャップと対応方針 | 必須 | ギャップごとに、直す生成元の成果物と解消の判定条件が分かること |
49
+ | 変更履歴と更新ルール | 条件付き | 再生成の契機や前回からの差分を残す必要があるときに置き、生成日と差分の要点を示す |
66
50
 
67
- ## 6. 記述ガイド
51
+ ### 5.1. トレースマトリクスの標準列
68
52
 
69
- ### 6.1. 目的と適用範囲
53
+ | 列名 | 内容・判断条件 |
54
+ | ---------- | ------------------------------------------------------------------------------------- |
55
+ | 要求ID | 追跡対象の要求 ID |
56
+ | 要求要約 | 要求の要点を 1 行で示す |
57
+ | 対応仕様ID | その要求 ID を `relations.satisfies` に持つ仕様 ID(複数可、なければ空とせず `なし`) |
58
+ | 充足状況 | `未着手` / `一部充足` / `充足`。判定は「充足状況の判定」に従う |
59
+ | ギャップ | 未対応点・不整合・未決事項。なければ `なし` |
60
+ | 備考 | 判定の根拠(参照先の `status`、review result など) |
70
61
 
71
- - どの要求群とどの仕様群の対応を管理するかを明記する。
72
- - 対象外(例: 廃止要求、移管済み要求)がある場合は理由付きで記載する。
62
+ どの要求にも対応しない仕様は、同じ表の末尾に要求ID を `なし` として並べるか、別の表で示します。
73
63
 
74
- ### 6.2. トレース対象の前提
64
+ ### 5.2. 充足状況の判定
65
+
66
+ | 充足状況 | 条件 |
67
+ | ---------- | ------------------------------------------------------------------ |
68
+ | `未着手` | その要求を `relations.satisfies` に持つ仕様がない |
69
+ | `一部充足` | 対応仕様はあるが、参照先が未作成・`draft` であるか、ギャップが残る |
70
+ | `充足` | 対応仕様がすべて存在して `ready` であり、ギャップが `なし` |
75
71
 
76
- - 要求側と仕様側の参照元(ID体系、版、作成日)を明記する。
77
- - トレース単位(1:1 / 1:N / N:1)を先に定義する。
72
+ ## 6. 記述ガイド
73
+
74
+ 完成例は Frontmatter の `sample` で宣言された sample を参照してください。
75
+
76
+ ### 6.1. 目的と適用範囲
78
77
 
79
- ### 6.3. トレースマトリクス
78
+ - **判断基準**: 誰がどのレビュー・変更判断に使い、どのリリースや領域の要求を対象とするかが分かること。
79
+ - **良い例**: 「第 1 リリースの会計・在庫・値引き・監査の要求と、それを充足する仕様の対応を示し、仕様レビューで要求漏れを見つける。次期リリースの要求は対象外とする。」
80
+ - **悪い例**: 「要求と仕様の対応を管理する。」(対象範囲と使う場面が分からない)
80
81
 
81
- - 表形式で記載し、最低限次のカラムを含める。
82
+ ### 6.2. トレース対象の前提
82
83
 
83
- | カラム | 内容 |
84
- | ---------- | ------------------------------ |
85
- | 要求ID | 追跡対象の要求 ID |
86
- | 要求要約 | 要求内容の要点(1 行) |
87
- | 対応仕様ID | 対応する仕様 ID(複数可) |
88
- | 充足状況 | `未着手` / `一部充足` / `充足` |
89
- | ギャップ | 未対応点・不整合・要確認事項 |
90
- | 備考 | 根拠、判断日、関連チケットなど |
84
+ - **判断基準**: 別の人が同じ前提で再生成し、同じ表を得られること。
85
+ - **良い例**: 「生成元: `bac-*` と、`relations.satisfies` を持つ `sf-*`・`bes-*`。生成: `<生成コマンド>` で 2026-05-01 に生成。」
86
+ - **悪い例**: 「最新の仕様から作成した。」(生成元の範囲と手段が分からず、検証できない)
91
87
 
92
- ### 6.4. 充足状況サマリ
88
+ ### 6.3. トレースマトリクスと充足状況サマリ
93
89
 
94
- - 充足状況は件数で集計し、未着手と一部充足を優先管理対象として明示する。
95
- - 重大ギャップ(業務影響が大きい項目)は個別 ID を記載して強調する。
90
+ - **判断基準**: 各行の充足状況が「充足状況の判定」の条件から説明でき、サマリの件数が表と一致すること。
91
+ - **良い例**: 「req-r1-002 / 在庫引当をリアルタイムで更新する / bes-stock-allocation, ifx-msg-stock / 一部充足 / 障害時の再送仕様が未確定 / `ifx-msg-stock` が `draft`」
92
+ - **悪い例**: 「req-r1-002 / … / ほぼ対応 / ― / ―」(曖昧語で判定できず、根拠がない)
96
93
 
97
- ### 6.5. ギャップと対応方針
94
+ ### 6.4. ギャップと対応方針
98
95
 
99
- - ギャップごとに「解消方針」「担当」「期限」「判定条件」を記載する。
100
- - 方針未確定の場合は _UNDECIDED_: ラベルで暫定状態を明示する。
96
+ - **判断基準**: 解消は本ビューでなく生成元の成果物で行うこととし、どの成果物をどう直せば解消と判定するかが分かること。担当・期限は登録簿で追跡し、本ビューに列を設けません。
97
+ - **良い例**: 「req-r1-004 / 監査ログの保持先が未決定 / `bes-audit-log` に保持方針を追記し `relations.satisfies` に req-r1-004 を持たせる / 再生成で `充足` になる」
98
+ - **悪い例**: 「監査ログは今後対応する。」(直す成果物も判定条件もない)
101
99
 
102
- ### 6.6. 変更履歴と更新ルール
100
+ ### 6.5. 変更履歴と更新ルール
103
101
 
104
- - 要求や仕様のID参照が更新された場合は、派生ビューを再生成する。
105
- - 充足状況やギャップをビューへ直接入力せず、生成元となる成果物または検証結果へ記録する。
102
+ - **判断基準**: 再生成の契機(要求・仕様の追加、ID 参照の変更、仕様の `status` 変更)と、前回から充足状況が変わった要求 ID が分かること。
106
103
 
107
104
  ## 7. 禁止事項
108
105
 
109
- - 要求本文・仕様本文の全文転記を行わない。
110
-
111
- - 要求IDまたは対応仕様IDが空の行を作成しない。
112
- - 充足状況に曖昧語(例: ほぼ対応、だいたい完了)を使用しない。
113
- - ギャップを「なし」としながら対応仕様IDが未記載の状態を許容しない。
114
- - 根拠リンクや判断履歴なしで充足状況を更新しない。
115
- - 生成したトレース表を手編集し、成果物の `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 は `trc-requirements-to-tests` とする。
38
- - 推奨ファイル名は `trc-requirements-to-tests.md` とする。
39
- - 本 rulebook の ID は `specdojo:trc-requirements-to-tests-rulebook` とする。
40
- - 追加分割が必要な場合は `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 | `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
+ | 「トレース対象の前提」に母集団と生成手段を書かずに表を示す | 再生成して照合できず、表が正しいか検証できないため |
@@ -13,51 +13,41 @@ specdojo:
13
13
 
14
14
  Technology Stack Index (TSD Index) Documentation Rules
15
15
 
16
- `tsd-index.md` は、対象システムや開発基盤で採用する技術と担当責務を一覧にし、詳細な構成・設定の正本へ導く入口文書である。技術の用途と適用範囲を俯瞰し、構築、実装、運用、変更時に参照すべき定義を判断できる内容を記載する。
16
+ `tsd-index.md` は、採用技術と担当責務を俯瞰し、構築・実装・運用・変更時に詳細な構成や設定の正本へ導く入口文書である。
17
17
 
18
18
  ## 1. 全体方針
19
19
 
20
- - 一つのシステムまたは合意した対象範囲につき、技術一覧の正本を一つにする。複数システムを扱う場合は、一覧の対象範囲を明示する。
21
- - 採用技術の名称、区分、担当責務を一覧で対応させる。実行基盤だけでなく、対象範囲に含まれる開発、検証、文書化、配布、運用の技術も扱う。
22
- - すべての依存パッケージを列挙するのではなく、構成や作業の前提として関係者が把握すべき技術を選ぶ。
23
- - 採用済みの必須構成と任意利用の構成を区別する。未決の候補は採用技術に混ぜず、判断の記録へ導く。
24
- - 詳細な設定、構築手順、接続方法、資源制約は `tsd-<term>` または設定ファイルなどの正本へ委ねる。
25
- - 版の粒度と参照元を明確にし、lockfile や詳細 TSD と異なる固定値を二重管理しない。
20
+ - 合意した対象範囲につき一覧の正本を一つにする。複数システムの場合も範囲を明示する。
21
+ - 全依存パッケージではなく、構成や作業の前提として把握すべき技術を選ぶ。網羅範囲は「区分と網羅範囲」に従う。
22
+ - 詳細な設定・手順・資源制約は「位置づけ」の正本に委ね、版や採用状態は「版と採用状態」に従う。
23
+ - **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
26
24
 
27
25
  ## 2. 位置づけ
28
26
 
29
- | 文書・情報 | 役割 | 一覧からの導線 |
30
- | ------------------------ | ------------------------------------ | ------------------------------------------ |
31
- | `tsd-index` | 採用技術と担当責務の全体一覧 | 対象範囲の技術を俯瞰する入口とする |
32
- | `tsd-<term>` | 技術領域や実行基盤の詳細定義 | 構成、前提、設定、導入、動作確認を参照する |
33
- | 接続設定・日常利用の TSD | 基盤を利用するクライアント設定や操作 | 初期構築と利用時の手順を区別して導く |
34
- | 設定ファイル・依存定義 | 実際に適用する版や設定の正本 | 正確な版や有効設定が必要な場合に参照する |
35
- | 採用判断の記録 | 技術を選んだ理由と未決事項 | 一覧で説明しきれない判断の根拠へ導く |
27
+ | 文書・情報 | 役割 | 一覧からの導線 |
28
+ | ------------------------ | ------------------------ | -------------------------------- |
29
+ | `tsd-index` | 採用技術と担当責務の一覧 | 対象範囲を俯瞰する入口 |
30
+ | `tsd-<term>` | 技術領域・実行基盤の詳細 | 構成・前提・設定・導入・動作確認 |
31
+ | 接続設定・日常利用の TSD | クライアント設定や操作 | 初期構築と利用手順を区別する |
32
+ | 設定ファイル・依存定義 | 適用する版・設定の正本 | 正確な版・有効設定 |
33
+ | 採用判断の記録 | 選定理由と未決事項 | 一覧で説明しきれない判断の根拠 |
36
34
 
37
- - 詳細 TSD が未作成でも、採用が確認できた技術と担当責務は一覧に記載してよい。未整備の詳細文書を存在するように参照しない。
38
- - 一つの技術に基盤設定と接続設定など複数の詳細文書がある場合は、参照先ごとの役割を示す。
39
- - 同じ技術を複数の用途で使う場合は、責務を一行にまとめるか、適用範囲を明示して行を分ける。説明のない重複は作らない。
35
+ - 詳細 TSD が未作成でも、採用を確認できた技術と責務は記載できる。
36
+ - 同じ技術の複数用途は責務を一行にまとめるか、適用範囲で行を分ける。
40
37
 
41
38
  ## 3. ファイル命名・ID規則
42
39
 
43
40
  - ファイル名は `tsd-index.md` とする。
44
- - `id` は `tsd-index` を基準に、名前空間と対象範囲内の一意性を共通のメタデータ規約に従って定める。
45
- - 配置先はプロジェクトのアーキテクチャまたは技術基盤の文書群とし、詳細な `tsd-<term>.md` も同じ文書群にまとめる。
46
- - 環境や領域ごとの補足を分冊する場合も、全体一覧の正本を複製せず、本書から参照する。
41
+ - `id` は `tsd-index` を基準とし、名前空間と一意性は共通のメタデータ規約に従う。
42
+ - アーキテクチャまたは技術基盤の文書群に詳細な `tsd-<term>.md` とまとめる。環境・領域別の補足は一覧を複製せず参照する。
47
43
 
48
44
  ## 4. 推奨 Frontmatter 項目
49
45
 
50
- 項目は `specdojo` 配下に置く。共通の型と参照形式は [document-metadata-standard.md](../standards/document-metadata-standard.md) と成果物の Frontmatter スキーマに従う。
46
+ 共通項目・必須性・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と成果物の Frontmatter スキーマに従う。
51
47
 
52
- | 項目 | 必須 | 値・記述内容 |
53
- | ------------ | -------- | -------------------------------------------------- |
54
- | `id` | ○ | 対象範囲で一意な `tsd-index` 系の ID |
55
- | `type` | ○ | `architecture` |
56
- | `status` | ○ | `draft` / `ready` / `deprecated` |
57
- | `rulebook` | 推奨 | `specdojo:tsd-index-rulebook` |
58
- | `part_of` | 任意 | 所属するアーキテクチャ文書などの ID 配列 |
59
- | `based_on` | 条件付き | 技術構成の直接の根拠となる設計や採用判断の ID 配列 |
60
- | `supersedes` | 条件付き | 既存の技術一覧を置き換える場合の旧文書 ID 配列 |
48
+ - `type` は `architecture`、`rulebook` は `specdojo:tsd-index-rulebook` とする。
49
+ - `part_of` は任意で、所属するアーキテクチャ文書の ID 配列を記す。
50
+ - `based_on` は直接の根拠となる設計・採用判断、`supersedes` は置き換える旧一覧がある場合に ID 配列で記す。
61
51
 
62
52
  ## 5. 本文要件
63
53
 
@@ -67,9 +57,9 @@ Technology Stack Index (TSD Index) Documentation Rules
67
57
  | 技術スタック一覧 | ○ | 区分、採用技術、担当責務を一つの主一覧表で対応させる |
68
58
  | 補足・詳細への導線 | 条件付き | 詳細 TSD や設定の正本がある場合、各参照先の役割と適用条件を示す |
69
59
 
70
- - 実行時に使う技術と、開発・検証・運用に使う技術の範囲が分かるようにする。対象外の領域まで空欄や仮の技術で埋めない。
71
- - 版、利用環境、必須・任意が判断に必要な場合は、一覧の列または補足に記載する。
72
- - 補足では全体の共通条件と参照先を示し、設定値や手順の詳細を転載しない。
60
+ - 対象外の領域を空欄や仮の技術で埋めない。
61
+ - 版・利用環境・必須と任意の違いは、判断に必要な場合に列または補足で示す。
62
+ - 補足には全体の共通条件と参照先を記す。
73
63
 
74
64
  ## 6. 記述ガイド
75
65
 
@@ -84,28 +74,28 @@ Technology Stack Index (TSD Index) Documentation Rules
84
74
  | 適用範囲 | 条件付き | 対象環境、実行場所、必須・任意など、利用条件の違い |
85
75
  | 詳細・備考 | 任意 | 詳細 TSD への参照、短い制約や選定理由 |
86
76
 
87
- - 担当責務は「開発用」「利用する」だけで終えず、対象と役割を一文で示す。
88
- - 複数の製品を一つの実行基盤としてまとめる場合は、構成の内訳と各役割を詳細 TSD へ導く。
77
+ - 担当責務は対象と役割を一文で示す。「開発用」「利用する」だけにしない。
78
+ - 複数製品を実行基盤としてまとめる場合は、内訳と各役割を詳細 TSD へ導く。
89
79
  - 版を採用技術名に含める場合は、別の版列で同じ情報を繰り返さない。
90
80
 
91
81
  ### 6.2. 区分と網羅範囲
92
82
 
93
- - 言語・ランタイム・フレームワーク、データ保存・連携、ホスティング・ネットワークなど、対象の実行に必要な技術を確認する。
94
- - build・テスト・静的検査・文書化・図解・ソース管理・CI/CD・パッケージ配布・運用監視など、対象の開発と保守を支える技術も確認する。
95
- - AI 実行環境やローカルモデル基盤など固有の領域は、実際に採用した範囲で追加する。区分名や製品名の例を、すべてのプロジェクトの必須構成にしない。
83
+ - 実行時の技術: 言語・ランタイム・フレームワーク、データ保存・連携、ホスティング・ネットワーク。
84
+ - 開発・保守の技術: build・テスト・静的検査・文書化・図解・ソース管理・CI/CD・配布・運用監視。
85
+ - AI 実行環境やローカルモデル基盤など固有の領域は採用範囲で追加する。例示を一律の必須構成にしない。
96
86
 
97
87
  ### 6.3. 版と採用状態
98
88
 
99
- - 一覧ではメジャーバージョンや互換性の制約など、構成を理解するために必要な粒度を使う。特定の版が採用判断に不可欠な場合は、その理由と正本を示す。
100
- - 正確なパッチ版や依存解決結果を lockfile などで管理する場合は、その参照先を示す。確認していない版を推測で記入しない。
101
- - 任意利用の技術は、採用済みの選択肢であることと適用条件を明示する。未採択の比較候補や将来案は、採用一覧の外で扱う。
102
- - 「最新版」と記載する場合は、取得元と更新方針を示す。実際に使用した版の確認方法が分からない表現にしない。
89
+ - メジャー版や互換性制約など必要な粒度を使い、特定版が採用判断に不可欠なら理由と正本を示す。
90
+ - パッチ版や依存解決結果は lockfile 等の参照先を示し、未確認の版を推測しない。
91
+ - 必須・任意を区別し、任意技術には採用済みであることと適用条件を示す。未採択の候補・将来案は判断の記録へ導く。
92
+ - 「最新版」は取得元・更新方針・使用版の確認方法を示す。
103
93
 
104
94
  ### 6.4. 詳細文書と更新
105
95
 
106
- - 技術の初期構築、クライアント接続、日常利用を分冊している場合は、それぞれの目的が分かる参照名にする。
107
- - 採用・廃止・責務・適用範囲が変わったときに一覧を更新し、詳細 TSD や設定の正本との不一致を確認する。
108
- - 未作成の詳細や未決の条件は共通ラベルで示し、仮の参照先や設定値を確定情報として残さない。
96
+ - 初期構築・クライアント接続・日常利用を分冊する場合は、各参照名で目的を示す。
97
+ - 技術の採用・廃止・責務・適用範囲の変更時は一覧と詳細 TSD・設定の正本を照合し、不一致を解消する。
98
+ - 未作成の詳細や未決条件は共通ラベルで示し、仮の参照先や設定値を確定情報にしない。
109
99
 
110
100
  ## 7. 禁止事項
111
101
 
@@ -116,5 +106,4 @@ Technology Stack Index (TSD Index) Documentation Rules
116
106
  | 同じ技術や一覧を、適用範囲を示さず重複させる | 責務と更新先が分からなくなるため |
117
107
  | 全依存パッケージやすべての版固定値を転載する | 一覧の目的を超え、依存定義と二重管理になるため |
118
108
  | 詳細設定、接続先、構築コマンド、コードを一覧の本文へ展開する | 詳細 TSD や設定の正本との責務が重なるため |
119
- | API キー、トークン、秘密鍵、機密の接続情報を記載する | 一覧の配布や履歴を通じて漏れるため |
120
109
  | 任意利用の製品や実例の構成を一律の必須技術にする | 対象範囲や環境による違いを失うため |