@edupia-tutor/spec-driven-docs 0.14.0 → 0.14.2

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 (162) hide show
  1. package/bin/index.js +12 -1
  2. package/commands/debug.md +436 -436
  3. package/commands/debug.tmpl +111 -111
  4. package/commands/define-product.md +350 -345
  5. package/commands/define-product.tmpl +69 -64
  6. package/commands/dev-gen-test.md +365 -365
  7. package/commands/dev-gen-test.tmpl +63 -63
  8. package/commands/dev-run-test.md +376 -376
  9. package/commands/dev-run-test.tmpl +74 -74
  10. package/commands/dev-smoke-test.md +341 -341
  11. package/commands/dev-smoke-test.tmpl +60 -60
  12. package/commands/fix-bug.md +403 -403
  13. package/commands/fix-bug.tmpl +78 -78
  14. package/commands/generate-bdd.md +513 -513
  15. package/commands/generate-bdd.tmpl +211 -211
  16. package/commands/generate-code.md +481 -483
  17. package/commands/generate-code.tmpl +179 -181
  18. package/commands/generate-design-spec.md +497 -497
  19. package/commands/generate-design-spec.tmpl +220 -220
  20. package/commands/generate-prd.md +452 -400
  21. package/commands/generate-prd.tmpl +50 -200
  22. package/commands/generate-spec-manifest.md +340 -340
  23. package/commands/generate-spec-manifest.tmpl +59 -59
  24. package/commands/generate-tech-docs.md +365 -365
  25. package/commands/generate-tech-docs.tmpl +84 -84
  26. package/commands/learn.md +347 -347
  27. package/commands/learn.tmpl +22 -22
  28. package/commands/map-testids.md +322 -322
  29. package/commands/map-testids.tmpl +41 -41
  30. package/commands/propose-scenario.md +335 -335
  31. package/commands/propose-scenario.tmpl +54 -54
  32. package/commands/qc-analyze.md +323 -324
  33. package/commands/qc-analyze.tmpl +42 -43
  34. package/commands/qc-design-test.md +304 -304
  35. package/commands/qc-design-test.tmpl +23 -23
  36. package/commands/qc-plan.md +297 -297
  37. package/commands/qc-plan.tmpl +16 -16
  38. package/commands/qc-report.md +302 -302
  39. package/commands/qc-report.tmpl +21 -21
  40. package/commands/qc-review.md +298 -298
  41. package/commands/qc-review.tmpl +17 -17
  42. package/commands/qc-run-test.md +337 -337
  43. package/commands/qc-run-test.tmpl +35 -35
  44. package/commands/refine-prd.md +428 -430
  45. package/commands/refine-prd.tmpl +62 -62
  46. package/commands/report-bug.md +351 -351
  47. package/commands/report-bug.tmpl +70 -70
  48. package/commands/review-code.md +364 -364
  49. package/commands/review-code.tmpl +39 -39
  50. package/commands/review-context.md +578 -580
  51. package/commands/review-context.tmpl +212 -212
  52. package/commands/review-tech-docs.md +427 -427
  53. package/commands/review-tech-docs.tmpl +146 -146
  54. package/commands/setup-ai-first.md +239 -239
  55. package/commands/setup-ai-first.tmpl +133 -133
  56. package/commands/sync.md +145 -145
  57. package/commands/sync.tmpl +93 -93
  58. package/commands/update-framework.md +88 -88
  59. package/commands/update-framework.tmpl +36 -36
  60. package/commands/validate-traces.md +381 -381
  61. package/commands/validate-traces.tmpl +100 -100
  62. package/core/FRAMEWORK_VERSION +1 -1
  63. package/core/commands/debug.md +436 -436
  64. package/core/commands/define-product.md +350 -345
  65. package/core/commands/dev-gen-test.md +365 -365
  66. package/core/commands/dev-run-test.md +376 -376
  67. package/core/commands/dev-smoke-test.md +341 -341
  68. package/core/commands/fix-bug.md +403 -403
  69. package/core/commands/generate-bdd.md +513 -513
  70. package/core/commands/generate-code.md +481 -483
  71. package/core/commands/generate-design-spec.md +497 -497
  72. package/core/commands/generate-prd.md +452 -400
  73. package/core/commands/generate-spec-manifest.md +340 -340
  74. package/core/commands/generate-tech-docs.md +365 -365
  75. package/core/commands/learn.md +347 -347
  76. package/core/commands/map-testids.md +322 -322
  77. package/core/commands/propose-scenario.md +335 -335
  78. package/core/commands/qc-analyze.md +323 -324
  79. package/core/commands/qc-design-test.md +304 -304
  80. package/core/commands/qc-plan.md +297 -297
  81. package/core/commands/qc-report.md +302 -302
  82. package/core/commands/qc-review.md +298 -298
  83. package/core/commands/qc-run-test.md +337 -337
  84. package/core/commands/refine-prd.md +428 -430
  85. package/core/commands/report-bug.md +351 -351
  86. package/core/commands/review-code.md +364 -364
  87. package/core/commands/review-context.md +578 -580
  88. package/core/commands/review-tech-docs.md +427 -427
  89. package/core/commands/setup-ai-first.md +239 -239
  90. package/core/commands/sync.md +145 -145
  91. package/core/commands/update-framework.md +88 -88
  92. package/core/commands/validate-traces.md +381 -381
  93. package/core/skills/code/SKILL.md +389 -389
  94. package/core/skills/debug/SKILL.md +391 -391
  95. package/core/skills/design-spec/SKILL.md +318 -318
  96. package/core/skills/discovery/SKILL.md +7 -547
  97. package/core/skills/prd/SKILL.md +298 -394
  98. package/core/skills/setup-ai-first/SKILL.md +80 -80
  99. package/core/skills/spec/SKILL.md +178 -178
  100. package/core/skills/test/SKILL.md +604 -604
  101. package/core/steps/capture-lesson.md +44 -44
  102. package/core/steps/context-loader.md +175 -175
  103. package/core/steps/gate.md +54 -54
  104. package/core/steps/report-footer.md +52 -52
  105. package/core/steps/review-fanout.md +85 -87
  106. package/core/steps/spawn-agent.md +45 -45
  107. package/core/steps/trace-mirror.md +21 -21
  108. package/core/templates/architecture.template.md +37 -37
  109. package/core/templates/design-spec.template.md +77 -77
  110. package/core/templates/platform-guide.template.md +47 -47
  111. package/core/templates/prd.template.md +107 -232
  112. package/core/templates/product-definition.template.md +101 -88
  113. package/core/templates/project-context.yaml +2 -2
  114. package/docs/01-getting-started/core-concepts.md +1 -1
  115. package/docs/01-getting-started/quickstart.md +7 -7
  116. package/docs/02-guides/developer/bdd-and-trace.md +1 -1
  117. package/docs/02-guides/developer/scenarios.md +5 -5
  118. package/docs/02-guides/product-owner/handoff-checklist.md +1 -1
  119. package/docs/02-guides/product-owner/scenarios.md +23 -23
  120. package/docs/02-guides/tester/bug-reporting.md +2 -2
  121. package/docs/02-guides/tester/reading-specs.md +2 -2
  122. package/docs/02-guides/tester/scenarios.md +1 -1
  123. package/docs/02-guides/tester/spec-manifest.md +3 -3
  124. package/docs/02-guides/tester/workflow.md +1 -1
  125. package/docs/03-concepts/architecture.md +3 -3
  126. package/docs/03-concepts/pipeline.md +3 -3
  127. package/docs/04-operations/publishing.md +20 -3
  128. package/docs/04-operations/sync-and-update.md +5 -5
  129. package/docs/05-reference/command-cheatsheet.md +2 -2
  130. package/docs/05-reference/commands.md +8 -8
  131. package/package.json +1 -1
  132. package/scripts/migrate-specs.js +5 -3
  133. package/scripts/rename-prd-files.js +174 -0
  134. package/skills/code/SKILL.md +389 -389
  135. package/skills/code/SKILL.tmpl +56 -56
  136. package/skills/debug/SKILL.md +391 -391
  137. package/skills/debug/SKILL.tmpl +60 -60
  138. package/skills/design-spec/SKILL.md +318 -318
  139. package/skills/design-spec/SKILL.tmpl +37 -37
  140. package/skills/discovery/SKILL.md +7 -547
  141. package/skills/discovery/SKILL.tmpl +7 -140
  142. package/skills/prd/SKILL.md +298 -394
  143. package/skills/prd/SKILL.tmpl +40 -151
  144. package/skills/setup-ai-first/SKILL.md +80 -80
  145. package/skills/setup-ai-first/SKILL.tmpl +28 -28
  146. package/skills/spec/SKILL.md +178 -178
  147. package/skills/spec/SKILL.tmpl +20 -20
  148. package/skills/test/SKILL.md +604 -604
  149. package/skills/test/SKILL.tmpl +44 -44
  150. package/steps/capture-lesson.md +44 -44
  151. package/steps/context-loader.md +175 -175
  152. package/steps/gate.md +54 -54
  153. package/steps/report-footer.md +52 -52
  154. package/steps/review-fanout.md +85 -87
  155. package/steps/spawn-agent.md +45 -45
  156. package/steps/trace-mirror.md +21 -21
  157. package/templates/architecture.template.md +37 -37
  158. package/templates/design-spec.template.md +77 -77
  159. package/templates/platform-guide.template.md +47 -47
  160. package/templates/prd.template.md +107 -232
  161. package/templates/product-definition.template.md +101 -88
  162. package/templates/project-context.yaml +2 -2
