specdojo 0.7.0 → 0.8.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 (337) hide show
  1. package/.github/agents/specdojo-orchestrator.md +3 -2
  2. package/CHANGELOG.md +153 -0
  3. package/dist/catalog/build.js +24 -1
  4. package/dist/catalog/plan.js +1 -1
  5. package/dist/catalog/scaffold.js +4 -1
  6. package/dist/commands/init.js +5 -1
  7. package/dist/commands/night-orchestrator.js +6 -4
  8. package/dist/dashboard/dashboard-timeline.js +18 -16
  9. package/dist/dashboard/dashboard.js +612 -259
  10. package/dist/dashboard/epic-plan.js +81 -0
  11. package/dist/dashboard/exec-records.js +16 -20
  12. package/dist/dashboard/routines.js +8 -6
  13. package/dist/dashboard/timeline-build.js +5 -9
  14. package/dist/dashboard/timeline.js +9 -4
  15. package/dist/devcontainer/scaffold.js +18 -0
  16. package/dist/docs/frontmatter-namespace.js +1 -48
  17. package/dist/docs/yaml-pages.js +125 -3
  18. package/dist/exec/agent-config.js +22 -0
  19. package/dist/exec/agent-plan.js +3 -2
  20. package/dist/exec/commands.js +69 -21
  21. package/dist/exec/commit-hook-skips.js +78 -0
  22. package/dist/exec/core.js +19 -7
  23. package/dist/exec/events.js +159 -8
  24. package/dist/exec/evidence.js +64 -16
  25. package/dist/exec/handoff.js +9 -13
  26. package/dist/exec/limit.js +1 -1
  27. package/dist/exec/mechanical-result.js +45 -0
  28. package/dist/exec/migrate-records.js +249 -0
  29. package/dist/exec/parent-validation.js +153 -12
  30. package/dist/exec/pipeline-state.js +27 -5
  31. package/dist/exec/plans-condense-findings.js +89 -0
  32. package/dist/exec/plans-core.js +24 -17
  33. package/dist/exec/plans-generation.js +48 -25
  34. package/dist/exec/plans-grade-findings.js +8 -3
  35. package/dist/exec/plans-kata-findings.js +61 -0
  36. package/dist/exec/plans-planning.js +3 -3
  37. package/dist/exec/plans-storage.js +12 -24
  38. package/dist/exec/register-resume.js +55 -56
  39. package/dist/exec/register.js +26 -22
  40. package/dist/exec/repo-integration-sync.js +8 -4
  41. package/dist/exec/repo-integration.js +21 -1
  42. package/dist/exec/reporter.js +121 -23
  43. package/dist/exec/results.js +85 -24
  44. package/dist/exec/review-completion.js +47 -0
  45. package/dist/exec/review-kata.js +109 -0
  46. package/dist/exec/run/agent-pipeline.js +75 -6
  47. package/dist/exec/run/agent.js +20 -7
  48. package/dist/exec/run/in-place.js +69 -32
  49. package/dist/exec/run/job.js +81 -24
  50. package/dist/exec/run/lifecycle-commands.js +188 -36
  51. package/dist/exec/run/mode-shared.js +11 -3
  52. package/dist/exec/run/register-command.js +6 -10
  53. package/dist/exec/run/register-core.js +20 -13
  54. package/dist/exec/run/register-mode.js +12 -12
  55. package/dist/exec/run/register-post-review.js +21 -9
  56. package/dist/exec/run/register-resume.js +28 -18
  57. package/dist/exec/run/register-state.js +10 -7
  58. package/dist/exec/run/register-worktree.js +60 -30
  59. package/dist/exec/run/schedule-mode.js +4 -4
  60. package/dist/exec/run/schedule-prepare.js +201 -59
  61. package/dist/exec/run/schedule-task.js +129 -25
  62. package/dist/exec/run/shared.js +4 -3
  63. package/dist/exec/run/trailing-records.js +35 -0
  64. package/dist/exec/run-records.js +2 -0
  65. package/dist/exec/strategy.js +1 -0
  66. package/dist/exec/trailing-records.js +242 -0
  67. package/dist/exec/trial-commands.js +3 -2
  68. package/dist/exec/validate-records-commit.js +110 -0
  69. package/dist/exec/validate-records.js +148 -0
  70. package/dist/exec/worktree-command.js +29 -16
  71. package/dist/exec/worktree-ops-commit.js +119 -48
  72. package/dist/exec/worktree-ops-lifecycle.js +77 -48
  73. package/dist/exec/worktree-ops-merge.js +13 -2
  74. package/dist/exec/worktree-ops.js +2 -2
  75. package/dist/exec/worktree.js +19 -2
  76. package/dist/grade/apply.js +32 -6
  77. package/dist/grade/command-inspect.js +2 -2
  78. package/dist/grade/command-run.js +2 -0
  79. package/dist/grade/command-shared.js +1 -1
  80. package/dist/grade/core.js +18 -5
  81. package/dist/grade/markdown.js +3 -3
  82. package/dist/grade/pipeline-state.js +15 -11
  83. package/dist/grade/plan.js +37 -17
  84. package/dist/grade/result.js +3 -3
  85. package/dist/grade/run.js +23 -3
  86. package/dist/grade/target-discovery.js +17 -4
  87. package/dist/grade/targets.js +12 -11
  88. package/dist/job/job.js +31 -17
  89. package/dist/job/noop.js +104 -0
  90. package/dist/register/core.js +2 -0
  91. package/dist/register/create-commands.js +28 -3
  92. package/dist/register/deliverable-target.js +9 -1
  93. package/dist/register/epic.js +104 -26
  94. package/dist/register/event-merge.js +3 -0
  95. package/dist/register/events.js +4 -0
  96. package/dist/register/external-project.js +3 -0
  97. package/dist/register/item.js +6 -0
  98. package/dist/register/maintenance-commands.js +4 -1
  99. package/dist/register/planning.js +7 -14
  100. package/dist/register/register.js +43 -9
  101. package/dist/register/track-domains.js +34 -0
  102. package/dist/register/track-plan.js +78 -0
  103. package/dist/register/transition-commands.js +8 -0
  104. package/dist/register/work-table.js +64 -0
  105. package/dist/review/grade.js +35 -13
  106. package/dist/routine/definition.js +4 -3
  107. package/dist/routine/failure.js +30 -0
  108. package/dist/routine/routine.js +56 -32
  109. package/dist/routine/storage.js +33 -0
  110. package/dist/schedule/schedule.js +1 -0
  111. package/dist/schedule/strategy-generate-document.js +26 -14
  112. package/dist/schedule/strategy-generate-scope.js +17 -45
  113. package/dist/schedule/strategy-generate.js +33 -3
  114. package/dist/schedule/strategy-profiles.js +86 -12
  115. package/dist/shared/agent-types.js +2 -0
  116. package/dist/shared/condense-records.js +25 -0
  117. package/dist/shared/deprecation.js +8 -0
  118. package/dist/shared/document-metadata.js +20 -0
  119. package/dist/shared/finding-cause.js +20 -0
  120. package/dist/shared/frontmatter-namespace.js +48 -0
  121. package/dist/shared/git.js +142 -15
  122. package/dist/shared/grade-result.js +17 -1
  123. package/dist/shared/local-state.js +20 -0
  124. package/dist/shared/markdownlint-config.js +8 -3
  125. package/dist/shared/plan-conventions.js +129 -0
  126. package/dist/shared/plan-templates.js +57 -41
  127. package/dist/shared/run-records.js +224 -0
  128. package/dist/shared/specdojo-config.js +39 -21
  129. package/dist/shared/text.js +65 -5
  130. package/dist/shared/timeline-index.js +2 -0
  131. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -2
  132. package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
  133. package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
  134. package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
  135. package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
  136. package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
  137. package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
  138. package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
  139. package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
  140. package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
  141. package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
  142. package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
  143. package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
  144. package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
  145. package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
  146. package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
  147. package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
  148. package/docs/ja/specdojo/guides/exec-config-guide.md +47 -16
  149. package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
  150. package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
  151. package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
  152. package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
  153. package/docs/ja/specdojo/guides/quick-start-guide.md +70 -14
  154. package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
  155. package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
  156. package/docs/ja/specdojo/guides/review-guide.md +22 -19
  157. package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
  158. package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
  159. package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
  160. package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
  161. package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
  162. package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
  163. package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
  164. package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
  165. package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
  166. package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
  167. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +36 -24
  168. package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
  169. package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
  170. package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
  171. package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
  172. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
  173. package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
  174. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
  175. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
  176. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
  177. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
  178. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
  179. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
  180. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
  181. package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
  182. package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
  183. package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
  184. package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
  185. package/docs/ja/specdojo/references/command-reference.md +79 -64
  186. package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
  187. package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
  188. package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
  189. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
  190. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
  191. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
  192. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
  193. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
  194. package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
  195. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
  196. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +56 -35
  197. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
  198. package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
  199. package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
  200. package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
  201. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
  202. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
  203. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
  204. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
  205. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
  206. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
  207. package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
  208. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
  209. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
  210. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
  211. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
  212. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
  213. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
  214. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
  215. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
  216. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
  217. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
  218. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
  219. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
  220. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
  221. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
  222. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
  223. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
  224. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
  225. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
  226. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
  227. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
  228. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
  229. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
  230. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
  231. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
  232. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
  233. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
  234. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
  235. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
  236. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
  237. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
  238. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
  239. package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
  240. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
  241. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
  242. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
  243. package/docs/ja/specdojo/samples/bac-sample.md +106 -21
  244. package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
  245. package/docs/ja/specdojo/samples/bds-sample.md +100 -21
  246. package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
  247. package/docs/ja/specdojo/samples/bes-sample.md +80 -21
  248. package/docs/ja/specdojo/samples/br-sample.md +68 -14
  249. package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
  250. package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
  251. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
  252. package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
  253. package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
  254. package/docs/ja/specdojo/samples/cld-sample.md +3 -30
  255. package/docs/ja/specdojo/samples/clis-sample.md +132 -0
  256. package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
  257. package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
  258. package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
  259. package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
  260. package/docs/ja/specdojo/samples/dss-sample.md +175 -0
  261. package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
  262. package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
  263. package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
  264. package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
  265. package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
  266. package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
  267. package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
  268. package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
  269. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
  270. package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
  271. package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
  272. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
  273. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
  274. package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
  275. package/docs/ja/specdojo/samples/sf-sample.md +121 -21
  276. package/docs/ja/specdojo/samples/sld-sample.md +107 -21
  277. package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
  278. package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
  279. package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
  280. package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
  281. package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
  282. package/docs/ja/specdojo/samples/uis-sample.md +164 -20
  283. package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
  284. package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
  285. package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
  286. package/docs/ja/specdojo/templates/bac-template.md +76 -0
  287. package/docs/ja/specdojo/templates/bes-template.md +56 -0
  288. package/docs/ja/specdojo/templates/br-template.md +64 -0
  289. package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
  290. package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
  291. package/docs/ja/specdojo/templates/cnd-template.md +137 -0
  292. package/docs/ja/specdojo/templates/cpd-template.md +129 -0
  293. package/docs/ja/specdojo/templates/cxd-template.md +105 -0
  294. package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
  295. package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
  296. package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
  297. package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
  298. package/docs/ja/specdojo/templates/ifd-template.md +86 -0
  299. package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
  300. package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
  301. package/docs/ja/specdojo/templates/opr-template.md +2 -4
  302. package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
  303. package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
  304. package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
  305. package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
  306. package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
  307. package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
  308. package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
  309. package/docs/ja/specdojo/templates/stsd-template.md +46 -21
  310. package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
  311. package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
  312. package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
  313. package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
  314. package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
  315. package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
  316. package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
  317. package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
  318. package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
  319. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
  320. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +53 -3
  321. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
  322. package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
  323. package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
  324. package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
  325. package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
  326. package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
  327. package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
  328. package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
  329. package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
  330. package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
  331. package/package.json +2 -2
  332. package/templates/antigravity/orchestrator.md +3 -2
  333. package/templates/claude/agents/specdojo-orchestrator.md +3 -2
  334. package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
  335. package/templates/codex/orchestrator.md +3 -2
  336. package/templates/devcontainer/tmux.conf +6 -0
  337. package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
