@educa-corp/sdd-framework 0.3.0 → 0.4.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/build.js +9 -0
- package/bin/index.js +115 -4
- package/bin/self-check.js +236 -0
- package/bin/trace-schema.json +692 -0
- package/commands/debug.md +82 -17
- package/commands/define-product.md +82 -17
- package/commands/dev-gen-test.md +82 -17
- package/commands/dev-run-test.md +84 -18
- package/commands/dev-run-test.tmpl +2 -1
- package/commands/dev-smoke-test.md +82 -17
- package/commands/fix-bug.md +137 -20
- package/commands/fix-bug.tmpl +29 -3
- package/commands/generate-architecture.md +82 -17
- package/commands/generate-bdd.md +187 -44
- package/commands/generate-bdd.tmpl +92 -17
- package/commands/generate-code.md +115 -20
- package/commands/generate-code.tmpl +33 -3
- package/commands/generate-design-spec.md +82 -17
- package/commands/generate-prd.md +82 -17
- package/commands/generate-spec-manifest.md +82 -17
- package/commands/generate-tech-docs.md +85 -20
- package/commands/generate-tech-docs.tmpl +2 -2
- package/commands/learn.md +82 -17
- package/commands/map-testids.md +82 -17
- package/commands/propose-scenario.md +102 -19
- package/commands/propose-scenario.tmpl +20 -2
- package/commands/qc-analyze.md +82 -17
- package/commands/qc-design-test.md +82 -17
- package/commands/qc-plan.md +82 -17
- package/commands/qc-report.md +82 -17
- package/commands/qc-review.md +82 -17
- package/commands/qc-run-test.md +104 -19
- package/commands/qc-run-test.tmpl +22 -2
- package/commands/refine-prd.md +82 -17
- package/commands/report-bug.md +82 -17
- package/commands/review-code.md +122 -19
- package/commands/review-code.tmpl +40 -2
- package/commands/review-context.md +124 -21
- package/commands/review-context.tmpl +42 -4
- package/commands/review-tech-docs.md +113 -19
- package/commands/review-tech-docs.tmpl +31 -2
- package/commands/setup-ai-first.md +35 -16
- package/commands/setup-ai-first.tmpl +19 -6
- package/commands/sync.md +15 -4
- package/commands/sync.tmpl +12 -2
- package/commands/update-framework.md +40 -2
- package/commands/update-framework.tmpl +37 -0
- package/commands/validate-traces.md +231 -25
- package/commands/validate-traces.tmpl +149 -8
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/README.md +56 -0
- package/core/commands/debug.md +82 -17
- package/core/commands/define-product.md +82 -17
- package/core/commands/dev-gen-test.md +82 -17
- package/core/commands/dev-run-test.md +84 -18
- package/core/commands/dev-smoke-test.md +82 -17
- package/core/commands/fix-bug.md +137 -20
- package/core/commands/generate-architecture.md +82 -17
- package/core/commands/generate-bdd.md +187 -44
- package/core/commands/generate-code.md +115 -20
- package/core/commands/generate-design-spec.md +82 -17
- package/core/commands/generate-prd.md +82 -17
- package/core/commands/generate-spec-manifest.md +82 -17
- package/core/commands/generate-tech-docs.md +85 -20
- package/core/commands/learn.md +82 -17
- package/core/commands/map-testids.md +82 -17
- package/core/commands/propose-scenario.md +102 -19
- package/core/commands/qc-analyze.md +82 -17
- package/core/commands/qc-design-test.md +82 -17
- package/core/commands/qc-plan.md +82 -17
- package/core/commands/qc-report.md +82 -17
- package/core/commands/qc-review.md +82 -17
- package/core/commands/qc-run-test.md +104 -19
- package/core/commands/refine-prd.md +82 -17
- package/core/commands/report-bug.md +82 -17
- package/core/commands/review-code.md +122 -19
- package/core/commands/review-context.md +124 -21
- package/core/commands/review-tech-docs.md +113 -19
- package/core/commands/setup-ai-first.md +35 -16
- package/core/commands/sync.md +15 -4
- package/core/commands/update-framework.md +40 -2
- package/core/commands/validate-traces.md +231 -25
- package/core/modules/android-compose/stack-profile.yaml +1 -1
- package/core/modules/flutter/stack-profile.yaml +1 -1
- package/core/modules/ios-swiftui/stack-profile.yaml +1 -1
- package/core/modules/java-spring/stack-profile.yaml +1 -1
- package/core/modules/nextjs/stack-profile.yaml +1 -1
- package/core/modules/nuxt/stack-profile.yaml +1 -1
- package/core/modules/phaser-game/stack-profile.yaml +1 -1
- package/core/modules/php-laravel/stack-profile.yaml +1 -1
- package/core/modules/qc-playwright/stack-profile.yaml +1 -1
- package/core/modules/react/stack-profile.yaml +1 -1
- package/core/modules/react-native/stack-profile.yaml +1 -1
- package/core/modules/vue/stack-profile.yaml +1 -1
- package/core/rules/workflow.md +11 -0
- package/core/steps/context-loader.md +66 -7
- package/core/steps/gate.md +13 -8
- package/core/steps/report-footer.md +3 -2
- package/core/templates/README.md +47 -0
- package/core/templates/feature.template +13 -10
- package/core/templates/project-context.yaml +49 -17
- package/core/templates/tech-design.template.md +1 -1
- package/docs/02-concepts/traceability.md +29 -6
- package/docs/04-reference/trace-schema.md +128 -37
- package/modules/android-compose/stack-profile.yaml +1 -1
- package/modules/flutter/stack-profile.yaml +1 -1
- package/modules/ios-swiftui/stack-profile.yaml +1 -1
- package/modules/java-spring/stack-profile.yaml +1 -1
- package/modules/nextjs/stack-profile.yaml +1 -1
- package/modules/nuxt/stack-profile.yaml +1 -1
- package/modules/phaser-game/stack-profile.yaml +1 -1
- package/modules/php-laravel/stack-profile.yaml +1 -1
- package/modules/qc-playwright/stack-profile.yaml +1 -1
- package/modules/react/stack-profile.yaml +1 -1
- package/modules/react-native/stack-profile.yaml +1 -1
- package/modules/vue/stack-profile.yaml +1 -1
- package/package.json +50 -49
- package/rules/workflow.md +11 -0
- package/scripts/migrate-bdd-platform.js +286 -0
- package/steps/context-loader.md +66 -7
- package/steps/gate.md +13 -8
- package/steps/report-footer.md +3 -2
- package/templates/README.md +47 -0
- package/templates/feature.template +13 -10
- package/templates/project-context.yaml +49 -17
- package/templates/tech-design.template.md +1 -1
|
@@ -90,23 +90,82 @@ Nếu có section `services`:
|
|
|
90
90
|
- Nếu target không mang `@trace.platform` (vd target là PRD `.md`), thử suy từ segment `bdd/{platform}/` trong path target.
|
|
91
91
|
- Nếu vẫn không xác định được → `active_platform = null`.
|
|
92
92
|
|
|
93
|
-
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
93
|
+
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
94
|
+
|
|
95
|
+
Hình dung việc này như **tra địa chỉ**: đi từ `domain`, có thể qua `platform`, có thể qua `prd_slug`, cho tới khi chỉ còn đúng một submodule.
|
|
96
|
+
|
|
97
|
+
Thứ trỏ tới đích gọi là một **service entry**. Nó chỉ có hai kiểu:
|
|
98
|
+
|
|
99
|
+
| Kiểu | Nhận ra bằng | Nghĩa |
|
|
100
|
+
|---|---|---|
|
|
101
|
+
| **Đã chốt** | có `path` | Xong — đây là submodule cần tìm |
|
|
102
|
+
| **Tra tiếp** | có `by_prd_slug` | Ô này còn nhiều submodule → tra thêm một nấc bằng `prd_slug` (2c) |
|
|
103
|
+
|
|
104
|
+
**Kiểm tra hợp lệ TRƯỚC khi dùng một entry** (làm ngay, đừng đợi tới 2a/2b/2c — sai ở đây mà đi tiếp là route nhầm repo mà không báo gì):
|
|
105
|
+
|
|
106
|
+
| Entry trông thế nào | Xử lý |
|
|
107
|
+
|---|---|
|
|
108
|
+
| có `path`, không có `by_prd_slug` | hợp lệ → dùng |
|
|
109
|
+
| có `by_prd_slug`, không có `path` | hợp lệ → tra tiếp (2c) |
|
|
110
|
+
| **có CẢ HAI** | ❌ lỗi cấu hình → `active_service = unresolved`. **KHÔNG** ưu tiên `path` rồi bỏ qua `by_prd_slug` — như vậy mọi feature sẽ âm thầm route về cùng một repo. Báo đúng key sai để người dùng sửa. |
|
|
111
|
+
| **không có cái nào** (và cũng không phải map platform) | ❌ lỗi cấu hình → `unresolved`, nêu rõ entry thiếu `path`/`by_prd_slug` |
|
|
112
|
+
| `by_prd_slug` chứa entry lại có `by_prd_slug` | ❌ lỗi cấu hình → `unresolved`. Chỉ tra đúng **một** nấc slug, không đệ quy |
|
|
113
|
+
|
|
114
|
+
Còn `services.{domain}` thì có thể là **một service entry** (chốt luôn ở cấp domain), hoặc **một map platform → service entry** (phải qua nấc platform trước). Nhận dạng theo đúng thứ tự này:
|
|
115
|
+
|
|
116
|
+
| Thấy gì trong `services.{domain}` | Đi nhánh |
|
|
117
|
+
|---|---|
|
|
118
|
+
| có `path` | **2a** — chốt luôn |
|
|
119
|
+
| có `by_prd_slug` | **2c** — tra bằng `prd_slug` |
|
|
120
|
+
| không có cả hai (chỉ có các sub-key `system`/`web`/`app`…) | **2b** — tra bằng `platform`, rồi lặp lại đúng bảng này cho entry con |
|
|
94
121
|
|
|
95
122
|
**2a. Dạng phẳng** — `services.{domain}` có **trực tiếp** `path`/`module` (một domain ↔ một service, mọi platform về cùng submodule). Route như cũ:
|
|
96
123
|
- Lưu `active_service` = `services.{domain}.path`
|
|
97
124
|
- Lưu `active_service_module` = `services.{domain}.module`
|
|
98
125
|
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
99
126
|
|
|
100
|
-
**2b. Dạng map-theo-platform** — `services.{domain}` **KHÔNG** có `path` trực tiếp mà chứa các sub-key platform (`system` / `web` / `app`), mỗi cái là
|
|
101
|
-
- Nếu `active_platform` khớp một sub-key → `entry = services.{domain}.{active_platform}
|
|
102
|
-
- Nếu `active_platform = null` (chưa xác định platform, vd đang thao tác cấp PRD) → **KHÔNG** chốt một service; đặt `active_service = multi` và lưu `service_candidates =
|
|
127
|
+
**2b. Dạng map-theo-platform** — `services.{domain}` **KHÔNG** có `path` trực tiếp mà chứa các sub-key platform (`system` / `web` / `app`), mỗi cái là một **service entry** (một business-domain trải trên nhiều platform/submodule). Route theo `active_platform` (bước 1b):
|
|
128
|
+
- Nếu `active_platform` khớp một sub-key → `entry = services.{domain}.{active_platform}`. Nếu `entry` có `path` → lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`). Nếu `entry` có `by_prd_slug` → **đi tiếp sang 2c** với entry đó.
|
|
129
|
+
- Nếu `active_platform = null` (chưa xác định platform, vd đang thao tác cấp PRD) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = platform`, và lưu `service_candidates` = map platform→`{path, module}`. **Làm phẳng luôn ở đây:** platform nào có entry `by_prd_slug` thì giải bằng `prd_slug` hiện tại (target cấp PRD vẫn nằm trong một feature-package nên `prd_slug` đã biết từ bước 1) → `service_candidates.{platform}` vẫn là `{path, module}` phẳng. Nếu `prd_slug` không khớp key nào, ghi platform đó là `unresolved` kèm lý do thay vì bỏ im. Nhờ vậy **mọi lệnh downstream chỉ cần biết một kiểu `service_candidates`**. Lệnh cần một service cụ thể (`/generate-code`, `/dev-*`, `/fix-bug`) luôn chạy trên target `.feature` có platform nên sẽ resolve được ở lần chạy đó; lệnh cấp PRD (`/generate-prd`, `/refine-prd`) không cần service cụ thể.
|
|
103
130
|
- Nếu `active_platform` xác định nhưng không có sub-key tương ứng → `active_service = unresolved` (xem Fallback) với lý do "domain `{domain}` chưa cấu hình platform `{active_platform}`".
|
|
104
131
|
|
|
105
|
-
|
|
132
|
+
**2c. Dạng map-theo-prd_slug** — một service entry chứa `by_prd_slug` thay cho `path`: **một ô của bảng định tuyến ứng với NHIỀU submodule**, mỗi feature-package một submodule. Dùng khi một platform (hoặc cả một domain) bị chia thành nhiều repo theo feature — ví dụ mỗi mini-game webview là một repo riêng.
|
|
133
|
+
|
|
134
|
+
Đến đây `prd_slug` đã được trích ở bước 1 (không cần detect thêm gì). Route:
|
|
135
|
+
|
|
136
|
+
- Nếu `prd_slug` khớp một key dưới `by_prd_slug` → `entry = {…}.by_prd_slug.{prd_slug}`; lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`).
|
|
137
|
+
**"Khớp" ở đây là khớp CHÍNH XÁC toàn chuỗi, phân biệt hoa/thường.** KHÔNG prefix, KHÔNG bỏ hậu tố, KHÔNG so gần đúng: `dap-chuot-v2` **không** khớp key `dap-chuot`; `Ban-Cung` **không** khớp `ban-cung`. Feature mới tách ra từ một feature cũ là một repo khác cho tới khi có người khai nó vào bảng.
|
|
138
|
+
- Nếu `prd_slug = null` (chưa xác định feature-package — chỉ xảy ra khi không có target file, vd `$ARGUMENTS` rỗng) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = prd_slug`, và lưu `service_candidates` = toàn map `by_prd_slug` (slug → `{path, module}`).
|
|
139
|
+
⚠️ Đây là kiểu `service_candidates` **khác** với 2b — lệnh nào duyệt `service_candidates` theo platform (vd `/generate-bdd` sinh `bdd/{platform}/`) phải kiểm `service_candidates_kind = platform` trước; gặp `prd_slug` thì DỪNG và yêu cầu người dùng chỉ rõ target, đừng coi slug là platform.
|
|
140
|
+
- Nếu `prd_slug` xác định nhưng **không** có key tương ứng → `active_service = unresolved` với lý do rõ: "domain `{domain}`{, platform `{active_platform}`} chưa cấu hình prd_slug `{prd_slug}`". **KHÔNG** tự đoán submodule gần đúng theo tên.
|
|
141
|
+
|
|
142
|
+
Vị trí đặt `by_prd_slug` — hợp lệ ở **cả hai cấp**:
|
|
143
|
+
- **Dưới một platform** (lồng trong 2b): `services.{domain}.{platform}.by_prd_slug` — platform đó có nhiều repo, các platform khác vẫn `{path, module}` như thường.
|
|
144
|
+
- **Ngay dưới domain** (thay cho `path` của 2a): `services.{domain}.by_prd_slug` — domain không chia platform nhưng vẫn nhiều repo theo feature.
|
|
145
|
+
|
|
146
|
+
*(`by_prd_slug` lồng trong `by_prd_slug` là vô nghĩa — nếu gặp, coi là lỗi cấu hình: `active_service = unresolved`, nêu rõ để người dùng sửa file. Một entry vừa có `path` vừa có `by_prd_slug` cũng là lỗi cấu hình — báo lỗi, không âm thầm ưu tiên cái nào.)*
|
|
147
|
+
|
|
148
|
+
Ví dụ (một domain trải nhiều platform, riêng `webview` chia theo feature):
|
|
149
|
+
```yaml
|
|
150
|
+
services:
|
|
151
|
+
learning:
|
|
152
|
+
system: { path: "backend", module: "java-spring" }
|
|
153
|
+
web: { path: "web-app", module: "nextjs" }
|
|
154
|
+
webview:
|
|
155
|
+
by_prd_slug:
|
|
156
|
+
dap-chuot: { path: "games/whac-a-mole", module: "phaser-game" }
|
|
157
|
+
ban-cung: { path: "games/archery", module: "phaser-game" }
|
|
158
|
+
```
|
|
159
|
+
→ target `specs/learning/dap-chuot/bdd/webview/UC1.feature` cho `domain = learning`,
|
|
160
|
+
`active_platform = webview`, `prd_slug = dap-chuot` → `active_service = games/whac-a-mole`.
|
|
161
|
+
|
|
162
|
+
*(Cả 2a/2b/2c: override `paths.specs_dir`/`paths.tech_docs_dir` per-service CHỈ khi `setup.spec_source` KHÔNG được đặt. Khi `spec_source` ĐƯỢC đặt, MỌI BDD/tech-doc là artifact liên team → để bước 4 route sang spec repo; KHÔNG pin per-service ở đây.)*
|
|
106
163
|
|
|
107
164
|
**3. Fallback**:
|
|
108
165
|
- Không phát hiện được domain, hoặc domain không khớp key nào trong `services` → giữ path mặc định từ Bước 1, đặt `active_service = unresolved`.
|
|
109
166
|
- Domain khớp một map-theo-platform (2b) nhưng `active_platform` xác định mà thiếu sub-key tương ứng → `active_service = unresolved`, ghi lý do rõ để lệnh DỪNG báo lỗi cấu hình (không tự đoán platform).
|
|
167
|
+
- Entry là map-theo-prd_slug (2c) nhưng `prd_slug` xác định mà thiếu key tương ứng → `active_service = unresolved`, ghi lý do rõ (không tự đoán submodule).
|
|
168
|
+
- Entry sai cấu trúc (vừa có `path` vừa có `by_prd_slug`, hoặc `by_prd_slug` lồng nhau) → `active_service = unresolved`, nêu đúng key sai để người dùng sửa `project-context.yaml`.
|
|
110
169
|
|
|
111
170
|
**4. Tự động override theo spec source** — nếu `setup.spec_source` được đặt VÀ path tương ứng chưa được set tường minh trong `paths:`:
|
|
112
171
|
- Override `paths.specs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt.** Mọi spec artifact (PRD, BDD, tech-docs, design-spec) nằm dưới gốc spec thống nhất trong spec repo dùng chung theo bố cục feature-package: `{spec_source}/specs/{domain}/{prd-slug}/`. Mọi umbrella (FE/App/BE) đều đọc từ đây. *(`specs/` theo service chỉ khi không có `spec_source`.)*
|
|
@@ -256,7 +315,7 @@ active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
|
256
315
|
| `platform_type` | Modules |
|
|
257
316
|
|---|---|
|
|
258
317
|
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
259
|
-
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
318
|
+
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular`, `phaser-game` |
|
|
260
319
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
261
320
|
|
|
262
321
|
Nếu `tech_stack.module` rỗng hoặc không nhận diện được → set `platform_type = "unknown"` và gắn cờ ⚠️ trong recap Bước 7.
|
|
@@ -303,7 +362,7 @@ Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
|
303
362
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
304
363
|
Lessons : {loaded — N guardrails | chưa có}
|
|
305
364
|
Platform : {active_platform: system | web | app | — nếu chưa xác định}
|
|
306
|
-
Service : {active_service} ({active_service_module}) | multi (map-theo-platform, chốt khi target
|
|
365
|
+
Service : {active_service} ({active_service_module}) [← domain{/platform}{/prd_slug} nếu route qua by_prd_slug] | multi (map-theo-platform hoặc map-theo-prd_slug, chốt khi target đủ platform/prd_slug) | single-service
|
|
307
366
|
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
308
367
|
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
309
368
|
```
|
package/core/steps/gate.md
CHANGED
|
@@ -29,23 +29,23 @@ Hiển thị và chờ phản hồi:
|
|
|
29
29
|
```
|
|
30
30
|
⚙️ MODEL CHECK
|
|
31
31
|
──────────────────────────────────────────────────────────────────
|
|
32
|
-
Recommended :
|
|
32
|
+
Recommended : model Opus mới nhất
|
|
33
33
|
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
34
|
-
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
34
|
+
suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
|
|
35
35
|
|
|
36
36
|
Cách đổi trong Claude Code:
|
|
37
|
-
•
|
|
38
|
-
• hoặc:
|
|
37
|
+
• /model → chọn model Opus
|
|
38
|
+
• hoặc: Settings → Model
|
|
39
39
|
|
|
40
|
-
Đang chạy
|
|
41
|
-
Y — đúng
|
|
40
|
+
Đang chạy một model Opus?
|
|
41
|
+
Y — đúng → tiếp tục
|
|
42
42
|
S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
|
|
43
43
|
──────────────────────────────────────────────────────────────────
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
- "Y" → tiếp tục sang Bước 1.
|
|
47
47
|
- "S" → tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
|
|
48
|
-
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang
|
|
48
|
+
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang một model Opus (`/model`) rồi chạy lại lệnh này."
|
|
49
49
|
|
|
50
50
|
## Bước 1 — Xác định Target File
|
|
51
51
|
|
|
@@ -54,7 +54,12 @@ Hiển thị và chờ phản hồi:
|
|
|
54
54
|
2. Nếu `$ARGUMENTS` là một **UC-ID / ticket ID / tên rút gọn** (không có path) → phân giải thành file bằng cách glob theo bố cục feature-package. `{prd-slug}` lúc này **chưa biết**, nên dùng wildcard `*` cho segment đó, và `**` đệ quy dưới `bdd/` để phủ hết các thư mục con theo platform (`bdd/web/`, `bdd/app/`, `bdd/system/`):
|
|
55
55
|
- **Lệnh BDD** (target là `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — hoặc `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` nếu domain cũng chưa biết. Nếu lệnh ngụ ý một platform/scope cụ thể (vd: system tech-doc cần BDD `system/`), ưu tiên kết quả trong thư mục con platform đó.
|
|
56
56
|
- **Lệnh PRD** (target là file PRD `{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder, cạnh `bdd/`): `{specs_dir}/{domain}/*/{TICKET-ID}*.md` nếu biết TICKET-ID; nếu không, `{specs_dir}/{domain}/*/*.md` (khớp feature folder có id tương ứng), hoặc `{specs_dir}/*/*/*.md` nếu domain cũng chưa biết. *(Glob `*/*.md` ở cấp gốc folder chỉ khớp PRD — tech-docs/design-spec `.md` nằm sâu hơn trong thư mục con.)*
|
|
57
|
-
- **Lệnh tech-docs
|
|
57
|
+
- **Lệnh tech-docs** — target là tech-doc **gộp cấp PRD** `{TICKET-ID}-tech-design.md` (MỘT doc phủ nhiều UC; danh sách UC nằm ở `@trace.ucs`). Vì tên file mang `{TICKET-ID}` chứ **không** mang `{UC-ID}`, phải tách trước khi glob:
|
|
58
|
+
- `$ARGUMENTS` là **UC-ID** (`{TICKET-ID}-UC{N}`) → lấy `{TICKET-ID}` = phần **trước** `-UC`, rồi glob `{specs_dir}/{domain}/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
59
|
+
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
60
|
+
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
61
|
+
- Vẫn không khớp → glob rộng `{specs_dir}/*/*/tech-docs/*tech-design*.md` rồi liệt kê để người dùng chọn.
|
|
62
|
+
*(Đừng glob `{UC-ID}*-tech-design*.md` — nó nở thành `FT-001-UC1*-tech-design*.md` và **không bao giờ** khớp `FT-001-tech-design.md`.)*
|
|
58
63
|
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
59
64
|
|
|
60
65
|
Khi một file khớp: đặt nó làm target **và** ghi lại `domain` + `prd_slug` từ path của nó (theo quy tắc trích xuất trong `context-loader.md` Bước 1 — `prd_slug` = segment đầu tiên sau `{specs_dir}/{domain}/`). Mọi path mà lệnh đọc/ghi về sau (BDD/tech-docs/design-spec/trace cùng cấp) đều dùng **`prd_slug` đã phân giải đó**, nên tất cả artifact nằm chung một feature package. Nếu nhiều file khớp (vd: nhiều platform), chọn theo platform/scope của lệnh hoặc liệt kê ra và hỏi.
|
|
@@ -71,6 +71,7 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
71
71
|
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
72
72
|
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
73
73
|
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
74
|
+
| /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
|
|
74
75
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
75
76
|
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
76
77
|
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
@@ -79,8 +80,8 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
79
80
|
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
80
81
|
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
81
82
|
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
82
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}
|
|
83
|
-
| /fix-bug |
|
|
83
|
+
| /validate-traces | **Cờ 🔴 trước (chặn PR):** SEAM_UNWIRED → nối binding sang class thật, xoá/thay stub · STUB_UNRESOLVED → `/generate-code {owner_uc}` (lấp logic tại chỗ + xoá hàm song song) · ORPHANED/TRACE_ORPHAN → quyết định thủ công (xoá code+test, đưa scenario trở lại `.feature`, hoặc sửa `sc_id` của tag). **Rồi:** DRIFT/UNTRACKED → `/generate-code {UC-ID}` · BDD_DRIFT → `/generate-code {feature-file}` · tech-doc lỗi thời vs BDD → `/generate-tech-docs` → `/review-tech-docs` · PRD drift → `/generate-bdd {prd-file}` · GAP → `/dev-gen-test {UC-ID}`. **Chỉ tạo PR khi mọi cờ 🔴 = 0** |
|
|
84
|
+
| /fix-bug | `/dev-run-test {UC-ID}` (dev_selftest vừa reset về not_run) → tạo PR; nếu fix một `{BUG-ID}` → QC chạy `/qc-run-test {UC-ID}` để verify + đóng bug |
|
|
84
85
|
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
85
86
|
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
86
87
|
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# templates/ — build-time skeletons
|
|
2
|
+
|
|
3
|
+
> **Nếu bạn đang mở thư mục này ở `.agent/templates/` trong một project: sửa file ở đây KHÔNG có tác dụng.**
|
|
4
|
+
|
|
5
|
+
## Vì sao
|
|
6
|
+
|
|
7
|
+
Các skeleton trong thư mục này được `{{include}}` **nướng cứng vào file lệnh lúc `npm run build`**:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
templates/feature.template
|
|
11
|
+
↓ {{include:templates/feature.template}} ← bin/build.js, thay thế văn bản lúc build
|
|
12
|
+
commands/generate-bdd.md
|
|
13
|
+
↓ copy vào core/ → mirror sang .agent/
|
|
14
|
+
.agent/commands/generate-bdd.md ← LỆNH THẬT SỰ CHẠY (đã chứa sẵn skeleton)
|
|
15
|
+
.agent/templates/feature.template ← bản tham khảo, KHÔNG lệnh nào đọc
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Không lệnh nào đọc một path template lúc chạy. `paths.feature_template` / `paths.prd_template` từng tồn tại trong `project-context.yaml` nhưng chưa bao giờ có tác dụng — đã được gỡ bỏ (xem `GAPS.md` G9).
|
|
19
|
+
|
|
20
|
+
**Thêm nữa:** `.agent/` là vùng bị ghi đè. `/update-framework` chạy `npx … --init`, và `--init` copy `core/` → `.agent/` **vô điều kiện** (`bin/index.js` → `copyDirRecursive`, không có existence check, không backup). File duy nhất được giữ lại là `.agent/project-context.yaml`. Nên mọi chỉnh sửa ở `.agent/templates/` sẽ **biến mất im lặng** ở lần nâng cấp kế tiếp.
|
|
21
|
+
|
|
22
|
+
## Muốn đổi cấu trúc artifact sinh ra thì làm gì
|
|
23
|
+
|
|
24
|
+
Sửa file trong **repo framework** rồi build lại:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# trong repo sdd-framework
|
|
28
|
+
vim templates/feature.template # hoặc prd.template.md, tech-design.template.md, …
|
|
29
|
+
npm run build # inline lại vào commands/*.md + core/ + .agent/
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Rồi phát hành version mới; project chạy `/update-framework` để nhận.
|
|
33
|
+
|
|
34
|
+
## File nào ở đây đi vào đâu
|
|
35
|
+
|
|
36
|
+
| Template | Được include vào | Trở thành |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| `feature.template` | `commands/generate-bdd.tmpl` | mỗi file `.feature` |
|
|
39
|
+
| `prd.template.md` | `commands/generate-prd.tmpl` | mỗi PRD |
|
|
40
|
+
| `tech-design.template.md` | `commands/generate-tech-docs.tmpl` | tech-doc gộp / PRD |
|
|
41
|
+
| `design-spec.template.md` | `commands/generate-design-spec.tmpl` | design-spec / platform |
|
|
42
|
+
| `architecture.template.md` | `commands/generate-architecture.tmpl` | tài liệu kiến trúc |
|
|
43
|
+
| `product-definition.template.md` | `commands/define-product.tmpl` | product definition |
|
|
44
|
+
| `platform-guide.template.md` | (tham khảo) | — |
|
|
45
|
+
| `project-context.yaml` | **không** include — được copy thẳng làm file config khởi tạo | `.agent/project-context.yaml` |
|
|
46
|
+
|
|
47
|
+
> Lưu ý `project-context.yaml` là ngoại lệ duy nhất: nó **được** copy ra làm file thật của project, và **được bảo vệ** khỏi ghi đè khi nâng cấp (chỉ tạo nếu chưa tồn tại).
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# ============================================================
|
|
2
2
|
# @trace.id: {TICKET-ID}-UC{N}
|
|
3
3
|
# @trace.title: <Feature name>
|
|
4
|
-
# @trace.revision: 1 ← field tĩnh;
|
|
4
|
+
# @trace.revision: 1 ← field tĩnh; version theo dõi bằng @trace.bdd_version
|
|
5
5
|
# @trace.domain: <domain>
|
|
6
|
-
# @trace.platform: {active_platform — web | app | system
|
|
6
|
+
# @trace.platform: {active_platform — web | app | system} ← BẮT BUỘC mọi mode; phải khớp segment bdd/{platform}/ của path
|
|
7
7
|
# @trace.service: {active_service — bỏ trong spec repo mode}
|
|
8
8
|
# @trace.module: {active_module trong umbrella mode; "unknown" trong spec repo mode}
|
|
9
9
|
# @trace.status: draft
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
# @trace.created_at: {YYYY-MM-DD}
|
|
12
12
|
# @trace.prd: {TICKET-ID}
|
|
13
13
|
# @trace.prd_version: {đọc từ metadata PRD "| **Version** |"}
|
|
14
|
-
# @trace.bdd_version: {1.0 nếu gen mới; tăng 0.1 khi gen lại
|
|
15
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
14
|
+
# @trace.bdd_version: {cấp FILE — 1.0 nếu gen mới; tăng 0.1 khi gen lại. Khác @trace.sc_version (cấp từng SC) bên dưới}
|
|
15
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m}, {TICKET-ID}-UC{N}-BR{m+1} ← {m} lấy NGUYÊN từ PRD §3: BR đánh số LIÊN TỤC toàn PRD, KHÔNG reset theo UC
|
|
16
16
|
# @trace.dataset: {domain}.testdata.yaml
|
|
17
17
|
# ============================================================
|
|
18
18
|
|
|
@@ -59,8 +59,8 @@ Feature: <Feature name>
|
|
|
59
59
|
|
|
60
60
|
# Side-effects: <liệt kê ngắn các Then side-effect cần verify>
|
|
61
61
|
# @trace.scenario: {TICKET-ID}-UC{N}-SC1
|
|
62
|
-
# @trace.sc_version: 1.0
|
|
63
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
62
|
+
# @trace.sc_version: 1.0 ← cấp SCENARIO. Sửa thân SC này (tên/step/table/side-effect) thì +0.1, nếu không code cũ mãi hiện OK
|
|
63
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m}
|
|
64
64
|
@happy
|
|
65
65
|
Scenario: <mô tả business outcome — dùng động từ chính xác: create/receive/assign/block>
|
|
66
66
|
Given <input state — alias từ dataset>
|
|
@@ -71,7 +71,7 @@ Feature: <Feature name>
|
|
|
71
71
|
# Side-effects: <...>
|
|
72
72
|
# @trace.scenario: {TICKET-ID}-UC{N}-SC2
|
|
73
73
|
# @trace.sc_version: 1.0
|
|
74
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
74
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m}
|
|
75
75
|
@happy @alternative
|
|
76
76
|
Scenario: <cùng theme NHÓM 1 nhưng path khác — vd: giá trị enum khác>
|
|
77
77
|
Given <state>
|
|
@@ -85,7 +85,7 @@ Feature: <Feature name>
|
|
|
85
85
|
# Side-effects: <...>
|
|
86
86
|
# @trace.scenario: {TICKET-ID}-UC{N}-SC3
|
|
87
87
|
# @trace.sc_version: 1.0
|
|
88
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
88
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m+2}
|
|
89
89
|
@edge
|
|
90
90
|
Scenario: <scenario boundary / error>
|
|
91
91
|
Given <state>
|
|
@@ -97,8 +97,8 @@ Feature: <Feature name>
|
|
|
97
97
|
# AC1 (...) → SC1, SC2
|
|
98
98
|
# AC2 (...) → SC3
|
|
99
99
|
# BR mapping (mỗi bullet PHẢI có ≥1 SC — C.2):
|
|
100
|
-
# {TICKET-ID}-UC{N}-
|
|
101
|
-
# {TICKET-ID}-UC{N}-
|
|
100
|
+
# {TICKET-ID}-UC{N}-BR{m} (...) → SC1, SC2
|
|
101
|
+
# {TICKET-ID}-UC{N}-BR{m+2} (...) → SC3
|
|
102
102
|
# Wireframe mapping (mỗi component/action ≥1 SC — C.1):
|
|
103
103
|
# Screen "<screen name>":
|
|
104
104
|
# [x] <action 1> → SC1
|
|
@@ -111,6 +111,9 @@ Feature: <Feature name>
|
|
|
111
111
|
|
|
112
112
|
# === PRE-MERGE CHECKLIST ===
|
|
113
113
|
# - [ ] Mỗi SC có Side-effects + @trace.scenario + @trace.sc_version + @trace.business_rules
|
|
114
|
+
# - [ ] SỬA nội dung một SC (tên / step / data table / side-effect) → đã bump @trace.sc_version của
|
|
115
|
+
# CHÍNH SC đó (+0.1). Quên bump = code sinh từ SC cũ vẫn hiện OK, không ai biết phải regen.
|
|
116
|
+
# (Đổi @trace.business_rules / tag / comment → KHÔNG bump: không đổi hành vi cần implement.)
|
|
114
117
|
# - [ ] Coverage Matrix: 0 dòng MISSING (C.1)
|
|
115
118
|
# - [ ] FE/App: mỗi Screen State (≠default) + AC-UI behavioral của design-spec có ≥1 SC (C.1 mở rộng)
|
|
116
119
|
# - [ ] Mỗi AC/BR map tới ≥1 SC (C.2)
|
|
@@ -25,28 +25,41 @@ project:
|
|
|
25
25
|
# All paths are relative to workspace root.
|
|
26
26
|
paths:
|
|
27
27
|
# Feature-Package Layout:
|
|
28
|
-
# specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md
|
|
29
|
-
# specs/{domain}/{prd-slug}/bdd/
|
|
30
|
-
# specs/{domain}/{prd-slug}/tech-docs/
|
|
31
|
-
# specs/{domain}/{prd-slug}/design-spec/
|
|
32
|
-
#
|
|
28
|
+
# specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md — PRD document
|
|
29
|
+
# specs/{domain}/{prd-slug}/bdd/{platform}/ — BDD .feature ({platform} = web | app | system)
|
|
30
|
+
# specs/{domain}/{prd-slug}/tech-docs/ — Technical design (ONE merged doc per PRD: {TICKET-ID}-tech-design.md)
|
|
31
|
+
# specs/{domain}/{prd-slug}/design-spec/ — Design specs (FE/App only)
|
|
32
|
+
# specs/{domain}/{prd-slug}/changelog/ — PRD changelog overflow (created once history exceeds 5 versions)
|
|
33
|
+
# .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv — Trace state (ONE book per UC × platform)
|
|
34
|
+
#
|
|
35
|
+
# The {platform} segment is NOT optional — in any mode, including umbrella.
|
|
36
|
+
# A UC's `web` and `system` features are two different files; without the segment they
|
|
37
|
+
# collide on one filename and overwrite each other. Trace is split the same way, so the
|
|
38
|
+
# spec layout has to match it. Every .feature also carries `@trace.platform` matching
|
|
39
|
+
# its own {platform} segment. (Projects still on the old flat bdd/ layout:
|
|
40
|
+
# run `npx @educa-corp/sdd-framework --migrate-bdd-platform` — dry-run by default.)
|
|
33
41
|
#
|
|
34
42
|
# specs_dir is the unified root for all spec artifact types (PRD, BDD, tech-docs, design-spec).
|
|
35
43
|
# prd-slug is derived from the PRD folder path — not a separate config variable.
|
|
36
44
|
specs_dir: "specs"
|
|
37
|
-
templates_dir: "specs/templates"
|
|
38
45
|
|
|
39
46
|
# Source code root — gốc mã nguồn của service/app này (nơi generate-code đặt & quét code).
|
|
40
47
|
# BE thường suy vị trí từ CLAUDE.md §2 (code_base_package + layer); src_dir là gốc chung,
|
|
41
48
|
# và là NGUỒN CHÍNH cho FE (component/hook/service/adapter) + phạm vi quét reuse (DS5).
|
|
42
49
|
# Ví dụ: "src" (mono FE), "app/src", "src/main/java" (BE). Chỉnh theo layout thật của repo.
|
|
43
50
|
src_dir: "src"
|
|
44
|
-
feature_template: ".agent/templates/feature.template" # SoT skeleton .feature (dùng bởi /generate-bdd qua {{include}})
|
|
45
|
-
bdd_writing_guide: "specs/templates/bdd-writing-guide.md"
|
|
46
|
-
trace_report: "specs/.trace/trace-report.md"
|
|
47
51
|
|
|
48
|
-
#
|
|
49
|
-
|
|
52
|
+
# ── Template artifact — KHÔNG cấu hình được ──
|
|
53
|
+
# Đã bỏ 6 key chết (không lệnh nào đọc): feature_template · prd_template ·
|
|
54
|
+
# templates_dir · bdd_writing_guide · product_definition_template · trace_report.
|
|
55
|
+
# Các skeleton được {{include}} NƯỚNG CỨNG vào file lệnh lúc `npm run build`,
|
|
56
|
+
# nên lệnh không bao giờ đọc một path template lúc chạy.
|
|
57
|
+
# (trace_report còn trỏ sai hẳn: report thật là {trace_dir}/trace-report.json.)
|
|
58
|
+
#
|
|
59
|
+
# Đổi cấu trúc .feature / PRD sinh ra = sửa templates/*.template* TRONG REPO
|
|
60
|
+
# FRAMEWORK rồi build lại. Sửa .agent/templates/* trong project KHÔNG có tác
|
|
61
|
+
# dụng, và sẽ bị GHI ĐÈ IM LẶNG ở lần /update-framework kế tiếp (--init copy
|
|
62
|
+
# core/ → .agent/ vô điều kiện; file duy nhất được giữ là .agent/project-context.yaml).
|
|
50
63
|
refinement_dir: ".agent/review"
|
|
51
64
|
|
|
52
65
|
# QC's OWN analysis/design working docs (qc-analyze/plan/design-test outputs:
|
|
@@ -66,7 +79,6 @@ paths:
|
|
|
66
79
|
|
|
67
80
|
# Product Definitions
|
|
68
81
|
product_definitions_dir: "specs/product-definition"
|
|
69
|
-
product_definition_template: "specs/templates/product-definition.template.md"
|
|
70
82
|
|
|
71
83
|
# Domain Knowledge
|
|
72
84
|
domain_knowledge_dir: "specs/domain-knowledge"
|
|
@@ -90,7 +102,7 @@ paths:
|
|
|
90
102
|
# This variable is no longer needed as a separate path — derived from specs_dir.
|
|
91
103
|
# design_spec_dir: "specs/design-spec" ← removed; use specs_dir instead
|
|
92
104
|
|
|
93
|
-
# Trace (internal structure: .trace/{domain}/{prd-slug}/{UC-ID}.tsv)
|
|
105
|
+
# Trace (internal structure: .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv — one book per UC × platform)
|
|
94
106
|
trace_dir: ".trace"
|
|
95
107
|
|
|
96
108
|
# Tester / QC feedback (written by /report-bug and /propose-scenario).
|
|
@@ -133,14 +145,16 @@ domains:
|
|
|
133
145
|
# specs_dir → {spec_source}/specs # unified root — PRD/BDD/tech-docs/design-spec
|
|
134
146
|
# tech_docs_dir → {spec_source}/specs # merged into specs_dir
|
|
135
147
|
# domain_knowledge_dir → {spec_source}/specs/domain-knowledge
|
|
136
|
-
# trace_dir → {spec_source}/.trace # structure: .trace/{domain}/{prd-slug}/{UC-ID}.tsv
|
|
148
|
+
# trace_dir → {spec_source}/.trace # structure: .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv
|
|
137
149
|
# (You can still override these manually in paths: section below.)
|
|
138
150
|
# With spec_source set, only ONE override is needed instead of four separate dir vars.
|
|
139
151
|
#
|
|
140
152
|
# services: # domain → service submodule routing
|
|
141
153
|
# # Each domain key MUST match the PRD's `Domain` (Metadata row) / folder path segment.
|
|
142
|
-
# # A domain value has
|
|
143
|
-
# # `path`
|
|
154
|
+
# # A domain value has THREE forms — context-loader (Step 1.5) auto-detects in this order:
|
|
155
|
+
# # has `path` → FORM A (resolved)
|
|
156
|
+
# # has `by_prd_slug` → FORM C (look up one more level)
|
|
157
|
+
# # otherwise → FORM B (per-platform map)
|
|
144
158
|
# #
|
|
145
159
|
# # FORM A — FLAT (one domain ↔ one submodule, all platforms):
|
|
146
160
|
# {{DOMAIN_1}}:
|
|
@@ -157,6 +171,22 @@ domains:
|
|
|
157
171
|
# web: { path: "{{WEB_SUBMODULE_DIR}}", module: "nextjs" }
|
|
158
172
|
# app: { path: "{{APP_SUBMODULE_DIR}}", module: "flutter" }
|
|
159
173
|
# #
|
|
174
|
+
# # FORM C — PER-PRD_SLUG MAP (one routing cell ↔ MANY submodules, one per feature-package).
|
|
175
|
+
# # Use when a platform — or a whole domain — is split into one repo per feature,
|
|
176
|
+
# # e.g. each webview mini-game lives in its own repo. No `path`; instead a
|
|
177
|
+
# # `by_prd_slug` table keyed by the feature-package folder name. context-loader
|
|
178
|
+
# # already extracted prd_slug in Step 1, so no extra detection is needed.
|
|
179
|
+
# # Valid at BOTH levels: directly under the domain, or nested under a platform.
|
|
180
|
+
# {{DOMAIN_3}}:
|
|
181
|
+
# system: { path: "{{BE_SUBMODULE_DIR}}", module: "java-spring" } # normal entry
|
|
182
|
+
# webview: # this cell → many repos
|
|
183
|
+
# by_prd_slug:
|
|
184
|
+
# {{PRD_SLUG_1}}: { path: "games/{{GAME_1}}", module: "phaser-game" }
|
|
185
|
+
# {{PRD_SLUG_2}}: { path: "games/{{GAME_2}}", module: "phaser-game" }
|
|
186
|
+
# # A prd_slug with no entry → active_service = unresolved (the command STOPS rather than
|
|
187
|
+
# # guessing a lookalike repo). An entry with BOTH `path` and `by_prd_slug` is a config
|
|
188
|
+
# # error, as is nesting `by_prd_slug` inside `by_prd_slug`.
|
|
189
|
+
# #
|
|
160
190
|
# # NOTE: with spec_source set, BDD + tech-docs are cross-team and live in the spec repo —
|
|
161
191
|
# # do NOT pin per-service specs_dir / tech_docs_dir here (they would be ignored).
|
|
162
192
|
# # Per-service specs_dir / tech_docs_dir apply ONLY when there is no spec_source.
|
|
@@ -169,7 +199,9 @@ domains:
|
|
|
169
199
|
# root, so without a service CLAUDE.md, code generation falls back to umbrella defaults
|
|
170
200
|
# + the module stack-profile (a ⚠️ is flagged in the context recap). Generate one per
|
|
171
201
|
# service via /setup-ai-first inside each. For FORM B, add one CLAUDE.md per platform
|
|
172
|
-
# submodule ({system|web|app}.path/CLAUDE.md).
|
|
202
|
+
# submodule ({system|web|app}.path/CLAUDE.md). For FORM C, one per feature repo
|
|
203
|
+
# (by_prd_slug.{slug}.path/CLAUDE.md) — these repos usually share a stack, so the fastest
|
|
204
|
+
# route is to write one and copy it, adjusting the parts that actually differ.
|
|
173
205
|
|
|
174
206
|
# ----- Architecture -----
|
|
175
207
|
architecture:
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
@trace.service: {service — từ header BDD @trace.service}
|
|
41
41
|
@trace.module: {module liên quan — vd dotnet, angular}
|
|
42
42
|
@trace.platforms: {system | web | app — tuỳ thư mục BDD nào tồn tại}
|
|
43
|
-
@trace.
|
|
43
|
+
@trace.bdd_versions: {MAP theo từng platform — số nhiều, KHÁC @trace.bdd_version (scalar) của .feature — vd system=1.5, web=1.9, app=1.7; chỉ platform có mặt. Mỗi feature mang bdd_version riêng; đừng gộp về một số.}
|
|
44
44
|
@trace.api_source: {existing | —}
|
|
45
45
|
@trace.revision: 1
|
|
46
46
|
@trace.status: draft
|
|
@@ -10,9 +10,11 @@
|
|
|
10
10
|
|
|
11
11
|
| Artifact | Trace tag |
|
|
12
12
|
|----------|-----------|
|
|
13
|
-
| **BDD
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
13
|
+
| **BDD file** (header) | `@trace.id` · **`@trace.platform`** · `@trace.domain` · `@trace.prd` · `@trace.prd_version` · `@trace.bdd_version` · `@trace.status` |
|
|
14
|
+
| **BDD scenario** (mỗi SC) | `@trace.scenario` · **`@trace.sc_version`** · `@trace.business_rules` |
|
|
15
|
+
| **Code** (boundary only) | `@trace.implements` · `@trace.source` · **`@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision`** — lặp cả block theo **từng UC** trong file đa-UC |
|
|
16
|
+
| **Code** (chỗ chưa implement) | `@trace.stub` · `@trace.stub_owner` · `@trace.stub_for` · `@trace.seam_pending` · `@trace.seam_port` |
|
|
17
|
+
| **Test** | `@trace.verifies` |
|
|
16
18
|
| **Bug fix** | `@trace.fixes` · `@trace.root_cause` · `@trace.regression` |
|
|
17
19
|
|
|
18
20
|
→ Đầy đủ field & format: [Reference › Trace Schema](../04-reference/trace-schema.md).
|
|
@@ -65,10 +67,31 @@ Chỉ tag `@trace` ở **boundary**, không tag mọi file → tránh **tag expl
|
|
|
65
67
|
|
|
66
68
|
---
|
|
67
69
|
|
|
68
|
-
##
|
|
70
|
+
## Version sống ở đâu — và vì sao code CŨNG mang version
|
|
69
71
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
+
**Spec là SSOT của "version hiện tại". Code mang version của "lúc tôi được sinh ra".** Hai thứ khác nhau, nên không phải dual SSOT.
|
|
73
|
+
|
|
74
|
+
| Nơi | Ghi cái gì | Ai ghi |
|
|
75
|
+
|---|---|---|
|
|
76
|
+
| `.feature` / PRD / tech-doc | version **hiện tại** của spec — SSOT | tác giả spec |
|
|
77
|
+
| `.tsv` `spec_ver` | gương của `@trace.sc_version` hiện tại | `/generate-bdd`, `/validate-traces` |
|
|
78
|
+
| `.tsv` `gen_ver` | version scenario **tại thời điểm codegen**, theo từng SC | `/generate-code` |
|
|
79
|
+
| **Code** `@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision` | version của **từng artifact upstream** tại thời điểm codegen, theo từng **method** | `/generate-code` |
|
|
80
|
+
|
|
81
|
+
Drift = **so các mốc này với nhau**; sự lệch nhau chính là tín hiệu, không phải lỗi dữ liệu:
|
|
82
|
+
|
|
83
|
+
- `spec_ver != gen_ver` → `DRIFT` (scenario đổi sau khi sinh code)
|
|
84
|
+
- `@trace.prd_version` trong code < Version PRD hiện tại → `PRD_DRIFT`
|
|
85
|
+
- `@trace.bdd_version` trong code < `.feature` hiện tại → `BDD_DRIFT`
|
|
86
|
+
- `@trace.tech_doc_revision` trong code < `@trace.revision` của tech-doc → `TECHDOC_DRIFT`
|
|
87
|
+
|
|
88
|
+
**Vì sao không thể bỏ tag version trong code và chỉ dựa vào `.tsv`:**
|
|
89
|
+
|
|
90
|
+
1. **Độ phân giải khác nhau.** `.tsv` là một sổ cho mỗi UC × platform. Một **file code** có thể phục vụ nhiều UC, mỗi UC ở một version khác nhau — chỉ tag đặt cạnh từng method mới diễn đạt được "UC1 ở bdd v1.4, UC3 ở v2.1".
|
|
91
|
+
2. **Vòng đời khác nhau.** `.tsv` là artifact **sinh ra**, có thể regen/xoá/mirror; ở chế độ umbrella nó còn nằm ở **repo khác** (spec submodule) với code. Tag trong code là bản ghi duy nhất **đi cùng** code qua mọi lần copy/move/merge.
|
|
92
|
+
3. **Sự lệch nhau là thứ ta muốn đo.** Nếu chỉ có một bản ghi thì không có gì để so — đó mới là lúc drift trở nên không phát hiện được.
|
|
93
|
+
|
|
94
|
+
> ⚠️ **Đừng "tối ưu" bằng cách gỡ tag version khỏi code.** `/validate-traces` Step 4/5/5c **đọc chính các tag đó**; gỡ đi là làm drift detection mù **im lặng** — build vẫn xanh, dashboard vẫn đẹp. `/review-code` lăng kính 1 gắn cờ **major** cho mỗi block `@trace.implements` thiếu tag version đi kèm.
|
|
72
95
|
|
|
73
96
|
---
|
|
74
97
|
|