@educa-corp/sdd-framework 0.1.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 (382) hide show
  1. package/bin/build.js +230 -0
  2. package/bin/index.js +609 -0
  3. package/commands/debug.md +835 -0
  4. package/commands/debug.tmpl +257 -0
  5. package/commands/define-product.md +746 -0
  6. package/commands/define-product.tmpl +191 -0
  7. package/commands/dev-gen-test.md +1015 -0
  8. package/commands/dev-gen-test.tmpl +490 -0
  9. package/commands/dev-run-test.md +749 -0
  10. package/commands/dev-run-test.tmpl +224 -0
  11. package/commands/dev-smoke-test.md +716 -0
  12. package/commands/dev-smoke-test.tmpl +217 -0
  13. package/commands/fix-bug.md +749 -0
  14. package/commands/fix-bug.tmpl +171 -0
  15. package/commands/generate-bdd.md +1144 -0
  16. package/commands/generate-bdd.tmpl +499 -0
  17. package/commands/generate-code.md +1038 -0
  18. package/commands/generate-code.tmpl +513 -0
  19. package/commands/generate-design-spec.md +1079 -0
  20. package/commands/generate-design-spec.tmpl +524 -0
  21. package/commands/generate-prd.md +945 -0
  22. package/commands/generate-prd.tmpl +166 -0
  23. package/commands/generate-spec-manifest.md +663 -0
  24. package/commands/generate-spec-manifest.tmpl +164 -0
  25. package/commands/generate-tech-docs.md +1249 -0
  26. package/commands/generate-tech-docs.tmpl +252 -0
  27. package/commands/learn.md +641 -0
  28. package/commands/learn.tmpl +63 -0
  29. package/commands/map-testids.md +580 -0
  30. package/commands/map-testids.tmpl +81 -0
  31. package/commands/propose-scenario.md +632 -0
  32. package/commands/propose-scenario.tmpl +133 -0
  33. package/commands/qc-analyze.md +611 -0
  34. package/commands/qc-analyze.tmpl +112 -0
  35. package/commands/qc-design-test.md +567 -0
  36. package/commands/qc-design-test.tmpl +68 -0
  37. package/commands/qc-plan.md +548 -0
  38. package/commands/qc-plan.tmpl +49 -0
  39. package/commands/qc-report.md +559 -0
  40. package/commands/qc-report.tmpl +60 -0
  41. package/commands/qc-review.md +552 -0
  42. package/commands/qc-review.tmpl +53 -0
  43. package/commands/qc-run-test.md +609 -0
  44. package/commands/qc-run-test.tmpl +84 -0
  45. package/commands/refine-prd.md +992 -0
  46. package/commands/refine-prd.tmpl +278 -0
  47. package/commands/report-bug.md +647 -0
  48. package/commands/report-bug.tmpl +148 -0
  49. package/commands/review-code.md +682 -0
  50. package/commands/review-code.tmpl +104 -0
  51. package/commands/review-context.md +1202 -0
  52. package/commands/review-context.tmpl +488 -0
  53. package/commands/review-tech-docs.md +871 -0
  54. package/commands/review-tech-docs.tmpl +372 -0
  55. package/commands/setup-ai-first.md +546 -0
  56. package/commands/setup-ai-first.tmpl +358 -0
  57. package/commands/sync.md +451 -0
  58. package/commands/sync.tmpl +351 -0
  59. package/commands/update-framework.md +251 -0
  60. package/commands/update-framework.tmpl +151 -0
  61. package/commands/validate-traces.md +928 -0
  62. package/commands/validate-traces.tmpl +429 -0
  63. package/core/FRAMEWORK_VERSION +1 -0
  64. package/core/commands/debug.md +835 -0
  65. package/core/commands/define-product.md +746 -0
  66. package/core/commands/dev-gen-test.md +1015 -0
  67. package/core/commands/dev-run-test.md +749 -0
  68. package/core/commands/dev-smoke-test.md +716 -0
  69. package/core/commands/fix-bug.md +749 -0
  70. package/core/commands/generate-bdd.md +1144 -0
  71. package/core/commands/generate-code.md +1038 -0
  72. package/core/commands/generate-design-spec.md +1079 -0
  73. package/core/commands/generate-prd.md +945 -0
  74. package/core/commands/generate-spec-manifest.md +663 -0
  75. package/core/commands/generate-tech-docs.md +1249 -0
  76. package/core/commands/learn.md +641 -0
  77. package/core/commands/map-testids.md +580 -0
  78. package/core/commands/propose-scenario.md +632 -0
  79. package/core/commands/qc-analyze.md +611 -0
  80. package/core/commands/qc-design-test.md +567 -0
  81. package/core/commands/qc-plan.md +548 -0
  82. package/core/commands/qc-report.md +559 -0
  83. package/core/commands/qc-review.md +552 -0
  84. package/core/commands/qc-run-test.md +609 -0
  85. package/core/commands/refine-prd.md +992 -0
  86. package/core/commands/report-bug.md +647 -0
  87. package/core/commands/review-code.md +682 -0
  88. package/core/commands/review-context.md +1202 -0
  89. package/core/commands/review-tech-docs.md +871 -0
  90. package/core/commands/setup-ai-first.md +546 -0
  91. package/core/commands/sync.md +451 -0
  92. package/core/commands/update-framework.md +251 -0
  93. package/core/commands/validate-traces.md +928 -0
  94. package/core/hooks/data-guard.js +141 -0
  95. package/core/hooks/settings.json +18 -0
  96. package/core/modules/android-compose/module.yaml +13 -0
  97. package/core/modules/android-compose/stack-profile.yaml +57 -0
  98. package/core/modules/angular/architecture-snippets/component-patterns.md +187 -0
  99. package/core/modules/angular/module.yaml +6 -0
  100. package/core/modules/angular/stack-profile.yaml +38 -0
  101. package/core/modules/context-engineering/architecture-snippets/context-design.md +119 -0
  102. package/core/modules/context-engineering/module.yaml +9 -0
  103. package/core/modules/context-engineering/stack-profile.yaml +61 -0
  104. package/core/modules/dotnet/architecture-snippets/clean-arch.md +160 -0
  105. package/core/modules/dotnet/module.yaml +6 -0
  106. package/core/modules/dotnet/stack-profile.yaml +50 -0
  107. package/core/modules/flutter/module.yaml +14 -0
  108. package/core/modules/flutter/stack-profile.yaml +59 -0
  109. package/core/modules/golang/architecture-snippets/domain-layout.md +283 -0
  110. package/core/modules/golang/module.yaml +6 -0
  111. package/core/modules/golang/stack-profile.yaml +40 -0
  112. package/core/modules/ios-swiftui/module.yaml +13 -0
  113. package/core/modules/ios-swiftui/stack-profile.yaml +55 -0
  114. package/core/modules/java-spring/architecture-snippets/layered-arch.md +201 -0
  115. package/core/modules/java-spring/module.yaml +15 -0
  116. package/core/modules/java-spring/stack-profile.yaml +28 -0
  117. package/core/modules/nextjs/architecture-snippets/app-router-patterns.md +269 -0
  118. package/core/modules/nextjs/module.yaml +14 -0
  119. package/core/modules/nextjs/stack-profile.yaml +74 -0
  120. package/core/modules/nuxt/module.yaml +14 -0
  121. package/core/modules/nuxt/stack-profile.yaml +58 -0
  122. package/core/modules/php-laravel/architecture-snippets/service-repository.md +302 -0
  123. package/core/modules/php-laravel/module.yaml +15 -0
  124. package/core/modules/php-laravel/stack-profile.yaml +56 -0
  125. package/core/modules/qc-playwright/stack-profile.yaml +66 -0
  126. package/core/modules/react/architecture-snippets/hooks-query-patterns.md +254 -0
  127. package/core/modules/react/module.yaml +14 -0
  128. package/core/modules/react/stack-profile.yaml +63 -0
  129. package/core/modules/react-native/module.yaml +14 -0
  130. package/core/modules/react-native/stack-profile.yaml +56 -0
  131. package/core/modules/vue/module.yaml +14 -0
  132. package/core/modules/vue/stack-profile.yaml +65 -0
  133. package/core/rules/data-protection.md +80 -0
  134. package/core/rules/workflow.md +44 -0
  135. package/core/skills/code/SKILL.md +19 -0
  136. package/core/skills/debug/SKILL.md +19 -0
  137. package/core/skills/design-spec/SKILL.md +11 -0
  138. package/core/skills/discovery/SKILL.md +14 -0
  139. package/core/skills/prd/SKILL.md +19 -0
  140. package/core/skills/qc/qa-analyst/DOC_GAPS.template.md +63 -0
  141. package/core/skills/qc/qa-analyst/acceptance-criteria.md +60 -0
  142. package/core/skills/qc/qa-analyst/business-rules.md +59 -0
  143. package/core/skills/qc/qa-analyst/data-flow.md +64 -0
  144. package/core/skills/qc/qa-analyst/spec-breakdown.md +61 -0
  145. package/core/skills/qc/qa-designer/e2e/journey.md +41 -0
  146. package/core/skills/qc/qa-designer/exploratory/charter.md +68 -0
  147. package/core/skills/qc/qa-designer/exploratory/explore-to-functional.md +43 -0
  148. package/core/skills/qc/qa-designer/functional/api.md +45 -0
  149. package/core/skills/qc/qa-designer/functional/gui-feature.md +46 -0
  150. package/core/skills/qc/qa-designer/functional/gui-screen.md +52 -0
  151. package/core/skills/qc/qa-designer/integration/api.md +42 -0
  152. package/core/skills/qc/qa-designer/integration/db.md +39 -0
  153. package/core/skills/qc/qa-designer/integration/gui.md +40 -0
  154. package/core/skills/qc/qa-designer/integration/kafka.md +40 -0
  155. package/core/skills/qc/qa-designer/non-functional.md +40 -0
  156. package/core/skills/qc/qa-planner/test-plan.md +120 -0
  157. package/core/skills/qc/qa-reviewer/script/e2e.md +87 -0
  158. package/core/skills/qc/qa-reviewer/script/exploratory.md +45 -0
  159. package/core/skills/qc/qa-reviewer/script/functional.md +101 -0
  160. package/core/skills/qc/qa-reviewer/script/integration.md +91 -0
  161. package/core/skills/qc/qa-reviewer/script/non-functional.md +126 -0
  162. package/core/skills/qc/qa-reviewer/test-case/e2e.md +73 -0
  163. package/core/skills/qc/qa-reviewer/test-case/exploratory.md +43 -0
  164. package/core/skills/qc/qa-reviewer/test-case/functional.md +76 -0
  165. package/core/skills/qc/qa-reviewer/test-case/integration.md +69 -0
  166. package/core/skills/qc/qa-reviewer/test-case/non-functional.md +73 -0
  167. package/core/skills/qc/qa-runner/e2e.md +49 -0
  168. package/core/skills/qc/qa-runner/exploratory/session.md +36 -0
  169. package/core/skills/qc/qa-runner/functional/api.md +35 -0
  170. package/core/skills/qc/qa-runner/functional/gui-feature.md +51 -0
  171. package/core/skills/qc/qa-runner/functional/gui-screen.md +55 -0
  172. package/core/skills/qc/qa-runner/integration.md +47 -0
  173. package/core/skills/qc/qa-runner/non-functional.md +49 -0
  174. package/core/skills/qc/qa-runner/report/report.md +37 -0
  175. package/core/skills/setup-ai-first/SKILL.md +11 -0
  176. package/core/skills/spec/SKILL.md +19 -0
  177. package/core/skills/test/SKILL.md +18 -0
  178. package/core/steps/business-language.md +56 -0
  179. package/core/steps/capture-lesson.md +79 -0
  180. package/core/steps/context-loader.md +311 -0
  181. package/core/steps/gate.md +88 -0
  182. package/core/steps/report-footer.md +100 -0
  183. package/core/steps/review-fanout.md +159 -0
  184. package/core/steps/spawn-agent.md +129 -0
  185. package/core/steps/trace-mirror.md +26 -0
  186. package/core/templates/architecture.template.md +113 -0
  187. package/core/templates/design-spec.template.md +217 -0
  188. package/core/templates/feature.template +120 -0
  189. package/core/templates/platform-guide.template.md +145 -0
  190. package/core/templates/prd.template.md +224 -0
  191. package/core/templates/product-definition.template.md +188 -0
  192. package/core/templates/project-context.yaml +161 -0
  193. package/core/templates/tech-design.template.md +498 -0
  194. package/docs/01-getting-started/README.md +19 -0
  195. package/docs/01-getting-started/core-concepts.md +102 -0
  196. package/docs/01-getting-started/installation.md +156 -0
  197. package/docs/01-getting-started/quickstart.md +86 -0
  198. package/docs/02-guides/README.md +26 -0
  199. package/docs/02-guides/bdd-input-checklist.md +68 -0
  200. package/docs/02-guides/developer/README.md +49 -0
  201. package/docs/02-guides/developer/bdd-and-trace.md +126 -0
  202. package/docs/02-guides/developer/commands.md +76 -0
  203. package/docs/02-guides/developer/pr-checklist.md +16 -0
  204. package/docs/02-guides/developer/scenarios.md +460 -0
  205. package/docs/02-guides/developer/workflow.md +121 -0
  206. package/docs/02-guides/prd-input-checklist.md +94 -0
  207. package/docs/02-guides/product-owner/README.md +81 -0
  208. package/docs/02-guides/product-owner/commands.md +30 -0
  209. package/docs/02-guides/product-owner/handoff-checklist.md +42 -0
  210. package/docs/02-guides/product-owner/prd-writing-rules.md +45 -0
  211. package/docs/02-guides/product-owner/scenarios.md +438 -0
  212. package/docs/02-guides/tech-docs-input-checklist.md +109 -0
  213. package/docs/02-guides/tester/README.md +75 -0
  214. package/docs/02-guides/tester/bug-reporting.md +117 -0
  215. package/docs/02-guides/tester/qc-automation.md +165 -0
  216. package/docs/02-guides/tester/reading-specs.md +79 -0
  217. package/docs/02-guides/tester/scenarios.md +186 -0
  218. package/docs/02-guides/tester/spec-manifest.md +130 -0
  219. package/docs/02-guides/tester/test-checklist.md +31 -0
  220. package/docs/02-guides/tester/workflow.md +77 -0
  221. package/docs/03-concepts/README.md +20 -0
  222. package/docs/03-concepts/architecture.md +248 -0
  223. package/docs/03-concepts/mechanisms-explained.md +124 -0
  224. package/docs/03-concepts/pipeline.md +278 -0
  225. package/docs/03-concepts/traceability.md +152 -0
  226. package/docs/04-operations/README.md +33 -0
  227. package/docs/04-operations/bug-flow.md +364 -0
  228. package/docs/04-operations/publishing.md +154 -0
  229. package/docs/04-operations/sync-and-update.md +522 -0
  230. package/docs/05-reference/README.md +34 -0
  231. package/docs/05-reference/command-cheatsheet.md +147 -0
  232. package/docs/05-reference/commands.md +234 -0
  233. package/docs/05-reference/model-selection.md +74 -0
  234. package/docs/05-reference/modules.md +110 -0
  235. package/docs/05-reference/trace-schema.md +154 -0
  236. package/docs/06-commands/README.md +75 -0
  237. package/docs/06-commands/explain-debug.md +32 -0
  238. package/docs/06-commands/explain-define-product.md +43 -0
  239. package/docs/06-commands/explain-dev-gen-test.md +28 -0
  240. package/docs/06-commands/explain-dev-run-test.md +24 -0
  241. package/docs/06-commands/explain-dev-smoke-test.md +25 -0
  242. package/docs/06-commands/explain-fix-bug.md +28 -0
  243. package/docs/06-commands/explain-generate-bdd.md +45 -0
  244. package/docs/06-commands/explain-generate-code.md +53 -0
  245. package/docs/06-commands/explain-generate-design-spec.md +54 -0
  246. package/docs/06-commands/explain-generate-prd.md +45 -0
  247. package/docs/06-commands/explain-generate-spec-manifest.md +20 -0
  248. package/docs/06-commands/explain-generate-tech-docs.md +56 -0
  249. package/docs/06-commands/explain-learn.md +21 -0
  250. package/docs/06-commands/explain-map-testids.md +28 -0
  251. package/docs/06-commands/explain-propose-scenario.md +24 -0
  252. package/docs/06-commands/explain-qc-analyze.md +22 -0
  253. package/docs/06-commands/explain-qc-design-test.md +20 -0
  254. package/docs/06-commands/explain-qc-plan.md +21 -0
  255. package/docs/06-commands/explain-qc-report.md +23 -0
  256. package/docs/06-commands/explain-qc-review.md +24 -0
  257. package/docs/06-commands/explain-qc-run-test.md +27 -0
  258. package/docs/06-commands/explain-refine-prd.md +51 -0
  259. package/docs/06-commands/explain-report-bug.md +24 -0
  260. package/docs/06-commands/explain-review-code.md +45 -0
  261. package/docs/06-commands/explain-review-context.md +68 -0
  262. package/docs/06-commands/explain-review-tech-docs.md +45 -0
  263. package/docs/06-commands/explain-setup-ai-first.md +25 -0
  264. package/docs/06-commands/explain-sync.md +24 -0
  265. package/docs/06-commands/explain-update-framework.md +22 -0
  266. package/docs/06-commands/explain-validate-traces.md +25 -0
  267. package/docs/README.md +53 -0
  268. package/docs/t-sample.md +826 -0
  269. package/hooks/data-guard.js +141 -0
  270. package/hooks/settings.json +18 -0
  271. package/modules/android-compose/module.yaml +13 -0
  272. package/modules/android-compose/stack-profile.yaml +57 -0
  273. package/modules/angular/architecture-snippets/component-patterns.md +187 -0
  274. package/modules/angular/module.yaml +6 -0
  275. package/modules/angular/stack-profile.yaml +38 -0
  276. package/modules/context-engineering/architecture-snippets/context-design.md +119 -0
  277. package/modules/context-engineering/module.yaml +9 -0
  278. package/modules/context-engineering/stack-profile.yaml +61 -0
  279. package/modules/dotnet/architecture-snippets/clean-arch.md +160 -0
  280. package/modules/dotnet/module.yaml +6 -0
  281. package/modules/dotnet/stack-profile.yaml +50 -0
  282. package/modules/flutter/module.yaml +14 -0
  283. package/modules/flutter/stack-profile.yaml +59 -0
  284. package/modules/golang/architecture-snippets/domain-layout.md +283 -0
  285. package/modules/golang/module.yaml +6 -0
  286. package/modules/golang/stack-profile.yaml +40 -0
  287. package/modules/ios-swiftui/module.yaml +13 -0
  288. package/modules/ios-swiftui/stack-profile.yaml +55 -0
  289. package/modules/java-spring/architecture-snippets/layered-arch.md +201 -0
  290. package/modules/java-spring/module.yaml +15 -0
  291. package/modules/java-spring/stack-profile.yaml +28 -0
  292. package/modules/nextjs/architecture-snippets/app-router-patterns.md +269 -0
  293. package/modules/nextjs/module.yaml +14 -0
  294. package/modules/nextjs/stack-profile.yaml +74 -0
  295. package/modules/nuxt/module.yaml +14 -0
  296. package/modules/nuxt/stack-profile.yaml +58 -0
  297. package/modules/php-laravel/architecture-snippets/service-repository.md +302 -0
  298. package/modules/php-laravel/module.yaml +15 -0
  299. package/modules/php-laravel/stack-profile.yaml +56 -0
  300. package/modules/qc-playwright/stack-profile.yaml +66 -0
  301. package/modules/react/architecture-snippets/hooks-query-patterns.md +254 -0
  302. package/modules/react/module.yaml +14 -0
  303. package/modules/react/stack-profile.yaml +63 -0
  304. package/modules/react-native/module.yaml +14 -0
  305. package/modules/react-native/stack-profile.yaml +56 -0
  306. package/modules/vue/module.yaml +14 -0
  307. package/modules/vue/stack-profile.yaml +65 -0
  308. package/package.json +49 -0
  309. package/readme.txt +1 -0
  310. package/rules/data-protection.md +80 -0
  311. package/rules/workflow.md +44 -0
  312. package/scripts/init.sh +49 -0
  313. package/scripts/migrate-specs.js +258 -0
  314. package/scripts/rename-prd-files.js +174 -0
  315. package/scripts/upgrade.sh +94 -0
  316. package/skills/code/SKILL.md +19 -0
  317. package/skills/code/SKILL.tmpl +19 -0
  318. package/skills/debug/SKILL.md +19 -0
  319. package/skills/debug/SKILL.tmpl +19 -0
  320. package/skills/design-spec/SKILL.md +11 -0
  321. package/skills/design-spec/SKILL.tmpl +11 -0
  322. package/skills/discovery/SKILL.md +14 -0
  323. package/skills/discovery/SKILL.tmpl +14 -0
  324. package/skills/prd/SKILL.md +19 -0
  325. package/skills/prd/SKILL.tmpl +19 -0
  326. package/skills/qc/qa-analyst/DOC_GAPS.template.md +63 -0
  327. package/skills/qc/qa-analyst/acceptance-criteria.md +60 -0
  328. package/skills/qc/qa-analyst/business-rules.md +59 -0
  329. package/skills/qc/qa-analyst/data-flow.md +64 -0
  330. package/skills/qc/qa-analyst/spec-breakdown.md +61 -0
  331. package/skills/qc/qa-designer/e2e/journey.md +41 -0
  332. package/skills/qc/qa-designer/exploratory/charter.md +68 -0
  333. package/skills/qc/qa-designer/exploratory/explore-to-functional.md +43 -0
  334. package/skills/qc/qa-designer/functional/api.md +45 -0
  335. package/skills/qc/qa-designer/functional/gui-feature.md +46 -0
  336. package/skills/qc/qa-designer/functional/gui-screen.md +52 -0
  337. package/skills/qc/qa-designer/integration/api.md +42 -0
  338. package/skills/qc/qa-designer/integration/db.md +39 -0
  339. package/skills/qc/qa-designer/integration/gui.md +40 -0
  340. package/skills/qc/qa-designer/integration/kafka.md +40 -0
  341. package/skills/qc/qa-designer/non-functional.md +40 -0
  342. package/skills/qc/qa-planner/test-plan.md +120 -0
  343. package/skills/qc/qa-reviewer/script/e2e.md +87 -0
  344. package/skills/qc/qa-reviewer/script/exploratory.md +45 -0
  345. package/skills/qc/qa-reviewer/script/functional.md +101 -0
  346. package/skills/qc/qa-reviewer/script/integration.md +91 -0
  347. package/skills/qc/qa-reviewer/script/non-functional.md +126 -0
  348. package/skills/qc/qa-reviewer/test-case/e2e.md +73 -0
  349. package/skills/qc/qa-reviewer/test-case/exploratory.md +43 -0
  350. package/skills/qc/qa-reviewer/test-case/functional.md +76 -0
  351. package/skills/qc/qa-reviewer/test-case/integration.md +69 -0
  352. package/skills/qc/qa-reviewer/test-case/non-functional.md +73 -0
  353. package/skills/qc/qa-runner/e2e.md +49 -0
  354. package/skills/qc/qa-runner/exploratory/session.md +36 -0
  355. package/skills/qc/qa-runner/functional/api.md +35 -0
  356. package/skills/qc/qa-runner/functional/gui-feature.md +51 -0
  357. package/skills/qc/qa-runner/functional/gui-screen.md +55 -0
  358. package/skills/qc/qa-runner/integration.md +47 -0
  359. package/skills/qc/qa-runner/non-functional.md +49 -0
  360. package/skills/qc/qa-runner/report/report.md +37 -0
  361. package/skills/setup-ai-first/SKILL.md +11 -0
  362. package/skills/setup-ai-first/SKILL.tmpl +11 -0
  363. package/skills/spec/SKILL.md +19 -0
  364. package/skills/spec/SKILL.tmpl +19 -0
  365. package/skills/test/SKILL.md +18 -0
  366. package/skills/test/SKILL.tmpl +18 -0
  367. package/steps/business-language.md +56 -0
  368. package/steps/capture-lesson.md +79 -0
  369. package/steps/context-loader.md +311 -0
  370. package/steps/gate.md +88 -0
  371. package/steps/report-footer.md +100 -0
  372. package/steps/review-fanout.md +159 -0
  373. package/steps/spawn-agent.md +129 -0
  374. package/steps/trace-mirror.md +26 -0
  375. package/templates/architecture.template.md +113 -0
  376. package/templates/design-spec.template.md +217 -0
  377. package/templates/feature.template +120 -0
  378. package/templates/platform-guide.template.md +145 -0
  379. package/templates/prd.template.md +224 -0
  380. package/templates/product-definition.template.md +188 -0
  381. package/templates/project-context.yaml +161 -0
  382. package/templates/tech-design.template.md +498 -0