@@ -17,27 +17,14 @@ specdojo:
17
17
 
18
18
  Comparison of Alternatives Documentation Rulebook
19
19
 
20
- 本ドキュメントは、複数の実行案を比較し、採択理由を説明可能な形で残すためのルールです。
21
- 意思決定の再現性と説明責任を担保します。
20
+ 複数の実行案を同じ条件で比較し、採否の根拠と見直し条件を残すためのルールです。`PM` が後続作業・依存・リスクを計画へ接続し、人間の `PO` が判断できる記載水準を定めます。
22
21
 
23
22
  ## 1. 全体方針
24
23
 
25
- - 本ルールの対象は、代替案比較(比較対象、評価軸、採択理由)です。
26
- - 目的は、選択肢の比較過程を可視化し、採択判断を再現可能にすることです。
27
- - 最低 2 案以上を比較し、採択しない案の理由も記載します。
28
- - 比較対象は、同じ課題を解決できる一式の案として構成し、業務方式、製品、開発方式など抽象度が異なる候補を同じ表で混在させません。
29
- - 前段文書からは課題、制約、必要能力、評価条件を引き継ぎ、候補集合は外部調査を含めて独立に構成します。
30
- - 候補名を先に決めず、比較レイヤーごとに候補カテゴリ、選定基準、具体候補の順で絞ります。
31
- - 比較レイヤーは対象プロジェクトの課題から定めます。業務運用、解決方式、購入 / 構築、製品、アーキテクチャ、運営・開発戦略など、必要な判断だけを扱います。
32
- - プロジェクトの業務課題や利用者課題を解く案の比較を優先し、開発戦略や作業管理は、それ自体が明示的な決定対象である場合だけ扱います。
33
- - 抽象度が異なる判断を一つの文書で扱う場合は、決定 ID を分けて順序を明示します。
34
- - 標準・方法論と製品・ツールを区別し、製品を標準または唯一の代表とみなす場合は客観的根拠を示します。
35
- - 外部ツールを扱う場合は、正本、導入時期、試行条件、移行・撤退可能性を比較します。
36
- - PMBOK 観点では、意思決定記録、リスク比較、制約下でのトレードオフ評価を含めます。
37
- - 評価軸は固定し、案ごとに評価基準を変えません。
38
- - 採択案の最終判断は人間の `PO` が行うことを明記する。AI Agent は比較分析の支援を担ってよい。
39
- - 技術的・方針的な代替案では、実現可能性、外部依存、後続成果物への影響を比較結果に含めます。
40
- - 公開リポジトリに配置する場合は、個人名、個人連絡先、非公開の組織情報を記載しない。
24
+ - 対象は、技術的・方針的な代替案の比較です。業務・利用者の課題から必要な意思決定を定め、比較過程を後から検証できるようにします。
25
+ - 比較レイヤーごとに、同じ課題を解決できる一式の案を最低 2 案比較します。前段文書から課題・制約・必要能力・評価条件を引き継ぎ、候補集合は外部調査も含めて構成します。
26
+ - 評価基準、採否の根拠、リスク、再評価条件を判断に必要な粒度で残します。詳細設計や製品仕様の転載は避け、正本を参照します。
27
+ - 最終判断は人間の `PO` が行います。AI Agent は調査・比較分析・検証を支援します。
41
28
 
