@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,21 +1,21 @@
|
|
|
1
1
|
---
|
|
2
|
-
description:
|
|
2
|
+
description: Sinh tài liệu Design Specification cho platform FE hoặc App từ một Business PRD. Trigger when: "/generate-design-spec", "tạo design spec", "generate design spec", "viết design spec", "tạo tài liệu thiết kế UI", "generate UI spec", "cần design spec cho", "tôi muốn spec UI", "tài liệu cho FE", "tài liệu cho app".
|
|
3
3
|
---
|
|
4
4
|
|
|
5
5
|
# /generate-design-spec — Generate Design Specification (FE / App)
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
Design Spec
|
|
9
|
-
|
|
7
|
+
Skill này sinh một Design Spec riêng theo platform từ một Business PRD.
|
|
8
|
+
Design Spec nắm bắt yêu cầu UI mức màn hình, component inventory, tương tác platform,
|
|
9
|
+
và AC-UI mức design để PO + Designer sign off — tách khỏi PRD mức nghiệp vụ.
|
|
10
10
|
|
|
11
|
-
**
|
|
12
|
-
**
|
|
11
|
+
**Platform hỗ trợ:** web (react / nextjs / vue / angular), app (flutter / react-native / ios-swiftui / android-compose)
|
|
12
|
+
**Không hỗ trợ:** service backend — API contract thuộc về Business PRD.
|
|
13
13
|
|
|
14
14
|
---
|
|
15
15
|
|
|
16
16
|
## Gate
|
|
17
17
|
|
|
18
|
-
<!-- Directory: specs
|
|
18
|
+
<!-- Directory: specs/*/*/*.md (file PRD ở gốc feature folder) -->
|
|
19
19
|
{{include:steps/gate.md}}
|
|
20
20
|
|
|
21
21
|
---
|
|
@@ -24,59 +24,59 @@ and design-level AC-UI for PO + Designer sign-off — separate from the business
|
|
|
24
24
|
|
|
25
25
|
{{include:steps/context-loader.md}}
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
*Đọc PRD target. Trích: TICKET-ID, domain, tên feature, Service, Module từ metadata, User Flow (Section 4a), tên màn hình Wireframe (Section 4b).*
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
31
|
## Platform Check
|
|
32
32
|
|
|
33
|
-
- `platform_type = "backend"` → **STOP**: "Design Spec
|
|
33
|
+
- `platform_type = "backend"` → **STOP**: "Design Spec chỉ dành cho FE/App. API contract BE đi vào Business PRD."
|
|
34
34
|
- `platform_type = "web-frontend"` → `active_platform = "web"`
|
|
35
|
-
- `platform_type = "mobile"` → `active_platform = "app"` (
|
|
36
|
-
- `platform_type = "unknown"` →
|
|
35
|
+
- `platform_type = "mobile"` → `active_platform = "app"` (hoặc `"app-ios"` / `"app-android"` cho native)
|
|
36
|
+
- `platform_type = "unknown"` → hỏi user chọn platform
|
|
37
37
|
|
|
38
38
|
---
|
|
39
39
|
|
|
40
40
|
## Figma Check
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
Hỏi: "Bạn có link Figma không? (dán URL hoặc Enter để skip)"
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
Lưu thành `figma_url` hoặc set `"TBD"` kèm AI Assumption.
|
|
45
45
|
|
|
46
46
|
---
|
|
47
47
|
|
|
48
48
|
## Screen Discovery
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
Trích tên màn hình từ Section 4 của PRD. Trình bày danh sách để PO confirm/thêm trước khi sinh.
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
54
|
## Generate
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
Ghi `specs/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md`.
|
|
57
57
|
|
|
58
|
-
|
|
59
|
-
1. **Metadata** — Spec ID, platform, module, service, Business PRD link
|
|
60
|
-
2. **Screen Inventory** —
|
|
61
|
-
3. **Screen Specs** (
|
|
62
|
-
- Layout (grid, spacing, design
|
|
58
|
+
Cấu trúc:
|
|
59
|
+
1. **Metadata** — Spec ID, platform, module, service, link Business PRD, link Figma
|
|
60
|
+
2. **Screen Inventory** — bảng mọi màn hình với entry point và link Figma frame
|
|
61
|
+
3. **Screen Specs** (theo từng màn):
|
|
62
|
+
- Layout (grid, spacing, design token)
|
|
63
63
|
- Component Inventory (Figma → code component, import path, states)
|
|
64
64
|
- Screen States (default / loading / error / empty / success)
|
|
65
|
-
- Actions & Navigation (
|
|
66
|
-
4. **Interaction Patterns** (platform
|
|
67
|
-
- Web: responsive
|
|
68
|
-
- App: gesture
|
|
69
|
-
5. **Platform Considerations** (platform
|
|
70
|
-
- Web: accessibility
|
|
71
|
-
- App: safe area, touch
|
|
72
|
-
6. **AC-UI** — design acceptance criteria
|
|
73
|
-
7. **Appendix** — Figma
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
-
|
|
77
|
-
- ✅ Found →
|
|
78
|
-
- ⚠️ TODO →
|
|
79
|
-
- ❌ Not found →
|
|
65
|
+
- Actions & Navigation (trigger → kết quả)
|
|
66
|
+
4. **Interaction Patterns** (thích ứng theo platform):
|
|
67
|
+
- Web: bảng responsive breakpoint, bảng hover/focus/keyboard
|
|
68
|
+
- App: bảng gesture, sơ đồ navigation stack, bảng convention iOS vs Android
|
|
69
|
+
5. **Platform Considerations** (thích ứng theo platform):
|
|
70
|
+
- Web: checklist accessibility (WCAG, keyboard, ARIA)
|
|
71
|
+
- App: safe area, touch target, deep link, permission, offline, dark mode
|
|
72
|
+
6. **AC-UI** — bảng design acceptance criteria (Verified by: Designer / PO / QA)
|
|
73
|
+
7. **Appendix** — tóm tắt Figma, design token, references, AI assumptions, changelog
|
|
74
|
+
|
|
75
|
+
Quy tắc component mapping:
|
|
76
|
+
- Kiểm tra `figma-components/{active_module}.md` (nạp trong context) cho mọi component
|
|
77
|
+
- ✅ Found → dùng đúng Code Component + Import Path
|
|
78
|
+
- ⚠️ TODO → đánh dấu `[TODO — implementation pending]`
|
|
79
|
+
- ❌ Not found → đánh dấu `[NEW — confirm with designer]`
|
|
80
80
|
|
|
81
81
|
---
|
|
82
82
|
|
|
@@ -85,11 +85,11 @@ Component mapping rules:
|
|
|
85
85
|
{{include:steps/report-footer.md}}
|
|
86
86
|
|
|
87
87
|
```
|
|
88
|
-
/generate-design-spec
|
|
88
|
+
/generate-design-spec Hoàn tất — {TICKET-ID} [{active_platform}]
|
|
89
89
|
---
|
|
90
90
|
Status : ✅ Complete
|
|
91
91
|
Output Artifacts:
|
|
92
92
|
created specs/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md (v1.0)
|
|
93
|
-
Next :
|
|
93
|
+
Next : Chia sẻ với Designer → thêm link Figma → PO + Designer sign-off
|
|
94
94
|
→ /generate-bdd {prd-file}
|
|
95
95
|
```
|