specdojo 0.1.0 → 0.2.1

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 (540) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +142 -35
  3. package/dist/agent-response.js +27 -0
  4. package/dist/agent.js +124 -0
  5. package/dist/build-command.js +149 -0
  6. package/dist/build-if-stale.js +35 -0
  7. package/dist/catalog-build.js +1079 -0
  8. package/dist/catalog-generate.js +226 -0
  9. package/dist/catalog-paths.js +31 -0
  10. package/dist/catalog-plan-generate.js +301 -0
  11. package/dist/catalog-plan-prompt.js +73 -0
  12. package/dist/catalog-plan.js +471 -0
  13. package/dist/catalog-scaffold.js +255 -0
  14. package/dist/catalog-types.js +4 -0
  15. package/dist/catalog.js +606 -0
  16. package/dist/dashboard.js +990 -0
  17. package/dist/deliverable-trash.js +148 -0
  18. package/dist/deliverable.js +97 -0
  19. package/dist/dist-freshness.js +150 -0
  20. package/dist/doc-index.js +424 -0
  21. package/dist/exec-agent-config.js +172 -0
  22. package/dist/exec-agent-git-state.js +136 -0
  23. package/dist/exec-agent-protected-config.js +276 -0
  24. package/dist/exec-events.js +250 -112
  25. package/dist/exec-evidence.js +317 -0
  26. package/dist/exec-format.js +54 -0
  27. package/dist/exec-limit.js +202 -0
  28. package/dist/exec-parent-validation.js +169 -0
  29. package/dist/exec-pipeline-state.js +160 -0
  30. package/dist/exec-plans.js +1016 -0
  31. package/dist/exec-project.js +25 -11
  32. package/dist/exec-protection-handoff.js +169 -0
  33. package/dist/exec-provider-scaffold.js +99 -0
  34. package/dist/exec-register-resume.js +196 -0
  35. package/dist/exec-register.js +281 -0
  36. package/dist/exec-reporter.js +329 -0
  37. package/dist/exec-results.js +510 -0
  38. package/dist/exec-run-lock.js +149 -0
  39. package/dist/exec-run.js +4953 -0
  40. package/dist/exec-schedule-calendar.js +86 -9
  41. package/dist/exec-schedule-cpm.js +30 -12
  42. package/dist/exec-schedule-gantt-chart-render.js +428 -0
  43. package/dist/exec-schedule-gantt-chart-scope.js +111 -0
  44. package/dist/exec-schedule-gantt-chart.js +2 -0
  45. package/dist/exec-schedule-hash.js +34 -25
  46. package/dist/exec-schedule-index.js +200 -67
  47. package/dist/exec-schedule-initial.js +100 -0
  48. package/dist/exec-schedule-progress.js +51 -26
  49. package/dist/exec-schedule-ready.js +71 -27
  50. package/dist/exec-schedule.js +171 -93
  51. package/dist/exec-shared.js +146 -25
  52. package/dist/exec-strategy.js +547 -0
  53. package/dist/exec-task-view.js +64 -0
  54. package/dist/exec-trial.js +895 -0
  55. package/dist/exec-worktree-command.js +426 -0
  56. package/dist/exec-worktree-ops.js +847 -0
  57. package/dist/exec-worktree.js +359 -0
  58. package/dist/exec.js +744 -192
  59. package/dist/frontmatter-namespace.js +48 -0
  60. package/dist/git-environment.js +23 -0
  61. package/dist/grade-result.js +137 -0
  62. package/dist/grade.js +2456 -0
  63. package/dist/index-command.js +103 -0
  64. package/dist/job.js +1081 -0
  65. package/dist/kata-command.js +303 -0
  66. package/dist/kata.js +187 -0
  67. package/dist/package-paths.js +33 -0
  68. package/dist/practice-id.js +24 -0
  69. package/dist/register-date.js +122 -0
  70. package/dist/register-events.js +363 -0
  71. package/dist/register-history.js +323 -0
  72. package/dist/register-item.js +455 -0
  73. package/dist/register-migrate-timestamps.js +176 -0
  74. package/dist/register.js +2199 -0
  75. package/dist/review-plan.js +199 -0
  76. package/dist/review-types.js +1 -0
  77. package/dist/role-types.js +1 -0
  78. package/dist/routine.js +814 -0
  79. package/dist/schedule-approach.js +252 -0
  80. package/dist/schedule-build.js +552 -0
  81. package/dist/schedule-phase-sets.js +73 -0
  82. package/dist/schedule-strategy-generate.js +812 -0
  83. package/dist/schedule-strategy-profiles.js +276 -0
  84. package/dist/schedule.js +420 -0
  85. package/dist/spawn-self.js +28 -0
  86. package/dist/specdojo-config.js +133 -39
  87. package/dist/specdojo.js +56 -7
  88. package/dist/template-frontmatter.js +89 -0
  89. package/dist/template-resolution.js +92 -0
  90. package/dist/timeline-build.js +334 -0
  91. package/dist/timeline.js +107 -0
  92. package/dist/watch.js +313 -0
  93. package/dist/yaml-pages-command.js +28 -0
  94. package/dist/yaml-pages.js +180 -0
  95. package/dist/yaml-schema-modeline.js +49 -0
  96. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
  97. package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
  98. package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
  99. package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
  100. package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
  101. package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
  102. package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
  103. package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
  104. package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
  105. package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
  106. package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
  107. package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
  108. package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
  109. package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
  110. package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
  111. package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
  112. package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
  113. package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
  114. package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
  115. package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
  116. package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
  117. package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
  118. package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
  119. package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
  120. package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
  121. package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
  122. package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
  123. package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
  124. package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
  125. package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
  126. package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
  127. package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
  128. package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
  129. package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
  130. package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
  131. package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
  132. package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
  133. package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
  134. package/docs/ja/specdojo/guides/kata-guide.md +89 -0
  135. package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
  136. package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
  137. package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
  138. package/docs/ja/specdojo/guides/quick-start-guide.md +472 -0
  139. package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
  140. package/docs/ja/specdojo/guides/remote-host-development-guide.md +163 -0
  141. package/docs/ja/specdojo/guides/review-guide.md +428 -0
  142. package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
  143. package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
  144. package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
  145. package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
  146. package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
  147. package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
  148. package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
  149. package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
  150. package/docs/ja/specdojo/guides/waza-guide.md +224 -0
  151. package/docs/ja/specdojo/index.md +33 -0
  152. package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
  153. package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
  154. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
  155. package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
  156. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
  157. package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
  158. package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
  159. package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
  160. package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
  161. package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
  162. package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
  163. package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
  164. package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
  165. package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
  166. package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
  167. package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
  168. package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
  169. package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
  170. package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
  171. package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
  172. package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
  173. package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
  174. package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
  175. package/docs/ja/specdojo/references/command-reference.md +718 -0
  176. package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
  177. package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
  178. package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
  179. package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
  180. package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
  181. package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
  182. package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
  183. package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
  184. package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
  185. package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
  186. package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
  187. package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
  188. package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
  189. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
  190. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
  191. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
  192. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
  193. package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
  194. package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
  195. package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
  196. package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
  197. package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
  198. package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
  199. package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
  200. package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
  201. package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
  202. package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
  203. package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
  204. package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
  205. package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
  206. package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
  207. package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
  208. package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
  209. package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
  210. package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
  211. package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
  212. package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
  213. package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
  214. package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
  215. package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
  216. package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
  217. package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
  218. package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
  219. package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
  220. package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
  221. package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
  222. package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
  223. package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
  224. package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
  225. package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
  226. package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
  227. package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
  228. package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
  229. package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
  230. package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
  231. package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
  232. package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
  233. package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
  234. package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
  235. package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
  236. package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
  237. package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
  238. package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
  239. package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
  240. package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
  241. package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
  242. package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
  243. package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
  244. package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
  245. package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
  246. package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
  247. package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
  248. package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
  249. package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
  250. package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
  251. package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
  252. package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
  253. package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
  254. package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
  255. package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
  256. package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
  257. package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
  258. package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
  259. package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
  260. package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
  261. package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
  262. package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
  263. package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
  264. package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
  265. package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
  266. package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
  267. package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
  268. package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
  269. package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
  270. package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
  271. package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
  272. package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
  273. package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
  274. package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
  275. package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
  276. package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
  277. package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
  278. package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
  279. package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
  280. package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
  281. package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
  282. package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
  283. package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
  284. package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
  285. package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
  286. package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
  287. package/docs/ja/specdojo/samples/atc-sample.md +41 -0
  288. package/docs/ja/specdojo/samples/bac-sample.md +38 -0
  289. package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
  290. package/docs/ja/specdojo/samples/bds-sample.md +38 -0
  291. package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
  292. package/docs/ja/specdojo/samples/bes-sample.md +38 -0
  293. package/docs/ja/specdojo/samples/bps-sample.md +38 -0
  294. package/docs/ja/specdojo/samples/br-sample.md +40 -0
  295. package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
  296. package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
  297. package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
  298. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
  299. package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
  300. package/docs/ja/specdojo/samples/cld-sample.md +38 -0
  301. package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
  302. package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
  303. package/docs/ja/specdojo/samples/cop-sample.md +38 -0
  304. package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
  305. package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
  306. package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
  307. package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
  308. package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
  309. package/docs/ja/specdojo/samples/dec-sample.md +39 -0
  310. package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
  311. package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
  312. package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
  313. package/docs/ja/specdojo/samples/etc-sample.md +38 -0
  314. package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
  315. package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
  316. package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
  317. package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
  318. package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
  319. package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
  320. package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
  321. package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
  322. package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
  323. package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
  324. package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
  325. package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
  326. package/docs/ja/specdojo/samples/itc-sample.md +38 -0
  327. package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
  328. package/docs/ja/specdojo/samples/mm-sample.md +35 -0
  329. package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
  330. package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
  331. package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
  332. package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
  333. package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
  334. package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
  335. package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
  336. package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
  337. package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
  338. package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
  339. package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
  340. package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
  341. package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
  342. package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
  343. package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
  344. package/docs/ja/specdojo/samples/opd-sample.md +38 -0
  345. package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
  346. package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
  347. package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
  348. package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
  349. package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
  350. package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
  351. package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
  352. package/docs/ja/specdojo/samples/opr-sample.md +38 -0
  353. package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
  354. package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
  355. package/docs/ja/specdojo/samples/otp-sample.md +68 -0
  356. package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
  357. package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
  358. package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
  359. package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
  360. package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
  361. package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
  362. package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
  363. package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
  364. package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
  365. package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
  366. package/docs/ja/specdojo/samples/pr-sample.md +39 -0
  367. package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
  368. package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
  369. package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
  370. package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
  371. package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
  372. package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
  373. package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
  374. package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
  375. package/docs/ja/specdojo/samples/sac-sample.md +38 -0
  376. package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
  377. package/docs/ja/specdojo/samples/sf-sample.md +38 -0
  378. package/docs/ja/specdojo/samples/sld-sample.md +38 -0
  379. package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
  380. package/docs/ja/specdojo/samples/stc-sample.md +38 -0
  381. package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
  382. package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
  383. package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
  384. package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
  385. package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
  386. package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
  387. package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
  388. package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
  389. package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
  390. package/docs/ja/specdojo/samples/uis-sample.md +38 -0
  391. package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
  392. package/docs/ja/specdojo/samples/utc-sample.md +38 -0
  393. package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
  394. package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
  395. package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
  396. package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
  397. package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
  398. package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
  399. package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
  400. package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
  401. package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
  402. package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
  403. package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
  404. package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
  405. package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
  406. package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
  407. package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
  408. package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
  409. package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
  410. package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
  411. package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
  412. package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
  413. package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
  414. package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
  415. package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
  416. package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
  417. package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
  418. package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
  419. package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
  420. package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
  421. package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
  422. package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
  423. package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
  424. package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
  425. package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
  426. package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
  427. package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
  428. package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
  429. package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
  430. package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
  431. package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
  432. package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
  433. package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
  434. package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
  435. package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
  436. package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
  437. package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
  438. package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
  439. package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
  440. package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
  441. package/docs/ja/specdojo/templates/opr-template.md +85 -0
  442. package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
  443. package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
  444. package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
  445. package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
  446. package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
  447. package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
  448. package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
  449. package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
  450. package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
  451. package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
  452. package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
  453. package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
  454. package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
  455. package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
  456. package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
  457. package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
  458. package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
  459. package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
  460. package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
  461. package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
  462. package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
  463. package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
  464. package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
  465. package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
  466. package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
  467. package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
  468. package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
  469. package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
  470. package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
  471. package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
  472. package/docs/ja/specdojo/templates/stsd-template.md +57 -0
  473. package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
  474. package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
  475. package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
  476. package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
  477. package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
  478. package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
  479. package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
  480. package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
  481. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
  482. package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
  483. package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
  484. package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
  485. package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
  486. package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
  487. package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
  488. package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
  489. package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
  490. package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
  491. package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
  492. package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
  493. package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
  494. package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
  495. package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
  496. package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
  497. package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
  498. package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
  499. package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
  500. package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
  501. package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
  502. package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
  503. package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
  504. package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
  505. package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
  506. package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
  507. package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
  508. package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
  509. package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
  510. package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
  511. package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
  512. package/package.json +121 -24
  513. package/templates/antigravity/README.md +35 -0
  514. package/templates/antigravity/exec-defaults-snippet.yaml +38 -0
  515. package/templates/antigravity/orchestrator.md +146 -0
  516. package/templates/antigravity/pm-members-snippet.yaml +55 -0
  517. package/templates/claude/README.md +46 -0
  518. package/templates/claude/agents/claude-expert-review-executor.md +14 -0
  519. package/templates/claude/agents/claude-review-executor.md +14 -0
  520. package/templates/claude/agents/specdojo-orchestrator.md +153 -0
  521. package/templates/claude/settings.edit.json +6 -0
  522. package/templates/claude/settings.report.json +6 -0
  523. package/templates/claude/settings.review.json +7 -0
  524. package/templates/codex/README.md +61 -0
  525. package/templates/codex/agents/codex-executor.toml +12 -0
  526. package/templates/codex/agents/codex-expert-executor.toml +12 -0
  527. package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
  528. package/templates/codex/agents/codex-review-executor.toml +10 -0
  529. package/templates/codex/agents/specdojo-orchestrator.toml +154 -0
  530. package/templates/codex/orchestrator.md +146 -0
  531. package/templates/copilot/README.md +41 -0
  532. package/templates/copilot/exec-defaults-snippet.yaml +28 -0
  533. package/templates/copilot/pm-members-snippet.yaml +44 -0
  534. package/templates/opencode/README.md +41 -0
  535. package/templates/opencode/agents/opencode-executor.md +59 -0
  536. package/templates/opencode/agents/opencode-reporter.md +26 -0
  537. package/templates/opencode/agents/opencode-review-executor.md +48 -0
  538. package/templates/opencode/agents/specdojo-orchestrator.md +193 -0
  539. package/dist/exec-schedule-timeline-render.js +0 -201
  540. package/dist/exec-schedule-timeline.js +0 -2