42
29
  ## 2. 位置づけと用語定義
43
30
 
@@ -66,155 +53,94 @@ flowchart LR
66
53
  | 代替案 | 同一の意思決定を代替でき、単独でも目的達成への道筋を説明できる一式の候補案 |
67
54
  | 比較レイヤー | 業務運用、解決方式、購入 / 構築、製品、開発方式など、同じ抽象度で比較する判断の単位 |
68
55
  | 候補カテゴリ | 同種の責務・統合範囲を持つ方式をまとめ、具体候補を探索する単位 |
69
- | 支援方式 | 採択した案を実行するための製品、ツール、台帳、タスク・状態管理など |
70
56
  | 正本 | 現在の状態または判断根拠について、最終的に正しいものとして参照する情報源 |
71
57
  | 比較試行 | 正式採用前に、入力、評価軸、完了条件を固定して適合性と可逆性を確認する活動 |
72
- | 評価軸 | 比較に使用する観点(効果、コスト、期間、リスク等) |
73
- | 評価基準 | 評価軸ごとの判定ルールや配点規則 |
74
- | 採択案 | 評価結果に基づいて選択した案 |
75
58
  | トレードオフ | 採択に伴って受容する不利条件 |
76
59
 
77
60
  ## 3. ファイル命名・ID規則
78
61
 
79
- ### 3.1. 配置(推奨)
80
-
81
- - `docs/ja/projects/<project-id>/020-project-definition/` 配下への配置を推奨します。
82
- - 評価根拠となる見積、リスク分析、検証結果を参照リンクで接続します。
83
-
84
- ### 3.2. ドキュメントID(推奨)
85
-
86
- - 推奨: `<project-id>:prj-comparison-of-alternatives`
87
- - 例: `prj-0001:prj-comparison-of-alternatives`
88
-
89
- ### 3.3. ファイル名(推奨)
90
-
91
- - 推奨: `prj-comparison-of-alternatives.md`
92
- - 日本語ファイル名の場合: `代替案比較.md`
62
+ - 共通の配置・命名は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
63
+ - 配置は `docs/ja/projects/<project-id>/020-project-definition/`、ファイル名は `prj-comparison-of-alternatives.md` を推奨します。日本語名を採用する場合は `代替案比較.md` とし、プロジェクト内で統一します。
64
+ - ID は `<project-id>:prj-comparison-of-alternatives` を推奨します。例: `prj-0001:prj-comparison-of-alternatives`。
93
65
 
94
66
  ## 4. 推奨 Frontmatter 項目
95
67
 
96
- ### 4.1. 設定内容
68
+ - 共通項目とライフサイクルは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]]、値・構文・必須性は [成果物 Frontmatter スキーマ](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) を正本とします。
69
+ - `type` は本書の `deliverable_type` に合わせ、`rulebook` には本書の ID を指定します。
70
+ - `based_on` には、スコープ、課題と解決アプローチ、前提・制約など、比較判断に直接使った文書だけを指定します。本文では判断箇所から見積・リスク分析・検証結果へ参照を接続します。
97
71
 
98
- - 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
99
- - メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
72
+ ## 5. 本文要件
100
73
 
101
- | 項目 | 説明 | 必須 |
102
- | ---------- | ----------------------------------------------------------------------------- | ---- |
103
- | id | `<project-id>:prj-comparison-of-alternatives` | ○ |
104
- | type | `project` 固定 | ○ |
105
- | status | `draft` / `ready` / `deprecated` | ○ |
106
- | rulebook | `specdojo:prj-comparison-of-alternatives-rulebook` | ○ |
107
- | based_on | 比較判断に直接使用するスコープ、課題と解決アプローチ、前提・制約などの文書 ID | 任意 |
108
- | supersedes | 置き換え対象の旧文書 ID | 任意 |
74
+ 見出し順・表・記入欄の骨組みは Frontmatter で宣言した template を正本とし、本書では内容の充足条件を定めます。
109
75
 
