@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.
- package/bin/index.js +12 -1
- package/commands/debug.md +436 -436
- package/commands/debug.tmpl +111 -111
- package/commands/define-product.md +350 -345
- package/commands/define-product.tmpl +69 -64
- package/commands/dev-gen-test.md +365 -365
- package/commands/dev-gen-test.tmpl +63 -63
- package/commands/dev-run-test.md +376 -376
- package/commands/dev-run-test.tmpl +74 -74
- package/commands/dev-smoke-test.md +341 -341
- package/commands/dev-smoke-test.tmpl +60 -60
- package/commands/fix-bug.md +403 -403
- package/commands/fix-bug.tmpl +78 -78
- package/commands/generate-bdd.md +513 -513
- package/commands/generate-bdd.tmpl +211 -211
- package/commands/generate-code.md +481 -483
- package/commands/generate-code.tmpl +179 -181
- package/commands/generate-design-spec.md +497 -497
- package/commands/generate-design-spec.tmpl +220 -220
- package/commands/generate-prd.md +452 -400
- package/commands/generate-prd.tmpl +50 -200
- package/commands/generate-spec-manifest.md +340 -340
- package/commands/generate-spec-manifest.tmpl +59 -59
- package/commands/generate-tech-docs.md +365 -365
- package/commands/generate-tech-docs.tmpl +84 -84
- package/commands/learn.md +347 -347
- package/commands/learn.tmpl +22 -22
- package/commands/map-testids.md +322 -322
- package/commands/map-testids.tmpl +41 -41
- package/commands/propose-scenario.md +335 -335
- package/commands/propose-scenario.tmpl +54 -54
- package/commands/qc-analyze.md +323 -324
- package/commands/qc-analyze.tmpl +42 -43
- package/commands/qc-design-test.md +304 -304
- package/commands/qc-design-test.tmpl +23 -23
- package/commands/qc-plan.md +297 -297
- package/commands/qc-plan.tmpl +16 -16
- package/commands/qc-report.md +302 -302
- package/commands/qc-report.tmpl +21 -21
- package/commands/qc-review.md +298 -298
- package/commands/qc-review.tmpl +17 -17
- package/commands/qc-run-test.md +337 -337
- package/commands/qc-run-test.tmpl +35 -35
- package/commands/refine-prd.md +428 -430
- package/commands/refine-prd.tmpl +62 -62
- package/commands/report-bug.md +351 -351
- package/commands/report-bug.tmpl +70 -70
- package/commands/review-code.md +364 -364
- package/commands/review-code.tmpl +39 -39
- package/commands/review-context.md +578 -580
- package/commands/review-context.tmpl +212 -212
- package/commands/review-tech-docs.md +427 -427
- package/commands/review-tech-docs.tmpl +146 -146
- package/commands/setup-ai-first.md +239 -239
- package/commands/setup-ai-first.tmpl +133 -133
- package/commands/sync.md +145 -145
- package/commands/sync.tmpl +93 -93
- package/commands/update-framework.md +88 -88
- package/commands/update-framework.tmpl +36 -36
- package/commands/validate-traces.md +381 -381
- package/commands/validate-traces.tmpl +100 -100
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +436 -436
- package/core/commands/define-product.md +350 -345
- package/core/commands/dev-gen-test.md +365 -365
- package/core/commands/dev-run-test.md +376 -376
- package/core/commands/dev-smoke-test.md +341 -341
- package/core/commands/fix-bug.md +403 -403
- package/core/commands/generate-bdd.md +513 -513
- package/core/commands/generate-code.md +481 -483
- package/core/commands/generate-design-spec.md +497 -497
- package/core/commands/generate-prd.md +452 -400
- package/core/commands/generate-spec-manifest.md +340 -340
- package/core/commands/generate-tech-docs.md +365 -365
- package/core/commands/learn.md +347 -347
- package/core/commands/map-testids.md +322 -322
- package/core/commands/propose-scenario.md +335 -335
- package/core/commands/qc-analyze.md +323 -324
- package/core/commands/qc-design-test.md +304 -304
- package/core/commands/qc-plan.md +297 -297
- package/core/commands/qc-report.md +302 -302
- package/core/commands/qc-review.md +298 -298
- package/core/commands/qc-run-test.md +337 -337
- package/core/commands/refine-prd.md +428 -430
- package/core/commands/report-bug.md +351 -351
- package/core/commands/review-code.md +364 -364
- package/core/commands/review-context.md +578 -580
- package/core/commands/review-tech-docs.md +427 -427
- package/core/commands/setup-ai-first.md +239 -239
- package/core/commands/sync.md +145 -145
- package/core/commands/update-framework.md +88 -88
- package/core/commands/validate-traces.md +381 -381
- package/core/skills/code/SKILL.md +389 -389
- package/core/skills/debug/SKILL.md +391 -391
- package/core/skills/design-spec/SKILL.md +318 -318
- package/core/skills/discovery/SKILL.md +7 -547
- package/core/skills/prd/SKILL.md +298 -394
- package/core/skills/setup-ai-first/SKILL.md +80 -80
- package/core/skills/spec/SKILL.md +178 -178
- package/core/skills/test/SKILL.md +604 -604
- package/core/steps/capture-lesson.md +44 -44
- package/core/steps/context-loader.md +175 -175
- package/core/steps/gate.md +54 -54
- package/core/steps/report-footer.md +52 -52
- package/core/steps/review-fanout.md +85 -87
- package/core/steps/spawn-agent.md +45 -45
- package/core/steps/trace-mirror.md +21 -21
- package/core/templates/architecture.template.md +37 -37
- package/core/templates/design-spec.template.md +77 -77
- package/core/templates/platform-guide.template.md +47 -47
- package/core/templates/prd.template.md +107 -232
- package/core/templates/product-definition.template.md +101 -88
- package/core/templates/project-context.yaml +2 -2
- package/docs/01-getting-started/core-concepts.md +1 -1
- package/docs/01-getting-started/quickstart.md +7 -7
- package/docs/02-guides/developer/bdd-and-trace.md +1 -1
- package/docs/02-guides/developer/scenarios.md +5 -5
- package/docs/02-guides/product-owner/handoff-checklist.md +1 -1
- package/docs/02-guides/product-owner/scenarios.md +23 -23
- package/docs/02-guides/tester/bug-reporting.md +2 -2
- package/docs/02-guides/tester/reading-specs.md +2 -2
- package/docs/02-guides/tester/scenarios.md +1 -1
- package/docs/02-guides/tester/spec-manifest.md +3 -3
- package/docs/02-guides/tester/workflow.md +1 -1
- package/docs/03-concepts/architecture.md +3 -3
- package/docs/03-concepts/pipeline.md +3 -3
- package/docs/04-operations/publishing.md +20 -3
- package/docs/04-operations/sync-and-update.md +5 -5
- package/docs/05-reference/command-cheatsheet.md +2 -2
- package/docs/05-reference/commands.md +8 -8
- package/package.json +1 -1
- package/scripts/migrate-specs.js +5 -3
- package/scripts/rename-prd-files.js +174 -0
- package/skills/code/SKILL.md +389 -389
- package/skills/code/SKILL.tmpl +56 -56
- package/skills/debug/SKILL.md +391 -391
- package/skills/debug/SKILL.tmpl +60 -60
- package/skills/design-spec/SKILL.md +318 -318
- package/skills/design-spec/SKILL.tmpl +37 -37
- package/skills/discovery/SKILL.md +7 -547
- package/skills/discovery/SKILL.tmpl +7 -140
- package/skills/prd/SKILL.md +298 -394
- package/skills/prd/SKILL.tmpl +40 -151
- package/skills/setup-ai-first/SKILL.md +80 -80
- package/skills/setup-ai-first/SKILL.tmpl +28 -28
- package/skills/spec/SKILL.md +178 -178
- package/skills/spec/SKILL.tmpl +20 -20
- package/skills/test/SKILL.md +604 -604
- package/skills/test/SKILL.tmpl +44 -44
- package/steps/capture-lesson.md +44 -44
- package/steps/context-loader.md +175 -175
- package/steps/gate.md +54 -54
- package/steps/report-footer.md +52 -52
- package/steps/review-fanout.md +85 -87
- package/steps/spawn-agent.md +45 -45
- package/steps/trace-mirror.md +21 -21
- package/templates/architecture.template.md +37 -37
- package/templates/design-spec.template.md +77 -77
- package/templates/platform-guide.template.md +47 -47
- package/templates/prd.template.md +107 -232
- package/templates/product-definition.template.md +101 -88
- package/templates/project-context.yaml +2 -2
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# /review-code —
|
|
1
|
+
# /review-code — Code Review chỉ-đọc
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**CẢNH BÁO: READ-ONLY. Chỉ report, KHÔNG sửa.**
|
|
4
4
|
|
|
5
5
|
## Gate
|
|
6
6
|
{{include:steps/gate.md}}
|
|
7
7
|
|
|
8
|
-
*
|
|
8
|
+
*Lưu ý: Với lệnh này, target ở Bước 1 là một UC-ID, file path, hoặc tên branch hiện tại. Bỏ qua sang nạp context ngay sau khi phân giải target.*
|
|
9
9
|
|
|
10
10
|
## Context
|
|
11
11
|
{{include:steps/context-loader.md}}
|
|
@@ -14,47 +14,47 @@
|
|
|
14
14
|
|
|
15
15
|
## Pre-Review Scan
|
|
16
16
|
|
|
17
|
-
*(
|
|
17
|
+
*(Tách khỏi CHECKPOINT của Gate — phần này liệt kê file và scenario thực tế trong scope.)*
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Quét tìm file implementation và scenario, rồi hiện:
|
|
20
20
|
|
|
21
21
|
```
|
|
22
22
|
Review Scope — {UC-ID}
|
|
23
23
|
──────────────────────────────────────
|
|
24
24
|
UC : {UC-ID}
|
|
25
|
-
Files : {
|
|
26
|
-
Scenarios : {N}
|
|
25
|
+
Files : {danh sách file gắn tag @trace.implements={UC-ID}}
|
|
26
|
+
Scenarios : {N} scenario trong file .feature
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Tiếp tục review? (Y/N)
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Chờ "Y" rõ ràng trước khi tiếp tục.
|
|
32
32
|
|
|
33
33
|
---
|
|
34
34
|
|
|
35
35
|
## Review Dimensions
|
|
36
36
|
|
|
37
37
|
### 1. Traceability
|
|
38
|
-
- [ ]
|
|
39
|
-
- [ ]
|
|
40
|
-
- [ ]
|
|
41
|
-
- [ ] `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
42
|
-
|
|
43
|
-
### 2. Layer Architecture (
|
|
44
|
-
- [ ]
|
|
45
|
-
- [ ]
|
|
46
|
-
- [ ]
|
|
47
|
-
|
|
48
|
-
### 3. Coding Standards (
|
|
49
|
-
- [ ]
|
|
50
|
-
- [ ] Response wrapper
|
|
51
|
-
- [ ]
|
|
52
|
-
- [ ]
|
|
53
|
-
- [ ]
|
|
38
|
+
- [ ] Mỗi controller endpoint có tag `@trace.implements`?
|
|
39
|
+
- [ ] Mỗi test file có tag `@trace.verifies`?
|
|
40
|
+
- [ ] Không có tag `@trace` ở sai layer?
|
|
41
|
+
- [ ] `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` cập nhật chưa? (nếu stale → chạy `/validate-traces {UC-ID}` trước, rồi chạy lại review này)
|
|
42
|
+
|
|
43
|
+
### 2. Layer Architecture (từ CLAUDE.md §2)
|
|
44
|
+
- [ ] Mỗi class ở đúng layer?
|
|
45
|
+
- [ ] Phụ thuộc giữa layer đi đúng chiều?
|
|
46
|
+
- [ ] Không layer nào bị bypass?
|
|
47
|
+
|
|
48
|
+
### 3. Coding Standards (từ CLAUDE.md §3)
|
|
49
|
+
- [ ] Tuân theo naming convention?
|
|
50
|
+
- [ ] Response wrapper dùng nhất quán?
|
|
51
|
+
- [ ] Exception được throw (không bị nuốt)?
|
|
52
|
+
- [ ] Không magic number, không dữ liệu nhạy cảm trong log?
|
|
53
|
+
- [ ] Annotation transaction đúng?
|
|
54
54
|
|
|
55
55
|
### 4. Spec Compliance
|
|
56
|
-
- [ ]
|
|
57
|
-
- [ ]
|
|
56
|
+
- [ ] Mỗi scenario trong .feature có implementation?
|
|
57
|
+
- [ ] Không có endpoint không tài liệu (code không có spec backing)?
|
|
58
58
|
|
|
59
59
|
## Output
|
|
60
60
|
|
|
@@ -77,28 +77,28 @@ Output Artifacts: none (read-only)
|
|
|
77
77
|
|
|
78
78
|
Verdict: APPROVED ✅ | NEEDS_FIX ❌
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Nếu APPROVED ✅:
|
|
81
81
|
Next: /dev-gen-test {UC-ID}
|
|
82
82
|
|
|
83
|
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
86
|
-
- Spec mismatch (code ≠ scenario)
|
|
83
|
+
Nếu NEEDS_FIX ❌:
|
|
84
|
+
- Fix nhỏ (1–3 dòng, không đổi logic) → fix inline → chạy lại /review-code {UC-ID}
|
|
85
|
+
- Vấn đề logic / kiến trúc → /fix-bug {TICKET_ID}
|
|
86
|
+
- Spec mismatch (code ≠ scenario) → /generate-code {feature-file} (gen lại UC bị ảnh hưởng)
|
|
87
87
|
```
|
|
88
88
|
|
|
89
89
|
---
|
|
90
90
|
|
|
91
|
-
##
|
|
91
|
+
## Đề xuất ghi Lessons (tuỳ chọn)
|
|
92
92
|
|
|
93
|
-
|
|
94
|
-
(
|
|
93
|
+
Với mỗi finding **Critical/Major** thể hiện một **lỗi AI lặp lại** trong quá trình sinh code
|
|
94
|
+
(một vi phạm kiến trúc/standards mà AI có khả năng làm lại — KHÔNG phải typo một lần hay nguyên nhân bên ngoài), hỏi:
|
|
95
95
|
|
|
96
96
|
```
|
|
97
|
-
Finding "{issue}"
|
|
98
|
-
|
|
97
|
+
Finding "{issue}" trông như một lỗi lặp lại.
|
|
98
|
+
Ghi nó thành project lesson để /generate-code không lặp lại? (Y/N)
|
|
99
99
|
```
|
|
100
100
|
|
|
101
|
-
|
|
102
|
-
`scope` =
|
|
101
|
+
Nếu `Y` → chạy quy trình capture bên dưới với `category=code-gen`, `source=/review-code {UC-ID}`,
|
|
102
|
+
`scope` = domain hoặc file glob bị ảnh hưởng.
|
|
103
103
|
|
|
104
104
|
{{include:steps/capture-lesson.md}}
|