@@ -1,10 +1,10 @@
1
1
  ---
2
- description: Generates implementation code from approved BDD specs with traceability tags, or performs a read-only code review against spec compliance and architecture rules. Trigger when: "/generate-code", "/review-code", "sinh code", "generate code", "viết code", "implement feature", "review code", "kiểm tra code", "code review", "check implementation".
2
+ description: Sinh implementation code từ BDD spec đã duyệt kèm tag traceability, hoặc review code read-only đối chiếu spec compliance quy tắc kiến trúc. Trigger when: "/generate-code", "/review-code", "sinh code", "generate code", "viết code", "implement feature", "review code", "kiểm tra code", "code review", "check implementation".
3
3
  ---
4
4
 
5
5
  # Code Skills — Generate & Review
6
6
 
7
- This skill handles `/generate-code` (implementation) and `/review-code` (read-only review).
7
+ Skill này xử `/generate-code` (implementation) `/review-code` (review read-only).
8
8
 
9
9
  ---
10
10
 
@@ -15,10 +15,10 @@ This skill handles `/generate-code` (implementation) and `/review-code` (read-on
15
15
  <!-- Directory: specs/*/*/bdd/*.feature -->
16
16
  {{include:steps/gate.md}}
17
17
 
18
- 4. Check for existing trace state: read `.trace/{domain}/{prd-slug}/{UC-ID}.tsv` if it exists.
19
- - Identify: new scenarios vs. drifted (changed) vs. synced (skip)
18
+ 4. Kiểm tra trace state có sẵn: đọc `.trace/{domain}/{prd-slug}/{UC-ID}.tsv` nếu tồn tại.
19
+ - Xác định: scenario mới vs. drifted (đã đổi) vs. synced (skip)
20
20
 
21
- 5. Show **CHECKPOINT — Comprehension**:
21
+ 5. Hiện **CHECKPOINT — Comprehension**:
22
22
  ```
23
23
  I understand:
24
24
  - Feature: {name} | Ticket: {TICKET_ID if known}
@@ -29,20 +29,20 @@ This skill handles `/generate-code` (implementation) and `/review-code` (read-on
29
29
 
30
30
  Proceed? (Y/N)
31
31
  ```
32
- Wait for confirmation.
32
+ Chờ xác nhận.
33
33
 
34
34
  ### Context Load
35
35
 
36
36
  {{include:steps/context-loader.md}}
37
37
 
38
- Also read:
39
- - `.feature` file (what to implement)
40
- - Tech doc `specs/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` (if exists)
41
- - Existing entity/model files in this domain (to follow patterns)
38
+ Cũng đọc:
39
+ - File `.feature` (cần implement )
40
+ - Tech doc `specs/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` (nếu tồn tại)
41
+ - File entity/model sẵn trong domain này (để theo pattern)
42
42
 
43
43
  ### Branch
44
44
 
45
- Create a feature branch:
45
+ Tạo feature branch:
46
46
  ```bash
47
47
  git checkout -b feature/{TICKET_ID}-{slug}
48
48
  # If no ticket ID: feature/{UC-ID}-{slug}
@@ -50,37 +50,37 @@ git checkout -b feature/{TICKET_ID}-{slug}
50
50
 
51
51
  ### Generate
52
52
 
53
- Generate code in layer order (adapt to your stack):
53
+ Sinh code theo thứ tự layer (thích ứng theo stack của bạn):
54
54
 
55
- **For a typical layered backend (e.g., Controller → Service → Repository):**
55
+ **Cho một backend phân lớp điển hình (vd Controller → Service → Repository):**
56
56
 
57
- 1. **DTOs / Request-Response models** — input validation, output shape
58
- 2. **Domain entity / model** — data representation
59
- 3. **Repository / Data Access** — queries, filters
57
+ 1. **DTOs / Request-Response models** — validate input, shape output
58
+ 2. **Domain entity / model** — biểu diễn dữ liệu
59
+ 3. **Repository / Data Access** — query, filter
60
60
  4. **Service interface** — contract
61
- 5. **Service implementation** — business logic, `@Transactional` where needed
62
- 6. **Facade interface** (if architecture uses facade layer) — orchestration contract
63
- 7. **Facade implementation** — cross-service orchestration
64
- 8. **Controller / Handler** — HTTP mapping, auth, `@trace` tags
61
+ 5. **Service implementation** — business logic, `@Transactional` khi cần
62
+ 6. **Facade interface** (nếu kiến trúc dùng facade layer) — contract orchestration
63
+ 7. **Facade implementation** — orchestration liên-service
64
+ 8. **Controller / Handler** — HTTP mapping, auth, tag `@trace`
65
65
 
66
- **Critical: Traceability tags on every controller method:**
66
+ **Quan trọng: Tag traceability trên mỗi controller method:**
67
67
  ```
68
68
  # @trace.implements={UC-ID}-SC{N}
69
69
  # @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature
70
70
  ```
71
- (Use your language's comment syntax)
71
+ (Dùng pháp comment của ngôn ngữ bạn)
72
72
 
73
- ### Self-Review (3 rounds)
73
+ ### Self-Review (3 vòng)
74
74
 
75
- After generating, verify:
76
- - [ ] Every scenario in .feature has a corresponding controller endpoint
77
- - [ ] `@trace.implements` tag on every endpoint
78
- - [ ] Architecture layer rules respected (from CLAUDE.md)
79
- - [ ] Error handling matches CLAUDE.md §error_handling
80
- - [ ] No magic numbers, no debug logging
81
- - [ ] Coding standards from CLAUDE.md followed
75
+ Sau khi sinh, verify:
76
+ - [ ] Mỗi scenario trong .feature controller endpoint tương ứng
77
+ - [ ] Tag `@trace.implements` trên mỗi endpoint
78
+ - [ ] Tôn trọng quy tắc layer kiến trúc (từ CLAUDE.md)
79
+ - [ ] Error handling khớp CLAUDE.md §error_handling
80
+ - [ ] Không magic number, không debug logging
81
+ - [ ] Theo coding standards từ CLAUDE.md
82
82
 
83
- If issues found → fix inline before proceeding.
83
+ Nếu phát hiện issue → fix inline trước khi tiếp tục.
84
84
 
85
85
  ### Build Verify
86
86
 
@@ -88,11 +88,11 @@ If issues found → fix inline before proceeding.
88
88
  {BUILD_COMMAND} # from project-context.yaml, max 3 retries
89
89
  ```
90
90
 
91
- If build fails: read error, fix, retry. After 3 failures, report to user with diagnosis.
91
+ Nếu build fail: đọc lỗi, fix, retry. Sau 3 lần fail, report cho user kèm diagnosis.
92
92
 
93
93
  ### Write Trace State
94
94
 
95
- Update `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`:
95
+ Cập nhật `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`:
96
96
  ```
97
97
  UC-ID\tSC-ID\tsc_version\timplemented_by\tlast_updated
98
98
  {UC-ID}\tSC1\t{hash of scenario text}\t{ControllerClass}.{method}\t{date}
@@ -119,38 +119,38 @@ git commit -m "{commit_format from CLAUDE.md}: {description}"
119
119
 
120
120
  ---
121
121
 
122
- ## /review-code — Read-Only Code Review
122
+ ## /review-code — Code Review chỉ-đọc
123
123
 
124
- **IMPORTANT**: This is READ-ONLY. Report issues but do NOT make changes.
124
+ **QUAN TRỌNG**: Đây READ-ONLY. Report issue nhưng KHÔNG sửa.
125
125
 
126
126
  ### Input
127
127
 
128
- Accept: UC-ID, file path, or current branch name.
128
+ Nhận: UC-ID, file path, hoặc tên branch hiện tại.
129
129
 
130
130
  ### Review Dimensions
131
131
 
132
132
  #### 1. Traceability
133
- - [ ] Every controller endpoint has `@trace.implements` tag?
134
- - [ ] Every test file has `@trace.verifies` tag?
135
- - [ ] No `@trace` tags on non-controller layers (Service, Repository, etc.)?
136
- - [ ] `.trace/{domain}/{prd-slug}/{UC-ID}.tsv` is up to date?
137
-
138
- #### 2. Layer Architecture (from CLAUDE.md)
139
- - [ ] Each class is in the correct layer?
140
- - [ ] Layer dependencies flow in the right direction?
141
- - [ ] No layer is bypassed (e.g., Controller calling Repository directly)?
142
-
143
- #### 3. Coding Standards (from CLAUDE.md)
144
- - [ ] Naming conventions followed?
145
- - [ ] Response wrapper used consistently?
146
- - [ ] Exceptions thrown (not swallowed or manually built into responses)?
147
- - [ ] No magic numbers?
148
- - [ ] No sensitive data in logs?
149
- - [ ] Transaction annotations correct?
133
+ - [ ] Mỗi controller endpoint tag `@trace.implements`?
134
+ - [ ] Mỗi test file tag `@trace.verifies`?
135
+ - [ ] Không có tag `@trace` layer không phải controller (Service, Repository, v.v.)?
136
+ - [ ] `.trace/{domain}/{prd-slug}/{UC-ID}.tsv` cập nhật chưa?
137
+
138
+ #### 2. Layer Architecture (từ CLAUDE.md)
139
+ - [ ] Mỗi class đúng layer?
140
+ - [ ] Phụ thuộc giữa layer đi đúng chiều?
141
+ - [ ] Không layer nào bị bypass (vd Controller gọi Repository trực tiếp)?
142
+
143
+ #### 3. Coding Standards (từ CLAUDE.md)
144
+ - [ ] Tuân theo naming convention?
145
+ - [ ] Response wrapper dùng nhất quán?
146
+ - [ ] Exception được throw (không bị nuốt hoặc tự build vào response)?
147
+ - [ ] Không magic number?
148
+ - [ ] Không dữ liệu nhạy cảm trong log?
149
+ - [ ] Annotation transaction đúng?
150
150
 
151
151
  #### 4. Spec Compliance
152
- - [ ] Every scenario in .feature has an implementation?
153
- - [ ] No undocumented endpoints (code not backed by spec)?
152
+ - [ ] Mỗi scenario trong .feature implementation?
153
+ - [ ] Không endpoint không tài liệu (code không spec backing)?
154
154
 
155
155
  ### Output
156
156
 
@@ -171,6 +171,6 @@ Critical: {X} | Major: {Y} | Minor: {Z}
171
171
  Verdict: APPROVED ✅ | NEEDS_FIX ❌
172
172
  ```
173
173
 
174
- If `NEEDS_FIX`: list specific files to change and run `/fix-bug` or correct inline.
174
+ Nếu `NEEDS_FIX`: liệt file cụ thể cần đổi và chạy `/fix-bug` hoặc sửa inline.
175
175
 
176
176
  {{include:steps/report-footer.md}}