110
- ### 4.2. 推奨ルール
111
-
112
- - `based_on` は、比較判断に直接使う根拠文書だけを列挙します。
113
- - 評価軸は固定し、案ごとに評価基準を変えません。
114
- - 配点や重みを使う場合は、判定への使い方を明示します。
115
-
116
- ## 5. 本文構成(標準テンプレ)
117
-
118
- ### 5.1. 代替案比較(Comparison of Alternatives)
119
-
120
- | 番号 | 見出し | 必須 | 内容(要点) |
121
- | ---- | -------------------- | ---- | --------------------------------------- |
122
- | 1 | 比較目的と前提条件 | ○ | 決定 ID、比較順序、対象外、候補選定基準 |
123
- | 2 | 比較対象案 | ○ | レイヤー別の候補カテゴリと具体候補 |
124
- | 3 | 評価軸と評価基準 | ○ | レイヤー別の観点、配点、判定基準 |
125
- | 4 | 比較結果と採択理由 | ○ | 採択、試行、保留、非採択とその理由 |
126
- | 5 | リスクとトレードオフ | ○ | 採択による不利益、軽減策 |
127
- | 6 | 決定と見直し | 任意 | 現時点の採択方針、再評価条件 |
76
+ - **比較目的と前提条件・比較対象案(必須)**: 何を決め、何を扱わないかを示し、候補カテゴリの選定根拠と各案の課題解決への道筋を説明します。複数レイヤーでは決定 ID と判断順序を明示します。
77
+ - **評価軸と評価基準・比較結果と採択理由(必須)**: 課題・制約に結び付く判定条件と、同一条件での各案の評価、採否の根拠を示します。技術的実現性、外部依存、後続成果物への影響を含めます。
78
+ - **リスクとトレードオフ(必須)**: 案に対応する不確実性と受容する不利益を区別し、軽減策を示します。後続作業へ渡す対象と確認条件を識別できる粒度にします。
79
+ - **決定と見直し(独立章は任意)**: 最終判断者、再評価トリガー、記録先は必須です。独立章を省く場合は「比較結果と採択理由」へ統合します。
128
80
 
129
81
  ## 6. 記述ガイド
130
82
 
131
83
  ### 6.1. 共通
132
84
 
133
- - 比較対象案は最低 2 案以上記載します。
134
- - 章参照は章番号ではなく章タイトルで記述します。
135
- - 評価結果には定量情報と定性理由の両方を含めます。
136
- - 根拠資料は、前段のスコープ、課題と解決アプローチ、前提・制約など、比較判断に直接必要な文書に限定します。
137
- - 根拠資料との整合は、候補案を前段文書の案に限定することを意味しません。前段文書から課題と評価条件を導き、候補案は外部調査を含めて展開します。
138
- - 複数の判断を扱う場合は `D-01` などの決定 ID を付け、上位の解決方式から製品・実装方式などへ判断する順序と、各決定で扱わない範囲を示します。
139
- - 同じ採択理由、非採択理由、見直し条件を複数の章や表に重複記載せず、評価結果に集約します。
140
-
141
- ### 6.2. 比較対象案
142
-
143
- - 各案は、単独で課題解決への道筋、適用範囲、主要な構成を説明できる一式の解決案にします。
144
- - 相互に組み合わせる要素を別案として並べず、業務運用を含む解決パッケージとして比較します。
145
- - 現行案に有利な候補だけで閉じず、現行運用の改善、汎用ツール、既存製品・サービス、個別構築、外部委託など、課題に応じた有力案を含めます。
146
- - 購入 / 構築を決める比較と、購入製品を選ぶ比較は分けます。上位判断で既存製品の採用可能性が残った場合に、具体製品を別レイヤーで比較します。
147
- - 開発戦略やタスク管理方式は、業務・システム解決案と分離します。プロジェクト運営そのものが比較目的の場合だけ主レイヤーとして扱います。
148
- - 具体候補を列挙する前に、非システム対応、汎用ツール、既存製品、個別構築など、比較目的に合う候補カテゴリと選定基準を定義します。
149
- - 各カテゴリから、公式資料で責務、データ保管、対応環境、移行可能性を確認できる候補を選びます。市場占有率を調べていない場合は「市場を代表する」と断定しません。
150
- - 現行・内製方式、専用ツールを採用しない案、外部の直接競合を必要に応じて含め、特定製品に有利な候補集合にしません。
151
-
152
- 推奨表(比較対象案):
153
-
154
- | 案ID | 比較レイヤー | 案 | 目的達成への道筋 | 主な構成要素 | 対象範囲 |
155
- | ---- | ------------ | --- | ---------------- | ------------ | -------- |
156
-
157
- 推奨表(候補カテゴリ):
158
-
159
- | 決定ID | 候補カテゴリ | 候補に含める基準 |
160
- | ------ | ------------ | ---------------- |
161
-
162
- ### 6.3. 評価軸と評価基準
163
-
164
- - 評価軸は効果、コスト、期間、リスク、運用適合、技術実現性の 6 観点を最低ラインとします。
165
-
166
- - 観点を省略する場合は省略理由を記載します。
167
- - 技術実現性は、既存環境、データ移行、外部依存、運用継続、後続成果物への影響を見ます。
168
- - 不確実性への適応、トレーサビリティ、人間の判断責任、AI Agent の長期作業と検証可能性が判断に影響する場合は、独立した評価軸として追加します。
169
- - 抽象度が異なる比較レイヤーには同じ評価軸を強制せず、各レイヤー内では候補ごとに同じ軸を使用します。
170
- - 製品・サービスには、業務適合、データ移行、ロックイン、可逆性、成熟度を必要に応じて追加します。
171
-
172
- 推奨表(評価基準):
173
-
174
- | 評価軸 | 重み | 判定基準 | 備考 |
175
- | ------ | ---- | -------- | ---- |
85
+ - 共通のメタ情報・ラベル・文書の改訂と廃止は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] を正本とし、ここでは比較固有の判断を扱います。
86
+ - 章はタイトルで参照し、同じ採否理由や見直し条件を複数箇所へ転載しません。評価結果を説明する箇所に理由と証拠を集約し、決定の要約から参照します。
87
+ - 実装、schema、リファレンスが定める値・構文・データ構造は正本への参照で示し、比較には採否を左右する差異・制約・影響だけを残します。
176
88
 
177
- ### 6.4. 比較結果と採択理由
89
+ ### 6.2. 比較目的と前提条件
178
90
 
179
- - 各候補を `採択` / `一部採択` / `比較試行` / `保留` / `非採択` などに判定し、その理由と再評価条件を記載します。
180
- - 判断過程を追跡できるよう、根拠資料へのリンクを記載します。
181
- - 採択案の最終判断は `PO` が行い、判断者を明記する。
182
- - 技術的実現性と影響は、決定または案ごとに表で明示します。
183
- - 比較試行は、同じ入力、評価軸、完了条件、記録先、採用・撤退判定を定義し、試行前に特定ツールを標準扱いしません。
184
- - 外部ツールを採択する場合は、仕様や状態の正本、同期方向、利用停止時の移行方法を明記します。
91
+ - スコープと課題に対して決めること・決めないことを定めます。業務運用、解決方式、購入 / 構築、製品、アーキテクチャなど必要な比較レイヤーだけを扱い、開発戦略や作業管理は明示的な決定対象である場合に限ります。
92
+ - 複数の判断には `D-01` などの決定 ID を付け、上位判断から後続判断への順序を示します。前段文書は候補の答えではなく、課題・制約・評価条件の根拠として読みます。
93
+ - **良い例**: 「D-01 で販売記録を継続できる解決方式を選ぶ。製品選定は既存サービス案が残った場合に行い、EC は対象外とする」。
94
+ - **悪い例**: 「使う製品を先に決め、導入理由を比較表にする」。課題と比較範囲を判断できません。
185
95
 
