@educa-corp/sdd-framework 0.6.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/gate-trace.js +25 -2
- package/bin/index.js +32 -5
- package/bin/lint-trace.js +41 -0
- package/bin/self-check.js +430 -3
- package/bin/trace-schema.json +418 -31
- package/core/FRAMEWORK_VERSION +1 -1
- package/{commands/extend-prd.md → core/commands/amend-prd.md} +206 -173
- package/core/commands/dev-run-test.md +48 -10
- package/core/commands/extend-prd.md +39 -12
- package/core/commands/generate-bdd.md +52 -10
- package/core/commands/generate-code.md +35 -2
- package/core/commands/generate-tech-docs.md +36 -4
- package/core/commands/map-testids.md +1 -1
- package/core/commands/qc-run-test.md +29 -3
- package/core/commands/refine-prd.md +13 -2
- package/core/commands/review-context.md +43 -8
- package/core/commands/sync.md +105 -1
- package/core/commands/validate-traces.md +289 -16
- package/core/rules/workflow.md +34 -0
- package/core/steps/context-loader.md +27 -6
- package/core/templates/feature.template +1 -1
- package/core/templates/project-context.yaml +3 -3
- package/core/templates/tech-design.template.md +2 -2
- package/docs/02-concepts/architecture.md +37 -1
- package/docs/02-concepts/overview.md +1 -1
- package/docs/02-concepts/pipeline-steps/02-specification.md +13 -7
- package/docs/02-concepts/pipeline-steps/07-dev-selftest.md +2 -0
- package/docs/02-concepts/pipeline-steps/08-qc-automation.md +1 -0
- package/docs/02-concepts/pipeline-steps/09-validate-traces.md +34 -3
- package/docs/02-concepts/pipeline-steps/10-feedback-loop.md +10 -1
- package/docs/02-concepts/traceability.md +187 -183
- package/docs/03-guides/architect.md +13 -4
- package/docs/03-guides/developer.md +1 -0
- package/docs/03-guides/product-owner.md +89 -72
- package/docs/03-guides/tester-qa.md +81 -81
- package/docs/04-reference/commands.md +148 -134
- package/docs/04-reference/trace-schema.md +45 -1
- package/docs/explain/02b-extend-prd.md +1 -1
- package/docs/explain/02c-amend-prd.md +152 -0
- package/docs/explain/06-generate-bdd.md +1 -1
- package/docs/explain/13-dev-run-test.md +15 -1
- package/docs/explain/19-qc-run-test.md +91 -87
- package/docs/explain/21-validate-traces.md +79 -75
- package/docs/explain/28-sync.md +25 -0
- package/docs/explain/README.md +136 -135
- package/package.json +1 -8
- package/commands/debug.md +0 -529
- package/commands/debug.tmpl +0 -260
- package/commands/define-product.md +0 -438
- package/commands/define-product.tmpl +0 -225
- package/commands/dev-gen-test.md +0 -700
- package/commands/dev-gen-test.tmpl +0 -490
- package/commands/dev-run-test.md +0 -435
- package/commands/dev-run-test.tmpl +0 -225
- package/commands/dev-smoke-test.md +0 -374
- package/commands/dev-smoke-test.tmpl +0 -217
- package/commands/extend-prd.tmpl +0 -273
- package/commands/fix-bug.md +0 -519
- package/commands/fix-bug.tmpl +0 -197
- package/commands/generate-architecture.md +0 -354
- package/commands/generate-architecture.tmpl +0 -197
- package/commands/generate-bdd.md +0 -923
- package/commands/generate-bdd.tmpl +0 -590
- package/commands/generate-code.md +0 -859
- package/commands/generate-code.tmpl +0 -649
- package/commands/generate-design-spec.md +0 -737
- package/commands/generate-design-spec.tmpl +0 -524
- package/commands/generate-prd.md +0 -722
- package/commands/generate-prd.tmpl +0 -226
- package/commands/generate-spec-manifest.md +0 -321
- package/commands/generate-spec-manifest.tmpl +0 -164
- package/commands/generate-tech-docs.md +0 -920
- package/commands/generate-tech-docs.tmpl +0 -273
- package/commands/learn.md +0 -399
- package/commands/learn.tmpl +0 -130
- package/commands/map-testids.md +0 -238
- package/commands/map-testids.tmpl +0 -81
- package/commands/propose-scenario.md +0 -359
- package/commands/propose-scenario.tmpl +0 -202
- package/commands/qc-analyze.md +0 -269
- package/commands/qc-analyze.tmpl +0 -112
- package/commands/qc-design-test.md +0 -226
- package/commands/qc-design-test.tmpl +0 -69
- package/commands/qc-plan.md +0 -206
- package/commands/qc-plan.tmpl +0 -49
- package/commands/qc-report.md +0 -217
- package/commands/qc-report.tmpl +0 -60
- package/commands/qc-review.md +0 -210
- package/commands/qc-review.tmpl +0 -53
- package/commands/qc-run-test.md +0 -326
- package/commands/qc-run-test.tmpl +0 -116
- package/commands/refine-prd.md +0 -653
- package/commands/refine-prd.tmpl +0 -281
- package/commands/report-bug.md +0 -305
- package/commands/report-bug.tmpl +0 -148
- package/commands/review-code.md +0 -415
- package/commands/review-code.tmpl +0 -146
- package/commands/review-context.md +0 -902
- package/commands/review-context.tmpl +0 -530
- package/commands/review-tech-docs.md +0 -561
- package/commands/review-tech-docs.tmpl +0 -404
- package/commands/setup-ai-first.md +0 -602
- package/commands/setup-ai-first.tmpl +0 -450
- package/commands/sync.md +0 -430
- package/commands/sync.tmpl +0 -429
- package/commands/update-framework.md +0 -203
- package/commands/update-framework.tmpl +0 -202
- package/commands/validate-traces.md +0 -1077
- package/commands/validate-traces.tmpl +0 -920
- package/hooks/data-guard.js +0 -232
- package/hooks/settings.json +0 -19
- package/modules/android-compose/module.yaml +0 -13
- package/modules/android-compose/stack-profile.yaml +0 -57
- package/modules/angular/architecture-snippets/component-patterns.md +0 -187
- package/modules/angular/module.yaml +0 -6
- package/modules/angular/stack-profile.yaml +0 -38
- package/modules/context-engineering/architecture-snippets/context-design.md +0 -119
- package/modules/context-engineering/module.yaml +0 -9
- package/modules/context-engineering/stack-profile.yaml +0 -61
- package/modules/dotnet/architecture-snippets/clean-arch.md +0 -160
- package/modules/dotnet/module.yaml +0 -6
- package/modules/dotnet/stack-profile.yaml +0 -50
- package/modules/flutter/module.yaml +0 -14
- package/modules/flutter/stack-profile.yaml +0 -59
- package/modules/golang/architecture-snippets/domain-layout.md +0 -283
- package/modules/golang/module.yaml +0 -6
- package/modules/golang/stack-profile.yaml +0 -40
- package/modules/ios-swiftui/module.yaml +0 -13
- package/modules/ios-swiftui/stack-profile.yaml +0 -55
- package/modules/java-spring/architecture-snippets/layered-arch.md +0 -201
- package/modules/java-spring/module.yaml +0 -15
- package/modules/java-spring/stack-profile.yaml +0 -28
- package/modules/nextjs/architecture-snippets/app-router-patterns.md +0 -269
- package/modules/nextjs/module.yaml +0 -14
- package/modules/nextjs/stack-profile.yaml +0 -74
- package/modules/nuxt/module.yaml +0 -14
- package/modules/nuxt/stack-profile.yaml +0 -58
- package/modules/phaser-game/architecture-snippets/phaser-scene-patterns.md +0 -646
- package/modules/phaser-game/module.yaml +0 -15
- package/modules/phaser-game/stack-profile.yaml +0 -90
- package/modules/php-laravel/architecture-snippets/service-repository.md +0 -302
- package/modules/php-laravel/module.yaml +0 -15
- package/modules/php-laravel/stack-profile.yaml +0 -56
- package/modules/qc-playwright/stack-profile.yaml +0 -66
- package/modules/react/architecture-snippets/hooks-query-patterns.md +0 -254
- package/modules/react/module.yaml +0 -14
- package/modules/react/stack-profile.yaml +0 -63
- package/modules/react-native/module.yaml +0 -14
- package/modules/react-native/stack-profile.yaml +0 -56
- package/modules/vue/module.yaml +0 -14
- package/modules/vue/stack-profile.yaml +0 -65
- package/rules/data-protection.md +0 -80
- package/rules/workflow.md +0 -99
- package/skills/code/SKILL.md +0 -19
- package/skills/code/SKILL.tmpl +0 -19
- package/skills/debug/SKILL.md +0 -19
- package/skills/debug/SKILL.tmpl +0 -19
- package/skills/design-spec/SKILL.md +0 -11
- package/skills/design-spec/SKILL.tmpl +0 -11
- package/skills/discovery/SKILL.md +0 -14
- package/skills/discovery/SKILL.tmpl +0 -14
- package/skills/prd/SKILL.md +0 -19
- package/skills/prd/SKILL.tmpl +0 -19
- package/skills/qc/qa-analyst/DOC_GAPS.template.md +0 -63
- package/skills/qc/qa-analyst/acceptance-criteria.md +0 -60
- package/skills/qc/qa-analyst/business-rules.md +0 -59
- package/skills/qc/qa-analyst/data-flow.md +0 -64
- package/skills/qc/qa-analyst/spec-breakdown.md +0 -61
- package/skills/qc/qa-designer/e2e/journey.md +0 -41
- package/skills/qc/qa-designer/exploratory/charter.md +0 -68
- package/skills/qc/qa-designer/exploratory/explore-to-functional.md +0 -43
- package/skills/qc/qa-designer/functional/api.md +0 -45
- package/skills/qc/qa-designer/functional/gui-feature.md +0 -46
- package/skills/qc/qa-designer/functional/gui-screen.md +0 -52
- package/skills/qc/qa-designer/integration/api.md +0 -42
- package/skills/qc/qa-designer/integration/db.md +0 -39
- package/skills/qc/qa-designer/integration/gui.md +0 -40
- package/skills/qc/qa-designer/integration/kafka.md +0 -40
- package/skills/qc/qa-designer/non-functional.md +0 -40
- package/skills/qc/qa-planner/test-plan.md +0 -120
- package/skills/qc/qa-reviewer/script/e2e.md +0 -87
- package/skills/qc/qa-reviewer/script/exploratory.md +0 -45
- package/skills/qc/qa-reviewer/script/functional.md +0 -101
- package/skills/qc/qa-reviewer/script/integration.md +0 -91
- package/skills/qc/qa-reviewer/script/non-functional.md +0 -126
- package/skills/qc/qa-reviewer/test-case/e2e.md +0 -73
- package/skills/qc/qa-reviewer/test-case/exploratory.md +0 -43
- package/skills/qc/qa-reviewer/test-case/functional.md +0 -76
- package/skills/qc/qa-reviewer/test-case/integration.md +0 -69
- package/skills/qc/qa-reviewer/test-case/non-functional.md +0 -73
- package/skills/qc/qa-runner/e2e.md +0 -49
- package/skills/qc/qa-runner/exploratory/session.md +0 -36
- package/skills/qc/qa-runner/functional/api.md +0 -35
- package/skills/qc/qa-runner/functional/gui-feature.md +0 -51
- package/skills/qc/qa-runner/functional/gui-screen.md +0 -55
- package/skills/qc/qa-runner/integration.md +0 -47
- package/skills/qc/qa-runner/non-functional.md +0 -49
- package/skills/qc/qa-runner/report/report.md +0 -37
- package/skills/setup-ai-first/SKILL.md +0 -19
- package/skills/setup-ai-first/SKILL.tmpl +0 -19
- package/skills/spec/SKILL.md +0 -19
- package/skills/spec/SKILL.tmpl +0 -19
- package/skills/test/SKILL.md +0 -18
- package/skills/test/SKILL.tmpl +0 -18
- package/steps/business-language.md +0 -56
- package/steps/capture-lesson.md +0 -112
- package/steps/context-loader.md +0 -406
- package/steps/gate.md +0 -151
- package/steps/report-footer.md +0 -125
- package/steps/review-fanout.md +0 -159
- package/steps/spawn-agent.md +0 -129
- package/steps/trace-mirror.md +0 -53
- package/templates/README.md +0 -70
- package/templates/architecture.template.md +0 -394
- package/templates/ci/trace-gate.yml +0 -146
- package/templates/design-spec.template.md +0 -217
- package/templates/feature.template +0 -123
- package/templates/hooks/pre-push +0 -61
- package/templates/platform-guide.template.md +0 -145
- package/templates/prd.template.md +0 -283
- package/templates/product-definition.template.md +0 -188
- package/templates/project-context.yaml +0 -212
- package/templates/tech-design.template.md +0 -490
|
@@ -1,590 +0,0 @@
|
|
|
1
|
-
# /generate-bdd — Sinh BDD Feature Files
|
|
2
|
-
|
|
3
|
-
## Gate
|
|
4
|
-
{{include:steps/gate.md}}
|
|
5
|
-
|
|
6
|
-
## Context
|
|
7
|
-
{{include:steps/context-loader.md}}
|
|
8
|
-
|
|
9
|
-
> **Proposal của tester (input tuỳ chọn):** trước khi sinh, quét `{paths.bdd_proposals_dir}/` (mặc định `{spec_source}/feedback/bdd-proposals/`) tìm `{UC-ID}-*.md`. Với mỗi proposal:
|
|
10
|
-
> - `Status: accepted` (PO/Dev đã duyệt) → chèn scenario vào `.feature` của UC, **normalize khi chèn** (xem dưới), rồi **lưu trữ**: chuyển file sang `{paths.bdd_proposals_dir}/archived/` + đặt `Status: incorporated`, và **commit + push** spec repo để gỡ khỏi feedback chung.
|
|
11
|
-
>
|
|
12
|
-
> **Normalize — bắt buộc, nếu không scenario sẽ vô hình với trace:**
|
|
13
|
-
> 1. Gán `# @trace.scenario: {UC-ID}-SC{N}` với `{N}` = số SC **kế tiếp** trong file đó (thay placeholder `SC?`).
|
|
14
|
-
> 2. Giữ `# @trace.sc_version: 1.0`. Bổ sung `# @trace.business_rules` nếu proposal để `—` (suy từ AC mà dòng `# Covers:` trỏ tới); không suy được → để `—` và nêu trong report.
|
|
15
|
-
> 3. **Strip** tag `@proposed` / `@from-test` — chúng là nhãn vòng đời proposal, không thuộc BDD canonical.
|
|
16
|
-
> 4. Đặt scenario vào **đúng NHÓM** theo business theme (C.5), không nối vào cuối file.
|
|
17
|
-
> 5. **Append row TSV** cho SC mới (như nhánh "SC mới" ở Write Trace State: `spec_ver = 1.0`, mọi cột gen/test/qc = `—`, `status = UNTRACKED`).
|
|
18
|
-
>
|
|
19
|
-
> **Backward-compat:** proposal cũ mang `@trace.uc=` / `@trace.ac=` (vocabulary trước đây, không thuộc contract `.feature`) → tự map sang canonical (`@trace.uc` bỏ — số UC đã có trong `sc_id`; `@trace.ac` → dòng `# Covers:`) và in một dòng cảnh báo khuyến nghị proposal sau viết theo format mới.
|
|
20
|
-
> - `Status: proposed`/`rejected` (hoặc thiếu `Status`) → **bỏ qua**, để nguyên cho PO/Dev xử lý (KHÔNG tự đoán, KHÔNG tự đưa vào).
|
|
21
|
-
> Bỏ qua sạch nếu folder rỗng.
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## Sub-Agent Mode — dùng state từ payload *(nếu `_agent_mode`)*
|
|
26
|
-
|
|
27
|
-
*Chỉ khi Gate Step 0 phát hiện `_agent_mode: true` (đang chạy như sub-agent do orchestration spawn).* Orchestrator (session chính) đã chạy các Guard + chọn platform + nạp design-spec **một lần**; sub-agent KHÔNG lặp lại:
|
|
28
|
-
- `active_platform` = `payload.active_platform` → **bỏ qua** Platform Selection / Service Detection.
|
|
29
|
-
- `design_coverage` = `payload.design_coverage` → **bỏ qua** "Design Spec — Gate & Load"; nếu rỗng thì chỉ phủ Wireframe PRD.
|
|
30
|
-
- **Bỏ qua** Guard "PRD đã duyệt" + Guard Design-Spec bên dưới (orchestrator đã kiểm).
|
|
31
|
-
- Đi thẳng tới UC Decomposition + Generate cho `payload.uc_id`, dùng `design_coverage` để phủ Screen States + AC-UI.
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
## Guard — PRD đã duyệt chưa
|
|
36
|
-
|
|
37
|
-
Đọc `| **Status** |` từ bảng Metadata của PRD nguồn:
|
|
38
|
-
- `Status: approved` → tiếp tục bình thường.
|
|
39
|
-
- `Status: draft` (hoặc khác `approved`) → **CHECKPOINT cảnh báo mềm** (không chặn cứng — cho phép prototype):
|
|
40
|
-
```
|
|
41
|
-
⚠️ PRD đang ở Status: {status} (chưa duyệt). BDD sinh từ PRD chưa chốt có thể phải làm lại.
|
|
42
|
-
Khuyến nghị: PO review xong đặt `| **Status** | approved |` rồi mới sinh BDD.
|
|
43
|
-
Vẫn sinh BDD bây giờ? (Y/N)
|
|
44
|
-
```
|
|
45
|
-
Chỉ tiếp tục khi người dùng chọn Y.
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
## Phát hiện Repo Mode
|
|
50
|
-
|
|
51
|
-
Sau khi nạp context, xác định chế độ hoạt động:
|
|
52
|
-
|
|
53
|
-
- **Spec repo mode**: `project-context.yaml` KHÔNG có section `services` HOẶC `setup.mode: spec`
|
|
54
|
-
- **Umbrella mode**: `project-context.yaml` CÓ section `services` VÀ `setup.mode: umbrella`
|
|
55
|
-
|
|
56
|
-
→ Spec repo mode → tới **Platform Selection** bên dưới (bỏ qua Service Detection)
|
|
57
|
-
→ Umbrella mode → tới **Service Detection** bên dưới (bỏ qua Platform Selection)
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## Platform Selection (chỉ Spec Repo Mode)
|
|
62
|
-
|
|
63
|
-
*Bỏ qua section này nếu đang chạy umbrella mode.*
|
|
64
|
-
|
|
65
|
-
Hỏi người dùng chọn platform target:
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
BDD này dành cho platform nào?
|
|
69
|
-
1. web — FE/Web (React, Next.js, Angular, Vue, Nuxt)
|
|
70
|
-
2. app — Mobile (Flutter, React Native, iOS, Android)
|
|
71
|
-
3. system — System/BE BDD (tổng hợp từ web + app BDD có sẵn)
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Chờ người dùng chọn. Set `active_platform` = giá trị đã chọn.
|
|
75
|
-
|
|
76
|
-
**Output path (spec repo mode):**
|
|
77
|
-
`{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
78
|
-
|
|
79
|
-
**Từ vựng theo platform:**
|
|
80
|
-
|
|
81
|
-
| Platform | "user action" | "type/input" | "observe" | "navigate" |
|
|
82
|
-
|---|---|---|---|---|
|
|
83
|
-
| web | "clicks" | "types into" / "enters" | "sees" / "the page shows" | "navigates to" / "goes to" |
|
|
84
|
-
| app | "taps" | "enters" / "inputs" | "sees" / "the screen shows" | "navigates to" / "opens" |
|
|
85
|
-
| system | N/A — dùng business event | — | "the system returns" / "receives response" | — |
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
## System BDD Synthesis (active_platform = system)
|
|
90
|
-
|
|
91
|
-
*Chỉ áp dụng khi platform = system. Bỏ qua với web và app.*
|
|
92
|
-
|
|
93
|
-
### Step S0 — Brownfield Check
|
|
94
|
-
|
|
95
|
-
Kiểm tra bảng Metadata của PRD nguồn tìm `| **API Source** | existing |`.
|
|
96
|
-
|
|
97
|
-
**Nếu `API Source: existing`:**
|
|
98
|
-
- API contract đã được PO ghi trong phần "Existing API Contract" của PRD.
|
|
99
|
-
- **Skip Steps S1–S3** — không cần scan FE/App BDD, không cần conflict resolution.
|
|
100
|
-
- Dùng bảng "Existing API Contract" trong PRD làm contract input cho Step S4.
|
|
101
|
-
- Set `# @trace.api_source: existing` trong header của file system BDD được gen.
|
|
102
|
-
|
|
103
|
-
**Nếu `API Source` không có hoặc không phải `existing`:**
|
|
104
|
-
- Tiếp tục Steps S1–S3 (normal synthesis flow).
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
### Step S1 — Scan các BDD FE/App có sẵn
|
|
109
|
-
|
|
110
|
-
Tìm các BDD có sẵn cho TICKET-ID này:
|
|
111
|
-
- Web BDD: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/web/{TICKET-ID}-*.feature`
|
|
112
|
-
- App BDD: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/app/{TICKET-ID}-*.feature`
|
|
113
|
-
|
|
114
|
-
Phân loại feature:
|
|
115
|
-
|
|
116
|
-
| Điều kiện | Mode |
|
|
117
|
-
|---|---|
|
|
118
|
-
| Tìm thấy cả web + app BDD | **Multi-platform** — tổng hợp từ cả hai |
|
|
119
|
-
| Chỉ tìm thấy web BDD | **Web-only** — tổng hợp từ web |
|
|
120
|
-
| Chỉ tìm thấy app BDD | **App-only** — tổng hợp từ app |
|
|
121
|
-
| Không tìm thấy FE/App BDD | **Backend-only** — gen trực tiếp từ PRD |
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
### Step S2 — Trích contract kỳ vọng theo từng platform
|
|
126
|
-
|
|
127
|
-
Với mỗi file BDD tìm thấy, trích:
|
|
128
|
-
- **Triggers**: hành động người dùng nào gọi backend? (map sang event "request" logic)
|
|
129
|
-
- **Expected response data**: mỗi mệnh đề `Then` cần field/shape gì từ hệ thống?
|
|
130
|
-
- **Error signals**: backend phải báo hiệu các trạng thái lỗi nào?
|
|
131
|
-
- **Business rules**: mỗi platform giả định hệ thống thực thi các invariant nào?
|
|
132
|
-
|
|
133
|
-
---
|
|
134
|
-
|
|
135
|
-
### Step S3 — Cross-Platform Conflict Check (chỉ multi-platform mode)
|
|
136
|
-
|
|
137
|
-
*Bỏ qua nếu web-only, app-only, hoặc backend-only.*
|
|
138
|
-
|
|
139
|
-
So sánh các contract đã trích giữa các platform. Gắn cờ conflict nếu bất kỳ cái nào khác nhau:
|
|
140
|
-
|
|
141
|
-
| Loại conflict | Ví dụ |
|
|
142
|
-
|---|---|
|
|
143
|
-
| **Response shape mismatch** | Web mong `{ token, redirect_url }`, App mong `{ token, user_profile }` |
|
|
144
|
-
| **Error semantics mismatch** | Web mong HTTP 423 cho lock, App mong custom error code `ACC_LOCKED` |
|
|
145
|
-
| **Business rule contradiction** | Web BDD nói "lock sau 5 lần", App BDD nói "lock sau 3 lần" |
|
|
146
|
-
| **Data field conflict** | Web mong `expires_in: seconds`, App mong `expires_at: ISO timestamp` |
|
|
147
|
-
|
|
148
|
-
**Nếu phát hiện conflict → CHECKPOINT (bắt buộc, không bỏ qua được):**
|
|
149
|
-
|
|
150
|
-
```
|
|
151
|
-
⚠️ CROSS-PLATFORM CONTRACT CONFLICT
|
|
152
|
-
──────────────────────────────────────────────────────────────────
|
|
153
|
-
Feature : {TICKET-ID} — {UC name}
|
|
154
|
-
|
|
155
|
-
Conflict 1: Response shape mismatch
|
|
156
|
-
Web BDD (Then): user sees dashboard → implies { token, redirect_url }
|
|
157
|
-
App BDD (Then): app navigates to HomeScreen → implies { token, user_profile }
|
|
158
|
-
|
|
159
|
-
Resolution options:
|
|
160
|
-
A — Union response
|
|
161
|
-
BE trả về tất cả field: { token, redirect_url, user_profile }
|
|
162
|
-
Client bỏ qua field không dùng. Đơn giản, hơi over-fetch.
|
|
163
|
-
B — Platform hint trong request
|
|
164
|
-
Client gửi X-Platform: web|app trong header, BE tuỳ biến response.
|
|
165
|
-
Response gọn hơn, nhiều BE logic hơn.
|
|
166
|
-
C — Endpoint riêng
|
|
167
|
-
POST /auth/login/web và POST /auth/login/app
|
|
168
|
-
Linh hoạt tối đa, nhiều endpoint phải bảo trì hơn.
|
|
169
|
-
D — Custom: mô tả cách của bạn
|
|
170
|
-
──────────────────────────────────────────────────────────────────
|
|
171
|
-
Chọn resolution cho mỗi conflict (A/B/C/D):
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
Chờ PO giải quyết từng conflict. Ghi mỗi quyết định thành annotation `# @system.resolution:` trong file system BDD được gen.
|
|
175
|
-
|
|
176
|
-
**Nếu không có conflict → tới Step S4 trực tiếp.**
|
|
177
|
-
|
|
178
|
-
---
|
|
179
|
-
|
|
180
|
-
### Step S4 — Sinh các scenario System BDD
|
|
181
|
-
|
|
182
|
-
Sinh scenario dựa trên mode và các conflict đã giải quyết:
|
|
183
|
-
|
|
184
|
-
- **Multi-platform**: tổng hợp từ cả contract web + app, áp dụng các resolution đã chọn
|
|
185
|
-
- **Web-only / App-only**: suy ra từ contract của một platform
|
|
186
|
-
- **Backend-only**: suy ra trực tiếp từ AC/BR của PRD dùng ngôn ngữ business event (không phải HTTP)
|
|
187
|
-
|
|
188
|
-
Từ vựng step của System BDD (luôn dùng — bất kể từ vựng FE/App):
|
|
189
|
-
- Triggers: "the system receives {event}" / "a {actor} submits {action}"
|
|
190
|
-
- Assertions: "the system returns {data}" / "the system signals {error}" / "the system stores {state}"
|
|
191
|
-
- KHÔNG dùng từ UI (click, tap, see, navigate) trong system BDD
|
|
192
|
-
|
|
193
|
-
**Nếu multi-platform với resolution A (union):**
|
|
194
|
-
- System BDD thể hiện contract response đầy đủ: tất cả field từ mọi platform
|
|
195
|
-
- Thêm comment: `# @system.resolution: union — clients receive all fields`
|
|
196
|
-
|
|
197
|
-
**Nếu resolution B (platform hint):**
|
|
198
|
-
- Viết `Scenario Outline` riêng dùng Examples table cho biến thể response `web` vs `app`
|
|
199
|
-
- Thêm comment: `# @system.resolution: platform-hint — X-Platform header determines response shape`
|
|
200
|
-
|
|
201
|
-
**Nếu resolution C (endpoint riêng):**
|
|
202
|
-
- Viết Scenario riêng cho mỗi endpoint
|
|
203
|
-
- Ghi rõ việc tách endpoint trong phần SCOPE
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## Service Detection (chỉ Umbrella Mode)
|
|
208
|
-
|
|
209
|
-
*Bỏ qua section này nếu đang chạy spec repo mode.*
|
|
210
|
-
|
|
211
|
-
Routing service là **domain-keyed** và **context-loader (Bước 1.5) đã phân giải sẵn** từ `@trace.domain`/Domain của PRD — KHÔNG re-resolve ở đây, chỉ dùng lại các biến đã set:
|
|
212
|
-
- `active_service` = path submodule đã phân giải (dạng phẳng), hoặc `"multi"` (dạng map-theo-platform ở cấp PRD — chưa chốt 1 platform), hoặc `"unresolved"` nếu domain không khớp entry nào, hoặc bỏ trống ở single-service.
|
|
213
|
-
- `active_module` = module của service (`services.{domain}.module`, đã override `tech_stack.module` ở Bước 1.5) — dùng cho từ vựng bên dưới. Với `"multi"` + `service_candidates_kind = platform`, lấy module theo từng platform từ `service_candidates.{platform}.module` khi sinh `bdd/{platform}/` (context-loader đã làm phẳng các entry `by_prd_slug` nên luôn có `.module` trực tiếp).
|
|
214
|
-
|
|
215
|
-
Chỉ cần kiểm tra trạng thái đã phân giải:
|
|
216
|
-
|
|
217
|
-
| Trạng thái (từ context-loader) | Hành động |
|
|
218
|
-
|---|---|
|
|
219
|
-
| `active_service` đã phân giải thành path service | Tiếp tục với `active_module` đã set. |
|
|
220
|
-
| `active_service = "multi"` **và** `service_candidates_kind = platform` (domain map-theo-platform, target PRD chưa gắn 1 platform) | Tiếp tục — BDD là artifact liên team, platform-split. Sinh `bdd/{platform}/` cho các platform có trong `service_candidates`; từ vựng lấy theo `service_candidates.{platform}.module`. KHÔNG cần chốt 1 service. Platform nào bị đánh dấu `unresolved` trong candidates (thiếu `prd_slug` tương ứng dưới `by_prd_slug`) → vẫn sinh BDD nhưng gắn ⚠️ nêu rõ chưa có repo nhận. |
|
|
221
|
-
| `active_service = "multi"` **và** `service_candidates_kind = prd_slug` | **DỪNG.** Candidates đang là map feature→repo, KHÔNG phải map platform — sinh `bdd/{slug}/` là sai bố cục. Yêu cầu người dùng chạy lại với target file cụ thể để `prd_slug` được xác định. |
|
|
222
|
-
| `active_service = "unresolved"` (có section `services` nhưng domain PRD không khớp entry nào) | **DỪNG**, báo: "Domain `{domain}` của PRD không khớp service nào trong `services:` của project-context.yaml — bổ sung mapping rồi chạy lại." (Không đoán/hỏi tay — domain là khoá định danh, lệch là lỗi cấu hình cần sửa ở SoT.) |
|
|
223
|
-
| Single-service (không có section `services`) | `active_module = tech_stack.module` (đã set ở Bước 6.5). Tiếp tục. |
|
|
224
|
-
|
|
225
|
-
### Phân giải `active_platform` (umbrella mode)
|
|
226
|
-
|
|
227
|
-
Umbrella mode không hỏi platform (khác spec repo mode) — nó **suy** từ module của service. Bắt buộc phải có giá trị: `active_platform` đi vào **path file**, vào **header `@trace.platform`**, và vào **tên sổ trace** `{UC-ID}-{platform}.tsv`.
|
|
228
|
-
|
|
229
|
-
| `active_module` | → `active_platform` |
|
|
230
|
-
|---|---|
|
|
231
|
-
| react · nextjs · vue · nuxt · angular | `web` |
|
|
232
|
-
| flutter · react-native · ios-swiftui · android-compose | `app` |
|
|
233
|
-
| java-spring · golang · dotnet · php-laravel | `system` |
|
|
234
|
-
| context-engineering · phaser-game | theo `platform_type` của stack-profile (`backend` → `system`, còn lại → `web`) |
|
|
235
|
-
|
|
236
|
-
- `active_service = "multi"` + `service_candidates_kind = platform` → **nhiều** `active_platform` (một cho mỗi platform trong `service_candidates`); sinh một file `.feature` cho mỗi platform, module lấy theo `service_candidates.{platform}.module`.
|
|
237
|
-
- Không suy được (module lạ, không có trong bảng và không có `platform_type`) → **DỪNG**, hỏi người dùng chọn `web`/`app`/`system`. **KHÔNG** ghi file khi chưa có `active_platform` — file thiếu platform sẽ vô hình với `/validate-traces` và va chạm tên với platform khác.
|
|
238
|
-
|
|
239
|
-
**Output path (umbrella mode):** `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
240
|
-
|
|
241
|
-
*(**Subfolder `{platform}/` LUÔN có — mọi mode.** `web` và `system` của cùng một UC là hai file khác nhau: nếu bỏ subfolder, chúng ra cùng filename và **ghi đè nhau**; ngoài ra trace tách theo platform (`{UC-ID}-{platform}.tsv`) nên bố cục spec phải tách tương ứng.*
|
|
242
|
-
*Cái KHÔNG thêm là subfolder theo **service**: feature-package đã domain-scoped sẵn ở `{domain}/`, mà service route 1-1 theo domain — thêm subfolder service chỉ lặp lại domain. `active_service` chỉ dùng cho `service_root`/từ vựng, KHÔNG vào path spec.)*
|
|
243
|
-
|
|
244
|
-
**Từ vựng theo platform** — điều chỉnh cách viết step BDD theo `active_module`:
|
|
245
|
-
|
|
246
|
-
| Platform type | Modules | "click" | "type" | "see" | "navigate" |
|
|
247
|
-
|---|---|---|---|---|---|
|
|
248
|
-
| Web | react, nextjs, vue, nuxt, angular | "clicks" | "types into" / "enters" | "sees" / "the page shows" | "navigates to" / "goes to" |
|
|
249
|
-
| Mobile | flutter, react-native, ios-swiftui, android-compose | "taps" | "enters" / "inputs" | "sees" / "the screen shows" | "navigates to" / "opens" |
|
|
250
|
-
| Backend / API | java-spring, golang, dotnet, php-laravel | *(không có UI step — dùng)* "submits a request" / "calls the API" | — | "receives response" / "the system returns" | — |
|
|
251
|
-
|
|
252
|
-
Áp dụng từ vựng này âm thầm khi viết step Gherkin. KHÔNG trộn từ web và mobile trong cùng một file feature.
|
|
253
|
-
|
|
254
|
-
---
|
|
255
|
-
|
|
256
|
-
## Design Spec — Gate & Load (chỉ FE/App)
|
|
257
|
-
|
|
258
|
-
*Chỉ chạy khi target platform là FE/App — spec mode: `active_platform ∈ {web, app, app-ios, app-android}`; umbrella mode: `active_module` là module FE/App (react/nextjs/vue/nuxt/angular/flutter/react-native/ios-swiftui/android-compose). Bỏ qua HOÀN TOÀN với `system` và backend/brownfield.*
|
|
259
|
-
|
|
260
|
-
**1. Định vị design-spec của platform:**
|
|
261
|
-
`{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{active_platform}-{slug}.md`
|
|
262
|
-
- `app-ios`/`app-android` không có bản riêng → fallback bản `-app-`.
|
|
263
|
-
|
|
264
|
-
**2. Guard — sign-off & độ tươi (cảnh báo MỀM, đồng bộ Guard PRD — không chặn cứng):**
|
|
265
|
-
Đọc `| **Status** |` và `| **Built from PRD** |` từ Metadata design-spec.
|
|
266
|
-
- Không tìm thấy file, HOẶC `Status ≠ approved`, HOẶC design-spec còn màn ❌ Missing, HOẶC `Built from PRD` ≠ `| **Version** |` của PRD hiện tại (design-spec **lỗi thời** so với PRD) → CHECKPOINT:
|
|
267
|
-
```
|
|
268
|
-
⚠️ Design Spec cho {active_platform} chưa sẵn sàng (Status: {status} / không có / còn màn thiếu Figma / lỗi thời: dựng từ PRD v{old}, PRD giờ v{new}).
|
|
269
|
-
BDD FE/App nên sinh từ design-spec đã approved & cập nhật để phủ đúng Screen States + AC-UI.
|
|
270
|
-
Khuyến nghị: hoàn tất / cập nhật design-spec (chạy lại /generate-design-spec nếu PRD đã đổi) rồi mới sinh BDD.
|
|
271
|
-
Vẫn sinh BDD bây giờ? (Y/N)
|
|
272
|
-
```
|
|
273
|
-
Chỉ tiếp khi chọn Y. Nếu Y mà KHÔNG có design-spec → bỏ qua bước 3 (chỉ phủ Wireframe PRD §4b).
|
|
274
|
-
- `Status: approved` VÀ `Built from PRD` khớp PRD hiện tại → nạp design-spec, sang bước 2.5.
|
|
275
|
-
|
|
276
|
-
**2.5. Sanity-scan nội dung design-spec** (lớp soi độc lập — D1; soi nhanh ngay tại chỗ đã mở file, trước khi dùng):
|
|
277
|
-
Quét tìm cờ đỏ; nếu có → **cảnh báo mềm** (liệt kê + hỏi "Vẫn dùng design-spec này? (Y/N)"):
|
|
278
|
-
- Màn nào thiếu state `loading`/`error`/`empty`.
|
|
279
|
-
- AC-UI nào mơ hồ, không testable ("looks good" / "đẹp" / không pass-fail rõ).
|
|
280
|
-
- Component còn `[NEW]` / `[TODO]` (chưa chốt với designer).
|
|
281
|
-
- Còn `❌ Missing` frame (lẽ ra Status đã `draft` — approved mà vẫn Missing là bất thường).
|
|
282
|
-
Bắt lỗi design-spec **ngay trước khi nó lan xuống BDD**. Chọn N → quay lại hoàn thiện design-spec; chọn Y → sang bước 3.
|
|
283
|
-
|
|
284
|
-
**3. Trích coverage từ design-spec** (lưu thành `design_coverage`, dùng ở UC Decomposition + Coverage Matrix):
|
|
285
|
-
- **Screen States** ≠ `default` cho mỗi màn: `loading`, `error`, `empty`, `success` (cái nào có).
|
|
286
|
-
- **AC-UI behavioral**: giữ AC-UI mà cột `Verified by` là **PO/QA** và mô tả outcome quan sát được (lỗi + đường khôi phục, empty state + CTA, gesture điều hướng, có loading state). **LOẠI AC-UI visual thuần** (khớp Figma trong dung sai, tương phản WCAG, màu/pixel/animation — thường `Verified by: Designer`): Designer/QA review riêng, KHÔNG đưa vào Gherkin (giữ R3/R5/R6).
|
|
287
|
-
- **Dedup**: nếu một Screen State / AC-UI đã trùng một AC nghiệp vụ của PRD → không tạo SC mới, chỉ ghi nhận đã phủ.
|
|
288
|
-
|
|
289
|
-
---
|
|
290
|
-
|
|
291
|
-
## Orchestration Check
|
|
292
|
-
|
|
293
|
-
*Bỏ qua section này nếu đã ở sub-agent mode (Step 0 của Gate đã kích hoạt).*
|
|
294
|
-
|
|
295
|
-
Sau khi nạp context, kiểm tra PRD target có đủ lớn để cần sub-agent không:
|
|
296
|
-
|
|
297
|
-
1. Đếm các heading `#### {TICKET-ID}-UC` trong PRD → **UC count**.
|
|
298
|
-
2. Đếm tổng số dòng trong PRD → **line count**.
|
|
299
|
-
3. Nếu **UC count > 3** HOẶC **line count > 300**:
|
|
300
|
-
- Chuyển sang orchestration mode — theo `steps/spawn-agent.md`.
|
|
301
|
-
- Session chính trở thành orchestrator: spawn 1 sub-agent cho mỗi UC.
|
|
302
|
-
- Mỗi sub-agent chạy `/generate-bdd` với payload `_agent_mode: true`.
|
|
303
|
-
- Thu thập kết quả và hiện report đã merge.
|
|
304
|
-
- **KHÔNG tiếp tục các bước bên dưới.**
|
|
305
|
-
4. Nếu UC count ≤ 3 VÀ line count ≤ 300 → tiếp tục Version Check bên dưới (single-session mode).
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
## Sub-Agent Return Format
|
|
310
|
-
|
|
311
|
-
*Section này áp dụng khi chạy như sub-agent (Gate Step 0 phát hiện `_agent_mode: true`).*
|
|
312
|
-
|
|
313
|
-
Sau khi sinh tất cả file `.feature` và `.tsv` cho UC được giao, trả về JSON kết quả có cấu trúc (theo `steps/spawn-agent.md` Step E):
|
|
314
|
-
|
|
315
|
-
```json
|
|
316
|
-
{ "uc_id": "{TICKET-ID}-UC{N}", "files_created": ["path/to/file1", "path/to/file2"], "status": "success | error", "errors": [] }
|
|
317
|
-
```
|
|
318
|
-
|
|
319
|
-
---
|
|
320
|
-
|
|
321
|
-
## Version Check
|
|
322
|
-
|
|
323
|
-
Trước khi sinh, kiểm tra các file `.feature` có sẵn cho PRD này:
|
|
324
|
-
|
|
325
|
-
1. Search path (**giống nhau ở cả hai mode** — bố cục `bdd/{platform}/` là chuẩn duy nhất):
|
|
326
|
-
`{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC*.feature`
|
|
327
|
-
> **Legacy:** nếu không khớp gì, thử thêm một lần ở bố cục phẳng cũ `…/bdd/{TICKET-ID}-UC*.feature`. Khớp → xử lý như file có sẵn **và** in cảnh báo: `⚠️ File .feature đang ở bố cục phẳng (trước v0.4.1). Chạy: npx sdd-framework --migrate-bdd-platform để chuyển sang bdd/{platform}/.` Đừng tự di chuyển file trong lệnh này.
|
|
328
|
-
2. Đọc `| **Version** |` hiện tại của PRD từ metadata (vd: `1.2`).
|
|
329
|
-
|
|
330
|
-
**Nếu không có file feature nào** → gen mới, tiếp tục bình thường. Dùng version PRD làm `@trace.prd_version`.
|
|
331
|
-
|
|
332
|
-
**Nếu tìm thấy file feature có sẵn**:
|
|
333
|
-
- Đọc `# @trace.prd_version:` từ header file feature có sẵn.
|
|
334
|
-
- So với version PRD hiện tại.
|
|
335
|
-
- Nếu **giống** → hỏi: "BDD đã sinh từ PRD v{version}. Gen lại? (Y/N)"
|
|
336
|
-
- Nếu **khác** (PRD đã cập nhật):
|
|
337
|
-
1. Đọc `# Change Log` từ PRD — trích tất cả row mới hơn `@trace.prd_version` của BDD hiện có. **Nếu `@trace.prd_version` của BDD CŨ HƠN row cũ nhất còn trong bảng** (lịch sử đã bị cắt sang `changelog/`) → không thấy đủ diff → **khuyến nghị F** (gen lại toàn bộ), đừng tin Y một phần.
|
|
338
|
-
2. Hiện CHECKPOINT:
|
|
339
|
-
```
|
|
340
|
-
⚠️ Phát hiện PRD version drift
|
|
341
|
-
BDD được sinh từ PRD v{old}
|
|
342
|
-
PRD giờ ở v{new}
|
|
343
|
-
|
|
344
|
-
Thay đổi kể từ v{old}:
|
|
345
|
-
{changelog rows}
|
|
346
|
-
|
|
347
|
-
Options:
|
|
348
|
-
Y — chỉ cập nhật các scenario bị ảnh hưởng
|
|
349
|
-
F — gen lại toàn bộ scenario
|
|
350
|
-
N — huỷ
|
|
351
|
-
```
|
|
352
|
-
3. Tiếp tục theo lựa chọn của người dùng. **Nếu changelog row không nêu rõ UC/AC/BR bị đổi (mơ hồ) → khuyến nghị F** (gen lại toàn bộ) thay vì Y, để khỏi sót scenario bị ảnh hưởng (lưới an toàn — không chắc đổi ở đâu thì quét rộng).
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
## BDD Writing Rules (R1-R10 — enforce nghiêm)
|
|
357
|
-
|
|
358
|
-
| Rule | Name | Yêu cầu |
|
|
359
|
-
|------|------|-------------|
|
|
360
|
-
| R1 | Given/When/Then Semantics | Given=state, When=action, Then=outcome. Mỗi SC cần đủ G/W/T. |
|
|
361
|
-
| R2 | One Behavior Per Scenario | 1 SC = 1 behavior. KHÔNG chain When→Then→When→Then. |
|
|
362
|
-
| R3 | Ubiquitous Language | KHÔNG dùng UI selector / tên API / tech term trong step. |
|
|
363
|
-
| R4 | Outside-in Naming | Tên SC mô tả business outcome. Không "click" / "(Case X)" / tên component. |
|
|
364
|
-
| R5 | Declarative over Imperative | Mô tả WHAT (ý định nghiệp vụ), KHÔNG phải HOW (cơ chế UI). |
|
|
365
|
-
| R6 | Observable Outcomes Only | Then khẳng định outcome quan sát được. Không phải trạng thái UI trung gian / internal state. |
|
|
366
|
-
| R7 | Key Examples / Concrete | Dùng giá trị cụ thể. Không "valid data" mơ hồ. |
|
|
367
|
-
| R8 | Independence | SC chạy độc lập. Không phụ thuộc state từ SC khác. |
|
|
368
|
-
| R9 | Test Data Completeness | Data table có đủ field để suy ra Then kỳ vọng. |
|
|
369
|
-
| R10 | Scope Boundary Explicit | Cross-UC reference dùng cách diễn đạt navigation + comment Note. |
|
|
370
|
-
|
|
371
|
-
## Project Compliance (fail review nếu thiếu — C.1-C.5)
|
|
372
|
-
|
|
373
|
-
| Check | Rule |
|
|
374
|
-
|-------|------|
|
|
375
|
-
| C.1 Wireframe Coverage | Mỗi component/action trong Wireframe (PRD §4b) có ≥1 SC. **FE/App: mỗi Screen State (≠default) và mỗi AC-UI behavioral của design-spec (`design_coverage`) cũng phải có ≥1 SC** — dedup với AC nghiệp vụ PRD; bỏ AC-UI visual thuần. |
|
|
376
|
-
| C.2 PRD Traceability | Mỗi AC **thuộc UC này** (đúng tập ở `**AC liên quan:**` của UC trong PRD §3) và mỗi BR trong bảng Business Rule của UC này map tới ≥1 SC. **KHÔNG** phủ AC của UC khác — đó là việc của `.feature` UC đó. *(AC ở PRD là global cấp PRD, còn `.feature` là per-UC; enforce theo nghĩa "mọi AC của PRD" sẽ bắt AI bịa scenario ngoài scope hoặc báo MISSING giả.)* |
|
|
377
|
-
| C.3 Business Dictionary | Dùng đúng canonical term từ business-dictionary.md. |
|
|
378
|
-
| C.4 Banned Terms | 0 banned term trong file — grep trước khi gen. |
|
|
379
|
-
| C.5 NHÓM Grouping | Feature ≥3 SC → PHẢI có NHÓM grouping theo business theme. |
|
|
380
|
-
|
|
381
|
-
---
|
|
382
|
-
|
|
383
|
-
## NHÓM Grouping Convention (C.5 — bắt buộc cho ≥3 scenario)
|
|
384
|
-
|
|
385
|
-
Gom theo business theme, KHÔNG theo happy/negative/edge.
|
|
386
|
-
|
|
387
|
-
Format header (thụt 2 space, cùng cấp với Background):
|
|
388
|
-
```
|
|
389
|
-
# ==========================================================
|
|
390
|
-
# NHÓM N: <Business theme> (<BR refs nếu áp dụng>)
|
|
391
|
-
# ==========================================================
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
Rules:
|
|
395
|
-
- Đánh số tuần tự NHÓM 1 → N. SC ID tuần tự xuyên suốt lifecycle (không reset theo từng NHÓM).
|
|
396
|
-
- Mỗi NHÓM có thể chứa @happy + @edge + @negative cùng theme.
|
|
397
|
-
- SC trong NHÓM không cần theo thứ tự ID (NHÓM 2 có thể chứa SC4, SC8, SC11 nếu cùng theme).
|
|
398
|
-
|
|
399
|
-
Pattern gợi ý (điều chỉnh theo UC):
|
|
400
|
-
- `Init / Save success — valid data combinations`
|
|
401
|
-
- `Validation / Block when invalid`
|
|
402
|
-
- `Error handling — API fail / system error`
|
|
403
|
-
- `Cancel changes / Close modal without saving`
|
|
404
|
-
- `Cross-system / Downstream effects`
|
|
405
|
-
- `Idempotency & Concurrency`
|
|
406
|
-
|
|
407
|
-
---
|
|
408
|
-
|
|
409
|
-
## UC Decomposition
|
|
410
|
-
|
|
411
|
-
Với mỗi UC trong PRD, trình bày outline SC **trước khi sinh**:
|
|
412
|
-
```
|
|
413
|
-
{TICKET-ID}-UC1: {Use Case Name}
|
|
414
|
-
NHÓM 1: {Theme} (BR1, BR2)
|
|
415
|
-
SC1 [@happy]: {business outcome}
|
|
416
|
-
SC2 [@happy @alternative]: {variant outcome}
|
|
417
|
-
NHÓM 2: {Theme} (BR2, BR3)
|
|
418
|
-
SC3 [@edge]: {edge case}
|
|
419
|
-
SC4 [@negative]: {error handling}
|
|
420
|
-
ACs covered: AC1, AC2
|
|
421
|
-
BRs covered: {TICKET-ID}-UC1-BR1, BR2, BR3
|
|
422
|
-
```
|
|
423
|
-
|
|
424
|
-
*(FE/App: nếu đã nạp design-spec (xem "Design Spec — Gate & Load"), đưa Screen State ≠default (loading/error/empty) + AC-UI behavioral của `design_coverage` vào outline — dedup với AC nghiệp vụ, đừng tạo SC trùng.)*
|
|
425
|
-
|
|
426
|
-
CHECKPOINT: "Outline này đúng chưa? Bạn muốn thêm hay bớt SC nào không?" → **Chờ confirm trước khi sinh.**
|
|
427
|
-
|
|
428
|
-
---
|
|
429
|
-
|
|
430
|
-
## Generate
|
|
431
|
-
|
|
432
|
-
**Output path — MỘT bố cục duy nhất cho cả hai mode:**
|
|
433
|
-
|
|
434
|
-
```
|
|
435
|
-
{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC{N}-{slug}.feature
|
|
436
|
-
```
|
|
437
|
-
|
|
438
|
-
`{active_platform}` ∈ `web` | `app` | `system` — từ Platform Selection (spec repo mode) hoặc suy từ `active_module` (umbrella mode, xem §Service Detection). **Không có `active_platform` thì không ghi file.**
|
|
439
|
-
|
|
440
|
-
Với mỗi UC, ghi vào path trên và set `# @trace.platform: {active_platform}` trong header (**bắt buộc, mọi mode** — `/generate-code` dùng nó để quyết BE/FE và để định vị sổ trace; `/generate-tech-docs` và `context-loader` cũng đọc nó). Dùng từ vựng cho active platform.
|
|
441
|
-
|
|
442
|
-
```gherkin
|
|
443
|
-
{{include:templates/feature.template}}
|
|
444
|
-
```
|
|
445
|
-
|
|
446
|
-
> **Template này đến từ đâu — đọc trước khi định "customize":**
|
|
447
|
-
> Skeleton trên là **single-source** ở `templates/feature.template` **của repo framework**, được `{{include}}` **nướng cứng vào lệnh này lúc `npm run build`**. Muốn đổi cấu trúc mọi `.feature` sinh ra: sửa file đó **trong repo framework** rồi build lại + phát hành.
|
|
448
|
-
>
|
|
449
|
-
> **Sửa `.agent/templates/feature.template` trong project KHÔNG có tác dụng** — không lệnh nào đọc file đó; nó chỉ là bản tham khảo. Và nó **sẽ bị ghi đè im lặng** ở lần `/update-framework` kế tiếp (`--init` copy `core/` → `.agent/` vô điều kiện; file duy nhất được giữ là `.agent/project-context.yaml`).
|
|
450
|
-
>
|
|
451
|
-
> Coverage Matrix + Pre-merge Checklist nằm ở **cuối** template, thêm vào cuối mỗi file.
|
|
452
|
-
|
|
453
|
-
### Bump `@trace.sc_version` *(CHỈ khi gen lại — file `.feature` đã tồn tại)*
|
|
454
|
-
|
|
455
|
-
*Bỏ qua hoàn toàn khi gen mới: mọi SC nhận `1.0`.*
|
|
456
|
-
|
|
457
|
-
`@trace.sc_version` là version **của từng scenario** — nó là tín hiệu DUY NHẤT cho `/validate-traces` biết code của SC đó đã lỗi thời (`spec_ver != gen_ver` → `DRIFT`). Không bump = code sinh từ scenario cũ mãi mãi hiện `OK`. Phân biệt với `@trace.bdd_version` (version **cả file**, không đủ phân giải để biết SC nào cần regen).
|
|
458
|
-
|
|
459
|
-
Trước khi ghi file, với **mỗi** SC, so **thân scenario** bản mới vs bản trên disk theo 4 thành phần:
|
|
460
|
-
|
|
461
|
-
1. dòng `Scenario:` (tên)
|
|
462
|
-
2. chuỗi step `Given` / `When` / `Then` / `And` (nội dung + thứ tự)
|
|
463
|
-
3. nội dung data table (nếu có)
|
|
464
|
-
4. dòng `# Side-effects:`
|
|
465
|
-
|
|
466
|
-
| Kết quả so | Hành động |
|
|
467
|
-
|---|---|
|
|
468
|
-
| Khác ở **bất kỳ** thành phần nào | `@trace.sc_version` += `0.1` (vd `1.0` → `1.1`) |
|
|
469
|
-
| Giống hoàn toàn | **GIỮ NGUYÊN** — bump vô cớ sẽ tạo `DRIFT` giả, làm cờ mất giá trị |
|
|
470
|
-
| SC mới (chưa có trong bản cũ) | `1.0` |
|
|
471
|
-
|
|
472
|
-
*(Thay đổi ngoài 4 thành phần trên — `@trace.business_rules`, tag `@happy`/`@edge`, comment — KHÔNG bump: chúng không đổi hành vi mà code phải implement.)*
|
|
473
|
-
|
|
474
|
-
In danh sách SC được bump vào report cuối để người dùng biết cái nào sẽ hiện `DRIFT`.
|
|
475
|
-
|
|
476
|
-
---
|
|
477
|
-
|
|
478
|
-
## Write Trace State
|
|
479
|
-
|
|
480
|
-
Sau khi sinh tất cả file `.feature`, tạo hoặc cập nhật **sổ trace theo platform** `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{active_platform}.tsv` cho mỗi UC — một sổ riêng cho `system` / `web` / `app`. Vì `sc_id` = `{UC-ID}-SC{N}` chỉ độc nhất trong (UC × platform) (mỗi platform tự đánh số SC từ 1), **mỗi platform một file** để scenario platform này không đè/xoá platform khác. Lệnh luôn biết `active_platform` (từ Platform Selection / Service Detection) nên chỉ ghi đúng sổ của platform đang gen.
|
|
481
|
-
|
|
482
|
-
> **Umbrella + `spec_source`:** cả file `.feature` **và** trace `.tsv` đều ghi vào **spec repo** (`{spec_source}/specs/{domain}/{prd-slug}/bdd/…` và `{spec_source}/.trace/{domain}/{prd-slug}/…`, do context-loader phân giải) — một thao tác ghi **single-repo**, commit/push vào spec submodule. (Trace được gộp trong spec repo để PM quản lý mọi status ở một chỗ; các lệnh phía code cập nhật liên-repo sau.)
|
|
483
|
-
|
|
484
|
-
**Cột TSV (tab-separated, một header row + một data row cho mỗi scenario):**
|
|
485
|
-
```
|
|
486
|
-
sc_id\tsc_title\tspec_ver\tgen_ver\timplemented_by\ttest_count\ttest_classes\tdev_selftest\tdev_selftest_at\tqc_status\tqc_run_at\tqc_owner\tqc_blocked_by\tprd_version\tbdd_version\ttech_doc_revision\tfe_tech_doc_revision\tprd_status\tuc_status\tfe_phase\tstatus\tlast_updated\tservice\tdesign_spec_version
|
|
487
|
-
```
|
|
488
|
-
|
|
489
|
-
**Rules:**
|
|
490
|
-
- Nếu file chưa tồn tại → tạo với header row + tất cả scenario row.
|
|
491
|
-
- Nếu file tồn tại (gen lại) → với mỗi SC trong `.feature` mới:
|
|
492
|
-
- SC đã có trong `.tsv` VÀ `spec_ver` không đổi → chỉ cập nhật: `sc_title`, `prd_version`, `bdd_version`, `prd_status`, `uc_status`, `service`, `design_spec_version`, `last_updated`. Giữ nguyên các cột khác. *(`service` + `design_spec_version` là sự thật cấp-file, làm mới theo `.feature`/design-spec hiện tại — chúng KHÔNG phải tín hiệu nghiệm thu nên làm mới chúng không che giấu gì.)*
|
|
493
|
-
- SC đã có trong `.tsv` VÀ `spec_ver` đổi (scenario bị sửa) → cập nhật: `sc_title`, `spec_ver`, `prd_version`, `bdd_version`, `prd_status`, `uc_status`, `service`, `design_spec_version`, `last_updated` VÀ set `status = DRIFT` ngay (để TSV phản ánh drift mà không cần đợi `/validate-traces`). Giữ nguyên `gen_ver`, `implemented_by`, `test_count`, `test_classes`, `tech_doc_revision`, `fe_tech_doc_revision`.
|
|
494
|
-
**VÀ hạ hiệu lực tín hiệu kiểm thử của đúng SC đó** — spec vừa đổi nên test/QC cũ đang nghiệm thu một hành vi **không còn tồn tại**:
|
|
495
|
-
`dev_selftest → not_run` · `dev_selftest_at → —` · `qc_status → not_run` · `qc_run_at → —`.
|
|
496
|
-
> **Vì sao bắt buộc** *(luật "Làm mất hiệu lực ≠ ghi đè", `rules/workflow.md`)*: không hạ thì chuỗi sau báo xanh sai — spec đổi → `DRIFT` → `/generate-code` sửa method → `gen_ver = spec_ver` → `/validate-traces` Rule 4 cho `OK` (vì `test_count` vẫn > 0) → dashboard hiện `OK · ✅ 10 tests · qc pass` trong khi hành vi mới **chưa được test lần nào**. Đây là lớp lỗi nguy hiểm hơn G1: G1 làm cờ im lặng, cái này làm cờ **nói dối**.
|
|
497
|
-
> **KHÔNG** đụng `test_count`/`test_classes` (test vẫn nằm trên đĩa — số lượng không sai, chỉ nội dung cũ; hạ số sẽ làm tỷ lệ coverage nhảy loạn) và **KHÔNG** đụng `qc_owner`/`qc_blocked_by` (con trỏ tới bug — spec đổi không làm bug biến mất).
|
|
498
|
-
In cảnh báo kèm: `⚠️ {test_count} test của {sc_id} viết cho spec cũ — /dev-gen-test rà lại trước khi chạy`.
|
|
499
|
-
- SC mới (thêm trong lần gen lại này) → append row mới với `gen_ver`, `implemented_by`, `test_count`, `test_classes`, `dev_selftest`, `dev_selftest_at`, `qc_status`, `qc_run_at`, `qc_owner`, `qc_blocked_by`, `tech_doc_revision`, `fe_tech_doc_revision` đều set `—`.
|
|
500
|
-
- SC không còn trong `.feature` (bị xoá / gộp / đổi số) → **phụ thuộc SC đó đã có code chưa:**
|
|
501
|
-
- `implemented_by == —` (**chưa** có code) → **xoá row**. Không có gì mồ côi.
|
|
502
|
-
- `implemented_by != —` (**ĐÃ** có code) → **GIỮ row**, set `status = ORPHANED`, giữ nguyên `implemented_by` / `test_count` / `test_classes` / các cột qc, cập nhật `last_updated`. **KHÔNG xoá** — xoá row thì method đó thành vô hình: không `UNTRACKED`, không `GAP`, không `DRIFT`, không xuất hiện ở report nào, mà vẫn nằm trong code và vẫn được caller gọi. Coverage còn *đẹp hơn* thực tế vì mẫu số nhỏ đi.
|
|
503
|
-
In cảnh báo nổi bật ở report cuối:
|
|
504
|
-
```
|
|
505
|
-
⚠️ ORPHANED — {UC-ID}-SC{N} "{sc_title}" đã bị xoá khỏi .feature nhưng còn code:
|
|
506
|
-
{implemented_by} (+ {test_count} test: {test_classes})
|
|
507
|
-
Không tự hết — chọn MỘT:
|
|
508
|
-
(a) behavior không còn cần → xoá method + test, rồi xoá row khỏi .tsv
|
|
509
|
-
(b) SC bị xoá do nhầm → đưa scenario trở lại .feature (row về DRIFT/OK bình thường)
|
|
510
|
-
(/validate-traces giữ cờ ORPHANED 🔴 và chặn "pass" tới khi xử lý xong.)
|
|
511
|
-
```
|
|
512
|
-
*(An toàn: sổ này chỉ chứa scenario của `{active_platform}`, so với `.feature` của chính platform đó — không bao giờ đụng scenario platform khác.)*
|
|
513
|
-
|
|
514
|
-
**Giá trị ghi cho mỗi scenario:**
|
|
515
|
-
|
|
516
|
-
| Cột | Giá trị |
|
|
517
|
-
|--------|-------|
|
|
518
|
-
| `sc_id` | `{UC-ID}-SC{N}` |
|
|
519
|
-
| `sc_title` | text title của scenario |
|
|
520
|
-
| `spec_ver` | `@trace.sc_version` của scenario này |
|
|
521
|
-
| `gen_ver` | `—` (chưa gen) |
|
|
522
|
-
| `implemented_by` | `—` |
|
|
523
|
-
| `test_count` | `—` |
|
|
524
|
-
| `test_classes` | `—` |
|
|
525
|
-
| `dev_selftest` | `—` (chưa chạy test) |
|
|
526
|
-
| `dev_selftest_at` | `—` |
|
|
527
|
-
| `qc_status` | `—` (kết quả QC automation chính thức — set bởi `/qc-run-test`) |
|
|
528
|
-
| `qc_run_at` | `—` |
|
|
529
|
-
| `qc_owner` | `—` (SC chưa pass đang chờ ai: `dev` / `po` — set bởi `/qc-run-test` + `/report-bug`) |
|
|
530
|
-
| `qc_blocked_by` | `—` (`BUG-{id}` / `GAP-{id}` liên kết — set bởi `/qc-run-test` + `/report-bug`) |
|
|
531
|
-
| `prd_version` | `@trace.prd_version` từ header `.feature` |
|
|
532
|
-
| `bdd_version` | `@trace.bdd_version` từ header `.feature` |
|
|
533
|
-
| `tech_doc_revision` | `—` (revision tech-doc gộp `{TICKET-ID}-tech-design.md` — set bởi `/generate-code` + `/review-tech-docs`) |
|
|
534
|
-
| `fe_tech_doc_revision` | `—` (revision cùng tech-doc gộp, ghi khi FE `--phase=integration` wire theo §4.5.4 — set bởi `/generate-code`) |
|
|
535
|
-
| `prd_status` | đọc `\| **Status** \|` từ metadata PRD |
|
|
536
|
-
| `uc_status` | `draft` cho UC mới; giữ giá trị hiện có khi gen lại |
|
|
537
|
-
| `fe_phase` | `—` (set bởi `/generate-code --phase` khi FE implement) |
|
|
538
|
-
| `status` | `UNTRACKED` |
|
|
539
|
-
| `last_updated` | hôm nay `YYYY-MM-DD` |
|
|
540
|
-
| `service` | `@trace.service` từ header `.feature` — đội/submodule sở hữu scenario này. `multi` nếu chưa chốt (map-theo-platform ở cấp PRD), `unresolved` nếu domain không khớp entry nào, `—` ở single-service mode. **Đừng bỏ trống** — trace gộp không tách theo service nên đây là chỗ DUY NHẤT mang thông tin sở hữu ở cấp row. |
|
|
541
|
-
| `design_spec_version` | `\| **Version** \|` của design-spec đã nạp ở §Design Spec — Gate & Load. `—` cho `system`/backend (không có design-spec), và `—` khi người dùng chọn "Y — vẫn sinh BDD" mà không có design-spec. |
|
|
542
|
-
|
|
543
|
-
## Refresh Panel Mirror
|
|
544
|
-
{{include:steps/trace-mirror.md}}
|
|
545
|
-
|
|
546
|
-
## Output
|
|
547
|
-
|
|
548
|
-
{{include:steps/report-footer.md}}
|
|
549
|
-
|
|
550
|
-
```
|
|
551
|
-
/generate-bdd Hoàn tất
|
|
552
|
-
|
|
553
|
-
[Spec repo mode — platform: {active_platform}]
|
|
554
|
-
Files:
|
|
555
|
-
{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC1-{slug}.feature ({N} scenarios)
|
|
556
|
-
{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC2-{slug}.feature ({N} scenarios)
|
|
557
|
-
Trace:
|
|
558
|
-
{paths.trace_dir}/{domain}/{prd-slug}/{TICKET-ID}-UC1-{active_platform}.tsv ({N} rows)
|
|
559
|
-
{paths.trace_dir}/{domain}/{prd-slug}/{TICKET-ID}-UC2-{active_platform}.tsv ({N} rows)
|
|
560
|
-
Next (spec repo):
|
|
561
|
-
→ Chạy /generate-bdd lại cho các platform khác (web → app → system)
|
|
562
|
-
→ Sau khi gen hết platform: commit + push + báo team dev
|
|
563
|
-
→ Team dev đọc BDD từ spec submodule — không chạy /generate-bdd ở phía họ
|
|
564
|
-
|
|
565
|
-
[Umbrella mode — service: {active_service} · platform: {active_platform} (suy từ module {active_module})]
|
|
566
|
-
Files:
|
|
567
|
-
{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC1-{slug}.feature ({N} scenarios)
|
|
568
|
-
Trace:
|
|
569
|
-
{paths.trace_dir}/{domain}/{prd-slug}/{TICKET-ID}-UC1-{active_platform}.tsv ({N} rows)
|
|
570
|
-
Next (umbrella):
|
|
571
|
-
→ /review-context {feature-file} để kiểm tra coverage
|
|
572
|
-
→ /generate-tech-docs {feature-file}
|
|
573
|
-
→ /generate-code {feature-file}
|
|
574
|
-
|
|
575
|
-
{chỉ khi gen lại VÀ có ≥1 SC bị bump — ngược lại bỏ cả khối}
|
|
576
|
-
🔄 sc_version đã bump (scenario đổi nội dung → code cũ lỗi thời):
|
|
577
|
-
{UC-ID}-SC2 1.0 → 1.1 {sc_title}
|
|
578
|
-
{UC-ID}-SC5 1.2 → 1.3 {sc_title}
|
|
579
|
-
→ {n} SC này sẽ hiện DRIFT ở /validate-traces. Sinh lại code: /generate-code {feature-file}
|
|
580
|
-
|
|
581
|
-
{cùng điều kiện — chỉ in các SC bump mà TRƯỚC ĐÓ có dev_selftest/qc_status khác "—"}
|
|
582
|
-
🔻 Tín hiệu kiểm thử bị hạ (spec vừa đổi — nghiệm thu cũ hết hiệu lực):
|
|
583
|
-
{UC-ID}-SC2 dev_selftest pass→not_run · qc_status pass→not_run
|
|
584
|
-
⚠️ {n} test của các SC này viết cho spec CŨ — rà lại nội dung, đừng chỉ chạy lại.
|
|
585
|
-
→ sau khi /generate-code: /dev-gen-test (rà test) → /dev-run-test → QC /qc-run-test
|
|
586
|
-
ℹ️ Coverage "đã kiểm đạt" sẽ TỤT trên dashboard — đó là số đúng; số cũ mới là số sai.
|
|
587
|
-
(Tỷ lệ phủ code/test KHÔNG đổi — test_count giữ nguyên vì test vẫn nằm trên đĩa.)
|
|
588
|
-
|
|
589
|
-
📊 Living Docs: chạy /validate-traces (hoặc /sync) để push trace này lên dashboard spec-module.
|
|
590
|
-
```
|