@@ -0,0 +1,1079 @@
1
+ # /generate-design-spec — Sinh Design Specification (FE / App)
2
+
3
+ ## Gate
4
+ # Gate — Quy trình vào chuẩn cho mọi lệnh
5
+
6
+ Mọi lệnh PHẢI chạy gate này trước khi thực thi phần logic riêng của nó.
7
+
8
+ ## Bước 0 — Kiểm tra chế độ Sub-Agent
9
+
10
+ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
11
+
12
+ 1. Thử parse `$ARGUMENTS` dưới dạng JSON.
13
+ 2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
14
+ - **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
15
+ - Đặt target file = `payload.target_file`
16
+ - Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
17
+ - Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
18
+ - Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
19
+ - Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
20
+ - Đi thẳng tới phần logic riêng của lệnh.
21
+ 3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
22
+
23
+ ## Bước 0-B — Kiểm tra Model
24
+
25
+ *Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
26
+
27
+ Các lệnh sinh nội dung và review phức tạp đòi hỏi khả năng suy luận mạnh.
28
+ Dùng model nhỏ hơn sẽ rủi ro: bỏ sót edge case, phân tích spec thiếu sót, vi phạm kiến trúc.
29
+
30
+ Hiển thị và chờ phản hồi:
31
+
32
+ ```
33
+ ⚙️ MODEL CHECK
34
+ ──────────────────────────────────────────────────────────────────
35
+ Recommended : claude-opus-4 (hoặc model Opus mới nhất)
36
+ Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
37
+ suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
38
+
39
+ Cách đổi trong Claude Code:
40
+ • Settings → Model → chọn "claude-opus"
41
+ • hoặc: /model → chọn claude-opus
42
+
43
+ Đang chạy claude-opus?
44
+ Y — đúng, đang dùng claude-opus → tiếp tục
45
+ S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
46
+ ──────────────────────────────────────────────────────────────────
47
+ ```
48
+
49
+ - "Y" → tiếp tục sang Bước 1.
50
+ - "S" → tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
51
+ - "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang claude-opus rồi chạy lại lệnh này."
52
+
53
+ ## Bước 1 — Xác định Target File
54
+
55
+ 1. Nếu `$ARGUMENTS` được cung cấp và trỏ tới một file tồn tại → dùng trực tiếp làm target.
56
+ 2. Nếu `$ARGUMENTS` là một **UC-ID / ticket ID / tên rút gọn** (không có path) → phân giải thành file bằng cách glob theo bố cục feature-package. `{prd-slug}` lúc này **chưa biết**, nên dùng wildcard `*` cho segment đó, và `**` đệ quy dưới `bdd/` để phủ hết các thư mục con theo platform (`bdd/web/`, `bdd/app/`, `bdd/system/`):
57
+ - **Lệnh BDD** (target là `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — hoặc `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` nếu domain cũng chưa biết. Nếu lệnh ngụ ý một platform/scope cụ thể (vd: system tech-doc cần BDD `system/`), ưu tiên kết quả trong thư mục con platform đó.
58
+ - **Lệnh PRD** (target là file PRD `{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder, cạnh `bdd/`): `{specs_dir}/{domain}/*/{TICKET-ID}*.md` nếu biết TICKET-ID; nếu không, `{specs_dir}/{domain}/*/*.md` (khớp feature folder có id tương ứng), hoặc `{specs_dir}/*/*/*.md` nếu domain cũng chưa biết. *(Glob `*/*.md` ở cấp gốc folder chỉ khớp PRD — tech-docs/design-spec `.md` nằm sâu hơn trong thư mục con.)*
59
+ - **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
60
+ - **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
61
+
62
+ Khi một file khớp: đặt nó làm target **và** ghi lại `domain` + `prd_slug` từ path của nó (theo quy tắc trích xuất trong `context-loader.md` Bước 1 — `prd_slug` = segment đầu tiên sau `{specs_dir}/{domain}/`). Mọi path mà lệnh đọc/ghi về sau (BDD/tech-docs/design-spec/trace cùng cấp) đều dùng **`prd_slug` đã phân giải đó**, nên tất cả artifact nằm chung một feature package. Nếu nhiều file khớp (vd: nhiều platform), chọn theo platform/scope của lệnh hoặc liệt kê ra và hỏi.
63
+ 3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
64
+ - Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/*.md` — file PRD ở gốc mỗi feature folder — cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
65
+ - Hiển thị danh sách cho người dùng và hỏi: "Bạn muốn làm việc với file nào? (Nhập số thứ tự hoặc tên file)"
66
+ - Chờ người dùng chọn rồi mới tiếp tục.
67
+
68
+ ## Bước 2 — Chạy Context Loader
69
+
70
+ Nạp toàn bộ context của dự án bằng cách làm theo quy trình trong `steps/context-loader.md`.
71
+ Lưu toàn bộ context đã nạp vào bộ nhớ để dùng xuyên suốt phiên làm việc của lệnh.
72
+
73
+ ## Bước 3 — CHECKPOINT
74
+
75
+ Sau khi hoàn thành Bước 1 và 2, hiển thị bản tóm tắt và chờ xác nhận:
76
+
77
+ ```
78
+ CHECKPOINT
79
+ -----------
80
+ Target : {resolved file path}
81
+ Project : {project.name từ project-context.yaml}
82
+ Tech stack : {language} / {framework}
83
+ Module : {module nếu có, else "not configured"}
84
+ Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
85
+
86
+ Tiếp tục? (Y/N)
87
+ ```
88
+
89
+ Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
90
+ - "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
91
+ - "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
92
+
93
+
94
+ *Lưu ý: Với lệnh này, target file là một Business PRD (`{TICKET-ID}-{prd-slug}.md` — file `.md` ở gốc feature folder) dưới `{paths.specs_dir}/{domain}/{prd-slug}/`. Phân giải từ `$ARGUMENTS` hoặc liệt kê thư mục và hỏi. Chỉ hỗ trợ PRD của FE và mobile — PRD của BE sẽ bị từ chối ở bước Platform Check.*
95
+
96
+ ## Context
97
+ # Context Loader — Nạp toàn bộ context dự án
98
+
99
+ Thực hiện các bước theo đúng thứ tự. Lưu mọi thứ vào bộ nhớ trong suốt phiên làm việc của lệnh.
100
+
101
+ **Hướng dẫn ưu tiên (chống lost-in-middle):**
102
+ - Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
103
+ - Bước 3 là CRITICAL — kiến trúc + coding standards, là các sự thật ưu tiên cao nhất khi sinh nội dung.
104
+ - Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
105
+ - Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
106
+ - Bước 7 là WORKING MEMORY RECAP — chốt các sự thật quan trọng lên đầu bộ nhớ làm việc.
107
+
108
+ ---
109
+
110
+ ## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
111
+
112
+ Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
113
+
114
+ **Tech Stack:**
115
+ - `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
116
+ - `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
117
+ - `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
118
+ - `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
119
+ - `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
120
+ - `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
121
+
122
+ **Conventions:**
123
+ - `conventions.build_command` → cách compile/build
124
+ - `conventions.test_command` → cách chạy test
125
+ - `conventions.service_run` → cách khởi động service
126
+ - `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
127
+
128
+ **Domains:**
129
+ - `domains` → danh sách các business domain đang hoạt động
130
+
131
+ **Paths (nếu có):**
132
+ - `paths.specs_dir` → gốc của spec artifact — PRD, BDD, tech-docs, design-spec. Cấu trúc: `{specs_dir}/{domain}/{prd-slug}/{ {TICKET-ID}-{prd-slug}.md | bdd/ | tech-docs/ | design-spec/}` (file PRD đặt tên `{TICKET-ID}-{prd-slug}.md`, là file `.md` duy nhất ở gốc feature folder)
133
+ - `paths.refinement_dir` → thư mục output cho findings/review
134
+ - `paths.qc_dir` → gốc artifact QC automation (hiện ở top-level, mỗi UC một thư mục con: `{qc_dir}/{UC-ID}/`)
135
+ - `paths.qc_skills_dir` → nơi các lệnh qc-* nạp QC skill (mặc định bundled `.agent/skills/qc`; override sang repo/submodule riêng của team QC để bản nâng cấp framework không ghi đè)
136
+ - `paths.product_definitions_dir` → gốc product definition
137
+ - `paths.domain_knowledge_dir` → gốc domain knowledge
138
+ - `paths.business_dictionary` → path tới business-dictionary.md
139
+ - `paths.core_entities` → path tới core-entities.md
140
+ - `paths.tech_docs_dir` → gốc tài liệu kỹ thuật (gộp với specs_dir trong bố cục feature-package — tech-docs nằm dưới `{specs_dir}/{domain}/{prd-slug}/tech-docs/`)
141
+ - `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` (mỗi UC × platform một sổ)
142
+
143
+ Nếu không có section `paths`, dùng các giá trị mặc định:
144
+ - `specs_dir` = `specs`
145
+ - `refinement_dir` = `.agent/review`
146
+ - `qc_dir` = `docs`
147
+ - `qc_skills_dir` = `.agent/skills/qc`
148
+ - `product_definitions_dir` = `specs/product-definition`
149
+ - `domain_knowledge_dir` = `specs/domain-knowledge`
150
+ - `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
151
+ - `core_entities` = `specs/domain-knowledge/core-entities.md`
152
+ - `tech_docs_dir` = `specs`
153
+ - `trace_dir` = `.trace`
154
+
155
+ Lưu ý: Trong bố cục feature-package, `specs_dir` là gốc thống nhất. Mọi loại spec artifact (PRD, BDD, tech-docs, design-spec) đều nằm dưới `{specs_dir}/{domain}/{prd-slug}/`. `prd-slug` là tên folder feature-package, không phải một biến config riêng.
156
+
157
+ **Cách trích xuất `prd_slug` (đúng cho MỌI target file, bất kể độ sâu lồng nhau):** với một path target dạng `{specs_dir}/{domain}/{prd-slug}/...`, lấy **segment path đầu tiên sau `{specs_dir}/{domain}/`** — tức vị trí `{prd-slug}`. KHÔNG dùng folder cha trực tiếp của file, vì artifact BDD/tech-docs/design-spec lồng sâu hơn một hoặc hai cấp bên trong package. Ví dụ:
158
+ - `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
159
+ - `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
160
+ - `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
161
+ - `specs/payment/create-invoice/tech-docs/PAY01-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
162
+ - `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
163
+
164
+ Mọi artifact cùng cấp của một feature (PRD, BDD của từng platform, tech-docs BE + FE, design-spec, và trace TSV) đều phân giải về **cùng một `prd_slug`** — nên một BDD **system** hay tech-doc **system/BE** được tổng hợp sẽ nằm chung package `{specs_dir}/{domain}/{prd-slug}/` với các artifact web/app mà nó được suy ra từ đó.
165
+
166
+ Nếu `tech_stack.module` được đặt, đồng thời nạp `.agent/modules/{module}/stack-profile.yaml` nếu file tồn tại.
167
+
168
+ ---
169
+
170
+ ## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
171
+
172
+ *Bỏ qua hoàn toàn bước này nếu `setup.mode` không phải `"umbrella"` và không có section `services` trong project-context.yaml.*
173
+
174
+ Nếu có section `services`:
175
+
176
+ **1. Phát hiện active domain** (theo thứ tự ưu tiên):
177
+ - Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
178
+ - Trích xuất từ path target file: `domain` = segment đầu tiên sau base path `specs_dir`; `prd_slug` = segment kế tiếp (folder feature-package). Điều này đúng ở mọi độ sâu target — xem quy tắc trích xuất `prd_slug` ở Bước 1.
179
+ *(vd: `specs/user/create-account/USR01-create-account.md` **và** `specs/user/create-account/bdd/system/UC1.feature` đều → domain = `user`, prd_slug = `create-account`)*
180
+ - Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
181
+
182
+ **2. Route tới service** — nếu active domain khớp với một key trong `services`:
183
+ - Override `paths.specs_dir` → `services.{domain}.specs_dir` — **chỉ khi `setup.spec_source` KHÔNG được đặt.** Khi `spec_source` ĐƯỢC đặt, MỌI BDD (web/app/**system**) là artifact dùng chung liên team → để bước 4 route sang spec repo; KHÔNG pin theo service ở đây.
184
+ - Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **chỉ khi `setup.spec_source` KHÔNG được đặt.** Khi `spec_source` ĐƯỢC đặt, tech-design (API contract) là artifact liên team và phải nằm trong spec repo dùng chung (xử lý ở bước 4), nên để bước 4 route `tech_docs_dir` — KHÔNG pin theo service ở đây.
185
+ - Lưu `active_service` = `services.{domain}.path`
186
+ - Lưu `active_service_module` = `services.{domain}.module`
187
+ - Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
188
+
189
+ **3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
190
+ - Giữ path mặc định từ Bước 1
191
+ - Đặt `active_service = unresolved`
192
+
193
+ **4. Tự động override theo spec source** — nếu `setup.spec_source` được đặt VÀ path tương ứng chưa được set tường minh trong `paths:`:
194
+ - Override `paths.specs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt.** Mọi spec artifact (PRD, BDD, tech-docs, design-spec) nằm dưới gốc spec thống nhất trong spec repo dùng chung theo bố cục feature-package: `{spec_source}/specs/{domain}/{prd-slug}/`. Mọi umbrella (FE/App/BE) đều đọc từ đây. *(`specs/` theo service chỉ khi không có `spec_source`.)*
195
+ - Override `paths.tech_docs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt** (bước 2 không còn pin tech-docs theo service trong trường hợp này). Tech-docs nằm tại `{spec_source}/specs/{domain}/{prd-slug}/tech-docs/`. Tech-design CHÍNH LÀ API contract liên team: BE viết ở đây, FE/App đọc nó từ cùng spec submodule tại `/generate-code --phase=integration`. *(tech-docs theo service chỉ xảy ra khi không có `spec_source` — repo BE thuần đa-service không có spec module dùng chung.)*
196
+ - Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
197
+ - Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
198
+ - Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
199
+ - Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
200
+ - Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
201
+ - Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
202
+ - Override `paths.trace_dir` → `{spec_source}/.trace` — **luôn khi `spec_source` được đặt.** Trace TSV được gộp vào spec repo (một nơi authoritative duy nhất, không tách theo service) để PM/PO có một chỗ duy nhất quản lý trạng thái. Cấu trúc bên trong: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv`. Các lệnh phía code (`/generate-code`, `/dev-run-test`, `/qc-run-test`) chạy từ `service_root` nhưng **ghi trace row của chúng vào `{spec_source}/.trace/{domain}/{prd-slug}/`** — giống như chúng đã push `feedback/` vào đó. *(`.trace` theo service chỉ khi không có `spec_source`.)*
203
+ - Override `paths.refinement_dir` → `{spec_source}/.agent/review` — **luôn khi `spec_source` được đặt.** Findings review (`/refine-prd`, `/review-context`, `/review-tech-docs`) là artifact liên-team *về* tài liệu trong spec repo (PRD/BDD/tech-design) — thuộc cùng khu vực ghi với `.trace/` và `feedback/`. Các lệnh review chạy từ working dir của service (BE repo) nhưng **ghi findings vào `{spec_source}/.agent/review/`**, KHÔNG phải `.agent/review` của service repo. Bên trong flat, phân biệt bằng tên file đã prefix `{prd-slug}`/`{UC-ID}`/`{TICKET-ID}`. *(`.agent/review` theo service chỉ khi không có `spec_source`.)*
204
+
205
+ > **Vì sao đặt dưới `spec_source`:** PRD, BDD, tech-docs, design-spec, domain knowledge, feedback của tester, **trạng thái coverage `.trace/`**, **và findings review `.agent/review/`** đều là **artifact liên team** — chúng nằm trong **spec repo dùng chung** theo bố cục feature-package để mọi umbrella (FE/App/BE) và PM đọc từ một nguồn qua `/sync`. Trong bố cục feature-package, một folder `specs/{domain}/{prd-slug}/` gom tất cả loại artifact của một PRD, giúp spec repo tự đủ và dễ điều hướng theo feature. Service submodule chỉ chứa **code** (+ tooling build/test). `.trace/`, `.agent/review/` và `feedback/` là khu vực **ghi** của dev/QC/reviewer trong spec repo. Ở chế độ single-service (không có `spec_source`), mọi thứ mặc định dưới gốc repo — vẫn là một repo.
206
+
207
+ ---
208
+
209
+ ## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
210
+
211
+ *Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
212
+
213
+ Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
214
+
215
+ **1. Định vị config của service** — thử theo thứ tự ưu tiên:
216
+ - `{active_service}/.agent/project-context.yaml`
217
+ - `{active_service}/project-context.yaml`
218
+
219
+ **2. Nếu tìm thấy, override bằng giá trị riêng của service:**
220
+
221
+ | Biến | Nguồn |
222
+ |----------|--------|
223
+ | `conventions.test_command` | `conventions.test_command` của service |
224
+ | `conventions.build_command` | `conventions.build_command` của service |
225
+ | `paths.trace_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/.trace`); bỏ qua mọi `trace_dir` cấp service.** Chỉ khi không có `spec_source`: `{active_service}/{service paths.trace_dir}` (mặc định `{active_service}/.trace`). |
226
+ | `paths.specs_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/specs`); bỏ qua mọi `specs_dir` cấp service** (mọi spec artifact đều liên team, không bao giờ theo service ở chế độ này). Chỉ khi không có `spec_source`: `{active_service}/{service paths.specs_dir}` nếu được set, else dùng override ở Bước 1.5. |
227
+ | `paths.refinement_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/.agent/review`); bỏ qua mọi `refinement_dir` cấp service** (findings review là artifact liên team). Chỉ khi không có `spec_source`: `{active_service}/.agent/review`. |
228
+
229
+ **3. Lưu** `service_root = {active_service}` làm mốc thư mục làm việc cho mọi lệnh phía sau:
230
+ - Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
231
+ - **File source/test** được ghi tương đối với `service_root`; **trace TSV** được ghi vào `{paths.trace_dir}` (là spec repo khi `spec_source` được đặt — một thao tác ghi liên-repo, commit/push vào spec submodule giống như `feedback/`).
232
+
233
+ **4. Nếu không tìm thấy config của service** — giữ mặc định umbrella, vẫn set `service_root = {active_service}` (luôn cần mốc path kể cả khi không có config override).
234
+
235
+ ---
236
+
237
+ ## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
238
+
239
+ Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
240
+ Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
241
+ Nếu file không tồn tại → bỏ qua âm thầm.
242
+
243
+ ---
244
+
245
+ ## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
246
+
247
+ *Đây là context ưu tiên cao nhất — nó định nghĩa CÁCH viết code và tài liệu cho dự án này.*
248
+
249
+ CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
250
+ riêng của service kết hợp đúng cách. Agent luôn đứng ở gốc umbrella, nhưng code triển khai nằm
251
+ trong một service submodule với stack, kiến trúc, và convention RIÊNG của nó — nên CLAUDE.md của
252
+ service phải thắng khi sinh code.
253
+
254
+ **Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
255
+ Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
256
+ git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
257
+ kiến trúc + coding standards duy nhất của dự án.
258
+
259
+ **Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
260
+ *Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
261
+ Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
262
+ thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
263
+ Overlay nó lên trên Tầng 1: **khi có xung đột, giá trị của service THẮNG** cho kiến trúc,
264
+ coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
265
+ (vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
266
+
267
+ Từ kết quả **đã merge**, trích xuất và lưu:
268
+
269
+ - **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
270
+ - **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
271
+ - **§2 Package Layout** → **base package** (vd `vn.edupia.{service}`) + **chiến lược đặt package** (by-layer / by-feature) + nơi code một domain sống. Đây là **quy ước đặt code trên đĩa**, PHẢI enforce khi sinh code. Nếu §2 chỉ nêu base package + thứ tự layer mà **không** nói tới sub-package theo feature → hiểu là **by-layer**: các layer đặt **TRỰC TIẾP** dưới base package (vd `vn.edupia.{service}.service`, `.repository`); feature/UC/prd-slug **KHÔNG** thành sub-package, chỉ phân biệt ở **tên class**. Lưu `code_base_package` + `package_strategy` — *service overlay thắng*.
272
+ - **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
273
+ - **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
274
+ - **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
275
+
276
+ **Quy tắc phân giải:**
277
+ - Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
278
+ - Nếu chỉ có service overlay (không có root CLAUDE.md) → dùng file service một mình; `claude_md_source = {service_root}`.
279
+ - Nếu `service_root` được set nhưng `{service_root}/CLAUDE.md` **thiếu** → fallback về root CLAUDE.md và gắn cờ ⚠️ trong recap Bước 7 (service không có định nghĩa kiến trúc/coding-standards — việc sinh code sẽ dùng mặc định umbrella, có thể sai stack).
280
+ - Nếu cả hai đều không tồn tại → ghi nhận CLAUDE.md thiếu và tiếp tục chỉ với dữ liệu từ project-context.yaml.
281
+
282
+ ---
283
+
284
+ ## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
285
+
286
+ Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
287
+
288
+ Lưu các pattern file nhạy cảm — bạn **tuyệt đối không** đọc, ghi, hiển thị, hay tham chiếu nội dung từ các file khớp những pattern đó trong suốt cả phiên.
289
+
290
+ Nếu cả hai file đều không tồn tại → áp dụng mặc định built-in: không bao giờ truy cập `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
291
+
292
+ ---
293
+
294
+ ## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
295
+
296
+ Kiểm tra file business dictionary có tồn tại không (dùng `paths.business_dictionary` đã phân giải ở Bước 1).
297
+
298
+ Nếu tồn tại, đọc và trích xuất:
299
+ - **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
300
+ - **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
301
+ - **Status / Enum Registry** → các giá trị enum được phép theo từng entity
302
+
303
+ Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
304
+ - Khi sinh bất kỳ văn bản nào (PRD, BDD, comment code, tech docs), kiểm tra không có banned term nào xuất hiện
305
+ - Tự động thay banned term bằng bản chuẩn tương đương
306
+
307
+ Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
308
+
309
+ ---
310
+
311
+ ## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
312
+
313
+ Kiểm tra file core entities có tồn tại tại `paths.core_entities` không (đã phân giải ở Bước 1).
314
+ Path mặc định: `specs/domain-knowledge/core-entities.md`.
315
+
316
+ Nếu tồn tại, đọc và lưu:
317
+ - **Entity catalog** → với mỗi entity: tên, mục đích, service sở hữu, các field chính (tên + kiểu), business invariant, và quan hệ
318
+ - **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
319
+ - **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
320
+
321
+ **Cách dùng catalog này:**
322
+ - Khi sinh code: dùng tên field, kiểu, và quan hệ định nghĩa ở đây — KHÔNG suy đoán từ code có sẵn
323
+ - Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
324
+ - Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
325
+
326
+ Nếu file không tồn tại → bỏ qua âm thầm.
327
+
328
+ ---
329
+
330
+ ## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
331
+
332
+ Dùng `tech_stack.module` đã nạp ở Bước 1, suy ra và lưu hai biến để mọi lệnh phía sau dùng:
333
+
334
+ ```
335
+ active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
336
+ ```
337
+
338
+ | `platform_type` | Modules |
339
+ |---|---|
340
+ | `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
341
+ | `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
342
+ | `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
343
+
344
+ Nếu `tech_stack.module` rỗng hoặc không nhận diện được → set `platform_type = "unknown"` và gắn cờ ⚠️ trong recap Bước 7.
345
+
346
+ Hai biến này (`active_module`, `platform_type`) là nguồn chuẩn cho mọi logic rẽ nhánh trong các lệnh cần hành vi riêng theo platform (dev-gen-test, debug, fix-bug, dev-smoke-test).
347
+
348
+ ---
349
+
350
+ ## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
351
+
352
+ *Các lỗi tích luỹ mà AI không được lặp lại trong dự án này. Chúng được bổ sung dần qua `/learn`
353
+ hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
354
+
355
+ Phân giải path file lessons:
356
+ - Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
357
+ - Else mặc định `specs/domain-knowledge/lessons-learned.md`
358
+ - Ở chế độ umbrella/service (khi `service_root` được set), nếu `paths.lessons_file` chưa set, mặc định `{service_root}/.agent/project-lessons.md`
359
+
360
+ Nếu file tồn tại, đọc và lưu TẤT CẢ lesson làm **GUARDRAIL ĐANG HOẠT ĐỘNG** cho phiên:
361
+ - Coi **Rule** của mỗi lesson là ràng buộc cứng — cùng mức ưu tiên với coding standards trong CLAUDE.md (Bước 3).
362
+ - Trước khi sinh hoặc sửa bất kỳ artifact nào (PRD, BDD, tech-doc, code, test), đối chiếu output với mọi lesson có `category` khớp lệnh hiện tại VÀ `scope` khớp target (domain / file).
363
+ - Nếu output sinh ra vi phạm một lesson → sửa **trước khi** trình bày, và ghi rõ lesson nào (`L-NNN`) đã được áp dụng.
364
+
365
+ Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
366
+
367
+ ---
368
+
369
+ ## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
370
+
371
+ Sau khi nạp toàn bộ context, tổng hợp và xuất một khối tóm tắt gọn.
372
+ Recap này đảm bảo các sự thật quan trọng nhất được nêu ở CUỐI quá trình nạp context
373
+ (hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
374
+
375
+ Xuất đúng khối này:
376
+ ```
377
+ [CTX LOADED]
378
+ Stack : {language} / {framework} / {database}
379
+ Platform : {active_module} ({platform_type})
380
+ Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
381
+ Package : {code_base_package}.{layer} · {by-layer | by-feature} ← feature/UC → tên class, KHÔNG thành package (nếu by-layer)
382
+ CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
383
+ Ticket : {ticket_prefix}-
384
+ Dict : {loaded — N canonical terms, M banned terms | missing}
385
+ Entities : {loaded — EntityA, EntityB, EntityC | missing}
386
+ Lessons : {loaded — N guardrails | chưa có}
387
+ Service : {active_service} ({active_service_module}) | single-service
388
+ Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
389
+ Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
390
+ ```
391
+
392
+ Nếu bất kỳ file CRITICAL nào thiếu (CLAUDE.md), gắn cờ rõ ràng để người dùng quyết định có tiếp tục hay không.
393
+
394
+ ---
395
+
396
+ ## Hoàn tất nạp Context
397
+
398
+ Sau khi hoàn thành tất cả các bước, bạn đã nạp:
399
+ - Định danh dự án, tech stack, convention module
400
+ - Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
401
+ - Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
402
+ - Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
403
+ - Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
404
+ - Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
405
+ - Toàn bộ path đã cấu hình
406
+
407
+ Tiếp tục sang bước kế tiếp của lệnh đang gọi.
408
+
409
+
410
+ *Context bổ sung cho lệnh này: Đọc toàn bộ PRD target. Trích xuất: **TICKET-ID**, **domain**, **tên feature**, **Service** và **Module** từ metadata PRD (row `| **Service** |` và `| **Module** |`), User Flow (Section 4a), và tên màn hình Wireframe (Section 4b).*
411
+
412
+ *Quy tắc trích xuất Service (giống /generate-prd):*
413
+ - *Nếu metadata PRD có `| **Service** |` → dùng làm `active_service` và `| **Module** |` làm `active_module`.*
414
+ - *Nếu vắng VÀ `services` được định nghĩa trong `project-context.yaml` → hỏi: "Design Spec này dành cho service nào?" (chỉ liệt kê service FE/App, chờ chọn).*
415
+ - *Nếu dự án single-service → `active_service = "default"`, `active_module = tech_stack.module`.*
416
+
417
+ ---
418
+
419
+ ## Guard — PRD đã duyệt chưa
420
+
421
+ Đọc `| **Status** |` từ bảng Metadata của Business PRD nguồn:
422
+ - `Status: approved` → tiếp tục bình thường.
423
+ - `Status: draft` (hoặc khác `approved`) → **CHECKPOINT cảnh báo mềm** (không chặn cứng — cho phép prototype song song):
424
+ ```
425
+ ⚠️ Business PRD đang ở Status: {status} (chưa duyệt). Design Spec dựng trên PRD chưa chốt có thể phải làm lại theo PRD.
426
+ Khuyến nghị: PO duyệt PRD (đặt `| **Status** | approved |`) rồi mới sinh Design Spec.
427
+ Vẫn sinh Design Spec bây giờ? (Y/N)
428
+ ```
429
+ Chỉ tiếp tục khi người dùng chọn Y.
430
+
431
+ ---
432
+
433
+ ## Platform Check
434
+
435
+ Dùng `active_module` và `platform_type` suy ra từ context loading:
436
+
437
+ 1. Nếu `platform_type = "backend"` → **STOP**. Xuất:
438
+ ```
439
+ ❌ Design Spec chỉ dành cho platform FE và mobile.
440
+ Với service BE, API contract thuộc về Business PRD (Use Case → section Business Logic).
441
+ ```
442
+
443
+ 2. Nếu `platform_type = "web-frontend"` → set `active_platform = "web"`.
444
+
445
+ 3. Nếu `platform_type = "mobile"`:
446
+ - `flutter` hoặc `react-native` → set `active_platform = "app"`
447
+ - `ios-swiftui` → set `active_platform = "app-ios"`
448
+ - `android-compose` → set `active_platform = "app-android"`
449
+
450
+ 4. Nếu `platform_type = "unknown"` → hỏi: "Design Spec này dành cho platform nào?"
451
+ ```
452
+ Options:
453
+ 1 — web (React / Next.js / Vue / Angular)
454
+ 2 — app (Flutter / React Native)
455
+ 3 — app-ios (iOS SwiftUI)
456
+ 4 — app-android (Android Compose)
457
+ ```
458
+ Chờ chọn. Map lựa chọn sang `active_platform` và suy ra `active_module` nếu được.
459
+
460
+ ---
461
+
462
+ ## Version Check (PRD drift)
463
+
464
+ Trước khi sinh, kiểm tra design-spec đã tồn tại cho platform này:
465
+ `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md`
466
+ Đọc `| **Version** |` hiện tại của PRD từ Metadata (vd `1.3`).
467
+
468
+ - **Không tồn tại** → sinh mới; ghi `| **Built from PRD** | v{prd_version hiện tại} |`.
469
+ - **Tồn tại** → đọc row `| **Built from PRD** |` của nó, so với `| **Version** |` PRD hiện tại:
470
+ - **Bằng nhau** → hỏi: "Design Spec đã dựng từ PRD v{x}. Sinh lại? (Y/N)".
471
+ - **Khác** (PRD đã đổi) → CHECKPOINT drift:
472
+ ```
473
+ ⚠️ Phát hiện PRD version drift
474
+ Design Spec dựng từ PRD v{old}; PRD giờ ở v{new}.
475
+ Thay đổi kể từ v{old} (đọc # Change Log của PRD):
476
+ {changelog rows}
477
+ Options:
478
+ Y — cập nhật phần ảnh hưởng (màn / flow đổi)
479
+ F — sinh lại toàn bộ
480
+ N — huỷ
481
+ ```
482
+ - Khi sinh / sinh lại → cập nhật `| **Built from PRD** | v{prd_version hiện tại} |`, bump `| **Version** |` Design Spec, **reset `| **Status** | draft |`** (design đổi → sign-off lại), thêm row Changelog.
483
+
484
+ ---
485
+
486
+ ## Screen Discovery
487
+
488
+ Từ Section 4 của PRD (User Flow + Wireframe), trích xuất mọi tên screen / page / modal được nhắc tới.
489
+
490
+ Trình bày danh sách và hỏi PO xác nhận:
491
+
492
+ ```
493
+ Screens detected from PRD:
494
+ 1. {Screen name 1}
495
+ 2. {Screen name 2}
496
+ ...
497
+
498
+ Đây đã đủ các màn cho platform {active_platform} chưa?
499
+ Thêm màn còn thiếu, bỏ màn không áp dụng, hoặc xác nhận bằng Y.
500
+ ```
501
+
502
+ Chờ xác nhận. Lưu danh sách đã xác nhận là `screen_list`.
503
+
504
+ ---
505
+
506
+ ## Figma Frame Links *(bắt buộc — một link node-level đọc được cho mỗi màn)*
507
+
508
+ Một Design Spec chỉ tốt ngang với design mà nó trỏ tới. AI **không đọc được link file
509
+ trần** (`figma.com/design/{fileKey}/...` không có `node-id`) — nó cần một
510
+ **link node-level tới từng frame cụ thể** để fetch layout, component, và token thật của
511
+ frame đó qua Figma MCP. Vậy nên thu thập một link **mỗi màn**, không phải một
512
+ link cho cả feature.
513
+
514
+ **Hỏi PO, liệt kê mọi màn trong `screen_list`:**
515
+
516
+ ```
517
+ Dán link Figma frame cho từng màn bên dưới.
518
+
519
+ Trong Figma: chọn frame → chuột phải → "Copy link to selection"
520
+ (URL phải chứa ?node-id=... — đó là link per-frame mà AI đọc được)
521
+
522
+ 1. {Screen 1} : ____
523
+ 2. {Screen 2} : ____
524
+ ...
525
+
526
+ Nếu một màn chưa có design, gõ none cho màn đó.
527
+ ```
528
+
529
+ **Với mỗi câu trả lời:**
530
+
531
+ 1. **Validate format** — URL phải khớp `figma.com/design/{fileKey}/...?node-id={nodeId}`.
532
+ - Hợp lệ → lưu thành `figma_frames[{screen}] = {url}`, parse ra `fileKey` + `nodeId`.
533
+ - Link file **không có `node-id`** → từ chối: "Link này trỏ tới cả file, không phải một frame. Copy lại qua chuột phải → Copy link to selection." Hỏi lại màn đó.
534
+ - `none` → `figma_frames[{screen}] = "TBD"`, đánh dấu màn đó ❌ Missing.
535
+
536
+ 2. **Fetch frame qua Figma MCP** (chỉ với link hợp lệ) — gọi `get_design_context`
537
+ (và `get_screenshot` khi hữu ích) với `fileKey` + `nodeId` đã parse để đọc
538
+ layout, tên component, và design token thật. Đặt mọi Screen Spec dựa trên dữ liệu
539
+ đã fetch này; **đừng** bịa layout mà frame không thể hiện. Nếu fetch thất bại
540
+ (permission / not found) → coi màn đó là ❌ Missing và ghi chú lỗi fetch.
541
+
542
+ 3. Suy ra `figma_url` mức feature = link file (không có `node-id`) chung của các
543
+ frame, cho row Metadata. Nếu các frame trải nhiều file, liệt kê từng cái.
544
+
545
+ **Gate bắt buộc (không abort — sinh ra draft):**
546
+ - Nếu **bất kỳ** màn nào ❌ Missing → spec được sinh dưới dạng **draft** với các màn đó
547
+ được gắn cờ, `Status` giữ `draft` cho tới khi mọi màn có link frame đọc được, đã fetch.
548
+ `/generate-bdd` FE/App sẽ **cảnh báo mềm** (đồng bộ Guard PRD) nếu sinh BDD khi design-spec chưa `approved`. Ghi `missing_frames = [screens]`.
549
+ - Thêm một AI Assumption cho mỗi màn thiếu: "Không có Figma frame đọc được cho {screen} — spec
550
+ của màn này chỉ là text và không được sign off cho tới khi thêm link `node-id`."
551
+
552
+ ---
553
+
554
+ ## CHECKPOINT
555
+
556
+ ```
557
+ CHECKPOINT — Design Spec
558
+ -------------------------
559
+ Target PRD : {prd-file-path}
560
+ Platform : {active_platform}
561
+ Module : {active_module}
562
+ Service : {active_service}
563
+ Domain : {domain}
564
+ Screens : {N} — {screen_list ngăn cách bởi dấu phẩy}
565
+ Figma : {linked}/{N} màn có link frame đọc được{; missing: missing_frames ngăn cách bởi dấu phẩy}
566
+ Output path : {paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md
567
+
568
+ {Nếu missing_frames khác rỗng}:
569
+ ⚠️ {count} màn không có link Figma frame đọc được — các màn này sẽ được sinh dưới dạng
570
+ draft chỉ-text và spec không thể sign off cho tới khi thêm link node-id.
571
+
572
+ Generate? (Y/N)
573
+ ```
574
+
575
+ Chờ Y rõ ràng trước khi tiếp tục.
576
+
577
+ ---
578
+
579
+ ## Ngôn ngữ — Language Guard *(áp khi viết mọi section)*
580
+ # Business Language Guard — chặn thuật ngữ kỹ thuật rò vào tài liệu nghiệp vụ
581
+
582
+ Tài liệu nghiệp vụ (PRD, product-definition) mô tả **WHAT** — chỉ ngôn ngữ nghiệp vụ. Guard này chạy **mỗi khi viết hoặc sửa** prose (gen mới, áp fix `--resume`, hiệu chỉnh): **quét và xử lý** các thuật ngữ kỹ thuật/UI phổ thông bên dưới **trước khi ghi**.
583
+
584
+ > Guard này là **baseline framework**, chạy **song song** với Banned Terms của `business-dictionary.md` (cơ chế dictionary giữ nguyên; project vẫn bổ sung term đặc thù vào đó). Khi cả hai cùng áp, ưu tiên bản chuẩn của dictionary nếu có.
585
+
586
+ ## Bản đồ xử lý (4 nhóm)
587
+
588
+ **Nhóm 1 — Tương tác/triển khai → DIỄN ĐẠT LẠI sang nghiệp vụ (giữ nguyên nghĩa):**
589
+
590
+ | Kỹ thuật/UI | Cách nói nghiệp vụ |
591
+ |---|---|
592
+ | re-render / render lại / reload / refresh (màn) | "hiển thị lại {tên màn}" |
593
+ | timeout | "quá thời gian chờ" |
594
+ | lỗi mạng / network error | "lỗi kết nối" |
595
+ | UI / giao diện (khi chỉ một màn) | "màn" / "màn hình" |
596
+ | click / tap | "bấm" / "chọn" |
597
+ | popup / modal (nếu chỉ là khái niệm hiển thị) | "hộp thoại" / "thông báo" |
598
+ | disable / enable (nút) | "khoá" / "mở" thao tác |
599
+ | redirect / navigate | "chuyển tới {màn}" |
600
+
601
+ **Nhóm 2 — Visual thuần → CHUYỂN Design Spec (bỏ khỏi PRD, ghi nhận lại):**
602
+ `spinner`, `loading indicator`, `animation`, `fade/slide`, màu sắc, font, layout pixel, micro-interaction → *"Chi tiết visual này thuộc Design Spec — ghi nhận để tạo Design Spec sau."*
603
+
604
+ **Nhóm 3 — Backend/contract thuần → BỎ khỏi PRD (thuộc Tech Docs):**
605
+ `API`, `endpoint`, `token/JWT`, `HTTP status`, tên class/bảng/cột DB, query, payload, header.
606
+ *(Ngoại lệ DUY NHẤT: Appendix "Existing API Contract" khi `API Source: existing` — xem Platform Strategy.)*
607
+
608
+ **Nhóm 4 — Ẩn dụ dữ liệu/cài đặt cho trạng thái nghiệp vụ → XÉT THEO NGHĨA (KHÔNG phải bảng thay thế):**
609
+
610
+ Các từ như `cờ / flag`, `biến / trường / field`, `giá trị / value`, `trả về / return`, `đọc / ghi (cờ)` **đa nghĩa** — kỹ thuật ở ngữ cảnh này, nghiệp vụ ở ngữ cảnh khác. **ĐỪNG thay máy móc.** Một từ chỉ là leak khi **cả hai** điều sau đúng:
611
+ 1. Nó chỉ một **artifact lưu trữ/cơ chế** (cờ, biến, trường, giá trị-trả-về, đọc/ghi) đứng thay cho một **trạng thái/khái niệm nghiệp vụ**; VÀ
612
+ 2. Khái niệm đó **đã có tên nghiệp vụ** (trong business-dictionary hoặc hiển nhiên).
613
+
614
+ → Cả hai đúng: viết lại theo **tên nghiệp vụ**, ưu tiên term chuẩn trong business-dictionary.
615
+ → Từ **tự nó là khái niệm nghiệp vụ**: **GIỮ NGUYÊN**.
616
+
617
+ | Reframe (là leak) | Giữ nguyên (nghiệp vụ thật) |
618
+ |---|---|
619
+ | "cờ tình trạng = chưa làm" → "con *chưa làm khảo sát*" (có term Tình trạng khảo sát) | "giá trị đơn hàng", "giá trị hợp đồng" |
620
+ | "cờ trả giá trị lạ" → "không đọc được tình trạng khảo sát" | "khách trả về sản phẩm" (hoàn hàng) |
621
+ | "đọc cờ thất bại" → "không xác định được tình trạng" | "trả kết quả học tập cho phụ huynh" |
622
+
623
+ **Neo an toàn:** lái theo business-dictionary — nếu đang diễn giải một khái niệm **đã có entry** thì dùng đúng term đó. Hỏi *"khái niệm này có tên nghiệp vụ chưa"*, KHÔNG hỏi *"từ này có bị cấm không"*.
624
+
625
+ **Luật code-format:** trong prose nghiệp vụ, **không bọc backtick/`code`** quanh giá trị/trạng thái nghiệp vụ (`chưa làm`, `đã nộp`) — code-format báo hiệu "token kỹ thuật". Dùng *nghiêng* hoặc "trong ngoặc kép". Backtick chỉ dành cho định danh code/kỹ thuật thật.
626
+
627
+ ## Quy tắc áp dụng
628
+ - Quét toàn bộ text sắp ghi (User Story, AC, BR, Business Logic, Scope, Edge Cases, Assumptions…).
629
+ - Nhóm 1 → thay tại chỗ, giữ nguyên nghĩa nghiệp vụ. **Đồng bộ cách diễn đạt** với chỗ đã có sẵn trong cùng tài liệu (vd nếu "quá thời gian chờ" đã dùng ở một BR → dùng nhất quán ở mọi nơi).
630
+ - Nhóm 2 → gỡ khỏi prose nghiệp vụ + nhắc chuyển Design Spec.
631
+ - Nhóm 3 → gỡ khỏi PRD (trừ ngoại lệ brownfield).
632
+ - Nhóm 4 → **xét ngữ cảnh, KHÔNG thay máy móc**: chỉ reframe khi là ẩn dụ dữ liệu cho một khái niệm đã có tên nghiệp vụ (ưu tiên term dictionary); **giữ nguyên** khi từ mang nghĩa nghiệp vụ thật. Đồng thời bỏ backtick khỏi giá trị nghiệp vụ trong prose.
633
+ - Nếu term không có trong bản đồ nhưng rõ ràng là tên kỹ thuật/triển khai → vẫn diễn đạt lại theo tinh thần Nhóm 1, đừng để lọt.
634
+
635
+ **Checklist (dùng ở Quality Checklist của lệnh):** 0 thuật ngữ kỹ thuật/UI (re-render, UI, timeout, spinner, API/endpoint/token…) trong prose nghiệp vụ — đã diễn đạt lại (Nhóm 1) / chuyển Design Spec (Nhóm 2) / bỏ về Tech Docs (Nhóm 3); 0 ẩn dụ dữ liệu cho trạng thái đã có tên nghiệp vụ (cờ/giá trị/đọc-ghi khi là artifact — Nhóm 4) và 0 backtick bọc giá trị nghiệp vụ.
636
+
637
+
638
+ **Design Language Guard — phân tầng bề mặt (bổ sung cho guard trên):**
639
+
640
+ Design Spec là cầu nối PRD → code, có **hai loại bề mặt** với ngôn ngữ khác nhau. Nguyên tắc: **không xoá chi tiết kỹ thuật — dồn về đúng tầng** (giống altitude AC/BR ở PRD).
641
+
642
+ - **Tầng A — bề mặt đọc (BẮT ngôn ngữ nghiệp vụ/UX):** §1 Screen Inventory (mọi cột), §2 Layout, cột "Hành vi UI" của Screen States, Actions & Navigation, blockquote mục đích màn, §5 AC-UI. Mô tả theo **vai trò/ý đồ** ("thanh tiến độ", "nút chính", "trạng thái chưa chọn đáp án"). **CẤM ở tầng này:** tên layer/variant Figma (`Q1--Selected`, `Base Design`), mã token/màu hex/số đo px-pt (`Primary/500 #0876B1`, `padding 16px`), định danh code, và ẩn dụ dữ liệu (Nhóm 4 của guard trên: cờ/giá trị/đọc-ghi khi là artifact).
643
+ - **Tầng B — cột/phụ lục kỹ thuật chuyên dụng (được giữ code):** Component Inventory (`Code Component`, `Import Path`), cột **Figma Frame** (link), bảng **Design Token** (phụ lục). Định danh Figma/code/token **chỉ** được xuất hiện ở đây.
644
+
645
+ Một state mô tả ở tầng A bằng lời ("chưa chọn đáp án → nút vô hiệu"); tên variant Figma của state đó (nếu cần) nằm ở cột Figma Frame / Component Inventory, KHÔNG lẫn vào prose.
646
+
647
+ ## Generation Rules
648
+
649
+ Áp dụng các quy tắc này nhất quán khi sinh mọi section:
650
+
651
+ **Component mapping (C.M — bắt buộc):**
652
+ - Với mỗi component được tham chiếu, kiểm tra `figma-components/{active_module}.md` (đã nạp trong context).
653
+ - ✅ Matched → dùng đúng `Code Component` và `Import Path` từ catalog.
654
+ - ⚠️ Matched nhưng `[TODO]` → đánh dấu ô component là `[TODO — implementation pending]`.
655
+ - ❌ Không có trong catalog → đánh dấu `[NEW — confirm with designer before generating code]`.
656
+ - Không bao giờ bịa tên component hay import path.
657
+
658
+ **Section thích ứng theo platform:**
659
+ - Section 3 (Interaction Patterns) và Section 4 (Platform Considerations) thích ứng theo `active_platform`:
660
+ - `web` → gồm responsive breakpoint, trạng thái hover/focus, keyboard navigation, accessibility.
661
+ - `app` / `app-ios` / `app-android` → gồm gesture, safe area, touch target tối thiểu, navigation pattern, deep link, permission, hành vi offline.
662
+ - Chỉ sinh section liên quan tới `active_platform`. Bỏ hẳn section của platform kia.
663
+
664
+ **Figma grounding (bắt buộc):**
665
+ - Với mỗi màn có frame đã fetch (`figma_frames[screen]` là link hợp lệ), dựa Layout,
666
+ Component Inventory, và Screen States trên **dữ liệu Figma đã fetch** — tên component thật,
667
+ token thật, cấu trúc frame thật. Đừng mâu thuẫn hay bịa layout.
668
+ - Dùng đúng URL `figma_frames[screen]` từng-màn trong Screen Inventory, header mỗi Screen
669
+ Spec, và Figma Summary — không bao giờ dùng fragment giả `{figma_url}#screen1`.
670
+ - Với màn ❌ Missing: sinh draft chỉ-text từ PRD, thêm tiền tố vào Screen Spec
671
+ `> [DRAFT — no Figma frame; do not sign off]`, và để ô Figma là ❌ Missing.
672
+
673
+ **Screen states (bắt buộc mỗi màn):**
674
+ - Mỗi màn phải mô tả tối thiểu: `default`, `loading`, `error`.
675
+ - Thêm `empty` khi màn có thể hiển thị trạng thái không dữ liệu.
676
+ - Thêm `success` khi một action hoàn tất tạo ra trạng thái xác nhận riêng biệt.
677
+ - Nếu một state không áp dụng → đánh dấu `N/A` kèm lý do ngắn.
678
+
679
+ ---
680
+
681
+ ## Generate
682
+
683
+ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md`:
684
+
685
+ ````markdown
686
+ # {TICKET-ID} {Feature Name} — Design Spec [{active_platform}]
687
+
688
+ ---
689
+
690
+ ## Metadata
691
+
692
+ | Field | Value |
693
+ |--------------------|---------------------------------------------------------------|
694
+ | **Spec ID** | {TICKET-ID}-DS-{active_platform} |
695
+ | **Version** | 1.0 |
696
+ | **Status** | draft |
697
+ | **Platform** | {active_platform} |
698
+ | **Module** | {active_module} |
699
+ | **Service** | {active_service} |
700
+ | **Domain** | {domain} |
701
+ | **Business PRD** | [{TICKET-ID}](../{TICKET-ID}-{prd-slug}.md) |
702
+ | **Built from PRD** | v{prd_version — `\| **Version** \|` của PRD lúc sinh; dùng phát hiện drift} |
703
+ | **Figma** | {figma_url — link file feature} ({linked}/{N} frame đã link) |
704
+ | **Author** | {tên PO hoặc "AI-assisted"} |
705
+ | **Created** | {YYYY-MM-DD} |
706
+ | **Updated** | {YYYY-MM-DD} |
707
+
708
+ ---
709
+
710
+ # 1. Danh mục màn hình (Screen Inventory)
711
+
712
+ > **Tầng A:** cột **Điểm vào** và **Ghi chú** viết bằng ngôn ngữ nghiệp vụ — mô tả điều kiện/ý đồ. KHÔNG liệt kê states, KHÔNG tên component/variant Figma (states thuộc §2; tên Figma thuộc cột Figma Frame / §2). Vd Điểm vào: "khi con *chưa làm khảo sát* và có ít nhất một câu hỏi" — KHÔNG "cờ tình trạng = `chưa làm`".
713
+
714
+ | # | Tên màn hình | Điểm vào | Figma Frame | Ghi chú |
715
+ |---|-------------|-------------|-------------|-------|
716
+ | 1 | {Màn hình 1} | {điều kiện nghiệp vụ để vào màn — vd: "sau khi hoàn tất Nhập thông tin con và con chưa làm khảo sát"} | [Frame]({figma_frames[Screen 1]}) | {ghi chú nghiệp vụ nếu có — KHÔNG states/tên Figma} |
717
+ | 2 | {Màn hình 2} | {điểm vào — ngôn ngữ nghiệp vụ} | [Frame]({figma_frames[Screen 2]}) / ❌ Missing | |
718
+
719
+ ---
720
+
721
+ # 2. Đặc tả màn hình (Screen Specs)
722
+
723
+ <!--
724
+ Lặp lại block này cho mỗi màn trong Screen Inventory.
725
+ Mỗi màn phải có: Layout, Component Inventory, Screen States, Actions & Navigation.
726
+ -->
727
+
728
+ ## Màn hình 1: {Tên màn hình}
729
+
730
+ **Figma**: [{Tên frame}]({figma_frames[Screen 1]}) <!-- ❌ Missing → thêm tiền tố cho màn này `> [DRAFT — no Figma frame; do not sign off]` -->
731
+
732
+ ### Layout
733
+
734
+ {Mô tả layout theo CẤU TRÚC & Ý ĐỒ bằng lời: thứ tự section trên→dưới, vai trò từng vùng, hệ phân cấp thị giác, hành vi co giãn. **KHÔNG rải mã token / màu hex / số đo px** trong văn xuôi — số đo & token cụ thể đặt ở cột Component Inventory và bảng Design Token (phụ lục, Tầng B). Vd: "một cột dọc, thanh tiến độ ở đầu, khu nội dung chính giữa, nút hành động cố định đáy màn".}
735
+
736
+ ### Component Inventory
737
+
738
+ | Component (Figma) | Code Component | Import Path | States | Ghi chú |
739
+ |---------------------|-----------------|------------------------|---------------------------------|--------------------|
740
+ | {Figma/Button/Primary} | Button | @/components/ui/Button | default, loading, disabled | |
741
+ | {Figma/Input/Text} | TextInput | @/components/ui/Input | default, focus, error, disabled | |
742
+ | {Figma/Card/Order} | OrderCard | @/features/{domain}/components/OrderCard | default, skeleton | |
743
+
744
+ ### Screen States
745
+
746
+ <!-- Tầng A: Trigger & Hành vi UI mô tả bằng lời quan sát được. KHÔNG tên variant Figma (Q1--Selected), KHÔNG "API/render/spinner" (→ "đang tải / hiển thị lại / vùng chờ"). Tên component/variant nếu cần → cột Figma / Component Inventory. -->
747
+
748
+ | State | Trigger | Hành vi UI (mô tả quan sát được) |
749
+ |-----------|---------------------------------------------|------------------------------------------------------|
750
+ | default | Màn đã hiển thị, có dữ liệu | {Mô tả giao diện người dùng thấy} |
751
+ | loading | Đang tải dữ liệu | {Vùng chờ / vị trí báo đang tải} |
752
+ | error | Tải dữ liệu thất bại / dữ liệu không hợp lệ | {Thông báo lỗi + hành động khôi phục} |
753
+ | empty | Không có dữ liệu để hiển thị | {Trạng thái trống + lời mời hành động} |
754
+ | success | Thao tác hoàn tất (nếu có) | {Xác nhận / chuyển màn / đổi trạng thái} |
755
+
756
+ ### Actions & Navigation
757
+
758
+ | Action | Trigger | Kết quả |
759
+ |-----------------|--------------------------------|-------------------------------------------------|
760
+ | {Tên action} | Tap/click {tên phần tử} | Điều hướng tới {Màn hình N} / Mở {Tên modal} |
761
+ | {Tên action} | Swipe trái trên {list item} | Hiện xác nhận xoá |
762
+ | {Back / Cancel} | Cử chỉ back / nút Cancel | Quay lại {màn trước} mà không lưu |
763
+
764
+ ---
765
+
766
+ <!-- Lặp lại block ## Màn hình N cho mỗi màn bổ sung -->
767
+
768
+ ---
769
+
770
+ # 3. Pattern tương tác (Interaction Patterns)
771
+
772
+ <!--
773
+ Platform web: gồm section A + B. Bỏ section C.
774
+ Platform app: gồm section C. Bỏ section A + B.
775
+ -->
776
+
777
+ <!-- ═══════════════════════════ CHỈ WEB ═══════════════════════════ -->
778
+
779
+ ## A. Hành vi Responsive *(chỉ web)*
780
+
781
+ | Breakpoint | Width | Thay đổi layout |
782
+ |------------|------------|----------------------------------------------------|
783
+ | Mobile | < 768px | {1 cột, bottom navigation bar, CTA full-width} |
784
+ | Tablet | 768–1279px | {grid 2 cột, sidebar thu gọn, tab navigation} |
785
+ | Desktop | ≥ 1280px | {layout đầy đủ, sidebar hiển thị, max-width 1440px}|
786
+
787
+ ## B. Hover / Focus / Keyboard *(chỉ web)*
788
+
789
+ | Phần tử | Trạng thái Hover | Trạng thái Focus | Phím tắt |
790
+ |----------------|-------------------------------|---------------------------------|-------------------|
791
+ | Primary button | Background → {color.hover} | Outline 2px {color.focus} | Enter / Space |
792
+ | Text input | Border → {color.border.hover} | Border → {color.primary}, label nổi | Tab to focus |
793
+ | Dropdown | Highlight nền | Giống hover + ring | Phím mũi tên điều hướng |
794
+
795
+ <!-- ═══════════════════════════ CHỈ APP ═══════════════════════════ -->
796
+
797
+ ## C. Cử chỉ & Điều hướng *(chỉ app)*
798
+
799
+ | Cử chỉ | Màn / Phần tử | Hành vi |
800
+ |-------------------|---------------------------|-------------------------------------------------------|
801
+ | Cử chỉ back (iOS swipe-right / Android back) | Mọi màn | {Quay lại màn trước / Hiện dialog "Discard changes?"} |
802
+ | Pull-to-refresh | {Tên màn} | Refresh dữ liệu, spinner ở trên cùng |
803
+ | Swipe trái trên row | {Tên list item} | Hiện action {Delete / Archive} |
804
+ | Long press | {Tên phần tử} | {Context menu / chế độ chọn} |
805
+ | Pinch / zoom | {Image viewer} | Scale ảnh, double-tap để reset |
806
+
807
+ ### Navigation Pattern *(chỉ app)*
808
+
809
+ ```
810
+ {Vẽ navigation stack cho feature này, vd:
811
+ BottomTab(Home) → FeatureListPage → FeatureDetailPage → EditPage
812
+ BottomTab(Home) → FeatureListPage ↘ (modal) CreatePage
813
+ }
814
+ ```
815
+
816
+ Entry: {người dùng vào feature này thế nào — tab / deeplink / push từ màn khác}
817
+ Exit: {người dùng rời thế nào — back stack / chuyển tab / deeplink out}
818
+
819
+ ### Platform Conventions *(chỉ app)*
820
+
821
+ | Khía cạnh | Hành vi iOS | Hành vi Android |
822
+ |--------------------------|-----------------------------------------|-----------------------------------------|
823
+ | Navigation bar | {Nút back trên-trái, title canh giữa} | {Mũi tên Up trên-trái, title canh trái} |
824
+ | Sheet / bottom modal | {UISheetPresentation, hiện grabber} | {BottomSheet, drag handle} |
825
+ | Alert / confirm dialog | {UIAlertController, action canh phải} | {Material AlertDialog, action canh trái}|
826
+ | Loading indicator | {UIActivityIndicatorView, center} | {CircularProgressIndicator} |
827
+ | Toast / snackbar | {Custom toast, bottom center} | {Material Snackbar, bottom} |
828
+
829
+ ---
830
+
831
+ # 4. Cân nhắc theo Platform (Platform Considerations)
832
+
833
+ <!--
834
+ Web: gồm section A. App: gồm section B. Bỏ section không áp dụng.
835
+ -->
836
+
837
+ <!-- ═══════════════════════════ CHỈ WEB ═══════════════════════════ -->
838
+
839
+ ## A. Accessibility *(chỉ web)*
840
+
841
+ - [ ] Mọi phần tử tương tác tới được bằng phím Tab — không có keyboard trap
842
+ - [ ] Focus trap bên trong modal dialog (Tab chỉ chạy vòng trong modal)
843
+ - [ ] Nút chỉ-icon có `aria-label` mô tả hành động
844
+ - [ ] Cập nhật nội dung động (loading → loaded) thông báo qua `aria-live`
845
+ - [ ] Tương phản màu đạt WCAG AA: text ≥ 4.5:1, text lớn ≥ 3:1
846
+ - [ ] Input form có label hiển thị (không chỉ placeholder)
847
+ - [ ] Message lỗi liên kết với input qua `aria-describedby`
848
+
849
+ <!-- ═══════════════════════════ CHỉ APP ═══════════════════════════ -->
850
+
851
+ ## B. Thiết bị & OS *(chỉ app)*
852
+
853
+ - [ ] Áp dụng safe area insets ở mọi màn — trên (status bar) và dưới (home indicator)
854
+ - [ ] Touch target tối thiểu: 44×44pt (iOS) / 48×48dp (Android)
855
+ - [ ] Đã test trên màn nhỏ: rộng 375pt (iPhone SE) / rộng 360dp (Android phổ biến)
856
+ - [ ] Deep link entry: `{scheme}://{host}/{path}` → vào {tên màn} với {param} đã điền sẵn
857
+ - [ ] Permission gate: {liệt kê permission cần — Camera / Location / Notification}
858
+ - {Permission}: yêu cầu ở {tên màn} với copy lý do: "{copy TBD}"
859
+ - [ ] Hành vi offline / không mạng:
860
+ - {Tên màn}: hiện dữ liệu cache + banner offline
861
+ - {Tên action}: disable nút, hiện tooltip "Requires connection"
862
+ - [ ] Dark mode: mọi màn đã test dark mode — không có màu hardcode
863
+
864
+ ---
865
+
866
+ # 5. AC-UI — Tiêu chí chấp nhận về Design
867
+
868
+ > Được **PO + Designer** cùng review và sign off trước khi sinh BDD.
869
+ > Bổ sung cho (không thay thế) AC mức nghiệp vụ trong [Business PRD]({prd-path}).
870
+
871
+ | ID | Tiêu chí chấp nhận | Verified by |
872
+ |--------|--------------------------------------------------------------------------------|-----------------|
873
+ | AC-UI1 | Mọi màn khớp frame Figma đã duyệt trong dung sai design-system | Designer |
874
+ | AC-UI2 | Trạng thái đang tải xuất hiện gần như tức thì (≤200ms) khi màn bắt đầu tải dữ liệu | QA |
875
+ | AC-UI3 | Mọi message lỗi đều hiển thị, rõ ràng, và kèm action khôi phục | PO |
876
+ | AC-UI4 | Empty state có illustration và call-to-action rõ ràng | PO + Designer |
877
+ | AC-UI5 | {Riêng platform — vd web: "Mọi màn pass kiểm tra tương phản WCAG AA"} | QA |
878
+ | AC-UI6 | {Riêng platform — vd app: "Cử chỉ back ở mọi màn quay về đúng màn trước"} | QA |
879
+ | AC-UI7 | {Tiêu chí UI riêng của feature từ section wireframe của Business PRD} | PO |
880
+
881
+ ---
882
+
883
+ # Appendix
884
+
885
+ ## Tóm tắt Figma
886
+
887
+ | Màn hình | Figma Frame | Trạng thái Link / Fetch |
888
+ |-----------------|--------------------------------------|--------------------------------------|
889
+ | {Màn hình 1} | [Link]({figma_frames[Screen 1]}) | ✅ Đã link & fetch |
890
+ | {Màn hình 2} | — | ❌ Missing — không có link node-id |
891
+
892
+ ## Design Token đã tham chiếu
893
+
894
+ | Token | Value | Dùng ở |
895
+ |-----------------------|---------------|---------------------------------|
896
+ | `color.primary` | {#hex} | Primary button, link, active state |
897
+ | `color.surface` | {#hex} | Nền card |
898
+ | `spacing.md` | {16px / 4} | Khoảng cách dọc tiêu chuẩn |
899
+ | `typography.heading2` | {font/size} | Title màn hình |
900
+
901
+ ## Tài liệu tham khảo
902
+
903
+ - [{TICKET-ID}]({prd-path}) — Business PRD (nguồn của AC, UC, BR)
904
+ - {[Design Spec khác](./other-ds.md) — nếu feature này dùng chung màn}
905
+
906
+ ## Giả định AI
907
+
908
+ > Mỗi giả định dưới đây được đưa ra vì input PO chưa đầy đủ.
909
+ > PO phải review và confirm trước khi sign-off.
910
+
911
+ - {Giả định 1 — [AI DRAFT]}
912
+ - {Một dòng cho mỗi màn ❌ Missing: "Không có Figma frame đọc được cho {screen} — draft chỉ-text; chặn sign-off cho tới khi thêm link node-id."}
913
+
914
+ ---
915
+
916
+ ## Changelog
917
+
918
+ | Version | Date | Changes |
919
+ |---------|--------------|-----------------|
920
+ | 1.0 | {YYYY-MM-DD} | Initial version |
921
+
922
+ <!--
923
+ NEXT STEPS:
924
+ 1. Điền các link Figma frame còn ❌ Missing (link node-id) — chạy lại để fetch & ground chúng.
925
+ 2. Chia sẻ với Designer — xác minh link Figma, cập nhật component inventory.
926
+ 3. PO + Designer sign off: đổi Status → "approved" (chỉ cho phép khi 0 màn ❌ Missing).
927
+ 4. Chạy /generate-bdd "{prd-file}" — BDD dùng AC-UI từ spec này cho FE scenario.
928
+ -->
929
+ ````
930
+
931
+ ---
932
+
933
+ ## Self-Review Gate *(cổng tự-rà — bắt buộc chạy trước khi ghi)*
934
+
935
+ - [ ] Mọi màn trong Screen Inventory có Screen Spec đầy đủ ở Section 2
936
+ - [ ] Mọi màn có tối thiểu các state: default, loading, error
937
+ - [ ] Mọi component Figma đã map trong Component Inventory — chưa map thì gắn cờ `[NEW]` hoặc `[TODO]`
938
+ - [ ] Chỉ sinh section liên quan platform ở Section 3 (không có section web trong doc app, và ngược lại)
939
+ - [ ] Chỉ sinh section liên quan platform ở Section 4
940
+ - [ ] Các mục AC-UI testable (pass/fail rõ ràng, không phải "looks good")
941
+ - [ ] Link cross-reference Business PRD là relative path hợp lệ
942
+ - [ ] Mọi màn có link Figma frame node-level (`?node-id=`) — và các màn có link đã được fetch qua Figma MCP và dùng để ground spec
943
+ - [ ] Mỗi màn ❌ Missing được gắn cờ trong spec (`> [DRAFT — no Figma frame...]`), liệt kê trong Figma Summary, và có một AI Assumption
944
+ - [ ] Nếu bất kỳ màn nào ❌ Missing → Status giữ `draft` (generate-bdd FE/App cảnh báo mềm, không chặn cứng)
945
+ - [ ] **Ngôn ngữ Tầng A sạch:** không tên layer/variant Figma, mã token/hex/px, hay ẩn dụ dữ liệu (cờ/giá trị/đọc-ghi khi là artifact) lọt vào §1, Layout, Screen States, Actions, AC-UI — định danh kỹ thuật chỉ ở Component Inventory / Design Token / cột Figma. Backtick không bọc giá trị nghiệp vụ. Khái niệm đã có trong business-dictionary dùng đúng term chuẩn.
946
+
947
+ > **Đây là CỔNG, không phải nhắc nhở:** chạy từng mục trên TRƯỚC khi ghi file. Mục nào **FAIL** → **bắt buộc**:
948
+ > 1. ghi một dòng `⚠️ {mục thiếu — màn/section cụ thể}` vào section **"Giả định AI"** của file (đừng để lọt im lặng), VÀ
949
+ > 2. giữ `| **Status** | draft |` (chưa đủ điều kiện để PO+Designer sign-off `approved`).
950
+ > KHÔNG xuất design-spec như "hoàn chỉnh" khi còn mục fail chưa gắn cờ.
951
+
952
+ ---
953
+
954
+ ## Output
955
+
956
+ # Report Footer — Định dạng output chuẩn cho mọi lệnh
957
+
958
+ Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
959
+
960
+ ## Status Badge
961
+
962
+ Chọn một theo kết quả:
963
+ - `✅ Complete` — mọi bước thành công, không có vấn đề
964
+ - `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
965
+ - `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
966
+
967
+ ## Output Artifacts
968
+
969
+ Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
970
+ ```
971
+ Output Artifacts:
972
+ {created|updated} {file-path} ({mô tả ngắn})
973
+ {created|updated} {file-path} ({mô tả ngắn})
974
+ ```
975
+
976
+ Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
977
+
978
+ ## Pipeline Position
979
+
980
+ In một sơ đồ pipeline một dòng, đánh dấu phase của lệnh HIỆN TẠI bằng `◀ bạn ở đây`,
981
+ để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
982
+
983
+ ```
984
+ Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
985
+ ```
986
+
987
+ Tìm lệnh hiện tại trong bảng phase dưới đây và đánh dấu **phase của nó** trong sơ đồ trên:
988
+
989
+ | Phase | Commands |
990
+ |-------|----------|
991
+ | Discovery | `/define-product` |
992
+ | PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
993
+ | Design Spec | `/generate-design-spec` |
994
+ | BDD | `/generate-bdd` · `/review-context` (BDD) |
995
+ | Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
996
+ | Code | `/generate-code` · `/review-code` |
997
+ | Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
998
+ | QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
999
+ | Trace Audit | `/validate-traces` |
1000
+
1001
+ Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
1002
+ `Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
1003
+
1004
+ **Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
1005
+ `/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
1006
+ **bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
1007
+
1008
+ ## Gợi ý lệnh tiếp theo
1009
+
1010
+ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
1011
+
1012
+ | Lệnh hiện tại | Gợi ý lệnh tiếp theo |
1013
+ |-------------------------|-----------------------------------------------|
1014
+ | /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
1015
+ | /define-product | `/generate-prd {product-definition-file}` |
1016
+ | /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
1017
+ | /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
1018
+ | /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
1019
+ | /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
1020
+ | /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
1021
+ | /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
1022
+ | /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
1023
+ | /qc-plan | `/qc-design-test {UC-ID}` |
1024
+ | /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
1025
+ | /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
1026
+ | /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
1027
+ | /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
1028
+ | /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
1029
+ | /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
1030
+ | /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
1031
+ | /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
1032
+ | /dev-gen-test | `/dev-run-test {UC-ID}` |
1033
+ | /dev-run-test (passing) | `/review-code {UC-ID}` |
1034
+ | /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
1035
+ | /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
1036
+ | /dev-smoke-test | Tạo PR và link tới ticket |
1037
+ | /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
1038
+ | /fix-bug | Tạo PR và link tới ticket |
1039
+ | /debug | `/fix-bug {ticket-id}` nếu cần sửa |
1040
+ | /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
1041
+ | /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
1042
+ | /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
1043
+ | /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
1044
+ | /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
1045
+
1046
+ Định dạng footer như sau:
1047
+ ```
1048
+ ---
1049
+ Status : {badge}
1050
+ {khối Output Artifacts}
1051
+ Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
1052
+ (lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
1053
+ Next : {lệnh gợi ý kèm ví dụ tham số}
1054
+ ```
1055
+ *(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
1056
+
1057
+
1058
+ {Nếu missing_frames rỗng}:
1059
+ ```
1060
+ /generate-design-spec Hoàn tất — {TICKET-ID} [{active_platform}]
1061
+ ---
1062
+ Status : ✅ Complete — cả {N} màn đã link & fetch từ Figma
1063
+ Output Artifacts:
1064
+ created {paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md (v1.0)
1065
+ Next : Chia sẻ với Designer → PO + Designer sign-off (Status: approved)
1066
+ → /generate-bdd {prd-file} (sinh BDD theo service; đọc AC-UI từ Design Spec)
1067
+ ```
1068
+
1069
+ {Nếu missing_frames khác rỗng}:
1070
+ ```
1071
+ /generate-design-spec Hoàn tất (DRAFT) — {TICKET-ID} [{active_platform}]
1072
+ ---
1073
+ Status : ⚠️ Warnings — {count} màn không có link Figma frame đọc được: {missing_frames ngăn cách bởi dấu phẩy}
1074
+ Output Artifacts:
1075
+ created {paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md (v1.0, draft)
1076
+ Next : 🔒 Khuyến nghị hoàn tất sign-off trước (đủ link Figma node-id); /generate-bdd FE/App sẽ cảnh báo nếu design-spec chưa approved.
1077
+ 1. Trong Figma: chọn mỗi frame còn thiếu → chuột phải → Copy link to selection
1078
+ 2. Chạy lại /generate-design-spec {prd-file} → AI fetch & ground các frame mới
1079
+ ```