186
- 推奨表(比較結果):
96
+ ### 6.3. 比較対象案
187
97
 
188
- | 案ID | 効果 | コスト | 期間 | リスク | 運用適合 | 技術実現性 | 総合評価 | 判定 |
189
- | ---- | ---- | ------ | ---- | ------ | -------- | ---------- | -------- | ---- |
98
+ - 各案は、単独でも目的達成への道筋、対象範囲、主要な構成を説明できる業務運用込みの解決案にします。相互に補完する部品を別案にせず、同じ抽象度の候補を並べます。
99
+ - 候補カテゴリと選定基準を先に定め、現行運用改善、汎用ツール、既存製品、個別構築、外部委託などから有力案を探します。専用ツールを使わない案や外部の直接競合も必要に応じて含めます。
100
+ - 標準・方法論と製品を区別し、公式資料で責務、データ保管、対応環境、移行可能性を確認します。市場代表と呼ぶ場合は客観的根拠を示します。
101
+ - **良い例**: 「紙帳票の統一、共有表計算、既存サービス、個別構築を同じ販売記録の課題で比較する」。
102
+ - **悪い例**: 「画面、データベース、開発ツールを別案にし、すべて採択する」。一つの意思決定を代替していません。
190
103
 
191
- 推奨表(非採択または一部採択の理由):
104
+ ### 6.4. 評価軸と評価基準
192
105
 
193
- | 案ID | 理由 | 再評価条件 |
194
- | ---- | ---- | ---------- |
106
+ - 最低ラインは **効果、コスト、期間、リスク、業務適合、技術実現性** の 6 観点です。業務適合は利用者の手順・体制への適合を指し、運用・保守性は継続運用に要する負荷として必要に応じて分けます。
107
+ - レイヤーごとに軸を変えてよいものの、最低観点を省略する場合は、観点名と比較目的上不要な理由を明示します。別名の軸へ統合する場合は対応先と判定条件を示します。別章にリスクや実現性の説明があるだけでは、評価軸の省略理由を記したことにはなりません。
108
+ - 同一レイヤー内では全候補に同じ軸・判定境界・評価方向を使用します。各軸を根拠資料の課題 ID・制約に対応付け、重みを使う場合は優先順位なのか加重計算なのかを明記します。
109
+ - 技術実現性は既存環境、移行、外部依存、運用継続、後続成果物への影響から判定します。製品比較ではロックイン・可逆性・成熟度、判断に影響する場合は適応性・追跡性・人間の統制・AI Agent の長期作業と検証可能性を追加します。
195
110
 
196
- 推奨表(技術的実現性と影響):
111
+ 評価基準表では、次の情報を読み取れるようにします。列の統合は、判定情報を失わない範囲で行います。
197
112
 
198
- | 案ID | 技術的実現性 | 主な影響 |
199
- | ---- | ------------ | -------- |
113
+ | 情報 | 記述・判定の基準 |
114
+ | -------------- | ------------------------------------------------------------ |
115
+ | 評価軸と根拠 | 観点の意味と、対応する課題 ID・制約を示す |
116
+ | 判定基準 | 測定値または観察可能な状態で評価の境界と有利な方向を定める |
117
+ | 重み・集約方法 | 使用する場合に、重みの理由と総合評価・採否への反映方法を示す |
200
118
 
201
- ### 6.5. リスクとトレードオフ
119
+ - **良い例**: 「期間は 2 週以内の試行開始を High、2 週超 4 週以内を Middle、それ超を Low とする。リスクは継続運用軸へ統合し、通信断時の記録保持で判定する」。
120
+ - **悪い例**: 「不要な軸を削除する」「リスクは別章に書いたので評価しない」。削除の妥当性と全候補への適用を確認できません。
202
121
 
203
- - 案ごとのリスクとトレードオフを、採択判断に必要な粒度で記載します。
122
+ ### 6.5. 比較結果と採択理由
204
123
 
205
- - リスクは「起きうること」と「軽減策」をセットにします。
206
- - トレードオフは、先送りする範囲、受容する負荷、後続成果物への影響を明示します。
124
+ - 各候補に採択・一部採択・比較試行・保留・非採択などの判定を付け、評価軸に結び付く理由と再評価条件を記載します。結果表は採用した評価軸と対応させ、測定値や定性理由、根拠資料へのリンクで評価を追跡できるようにします。
125
+ - 技術的実現性と影響は、決定または案ごとの表で示します。外部ツールは仕様・状態の正本、導入時期、同期方向、停止時の移行・取り出し方法を明示します。
126
+ - 比較試行では同じ入力・範囲・評価軸を使用し、測定項目、完了条件、採用・撤退の閾値、記録先を事前に定めます。試行候補は正式採用や標準と区別し、未確認事項は確認済みの高評価にせず、仮定と確認作業を分けます。
127
+ - **良い例**: 「ALT-02 は操作検証で 10 件中 2 件の記録漏れがあり、漏れ 0 件の基準を満たさず非採択。入力手順改善後に再試行する」。
128
+ - **悪い例**: 「新しい製品なので High、採択する」。評価条件と証拠がなく再現できません。
207
129
 
208
- 推奨表(リスクとトレードオフ):
130
+ ### 6.6. リスクとトレードオフ
209
131
 
210
- | 区分 | 内容 | 軽減策 |
211
- | ---- | ---- | ------ |
132
+ - リスクは起きうる事象と軽減策、トレードオフは先送りする範囲・受容する負荷・後続への影響を記します。決定 ID または案 ID で対象を特定し、全候補に共通する場合はその旨を示します。
133
+ - 軽減策を後続作業にする場合は、担当 Role code、依存する作業・成果物、完了を確認する条件を示します。具体的な計画書名や台帳名は根拠資料で実在を確認し、詳細設計は後続成果物へ委譲します。
134
+ - **良い例**: 「ALT-04 の残高移行漏れを抑えるため、移行後に `QE` が元ノートとの全件照合を行い、差分 0 件を受入条件とする」。
135
+ - **悪い例**: 「移行には注意する」。対象、実施者、完了条件がなく計画へ渡せません。
212
136
 
213
- ### 6.6. 決定と見直し
137
+ ### 6.7. 決定と見直し
214
138
 