@@ -0,0 +1,311 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:ifx-file-rulebook
4
+ type: rulebook
5
+ status: draft
6
+ recipe: not-needed
7
+ sample: specdojo:ifx-file-sample
8
+ template: not-needed
9
+ ---
10
+
11
+ # 外部ファイル連携仕様(External File Exchange Specification: EFES)作成ルール
12
+
13
+ 外部システム(仕入先、物流、会計など)と **ファイル連携**するために、ファイルの形式・項目・制約・受け渡し手順を定義します。
14
+
15
+ EFES は ESIL(外部システムIF一覧)から参照される「詳細仕様」です。
16
+ ESIL 側の `spec_ref: ifx-file-...` は、このEFESのID(およびファイル名)と対応させます。
17
+
18
+ この章では **表ではなく YAML 1ファイル**で EFES を管理します。
19
+
20
+ 対応フォーマット:
21
+
22
+ - **CSV / TSV**
23
+ - **JSON**
24
+ - **XML**
25
+
26
+ ## 1. ファイル規約
27
+
28
+ - ファイル名: `ifx-file-<短い英小文字ハイフン>.yaml`
29
+ - ESILからの参照: `spec_ref: ifx-file-...`(例: `ifx-file-orders`)
30
+ - 1ファイル = 1つのファイル連携仕様(1つの連携ファイル、または同一契約での複数ファイル群)
31
+
32
+ ## 2. 記載方針(必須)
33
+
34
+ - **外部との合意に必要な最小十分**を記載する(内部実装の都合は書かない)
35
+ - 実ファイルの「**生成/受領の責任境界**」が分かるようにする(送信者/受信者/方向)
36
+ - 「どこに置くか/どう受け渡すか」(SFTP/共有ストレージ等)は **概要レベル**に留める
37
+ - フォーマットの差異(CSV/TSV/JSON/XML)に応じて、**検証可能な構造定義**を置く
38
+ - **メタ情報は `x-spec-meta` に集約**し、トレーサビリティを確保する
39
+ - 仕様ファイル(このYAML)のキーは snake_case を用いる
40
+
41
+ 禁止(書かない):
42
+
43
+ - DB物理テーブル名・物理カラム名・SQL全文
44
+ - 実装クラス/関数名・内部モジュール構成
45
+ - UI操作の逐語列挙
46
+
47
+ ## 3. 必須構造(EFES YAML)
48
+
49
+ 最低限、以下を必ず含めます。
50
+
51
+ - `x-spec-meta`(`id`, `type`, `status` を含む)
52
+ - `file`(ファイル名/拡張子/命名規則)
53
+ - `direction`(連携方向)
54
+ - `format`(`CSV`/`TSV`/`JSON`/`XML`)
55
+ - `transport`(受け渡し方法の概要)
56
+ - `schema`(フォーマット別の構造定義)
57
+
58
+ ## 3.1 メタ情報(x-spec-meta)
59
+
60
+ | キー | 説明 | 必須 |
61
+ | -------- | ---------------------------------------------------------- | ---- |
62
+ | id | ファイル仕様ID(`ifx-file-...`)、ESILの `spec_ref` と対応 | ○ |
63
+ | type | `file` 固定 | ○ |
64
+ | status | `draft` / `ready` / `deprecated` | ○ |
65
+ | based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
66
+
67
+ ## 4. 主要項目
68
+
69
+ ### 4.1 direction(連携方向)
70
+
71
+ - `source_to_target` / `target_to_source`
72
+
73
+ ※ ESIL の `direction` と同じ語彙で揃えます。
74
+
75
+ ### 4.2 format(ファイルフォーマット)
76
+
77
+ - `CSV` / `TSV` / `JSON` / `XML`
78
+
79
+ ### 4.3 transport(受け渡し方法)
80
+
81
+ 手段は実環境で変わりやすいため、仕様では以下を最低限にします。
82
+
83
+ - `method`: `SFTP` / `HTTPS` / `共有ストレージ` / `その他` / `TBD`
84
+ - `endpoint`: 接続先の説明(URL/ホスト名/共有パス等。機密値は書かない)
85
+
86
+ - `frequency`: 連携頻度(例: 日次 02:00、都度、手動)
87
+
88
+ ## 5. schema(フォーマット別の構造定義)
89
+
90
+ EFES は「構造定義」を機械判読可能にするため、以下のいずれか(または両方)を採用します。
91
+
92
+ - **フィールド一覧(共通・推奨)**: `schema.fields` で項目を列挙(CSV/TSV/JSON/XMLいずれも対応)
93
+ - **厳密スキーマ(任意)**:
94
+ - JSON: `schema.json_schema`(JSON Schema相当をYAMLで記述、または外部参照)
95
+ - XML: `schema.xsd_ref`(XSDへの参照)
96
+
97
+ ### 5.1 schema.fields(共通フィールド定義)
98
+
99
+ - `schema.fields` は配列
100
+ - 各フィールド要素は以下を持つ
101
+
102
+ | キー | 説明 | 必須 |
103
+ | ----------- | -------------------------------------------------------------------------- | ---- |
104
+ | name | 項目名(snake_case推奨) | ○ |
105
+ | type | `string` / `integer` / `number` / `boolean` / `date` / `datetime` / `enum` | ○ |
106
+ | description | 項目説明 | 任意 |
107
+ | required | 必須かどうか(true/false) | 任意 |
108
+ | example | 例値 | 任意 |
109
+ | constraints | 制約(min/max/pattern等。必要な範囲で) | 任意 |
110
+ | enum | `type: enum` の場合の許容値 | 任意 |
111
+ | mapping | フォーマット別の対応付け(CSV列名、JSONパス、XPath等) | 任意 |
112
+
113
+ #### mapping の例
114
+
115
+ - CSV/TSV: `mapping.csv.column: "order_id"`(ヘッダ名)または `mapping.csv.index: 1`(1始まり)
116
+ - JSON: `mapping.json.pointer: "/data/order_id"`(JSON Pointer)
117
+ - XML: `mapping.xml.xpath: "/Order/OrderId"`(XPath例)
118
+
119
+ ### 5.2 CSV/TSV 固有
120
+
121
+ `schema.csv` を定義します。
122
+
123
+ - `delimiter`: `,`(CSV)/ `\t`(TSV)
124
+ - `header`: true/false
125
+ - `quote`: `"` など(任意)
126
+ - `encoding`: `UTF-8` 推奨
127
+ - `line_ending`: `LF` 推奨(必要なら `CRLF`)
128
+
129
+ ### 5.3 JSON 固有
130
+
131
+ `schema.json` を定義します。
132
+
133
+ - `root_type`: `object` / `array`
134
+ - `content_type`: `application/json`
135
+ - `json_schema`: 任意(厳密に縛る場合)
136
+
137
+ ### 5.4 XML 固有
138
+
139
+ `schema.xml` を定義します。
140
+
141
+ - `root_element`: ルート要素名
142
+ - `namespace`: 任意
143
+ - `content_type`: `application/xml`
144
+ - `xsd_ref`: 任意(厳密に縛る場合。ファイル名やURLを記載)
145
+
146
+ ## 6. サンプル(CSV)
147
+
148
+ ```yaml
149
+ x-spec-meta:
150
+ id: ifx-file-orders
151
+ type: file
152
+ status: draft
153
+ based_on: []
154
+
155
+ file:
156
+ name: orders.csv
157
+ naming_rule: orders_YYYYMMDD.csv
158
+ description: 発注データ(仕入先へ送付)
159
+
160
+ source: 受発注管理(コンテナ)
161
+ target: 仕入先システム
162
+
163
+ direction: source_to_target
164
+ format: CSV
165
+
166
+ timing: 発注確定時
167
+
168
+ transport:
169
+ method: SFTP
170
+ endpoint: supplier-sftp.example.com:/inbound/orders
171
+ frequency: 都度
172
+
173
+ schema:
174
+ csv:
175
+ delimiter: ","
176
+ header: true
177
+ quote: '"'
178
+ encoding: UTF-8
179
+ line_ending: LF
180
+
181
+ fields:
182
+ - name: order_id
183
+ type: string
184
+ description: 発注ID
185
+ required: true
186
+ example: ORD-0001
187
+ mapping:
188
+ csv:
189
+ column: order_id
190
+
191
+ - name: ordered_at
192
+ type: datetime
193
+ description: 発注日時(RFC3339)
194
+ required: true
195
+ example: 2025-12-24T12:34:56Z
196
+ mapping:
197
+ csv:
198
+ column: ordered_at
199
+
200
+ - name: total_amount
201
+ type: integer
202
+ description: 合計金額
203
+ required: true
204
+ example: 1200
205
+ constraints:
206
+ min: 0
207
+ mapping:
208
+ csv:
209
+ column: total_amount
210
+ ```
211
+
212
+ ## 7. サンプル(JSON)
213
+
214
+ ```yaml
215
+ x-spec-meta:
216
+ id: ifx-file-inventory-snapshot
217
+ type: file
218
+ status: draft
219
+ based_on: []
220
+
221
+ file:
222
+ name: inventory.json
223
+ naming_rule: inventory_YYYYMMDD.json
224
+ description: 在庫スナップショット
225
+
226
+ source: 在庫(コンテナ)
227
+ target: 物流システム
228
+
229
+ direction: source_to_target
230
+ format: JSON
231
+
232
+ timing: 日次集計後
233
+
234
+ transport:
235
+ method: HTTPS
236
+ endpoint: https://logistics.example.com/upload
237
+ frequency: 日次 02:00
238
+
239
+ schema:
240
+ json:
241
+ root_type: object
242
+ content_type: application/json
243
+
244
+ fields:
245
+ - name: snapshot_date
246
+ type: date
247
+ required: true
248
+ example: 2025-12-24
249
+ mapping:
250
+ json:
251
+ pointer: /snapshot_date
252
+
253
+ - name: items
254
+ type: string
255
+ description: 明細配列(厳密に縛る場合は json_schema を使用)
256
+ required: true
257
+ mapping:
258
+ json:
259
+ pointer: /items
260
+ ```
261
+
262
+ ## 8. サンプル(XML)
263
+
264
+ ```yaml
265
+ x-spec-meta:
266
+ id: ifx-file-payment-result
267
+ type: file
268
+ status: draft
269
+ based_on: []
270
+
271
+ file:
272
+ name: payment_result.xml
273
+ naming_rule: payment_result_YYYYMMDDHHmmss.xml
274
+ description: 決済結果(外部→当社)
275
+
276
+ source: 決済サービス
277
+ target: 決済(コンテナ)
278
+
279
+ direction: target_to_source
280
+ format: XML
281
+
282
+ timing: 決済結果通知
283
+
284
+ transport:
285
+ method: 共有ストレージ
286
+ endpoint: /shared/payment/result
287
+ frequency: 都度
288
+
289
+ schema:
290
+ xml:
291
+ root_element: PaymentResult
292
+ namespace: TBD
293
+ content_type: application/xml
294
+ xsd_ref: TBD
295
+
296
+ fields:
297
+ - name: payment_id
298
+ type: string
299
+ required: true
300
+ mapping:
301
+ xml:
302
+ xpath: /PaymentResult/PaymentId
303
+
304
+ - name: status
305
+ type: enum
306
+ required: true
307
+ enum: [PENDING, PAID, FAILED]
308
+ mapping:
309
+ xml:
310
+ xpath: /PaymentResult/Status
311
+ ```
@@ -0,0 +1,94 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:ifx-index-rulebook
4
+ type: rulebook
5
+ status: draft
6
+ target_format: yaml
7
+ recipe: not-needed
8
+ sample: not-needed
9
+ template: not-needed
10
+ ---
11
+
12
+ # 外部システムIF一覧(External System Interface List: ESIL)作成ルール
13
+
14
+ External System Interface List (ESIL) Documentation Rules
15
+
16
+ 外部システム(仕入先、会計、物流、決済など)との連携を、**一覧(インベントリ)**として定義します。
17
+
18
+ ESIL は「どの外部システムと」「何を」「どの方向で」「どの形式で」「いつ連携し」「異常時にどう扱うか」を、関係者間で合意するための入口です。
19
+
20
+ 詳細なAPI仕様、ファイル/メッセージの項目定義、外部コマンドの起動契約は、別ドキュメント(外部API仕様、外部ファイル連携仕様、外部メッセージ仕様、外部コマンド連携仕様など)に分離し、ESIL から参照できるようにします。
21
+
22
+ この章では **表ではなく YAML 1ファイル**で ESIL を管理します。
23
+
24
+ ## 1. 参照スキーマ
25
+
26
+ - 参照スキーマ: [docs/specdojo/schemas/v1/esil.schema.yaml](../../../specdojo/schemas/v1/esil.schema.yaml)
27
+ - ESIL は `docs/**/ifx-*.yaml` のような YAML ファイルとして作成し、スキーマに従って記述します。
28
+
29
+ ## 2. ファイル規約
30
+
31
+ - ファイル名: `ifx-<短い英小文字ハイフン>.yaml`
32
+ - `id`: `^ifx-[a-z0-9-]+$` に合致する一意ID
33
+ - `type`: `api` 固定
34
+
35
+ ## 3. ルート要素
36
+
37
+ | キー | 説明 | 必須 |
38
+ | ---------- | ----------------------------- | ---- |
39
+ | id | ESIL ID(`ifx-...`) | ○ |
40
+ | type | `api` 固定 | ○ |
41
+ | title | 外部システムIF一覧名 | ○ |
42
+ | status | `draft`/`ready`/`deprecated` | ○ |
43
+ | interfaces | 外部連携の配列(1件以上) | ○ |
44
+ | supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
45
+
46
+ ※ ルートは `additionalProperties: false` です。上記以外のキーは追加しません。
47
+
48
+ ## 4. interfaces(外部連携)
49
+
50
+ 1要素が「1つの外部連携(IF)」を表します。
51
+
52
+ | キー | 説明 | 必須 |
53
+ | -------------- | ---------------------------------------------------------------------------------------- | ---- |
54
+ | name | 連携名(短い日本語) | ○ |
55
+ | source | 連携元(システム/コンテナ/コンポーネントなど) | ○ |
56
+ | target | 連携先(外部システムの一般名) | ○ |
57
+ | direction | `source_to_target` / `target_to_source` / `bidirectional` | ○ |
58
+ | kind | `API` / `ファイル` / `メッセージ` / `コマンド` | ○ |
59
+ | format | `CSV` / `JSON` / `XML` / `その他` / `TBD` | ○ |
60
+ | timing | 連携タイミング(例: 発注確定時、日次集計後) | ○ |
61
+ | error_handling | エラー処理・備考(簡潔に) | 任意 |
62
+ | spec_ref | 詳細仕様ID(`ifx-api-...` / `ifx-file-...` / `ifx-msg-...` / `ifx-cmd-...`)または `TBD` | 任意 |
63
+
64
+ ## 5. サンプル(YAML)
65
+
66
+ ```yaml
67
+ id: ifx-main
68
+ type: api
69
+ title: 外部システムIF一覧(main)
70
+ status: draft
71
+ supersedes: []
72
+
73
+ interfaces:
74
+ - name: 発注データ送信
75
+ source: 受発注管理(コンテナ)
76
+ target: 仕入先システム
77
+ direction: source_to_target
78
+ kind: ファイル
79
+ format: CSV
80
+ timing: 発注確定時
81
+ error_handling: 異常時は再送・管理者通知
82
+
83
+ spec_ref: ifx-file-orders
84
+
85
+ - name: 決済依頼/結果
86
+ source: 決済(コンテナ)
87
+ target: 決済サービス
88
+ direction: bidirectional
89
+ kind: API
90
+ format: JSON
91
+ timing: 決済時
92
+ error_handling: 失敗時はリトライ/保留
93
+ spec_ref: ifx-api-payment
94
+ ```
@@ -0,0 +1,81 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:ifx-msg-rulebook
4
+ type: rulebook
5
+ status: draft
6
+ target_format: yaml
7
+ recipe: not-needed
8
+ sample: specdojo:ifx-msg-sample
9
+ template: not-needed
10
+ ---
11
+
12
+ # 外部メッセージ仕様(External Message Specification: EMS)作成ルール
13
+
14
+ 外部システム(物流、決済、会計など)との非同期連携のために、**メッセージング仕様**を定義します。
15
+
16
+ EMS は ESIL(外部システムIF一覧)から参照される「詳細仕様」です。
17
+ ESIL 側の `spec_ref: ifx-msg-...` は、このEMSのID(およびファイル名)と対応させます。
18
+
19
+ この章では **表ではなく YAML 1ファイル**で EMS を管理します。
20
+ フォーマットは **AsyncAPI + CloudEvents**(YAML)を正とします。
21
+
22
+ ## 1. ファイル規約
23
+
24
+ - ファイル名: `ifx-msg-<短い英小文字ハイフン>.yaml`
25
+ - ESILからの参照: `spec_ref: ifx-msg-...`(例: `ifx-msg-stock-changed`)
26
+ - 1ファイル = 1つのメッセージング仕様(1つのイベント群/チャネル群)
27
+
28
+ ## 2. バージョン
29
+
30
+ - **AsyncAPI 2.6.0**(推奨)を第一候補とする(ツール互換性が高いため)
31
+ - CloudEvents は **1.0** を前提とする
32
+
33
+ ## 3. 記載方針(必須)
34
+
35
+ - **外部との合意に必要な最小十分**を記載する(内部実装の都合は書かない)
36
+ - メッセージのエンベロープは **CloudEvents** とし、イベント属性を明示する
37
+ - チャネル(topic/queue)や方向(publish/subscribe)を明確にする
38
+ - payload(`data`)のスキーマは `components/schemas` に集約し、参照で使い回す
39
+ - **メタ情報は `x-spec-meta` に集約**し、トレーサビリティを確保する
40
+
41
+ 禁止(書かない):
42
+
43
+ - DB物理テーブル名・物理カラム名・SQL全文
44
+ - 実装クラス/関数名・内部モジュール構成
45
+ - UI操作の逐語列挙
46
+
47
+ ## 4. 必須構造(AsyncAPI YAML)
48
+
49
+ 最低限、以下を必ず含めます。
50
+
51
+ - `asyncapi`
52
+ - `info`(`title`, `version` を含む)
53
+
54
+ - `x-spec-meta`(`id`, `type`, `status` を含む)
55
+ - `channels`(少なくとも1つ)
56
+ - `components/messages`(少なくとも1つ)
57
+
58
+ ## 4.1 メタ情報(x-spec-meta)
59
+
60
+ 仕様のトレーサビリティ管理のため、以下を `x-spec-meta` に含めます。
61
+
62
+ | キー | 説明 | 必須 |
63
+ | -------- | ----------------------------------------------------------- | ---- |
64
+ | id | メッセージ仕様ID(`ifx-msg-...`)、ESILの `spec_ref` と対応 | ○ |
65
+ | type | `message` 固定 | ○ |
66
+ | status | `draft` / `ready` / `deprecated` | ○ |
67
+ | based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
68
+
69
+ ## 5. CloudEventsルール(必須)
70
+
71
+ CloudEventsの「属性」は仕様で名前が固定です(snake_caseに変換しません)。最低限、以下を含めます。
72
+
73
+ - `specversion`: `"1.0"`
74
+ - `type`: イベント種別(例: `com.kinuya.stock.changed.v1`)
75
+ - `source`: イベント発生元(URI形式推奨、例: `"/inventory"`)
76
+ - `id`: イベントID(重複しない)
77
+ - `time`: 発生時刻(RFC3339)
78
+ - `datacontenttype`: `application/json`
79
+ - `subject`: 任意(推奨。対象を識別できる文字列)
80
+
81
+ - `data`: 業務ペイロード(この中のプロパティ名は snake_case 推奨)
@@ -0,0 +1,117 @@
1
+ ---
2
+ specdojo:
3
+ id: specdojo:imp-business-rulebook
4
+ type: rulebook
5
+ status: draft
6
+ recipe: undecided
7
+ sample: specdojo:imp-business-sample
8
+ template: undecided
9
+ ---
10
+
11
+ # 影響調査(業務)作成ルール
12
+
13
+ Impact Analysis (Business) Rulebook
14
+
15
+ 本ドキュメントは、変更要求が業務へ与える影響を整理するための「影響調査(業務)」の記述ルールを定義します。プロジェクト関係者が変更要否・影響度・対応方針・未解決事項を同じ粒度で判断できる状態を目標とします。
16
+
17
+ ## 1. 全体方針
18
+
19
+ - 対象は「変更要求による業務影響の把握と判断」であり、実装設計の詳細化は扱わない。
20
+ - 記載粒度は「業務担当者とプロジェクト管理者が合意形成できるレベル」とし、影響の有無だけでなく、判断根拠を簡潔に残す。
21
+ - 1 ドキュメントで複数の業務領域を扱ってよいが、影響詳細は業務単位で分割して管理する。
22
+ - プロセス仕様、データ仕様、テスト仕様への波及がある場合は、本書で概要と判断を記載し、詳細は各ドキュメントへ委譲する。
23
+
24
+ ## 2. 位置づけと用語定義(必要に応じて)
25
+
26
+ | 用語 | 定義 |
27
+ | ------------ | ------------------------------------------------------------------ |
28
+ | 変更要求 | プロダクトまたは運用に対する変更の要望。起票済みの要求や課題を含む |
29
+ | 影響対象業務 | 変更要求の影響を受ける業務プロセス、業務ルール、運用手順 |
30
+ | 変更要否 | 影響対象に対して変更が必要かどうかの判定 |
31
+ | 影響度 | 影響の強さ。業務継続性、手戻り、利用者影響を踏まえて評価する |
32
+ | 対応方針 | 影響に対して採用する対処方針(実施、代替、見送りなど) |
33
+ | 未解決事項 | 判断や実施に必要な情報が不足している課題 |
34
+
35
+ ## 3. ファイル命名・ID規則
36
+
37
+ - 対象ドキュメント ID は `imp-business` とする。
38
+ - 対象ドキュメントの推奨ファイル名は `imp-business.md` とする。
39
+ - `id` は [id-and-file-naming-standard.md](../standards/id-and-file-naming-standard.md) の規則に従い、英小文字・数字・ハイフンで構成する。
40
+ - 関連する追補文書を分割する場合は `imp-business-<term>` 形式を用いる。
41
+
42
+ ## 4. 推奨 Frontmatter 項目
43
+
44
+ 影響調査(業務)ドキュメントでは、[document-metadata-standard.md](../standards/document-metadata-standard.md) に準拠し、以下を推奨する。
45
+
46
+ | 項目 | 説明 | 必須 |
47
+ | ---------- | ------------------------------------- | ---- |
48
+ | id | ドキュメント ID(例: `imp-business`) | ○ |
49
+ | type | `project` | ○ |
50
+ | status | `draft` / `ready` / `deprecated` | ○ |
51
+ | rulebook | `specdojo:imp-business-rulebook` 固定 | ○ |
52
+ | part_of | 一覧/親ドキュメントへの所属 ID 配列 | 任意 |
53
+ | based_on | 変更要求や根拠資料の ID 配列 | 任意 |
54
+ | supersedes | 置き換え対象ドキュメント ID 配列 | 任意 |
55
+
56
+ ## 5. 本文構成(標準テンプレ)
57
+
58
+ 影響調査(業務)の本文は、以下の構成を標準とする。
59
+
60
+ | 章 | 見出し | 必須 | 目的 |
61
+ | --- | -------------- | ---- | -------------------------------------------- |
62
+ | 1 | 目的と適用範囲 | ○ | 対象と判断対象範囲を明確化する |
63
+ | 2 | 変更要求の概要 | ○ | 変更背景と要求内容を要約する |
64
+ | 3 | 影響分析サマリ | ○ | 影響の全体像と優先順位を俯瞰する |
65
+ | 4 | 影響詳細一覧 | ○ | 影響対象業務ごとの変更要否・影響度を記録する |
66
+ | 5 | 対応方針 | ○ | 採用方針、実施条件、担当と期限を整理する |
67
+ | 6 | 未解決事項 | ○ | 意思決定待ちや調査不足を明示する |
68
+
69
+ ## 6. 記述ガイド
70
+
71
+ ### 6.1. 目的と適用範囲
72
+
73
+ - 対象変更要求の識別子、対象業務領域、対象期間を明記する。
74
+ - 「何を判断する文書か」を 2〜4 行で示す。
75
+
76
+ ### 6.2. 変更要求の概要
77
+
78
+ - 変更の背景、狙い、成功条件を簡潔に記述する。
79
+ - 要求詳細は原文を転記せず、判断に必要な要点のみを要約する。
80
+
81
+ ### 6.3. 影響分析サマリ
82
+
83
+ - 高・中・低の影響度で件数を整理し、優先対応対象を明記する。
84
+ - サマリで使用した評価観点(例: 利用者影響、法令・契約影響、運用影響)を先に示す。
85
+
86
+ ### 6.4. 影響詳細一覧
87
+
88
+ - 影響詳細は表形式で記載し、最低限次のカラムを含める。
89
+
90
+ | カラム | 内容 |
91
+ | ------------ | ------------------------------------ |
92
+ | 影響対象業務 | 影響を受ける業務名または業務プロセス |
93
+ | 変更要否 | `要` / `否` |
94
+
95
+ | 影響度 | `高` / `中` / `低` |
96
+ | 対応方針 | 実施・代替・見送りなどの方針 |
97
+ | 判断根拠 | 判定理由の要点 |
98
+ | 備考 | 制約、前提、関連ドキュメント |
99
+
100
+ ### 6.5. 対応方針
101
+
102
+ - 重要度が高い項目から順に、実施時期、担当、前提条件を記載する。
103
+ - 見送りの場合は、再評価条件と時期を必ず記載する。
104
+
105
+ ### 6.6. 未解決事項
106
+
107
+ - 各項目に「論点」「不足情報」「決定期限」「担当」を記載する。
108
+ - 未解決事項は放置せず、次回レビューでの処理方針を記録する。
109
+
110
+ ## 7. 禁止事項
111
+
112
+ - 実装詳細(SQL 全文、クラス名、API リクエスト構造)を記載しない。
113
+ - 「影響あり」「要対応」のみで根拠を記載しない。
114
+
115
+ - 影響度の尺度を定義せずに高・中・低を混在させない。
116
+ - 未解決事項に期限や担当を設定せずに放置しない。
117
+ - 他ドキュメントの本文を重複転記し、参照元との不整合を生む記述をしない。