215
- - 現時点の採択方針と再評価トリガーを明記する。
216
- - 複数レイヤーを扱う場合は、各決定の採択、試行、保留を短く要約する。
217
- - 方針変更時は変更理由と影響範囲をプロジェクト登録簿または決定記録に残す。
139
+ - 現時点の採択・試行・保留を決定 ID 単位で短く要約し、最終判断者を明記します。再評価トリガーは期間、測定値、制約や依存の変化で定め、特定製品の自動採用条件にしません。
140
+ - 方針変更は理由、評価結果、影響範囲、移行・撤退方法とともに、実在するプロジェクト登録簿または決定記録へ残します。恒久的なリスク・課題・変更要求・未決事項は種類を分け、担当 Role code と転送先レコードを示します。
141
+ - 改訂・廃止時は `PM` が後続成果物・Schedule・PJR の追従作業を管理します。`BA` は業務影響、`ARC` は技術制約と外部依存、`DEV` は関連実装、`QE` は受入条件と検証、`PO` は方針変更を確認・判断します。
142
+ - **良い例**: 「`PO` が ALT-04 を採択。2 週間の試行で記録継続が営業日の 90% 未満なら `PM` が再比較を計画し、判断理由を既存の決定記録へ残す」。
143
+ - **悪い例**: 「Agent が必要に応じて採用ツールを変更する」。再評価条件と人間の判断責任が不明です。
218
144
 
219
145
  ## 7. 禁止事項
220
146
 
@@ -4,61 +4,145 @@ specdojo:
4
4
  type: rulebook
5
5
  deliverable_type: requirement
6
6
  status: draft
7
- recipe: undecided
7
+ target_format: markdown
8
+ recipe: not-needed
8
9
  sample: specdojo:sf-index-sample
9
- template: undecided
10
+ template: not-needed
10
11
  ---
11
12
 
12
- # [システム化機能一覧 / 全体構成](../rulebooks/sf-rulebook.md) 作成ルール
13
+ # システム化機能一覧(全体構成)作成ルール
13
14
 
14
15
  System Functions Index Documentation Rules
15
16
 
16
- 本ドキュメントは、`[システム化機能一覧 / 全体構成](../rulebooks/sf-rulebook.md)` を一貫した粒度で作成するためのルールを定義する。
17
+ `sf-index.md` は、対象システムが実現する機能の全体構成と一覧を定義し、業務プロセス仕様(BPS)・利用接点の仕様・個別機能仕様(`sf-<term>`)へ導く入口文書である。業務プロセス領域ごとにシステムが担う責務を一覧で示し、スコープの承認、機能分割、テスト対象の網羅確認に使える内容を記載する。
17
18
 
18
19
  ## 1. 全体方針
19
20
 
20
- - 目的: システムで実現する機能の全体構成と一覧を定義する
21
- - 主な内容: 機能ID、機能名、概要、関連プロセス、関連仕様ID など
21
+ - 一つのシステムまたは合意した対象範囲につき、機能一覧の正本を一つにする。複数システムを扱う場合は、一覧の対象範囲を冒頭で明示する。
22
+ - 機能は業務プロセス領域を起点に洗い出し、すべての業務プロセス領域が、いずれかの機能に属するか、システム化しない理由を持つ状態にする。
23
+ - 一覧行には機能 ID、機能名、概要、対応する業務プロセス仕様と利用接点、個別仕様の有無を対応させる。各行は要約参照にとどめ、入出力・振る舞い・受入条件は個別機能仕様へ委ねる。
24
+ - システムが担う処理(記録・検証・生成・起動)と、人間に残す判断を区別する。承認や確定の判断をシステム化機能として数えない。
25
+ - 上流の BPS・利用接点の仕様が未作成でも、成果物カタログなど確認できた根拠から一覧を作ってよい。未照合の対応は確定扱いにせず、未決事項で追跡する。
22
26
 
23
- - 曖昧表現を避け、判定可能な記述にする。
27
+ ## 2. 位置づけ
24
28
 
25
- ## 2. 位置づけと用語定義(必要に応じて)
29
+ | 文書・情報 | 役割 | 一覧との関係 |
30
+ | -------------------------------- | ------------------------------------------------ | -------------------------------------------------------------------- |
31
+ | `sf-index` | 機能の全体構成と一覧、機能 ID の採番元 | 本書の対象 |
32
+ | `sf-<term>` | 個別機能の入出力・処理要件・制約・受入観点 | 一覧行から参照する。一覧の内容を詳細化し、一覧全体の網羅性は扱わない |
33
+ | 業務プロセス仕様(BPS) | 業務のトリガー・処理ステップ・判断 | 一覧の網羅の起点。各行が担う業務プロセスの参照先 |
34
+ | 利用接点の仕様(CLIS・UIS・IFX) | コマンド群・画面・外部 I/F の利用方法と入出力 | 各行の利用接点の参照先。構文・画面配置は接点の仕様を正本とする |
35
+ | 成果物カタログ | 個別機能仕様を作るかどうかと、その依存・完了条件 | 個別仕様を追加するときは先にカタログへ登録する |
26
36
 
27
- - 上位方針・関連成果物との責務境界を明確化する。
28
- - 必要に応じて用語を定義し、命名ゆれを防ぐ。
37
+ - 個別機能仕様の作成ルールは [[specdojo:sf-rulebook|システム化機能仕様 作成ルール]] とし、本書は一覧ハブだけを扱う。
38
+ - 一覧に載せた機能のうち、どれを個別仕様へ詳細化するかは成果物カタログで管理する。個別仕様がない機能は、一覧行の要約を正とする。
39
+ - 作成の入力は、上位の目的・スコープ、業務プロセス領域と BPS、利用接点の仕様、成果物カタログとする。業務から機能への割当てを先に決め、実装・schema・リファレンスは参照先や現行制約の照合に使う。
29
40
 
30
41
  ## 3. ファイル命名・ID規則
31
42
 
32
- - 推奨ファイル名: `sf-index`
33
- - ドキュメントID: `sf-index-<term>` または用途に応じた識別子
43
+ - ファイル名は `sf-index.md`、成果物 ID は `sf-index` とする。`sf-index` は一覧ハブ用に予約し、個別機能には使わない。
44
+ - 機能 ID は `SF-<AREA>-<NN>` とする。`<AREA>` は機能領域を表す英大文字の略号(例: `POS`、`EXEC`)、`<NN>` は領域内の 2 桁連番とする。
45
+ - 機能 ID は一度採番したら意味を変えない。機能を廃止・統合した場合は ID を再利用せず、一覧から外した理由を未決事項または変更記録に残す。
46
+ - 配置は成果物カタログの宣言を優先し、命名・管理境界の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従う。
34
47
 
35
48
  ## 4. 推奨 Frontmatter 項目
36
49
 
37
- | 項目 | 値 | 必須 |
38
- | -------- | -------------------------- | ---- |
39
- | id | 一意なID | ○ |
40
- | type | `requirement` 固定 | ○ |
41
- | status | draft / ready / deprecated | ○ |
42
- | rulebook | `sf-index-rulebook` | 任意 |
50
+ - 共通の必須・任意項目と ID・参照・状態の制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。項目の型や許可値を本書で再定義しない。
51
+ - `type` は `requirement`、`rulebook` は `specdojo:sf-index-rulebook` とする。文書名は H1 に置く。
52
+ - 作成・改訂中は `status: draft` とする。静的検査の成功や作業タスクの完了だけで `ready` へ昇格せず、人間の PO がスコープを承認して判断する。
43
53
 
44
- ## 5. 本文構成(標準テンプレ)
54
+ ## 5. 本文要件
45
55
 
46
- | 章 | 必須 | 内容 |
47
- | ----------------- | ---- | ---------------------- |
48
- | 1. 目的と適用範囲 | ○ | 対象、目的、適用境界 |
49
- | 2. 入力情報 | ○ | 前提、参照元、制約 |
50
- | 3. 記述内容 | ○ | 主要項目、構成、記述順 |
51
- | 4. 検証観点 | ○ | 完了条件、確認観点 |
52
- | 5. 未解決事項 | 任意 | 課題、決定期限、担当 |
56
+ 次の章を開始時の構成とする。見出しには階層ごとの連番を付ける。
57
+
58
+ | 章 | 章タイトル | 必須 | 目的と記載要件 |
59
+ | --- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
60
+ | - | 冒頭の概要 | ○ | 対象システム、一覧の利用目的と対象範囲を 1〜3 文で示す |
61
+ | 1 | 目的と対象範囲 | ○ | 一覧で判断できることと上位目的の関係、対象者の業務課題、対象・対象外、読者・確認者、保守担当、公開範囲と承認者を示す |
62
+ | 2 | 機能構成 | ○ | 機能領域ごとに、略号、対応する業務プロセス領域、システムの責務、人間に残す判断を示す。システム化しない業務プロセス領域と理由を示す |
63
+ | 3 | システム化機能一覧 | ○ | 機能 ID、機能名、概要、業務プロセス仕様、利用接点、個別仕様を一つの主一覧表で対応させる |
64
+ | 4 | 未決事項 | 条件付き | 未照合の対応や未作成の参照先がある場合に、論点、影響、担当・判断者、判断時点、次アクション、追跡先と承認への影響を示す |
65
+
66
+ - 機能構成と一覧の両方で、すべての業務プロセス領域を確認できるようにする。一覧から機能構成へ、機能構成から業務プロセス領域へ辿れれば、網羅の確認表を別に設けない。
67
+ - 行が多く一つの表で領域を見分けにくい場合は、機能領域ごとに小節を分けてよい。列は全小節でそろえる。
53
68
 
54
69
  ## 6. 記述ガイド
55
70
 
56
- - 事実と判断を分離し、根拠を併記する。
57
- - 表は列見出しを固定し、欠損値の扱いを明示する。
58
- - 章参照は章番号ではなく章タイトルで記述する。
71
+ 共通事項は上位の目的・スコープ、BPS、利用接点の仕様を正本として参照し、一覧には割当てと責務境界を残す。実在する文書へのリンクは `[[id|title]]`、表のセル内は `[[id\|title]]` とし、未作成の参照先は ID をインラインコードで仮置きする。以下の良い例・悪い例は判断の差を示す断片である。
72
+
73
+ ### 6.1. 目的と対象範囲
74
+
75
+ - 対象者のどの業務課題を解消し、一覧で何を判断できるようにするかを書き、上位目的の参照先を添える。システムの紹介文や機能の列挙で終えない。
76
+ - 対象と対象外を対にして示す。対象外には、人間が行う判断、外部製品の内部処理、個別機能の詳細を必要に応じて含める。
77
+ - 読者ごとの用途(機能分割、実装範囲、テスト対象の洗い出し、業務対応の確認)、確認者と保守担当の Role code、スコープと公開可否を最終判断する人間の PO を示す。担当者の割当てはプロジェクトの組織・メンバー定義を参照する。
78
+ - 公開する相手と範囲を明記する。顧客の個人情報、認証情報、非公開の接続先や内部構成を本文・例・証跡に含めず、説明には架空名を使う。
79
+ - 良い例: 「店番交代時の記録漏れを減らすため、販売・在庫の責務分担を確定する。BA が一覧を保守し、店主代表(PO)が対象範囲と外部公開用の匿名化を確認する」。
80
+ - 悪い例: 「本システムの機能を一覧にする」。一覧で判断することと対象範囲が分からない。
81
+
82
+ ### 6.2. 機能構成
83
+
84
+ - 機能領域は業務プロセス領域のまとまりを基に分ける。業務の区分と責務が異なる処理を同じ領域に入れる場合、または一つの区分を分ける場合は、その理由を示す。
85
+ - 「システムの責務」には、記録・検証・生成・起動など、システムが行うことを動詞で書く。「人間に残す判断」には承認・確定・方針決定など、システム化しない判断を書く。
86
+ - システム化しない業務プロセス領域がある場合は、その領域と理由(手作業で足りる、外部サービスが担う、対象外と合意した等)を示す。ない場合も、ないことを明記する。
87
+ - 推奨する列は「機能領域」「略号」「業務プロセス領域」「システムの責務」「人間に残す判断」とする。
88
+ - 良い例: 「実行サイクル: タスクの実行受入から検証・統合・結果記録までを行う。業務上の完了承認は人間に残す」。
89
+ - 悪い例: 「実行サイクル: タスクを管理する」。システムが行うことと人間の判断の境界がない。
90
+
91
+ ### 6.3. システム化機能一覧
92
+
93
+ | 列 | 必須 | 記述内容 |
94
+ | ---------------- | ---- | ---------------------------------------------------------------------------------------------- |
95
+ | 機能 ID | ○ | `SF-<AREA>-<NN>` 形式の ID |
96
+ | 機能名 | ○ | 業務上の責務が分かる名詞句。実装のモジュール名やコマンド名を機能名にしない |
97
+ | 概要 | ○ | 何を入力に、何を確定・記録・生成するかを 1 文で示す |
98
+ | 業務プロセス仕様 | ○ | 対応する BPS の ID またはリンク。複数ある場合は代表とするものを含めて並べる |
99
+ | 利用接点 | ○ | 画面、CLI コマンド群、外部 I/F、自動実行などの起動接点と、その仕様への参照。接点がなければ理由 |
100
+ | 個別仕様 | ○ | 個別機能仕様へのリンク、または「一覧行で要約」などの扱い |
101
+
102
+ - 利用接点の列は、接点の種類に合わせて列名を変えてよい(画面中心なら「画面」、CLI 中心なら「CLI」)。構文・引数・画面配置は接点の仕様を正本とし、一覧へ転記しない。
103
+ - 一つの接点(コマンド群・画面)が複数の機能にまたがる場合は、機能ごとに行を分け、表の後にまたがりを注記する。
104
+ - 機能の境界が業務プロセスの区分とずれる場合(ある機能が別の領域の記録も担う等)は、表の後に責務の分担を注記する。
105
+ - 良い例: 「`SF-EXEC-02` 成果物評価: editor から独立した runner が成果物を評価し、grade と finding を記録する」。
106
+ - 悪い例: 「`SF-EXEC-02` grade: grade コマンド」。機能名がコマンド名で、何を確定するかが分からない。
107
+
108
+ ### 6.4. 未決事項
109
+
110
+ - `_TODO_`・`_UNDECIDED_`・`_ASSUMPTION_` の使い分けはドキュメントメタ情報標準に従う。論点ごとに影響する機能 ID・参照先、担当・判断者の Role code、期限または判断時点、次アクション、追跡先、承認を保留する条件を示す。
111
+ - 上流の BPS や利用接点の仕様が未作成で暫定の対応を置いた場合は、照合する時点と担当を残す。網羅の根拠(成果物カタログの依存など)と一覧の範囲が一致しない場合も論点にする。
112
+ - 上流仕様の作成・改訂、機能の追加・廃止・統合、接点や個別仕様の変更を再照合の契機とする。BA は BPS と一覧、ARC は機能分割・コンポーネント設計、DEV は接点・実装・schema・生成処理・運用手順、QE はテスト対象への影響先を機能 ID から特定する。該当しない影響先には理由を残す。
113
+ - 依存の不足や責務境界の未合意で後続設計・実装・検証の着手を妨げる場合は、PM に対象機能、影響する成果物・タスク、再開条件を渡す。PM は課題・リスク・変更要求・決定を PJR へ、追従作業の担当・順序・期限を Schedule へ接続し、進捗は実行記録で報告する。一覧には追跡参照を残し、管理台帳を複製しない。
114
+ - 改訂・廃止の共通手続きは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従う。
115
+ - 良い例: 「BA が BPS 作成時に `SF-INV-01` の在庫反映の責務を照合する。未合意の間は当該境界の承認を保留し、PM が PJR で追跡して在庫設計の着手時期を見直す」。
116
+ - 悪い例: 「対応は後で確認する」。担当と確認の時点がない。
117
+
118
+ ### 6.5. 完成判定と継続保守
119
+
120
+ 一覧の内容確認は次を基準とし、確認結果と未充足条件をレビュー記録へ残す。具体的な責任分担と成果物の完了条件は、プロジェクトの Role 定義・成果物カタログを正とする。
121
+
122
+ | 確認ロール | 合格と判断できる状態 |
123
+ | ---------- | ---------------------------------------------------------------------------------------------------------------- |
124
+ | BA | 全業務プロセス領域が機能または対象外の理由に対応し、各行の概要と根拠仕様の責務が矛盾しない |
125
+ | ARC | 機能 ID が一意で領域に対応し、重なる責務の分担と外部・人間との境界を設計入力として特定できる |
126
+ | DEV | 各行から起動接点と仕様の正本を辿れ、個別仕様を作る機能と一覧で要約する機能が区別できる |
127
+ | QE | 対象機能 ID をテスト対象へ対応付けられ、必須列の欠落、参照切れ、未記録の暫定対応がない |
128
+ | PM | 機能領域ごとの照合と影響先の追従を作業単位に分け、完了条件・担当・判断時点をカタログ・Schedule・PJR で追跡できる |
129
+ | PO | 上位目的に沿う対象範囲、人間に残す判断、公開範囲と非公開情報の除外を確認し、未決事項を含めて承認可否を判断できる |
130
+
131
+ - 文書検査は利用リポジトリの package・hook 設定と実行規約に従い、Markdown 整形・lint、Frontmatter と参照の検査を行う。同梱リポジトリでは `lint:md`・`lint:fm` 等の設定を参照する。対象ファイル、コマンド、結果を実行記録に残し、適用検査がすべてエラーなく終了することを合格条件とする。
132
+ - 人間の PO は、未照合の対応や未解決指摘がスコープ・責務境界・公開可否に影響する場合は承認を保留または差し戻す。承認範囲から切り出す場合も、その範囲と後続作業の追跡先を明記する。文書検査の成功は、内容の合意、機能の受入試験、製品リリースの判断を代替しない。
133
+ - 公開後の対応漏れや参照切れは保守担当へ渡し、スコープ変更は PO、技術境界の矛盾は ARC、計画への影響は PM へ接続する。変更後は影響する一覧行と参照先を再確認する。
134
+ - 良い例: 「lint は成功したが、在庫反映の責務が未照合のため `draft` を維持する。BA・ARC の確認後に PO が対象範囲を承認する」。
135
+ - 悪い例: 「一覧が埋まり lint が通ったので `ready` として公開する」。網羅性・責務の合意と人間の最終判断を省いている。
59
136
 
60
137
  ## 7. 禁止事項
61
138
 
62
- - 実装依存の詳細を記載しない。
63
- - 判定不能な曖昧語を使わない。
64
- - 参照元不明の値を断定しない。
139
+ | 禁止事項 | 理由 |
140
+ | -------------------------------------------------------------------------- | ------------------------------------------------------------ |
141
+ | 業務プロセス領域を確認せず、実装のモジュールやコマンドの列挙から一覧を作る | 業務仕様からの漏れと、業務に対応しない機能を判断できないため |
142
+ | 人間の承認・確定の判断をシステム化機能として数える | システムが保証する範囲を誤らせるため |
143
+ | 個別機能の入出力・処理要件・受入条件を一覧へ展開する | 個別機能仕様と責務が重なり、更新先が分からなくなるため |
144
+ | コマンド構文・引数・画面配置・schema の項目を一覧へ転記する | 利用接点の仕様や schema と二重管理になるため |
145
+ | 成果物カタログに登録していない個別仕様を、存在するようにリンクする | デッドリンクと、作成判断の不在を招くため |
146
+ | 未照合の対応や未作成の参照先を、未決事項に残さず確定事項として扱う | 上流仕様の作成時に照合されず、誤りが残るため |
147
+ | 機能 ID を再利用する、または意味を変える | 個別仕様・テスト・変更記録からの参照が壊れるため |
148
+ | 文書検査の成功だけで agent が `ready` 昇格や公開の承認を行う | スコープと公開可否の最終判断は人間の PO が担うため |