@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
package/commands/report-bug.tmpl
DELETED
|
@@ -1,148 +0,0 @@
|
|
|
1
|
-
# /report-bug — File một Bug có trace-spec (cho Tester & QC)
|
|
2
|
-
|
|
3
|
-
Dành cho **tester và QC** — gồm cả **product-gap** lòi ra từ pipeline `/qc-*`
|
|
4
|
-
(`/qc-run-test` FAIL phân loại product-gap, hoặc một spec-defect blocker `DOC_GAPS` từ
|
|
5
|
-
`/qc-analyze`). Sinh một bug report có cấu trúc với đầy đủ spec context, phân loại layer
|
|
6
|
-
khả nghi, và lưu lại để handoff cho team dev.
|
|
7
|
-
|
|
8
|
-
**READ-ONLY trên spec và code.** Lệnh này không bao giờ sửa PRD, BDD, tech-docs, hay source.
|
|
9
|
-
Fix là việc của dev (`/fix-bug`); viết scenario là `/propose-scenario`.
|
|
10
|
-
|
|
11
|
-
Usage: `/report-bug {UC-ID hoặc TICKET} {mô tả ngắn}`
|
|
12
|
-
Ví dụ: `/report-bug FT-001 tài khoản khoá sau 6 lần login fail, spec nói 5`
|
|
13
|
-
|
|
14
|
-
## Gate
|
|
15
|
-
{{include:steps/gate.md}}
|
|
16
|
-
|
|
17
|
-
*Lưu ý: Với lệnh này, target ở Bước 1 là một UC-ID / TICKET từ `$ARGUMENTS`. Phân giải file `.feature` khớp nếu có; nếu không, tiếp tục — bug vẫn file được.*
|
|
18
|
-
|
|
19
|
-
## Context
|
|
20
|
-
{{include:steps/context-loader.md}}
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Step 1 — Phân giải Spec Context
|
|
25
|
-
|
|
26
|
-
Định vị chuỗi spec cho UC/TICKET của bug. Ưu tiên `spec-manifest.yaml` (setup umbrella/tester) nếu có; else dùng `paths` đã phân giải.
|
|
27
|
-
|
|
28
|
-
Thu thập và lưu:
|
|
29
|
-
- `prd_path` + `Version` hiện tại của PRD
|
|
30
|
-
- `bdd_path` (file `.feature` của UC này) + tiêu đề **scenario fail** cụ thể, nếu có cái khớp
|
|
31
|
-
- `tech_doc_path` (nếu có)
|
|
32
|
-
- `service` / domain
|
|
33
|
-
|
|
34
|
-
Nếu không có scenario `.feature` nào khớp behavior báo cáo → set `coverage_gap = true` (behavior chưa được BDD test).
|
|
35
|
-
|
|
36
|
-
## Step 2 — Thu thập chi tiết Bug
|
|
37
|
-
|
|
38
|
-
Nếu chưa có trong `$ARGUMENTS`, hỏi tester (một prompt gọn):
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
File một bug — trả lời những gì bạn biết:
|
|
42
|
-
1. Xảy ra ở đâu? (endpoint / screen / flow)
|
|
43
|
-
2. Các bước tái hiện?
|
|
44
|
-
3. Expected (theo spec) vs Actual?
|
|
45
|
-
4. Error / log / status code?
|
|
46
|
-
5. Environment? (staging / prod / local)
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## Step 3 — Xác định AC bị vi phạm
|
|
50
|
-
|
|
51
|
-
Đọc PRD acceptance criteria cho UC này. Khớp bug với **AC** cụ thể nó vi phạm
|
|
52
|
-
(vd `AC3: "5 lần login fail → khoá 30m"`). Trích nguyên văn. Nếu behavior không map AC nào →
|
|
53
|
-
ghi "No AC covers this" và coi như một PRD gap khả dĩ.
|
|
54
|
-
|
|
55
|
-
## Step 4 — Phân loại Layer khả nghi (BUG_FLOW)
|
|
56
|
-
|
|
57
|
-
Áp dụng bảng quyết định BUG_FLOW để gợi ý root cause khả năng ở đâu — cái này route bug:
|
|
58
|
-
|
|
59
|
-
| Nếu… | Layer khả nghi | Route tới |
|
|
60
|
-
|------|-------------|----------|
|
|
61
|
-
| Code mâu thuẫn một BDD scenario | **Code bug** (Case 1) | Dev → `/fix-bug` |
|
|
62
|
-
| BDD scenario mâu thuẫn PRD AC | **BDD bug** (Case 2) | Dev/PO fix BDD |
|
|
63
|
-
| PRD AC mơ hồ / im lặng | **PRD ambiguity** (Case 3) | PO làm rõ PRD |
|
|
64
|
-
| Behavior đúng nhưng **không scenario nào phủ** | **BDD coverage gap** | Tester → `/propose-scenario` |
|
|
65
|
-
| UI ≠ Design Spec | **Design Spec bug** (Case 5) | Dev/Designer |
|
|
66
|
-
| Chỉ Env / data | **Environment** (Case 6) | DevOps |
|
|
67
|
-
|
|
68
|
-
Nêu phân loại như một gợi ý (dev confirm trong `/fix-bug`).
|
|
69
|
-
|
|
70
|
-
## Step 5 — Ghi Report
|
|
71
|
-
|
|
72
|
-
Gán `BUG-{today YYYYMMDD}-{NN}` (NN = sequence kế tiếp trong các report có sẵn).
|
|
73
|
-
Ghi vào `{paths.bug_reports_dir}/{BUG-ID}.md` (phân giải về `{spec_source}/feedback/bug-reports/` ở umbrella mode; tạo dir nếu cần) theo cấu trúc trong Output block, và cũng in nó ra để dán vào Jira/Slack.
|
|
74
|
-
|
|
75
|
-
## Step 5.5 — Backfill trace (link pending-view)
|
|
76
|
-
|
|
77
|
-
Nếu Step 1 khớp một scenario fail cụ thể `{UC-ID}-SC{N}`, xác định **sổ platform** cần cập nhật (trace tách theo platform: `{UC-ID}-{platform}.tsv`):
|
|
78
|
-
- `{platform}` = platform mà bug xảy ra (từ ngữ cảnh test/feature fail — `web`/`app`/`system`). Nếu biết → dùng thẳng.
|
|
79
|
-
- Nếu **không rõ platform**: glob `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-*.tsv` tìm sổ nào có `sc_id` = `{UC-ID}-SC{N}`. Khớp đúng **một** sổ → dùng nó. Khớp **nhiều** sổ (cùng số SC ở nhiều platform, là 2 scenario khác nhau) → **hỏi tester bug thuộc platform nào** rồi mới ghi.
|
|
80
|
-
|
|
81
|
-
Nếu tìm được đúng row trong sổ `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv`, cập nhật **chỉ** row đó để view "waiting-on" của PO/PM trỏ
|
|
82
|
-
tới bug này — giữ nguyên mọi cột khác (gồm `qc_status`):
|
|
83
|
-
- `qc_blocked_by` = `{BUG-ID}`
|
|
84
|
-
- `qc_owner` = `dev` nếu layer khả nghi ∈ {Code, BDD, Design Spec, Env} · `po` nếu layer khả nghi = PRD ambiguity
|
|
85
|
-
|
|
86
|
-
Skip âm thầm nếu không SC nào khớp hoặc không có file/row trace (bug vẫn file được). Đây là
|
|
87
|
-
lần ghi duy nhất lệnh này làm tới operational state — nó vẫn **không bao giờ** sửa PRD/BDD/code.
|
|
88
|
-
|
|
89
|
-
## Step 6 — Handoff (để PO/Dev thực sự thấy)
|
|
90
|
-
|
|
91
|
-
Report chỉ tới PO/Dev nếu được **commit và push lên spec repo dùng chung**. File local là dead drop.
|
|
92
|
-
|
|
93
|
-
Xác định repo sở hữu `{paths.bug_reports_dir}`:
|
|
94
|
-
- Umbrella mode → spec submodule tại `{spec_source}`
|
|
95
|
-
- Single-service → repo hiện tại
|
|
96
|
-
|
|
97
|
-
Rồi commit + push **repo đó**:
|
|
98
|
-
|
|
99
|
-
```bash
|
|
100
|
-
cd {spec_source} # umbrella: spec submodule; single-service: bỏ
|
|
101
|
-
git add feedback/bug-reports/{BUG-ID}.md
|
|
102
|
-
git commit -m "qa(bug): {BUG-ID} — {short description}"
|
|
103
|
-
git push # → PO/Dev thấy nó ở lần /sync tiếp theo
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
- Nếu tester không có quyền push spec repo → mở PR / MR thay vì, hoặc đưa file cho người sở hữu. In fallback này.
|
|
107
|
-
- In chính xác các lệnh nếu bạn không tự chạy chúng.
|
|
108
|
-
|
|
109
|
-
> PO/Dev được thông báo qua routine bình thường: `/sync` liệt kê các bug report vừa pull về.
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
|
-
## Output
|
|
114
|
-
|
|
115
|
-
{{include:steps/report-footer.md}}
|
|
116
|
-
|
|
117
|
-
```
|
|
118
|
-
🐞 {BUG-ID} → {paths.bug_reports_dir}/{BUG-ID}.md (trong spec repo dùng chung)
|
|
119
|
-
|
|
120
|
-
Feature : {UC-ID} — {feature name} | Service: {service} | Severity: {Critical|Major|Minor}
|
|
121
|
-
State : 🟢 Open (lifecycle: Open → Fixed → Closed — set `Fixed` bởi /fix-bug, `Closed` sau khi /qc-run-test re-verify pass)
|
|
122
|
-
|
|
123
|
-
Spec context
|
|
124
|
-
PRD : {prd_path} (v{prd_version})
|
|
125
|
-
BDD : {bdd_path} → Scenario: "{scenario title}" {hoặc: ⚠️ no scenario covers this}
|
|
126
|
-
Tech Doc : {tech_doc_path}
|
|
127
|
-
|
|
128
|
-
AC bị vi phạm
|
|
129
|
-
{AC-N}: "{AC text}"
|
|
130
|
-
|
|
131
|
-
Expected (theo spec) : {expected}
|
|
132
|
-
Actual : {actual}
|
|
133
|
-
Steps to reproduce : {1..N}
|
|
134
|
-
Environment : {env}
|
|
135
|
-
|
|
136
|
-
Layer khả nghi : {Code | BDD | PRD | Design Spec | Env} → {route}
|
|
137
|
-
|
|
138
|
-
Handoff : {✅ committed + pushed to spec repo | ⚠️ chạy git command ở trên / mở PR}
|
|
139
|
-
|
|
140
|
-
---
|
|
141
|
-
Status : ✅ Complete (read-only trên specs/code — chỉ ghi file feedback)
|
|
142
|
-
Output Artifacts: created {paths.bug_reports_dir}/{BUG-ID}.md (pushed to shared spec repo)
|
|
143
|
-
Next :
|
|
144
|
-
- PO/Dev sẽ thấy nó ở lần /sync tiếp theo
|
|
145
|
-
- Code bug → dev chạy /fix-bug {BUG-ID}
|
|
146
|
-
- PRD ambiguity → PO (BUG_FLOW Case 3)
|
|
147
|
-
- Coverage gap → /propose-scenario {UC-ID}
|
|
148
|
-
```
|
package/commands/review-code.md
DELETED
|
@@ -1,415 +0,0 @@
|
|
|
1
|
-
# /review-code — Code Review chỉ-đọc
|
|
2
|
-
|
|
3
|
-
**CẢNH BÁO: READ-ONLY. Chỉ report, KHÔNG sửa.**
|
|
4
|
-
|
|
5
|
-
## Gate
|
|
6
|
-
|
|
7
|
-
*Checkpoint: **không chặn** — read-only. Gate Bước 3 bỏ qua CHECKPOINT (Bước 3a).*
|
|
8
|
-
|
|
9
|
-
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
10
|
-
|
|
11
|
-
Mọi lệnh PHẢI chạy gate này trước khi thực thi phần logic riêng của nó.
|
|
12
|
-
|
|
13
|
-
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
14
|
-
|
|
15
|
-
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
16
|
-
|
|
17
|
-
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
18
|
-
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
19
|
-
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
20
|
-
- Đặt target file = `payload.target_file`
|
|
21
|
-
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
22
|
-
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
23
|
-
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
24
|
-
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
25
|
-
- Đi thẳng tới phần logic riêng của lệnh.
|
|
26
|
-
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
27
|
-
|
|
28
|
-
## Bước 0-B — Ghi nhận Model *(KHÔNG chặn)*
|
|
29
|
-
|
|
30
|
-
*Bỏ qua nếu `_agent_mode: true` (sub-agent — orchestrator đã ghi nhận rồi).*
|
|
31
|
-
|
|
32
|
-
Ghi lại **model mà bạn — agent đang chạy lệnh này — thực sự đang dùng**, rồi mang nó vào
|
|
33
|
-
dòng `Model:` của report cuối (xem `report-footer`). Nếu bạn biết mình **không** phải một
|
|
34
|
-
model Opus, gắn thêm cảnh báo ngay ở dòng đó.
|
|
35
|
-
|
|
36
|
-
**KHÔNG hỏi người dùng. KHÔNG chờ. KHÔNG dừng.**
|
|
37
|
-
|
|
38
|
-
> **Vì sao bước này từng là prompt chặn, và vì sao bỏ (GAPS-v3 G41):** bản cũ hiện khối
|
|
39
|
-
> `⚙️ MODEL CHECK` rồi chờ `Y/S/N`. Ba vấn đề cùng chỉ một hướng:
|
|
40
|
-
> **(1)** nó hỏi người dùng thứ mà **agent đã biết chính xác**;
|
|
41
|
-
> **(2)** câu trả lời **không kiểm chứng được** — gõ `Y` xong vẫn đang chạy Haiku thì không
|
|
42
|
-
> gì phát hiện;
|
|
43
|
-
> **(3)** **cả `Y` lẫn `S` đều đi tiếp** — cách duy nhất để nó dừng là tự nguyện gõ `N`.
|
|
44
|
-
> Tức nó **không chặn được ai**, mà tốn một lần chặn ở **mọi** lệnh. Một feature đi hết
|
|
45
|
-
> pipeline dùng 20 lệnh; 30/32 lệnh chạy gate. Hai mươi lần bấm cho một tín hiệu tự-khai
|
|
46
|
-
> không kiểm chứng được — và chính cái giá đó làm mòn CHECKPOINT ở Bước 3, cổng có giá trị thật.
|
|
47
|
-
>
|
|
48
|
-
> Khai báo trong report **mạnh hơn** hỏi: đúng nguồn (agent, không phải người), và nằm
|
|
49
|
-
> **cạnh kết quả** để cân nhắc, thay vì nằm trước khi có kết quả để bấm cho xong.
|
|
50
|
-
|
|
51
|
-
**Vẫn khuyến nghị Opus:** phân tích spec, review kiến trúc và sinh code đòi hỏi suy luận sâu;
|
|
52
|
-
model nhỏ hơn dễ bỏ sót edge case và vi phạm kiến trúc. Đổi: `/model` → chọn Opus.
|
|
53
|
-
|
|
54
|
-
## Bước 1 — Xác định Target File
|
|
55
|
-
|
|
56
|
-
0. **Tách cờ trước khi resolve target.** `$ARGUMENTS` có thể lẫn các `--flag` (vd `--phase=integration`, `--comment`, `--fix`). **Loại bỏ mọi token bắt đầu bằng `--`** ra khỏi phần dùng để tìm target — chỉ giữ phần path/UC-ID/ticket. (Các flag đó do phần logic riêng của lệnh parse ở bước sau, KHÔNG phải tên file.)
|
|
57
|
-
1. Nếu `$ARGUMENTS` (đã tách cờ) được cung cấp và trỏ tới một file tồn tại → dùng trực tiếp làm target.
|
|
58
|
-
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/`):
|
|
59
|
-
- **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 đó.
|
|
60
|
-
- **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.)*
|
|
61
|
-
- **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:
|
|
62
|
-
- `$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`.
|
|
63
|
-
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
64
|
-
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
65
|
-
- 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.
|
|
66
|
-
*(Đừ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`.)*
|
|
67
|
-
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
68
|
-
|
|
69
|
-
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.
|
|
70
|
-
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
71
|
-
- Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/*.md` — file PRD ở gốc mỗi feature folder — cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
|
|
72
|
-
- Hiển thị danh sách cho người dùng và hỏi: "Bạn muốn làm việc với file nào? (Nhập số thứ tự hoặc tên file)"
|
|
73
|
-
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
74
|
-
|
|
75
|
-
## Bước 2 — Chạy Context Loader
|
|
76
|
-
|
|
77
|
-
Nạp toàn bộ context của dự án bằng cách làm theo quy trình trong `steps/context-loader.md`.
|
|
78
|
-
Lưu toàn bộ context đã nạp vào bộ nhớ để dùng xuyên suốt phiên làm việc của lệnh.
|
|
79
|
-
|
|
80
|
-
## Bước 3 — CHECKPOINT
|
|
81
|
-
|
|
82
|
-
*Bỏ qua nếu `_agent_mode: true`.*
|
|
83
|
-
|
|
84
|
-
### 3a — Lệnh này có phải chặn không?
|
|
85
|
-
|
|
86
|
-
| Mức | Lệnh nào | `--yes` bỏ qua được? |
|
|
87
|
-
|---|---|:---:|
|
|
88
|
-
| **Không chặn** | Lệnh read-only: `/review-code` · `/validate-traces` · `/debug` · `/review-context` · `/review-tech-docs` | — (vốn không có) |
|
|
89
|
-
| **Chặn thường** | Mọi lệnh sinh/sửa artifact | ✅ |
|
|
90
|
-
| **Chặn CỨNG** | Ghi đè file đã tồn tại · `--resume` áp findings · migrate · prune | ❌ **không bao giờ** |
|
|
91
|
-
|
|
92
|
-
`--yes` trong `$ARGUMENTS` → bỏ qua CHECKPOINT mức *chặn thường*. (Bước 1 đã tách mọi token
|
|
93
|
-
`--` khỏi phần resolve target, nên cờ này không ảnh hưởng việc tìm file.) Mở đường chạy
|
|
94
|
-
headless: `claude -p "/generate-code UC1 --yes"`.
|
|
95
|
-
|
|
96
|
-
> **KHÔNG tự suy mức từ bảng này.** Mỗi lệnh **tự khai** mức của nó ở một dòng `*Checkpoint: …*`
|
|
97
|
-
> ngay dưới `## Gate` của chính nó — đọc dòng đó, đừng suy diễn. Bảng trên chỉ giải thích ba mức
|
|
98
|
-
> **nghĩa là gì**.
|
|
99
|
-
> Nguồn máy đọc: `bin/trace-schema.json` → `gate.checkpoint_levels`; `self-check` **R11** fail
|
|
100
|
-
> build nếu nhãn trong file lệnh lệch với schema, hoặc nếu một lệnh `hard`/`none` thiếu nhãn.
|
|
101
|
-
> *(Lệnh không có dòng nào = mức **chặn thường**, mặc định.)*
|
|
102
|
-
|
|
103
|
-
> **Mức *không chặn* là thực thi đúng miễn trừ mà `rules/workflow.md` đã cấp từ trước** —
|
|
104
|
-
> trước G41 file đó viết *"read-only commands may skip CHECKPOINT"* còn gate thì luôn đòi.
|
|
105
|
-
> Hai file cùng được nạp vào mọi lệnh mà nói ngược nhau; agent theo cái nào là tuỳ lúc.
|
|
106
|
-
|
|
107
|
-
### 3b — In gì
|
|
108
|
-
|
|
109
|
-
**KHÔNG lặp lại những gì `[CTX LOADED]` vừa in.** Recap của context-loader (Bước 7) đã hiện
|
|
110
|
-
Stack · Platform · Layers · CLAUDE.md · Dict · Entities · Lessons · Service · Status ngay phía
|
|
111
|
-
trên. CHECKPOINT chỉ thêm **một** thông tin mới là `Target`.
|
|
112
|
-
|
|
113
|
-
**Mọi thứ sạch** — recap báo `Status: FULL`, không cờ nào bật → in đúng hai dòng:
|
|
114
|
-
|
|
115
|
-
```
|
|
116
|
-
CHECKPOINT — Target: {resolved file path}
|
|
117
|
-
Tiếp tục? (Y/N)
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
**Có bất thường** → thêm một dòng cho **mỗi** trạng thái, nặng nhất lên đầu:
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
CHECKPOINT
|
|
124
|
-
🔴 Service : unresolved — {lý do context-loader đã ghi}
|
|
125
|
-
⚠️ CLAUDE.md: service overlay THIẾU — dùng root (code sinh ra có thể sai stack)
|
|
126
|
-
⚠️ Target : resolve bằng wildcard — {n} file khớp, chọn {file}
|
|
127
|
-
⚠️ Module : not configured — code sinh ra sẽ dùng default
|
|
128
|
-
Status : PARTIAL — thiếu: {danh sách}
|
|
129
|
-
Target : {resolved file path}
|
|
130
|
-
Tiếp tục? (Y/N)
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### 3c — Cờ nào bật, cờ nào KHÔNG
|
|
134
|
-
|
|
135
|
-
Mỗi dòng ⚠️/🔴 phải ứng với một trạng thái **context-loader đã tính rồi** — không phát minh
|
|
136
|
-
điều kiện mới, chỉ mang thứ đang bị giấu lên chỗ người dùng phải quyết định:
|
|
137
|
-
|
|
138
|
-
| Bật cờ khi | Nguồn | Mức |
|
|
139
|
-
|---|---|:---:|
|
|
140
|
-
| `active_service = unresolved` | context-loader Bước 2b/2c/Fallback | 🔴 |
|
|
141
|
-
| `Status = MINIMAL` | recap Bước 7 | 🔴 |
|
|
142
|
-
| `Status = PARTIAL` | recap Bước 7 | ⚠️ |
|
|
143
|
-
| CLAUDE.md thiếu, hoặc service overlay thiếu | context-loader Bước 3 | ⚠️ |
|
|
144
|
-
| Target resolve qua wildcard, hoặc nhiều file khớp mà lệnh tự chọn | Bước 1 ở trên | ⚠️ |
|
|
145
|
-
| `module` không cấu hình | recap Bước 7 | ⚠️ |
|
|
146
|
-
|
|
147
|
-
**KHÔNG bật cờ cho:** `Lessons: chưa có` · `Dict: missing` · `Entities: missing`. Đó là
|
|
148
|
-
*"dự án chưa điền"*, không phải *"có gì đó sai"* — chúng ở lại trong recap.
|
|
149
|
-
|
|
150
|
-
> **Nguyên tắc một câu:** cờ dành cho thứ **framework không chắc chắn hoặc đã phải đoán**,
|
|
151
|
-
> không dành cho thứ **người dùng chưa làm**. Đẩy hết mọi thứ lên thì CHECKPOINT lại đầy như
|
|
152
|
-
> cũ, và ta quay về đúng chỗ xuất phát: một cổng luôn giống nhau thì bị lướt qua.
|
|
153
|
-
|
|
154
|
-
### 3d — Chờ trả lời
|
|
155
|
-
|
|
156
|
-
- "Y" → tiếp tục sang các bước riêng của lệnh.
|
|
157
|
-
- "N" → dừng, hỏi người dùng muốn thay đổi gì.
|
|
158
|
-
- Có `--yes` và mức *chặn thường* → coi như "Y", **nhưng vẫn IN khối CHECKPOINT** nếu có cờ
|
|
159
|
-
🔴/⚠️ (không chặn ≠ không báo — người đọc log sau này vẫn cần thấy).
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
*Lưu ý: Với lệnh này, target ở Bước 1 là một UC-ID, file path, hoặc tên branch hiện tại. Bỏ qua sang nạp context ngay sau khi phân giải target.*
|
|
163
|
-
|
|
164
|
-
## Context
|
|
165
|
-
**BẮT BUỘC — đọc `.agent/steps/context-loader.md` và thực thi TOÀN BỘ quy trình trong đó**,
|
|
166
|
-
rồi mới tiếp tục phần bên dưới.
|
|
167
|
-
|
|
168
|
-
Bỏ qua bước này thì `{paths.*}`, `{tech_stack.*}`, `{conventions.*}`, guardrail từ
|
|
169
|
-
`project-lessons`, và routing service (chế độ umbrella) đều **chưa được phân giải** — mọi
|
|
170
|
-
placeholder bên dưới sẽ rỗng và lệnh sẽ đọc/ghi sai chỗ.
|
|
171
|
-
|
|
172
|
-
---
|
|
173
|
-
|
|
174
|
-
## Pre-Review Scan
|
|
175
|
-
|
|
176
|
-
*(Tách khỏi CHECKPOINT của Gate — phần này liệt kê file và scenario thực tế trong scope.)*
|
|
177
|
-
|
|
178
|
-
Quét tìm file implementation và scenario, rồi hiện:
|
|
179
|
-
|
|
180
|
-
```
|
|
181
|
-
Review Scope — {UC-ID}
|
|
182
|
-
──────────────────────────────────────
|
|
183
|
-
UC : {UC-ID}
|
|
184
|
-
Files : {danh sách file gắn tag @trace.implements={UC-ID}}
|
|
185
|
-
Scenarios : {N} scenario trong file .feature
|
|
186
|
-
|
|
187
|
-
Tiếp tục review? (Y/N)
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
Chờ "Y" rõ ràng trước khi tiếp tục.
|
|
191
|
-
|
|
192
|
-
---
|
|
193
|
-
|
|
194
|
-
## Review Dimensions
|
|
195
|
-
|
|
196
|
-
### 1. Traceability
|
|
197
|
-
|
|
198
|
-
*Đây là lăng kính bảo vệ toàn bộ cơ chế drift-detection. `/generate-code` phải ghi **5 tag** lên mỗi entry-point (**6** với FE/App); thiếu bất kỳ tag nào thì `/validate-traces` mù ở file đó — **im lặng**, không lệnh nào khác bắt được.*
|
|
199
|
-
|
|
200
|
-
- [ ] Mỗi entry-point (layer theo CLAUDE.md §2) có `@trace.implements={UC-ID}-SC{N}`?
|
|
201
|
-
- [ ] **Mỗi block `@trace.implements` có đủ tag đi kèm?** → thiếu bất kỳ tag nào = **major** (không phải minor):
|
|
202
|
-
|
|
203
|
-
| Tag | Thiếu thì mù cái gì |
|
|
204
|
-
|---|---|
|
|
205
|
-
| `@trace.prd_version` | `/validate-traces` Step 4 — PRD drift |
|
|
206
|
-
| `@trace.bdd_version` | Step 5c — BDD drift |
|
|
207
|
-
| `@trace.tech_doc_revision` | Step 5 — tech-doc drift *(bỏ được nếu UC không có tech-doc)* |
|
|
208
|
-
| `@trace.design_spec_version` | Step 5d — design-spec drift. **CHỈ FE/App** (`@trace.platform` = `web`/`app`): thiếu ở FE = **major**; có ở `system`/backend = **minor** (tag thừa, không có design-spec để so) |
|
|
209
|
-
| `@trace.source` | mất con trỏ ngược về spec |
|
|
210
|
-
|
|
211
|
-
- [ ] `@trace.source` trỏ tới file `.feature` **có thật**, đúng platform (`bdd/{platform}/{UC-ID}-{slug}.feature`)? → sai path = **major**
|
|
212
|
-
- [ ] **File phủ nhiều UC: mỗi UC có block tag RIÊNG đặt trên method của nó?** → gộp về một header file, hoặc `@trace.source` trỏ **thư mục**, = **major**. Lý do: 4 tag version là scalar theo từng UC (gộp → Step 4/5/5c/5d báo drift oan hoặc mù drift thật); và các lệnh tra tag bằng **khớp chuỗi chính xác** nên tag trỏ folder ra 0 kết quả → UC rơi về `UNTRACKED` dù code đã có.
|
|
213
|
-
- [ ] Mỗi test file có tag `@trace.verifies={UC-ID}-SC{N}`?
|
|
214
|
-
- [ ] **Không có tag mồ côi** — `@trace.implements`/`@trace.verifies` trỏ tới SC **không tồn tại** trong `.feature`? → **critical** (`TRACE_ORPHAN`; xem `/validate-traces` Step 2b)
|
|
215
|
-
- [ ] Không có tag `@trace` ở sai layer?
|
|
216
|
-
- [ ] `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` cập nhật chưa? (nếu stale → chạy `/validate-traces {UC-ID}` trước, rồi chạy lại review này)
|
|
217
|
-
|
|
218
|
-
### 2. Layer Architecture (từ CLAUDE.md §2)
|
|
219
|
-
- [ ] Mỗi class ở đúng layer?
|
|
220
|
-
- [ ] Phụ thuộc giữa layer đi đúng chiều?
|
|
221
|
-
- [ ] Không layer nào bị bypass?
|
|
222
|
-
|
|
223
|
-
### 3. Coding Standards (từ CLAUDE.md §3)
|
|
224
|
-
- [ ] Tuân theo naming convention?
|
|
225
|
-
- [ ] Response wrapper dùng nhất quán?
|
|
226
|
-
- [ ] Exception được throw (không bị nuốt)?
|
|
227
|
-
- [ ] Không magic number, không dữ liệu nhạy cảm trong log?
|
|
228
|
-
- [ ] Annotation transaction đúng?
|
|
229
|
-
|
|
230
|
-
### 4. Spec Compliance
|
|
231
|
-
- [ ] Mỗi scenario trong .feature có implementation?
|
|
232
|
-
- [ ] Không có endpoint không tài liệu (code không có spec backing)?
|
|
233
|
-
|
|
234
|
-
### 5. Seam & Stub — mồ côi khi ghép luồng
|
|
235
|
-
|
|
236
|
-
*`/generate-code` vừa sinh ra sổ `_seams.tsv` ở bước trước. Đây là lớp lỗi mà **build xanh + test từng-UC xanh** vẫn không bắt được: luồng ghép chạy vào no-op, hoặc hàm thật không ai gọi. `/validate-traces` Step 5b cũng soi — trùng có chủ đích, vì bắt ở đây rẻ hơn (ngay sau codegen, trước khi sinh test).*
|
|
237
|
-
|
|
238
|
-
Đọc sổ `{paths.trace_dir}/{domain}/{prd-slug}/_seams.tsv` (nếu có) + quét code dưới `{code_base_package}`:
|
|
239
|
-
|
|
240
|
-
- [ ] Sổ **0 dòng** `status = READY`? (`READY` = đồng nghĩa cờ 🔴 `SEAM_UNWIRED` / `STUB_UNRESOLVED`) → còn dòng nào = **critical**
|
|
241
|
-
- [ ] Không có class `*Stub*`/`*Mock*` nào **còn là binding đang dùng** trong khi hàng thật đã tồn tại? → `SEAM_UNWIRED`, **critical**
|
|
242
|
-
- [ ] Không có method nào còn `@trace.stub` rỗng trong khi `@trace.stub_owner` **đã gen**? → `STUB_UNRESOLVED`, **critical**
|
|
243
|
-
- [ ] Không có method thật **mồ côi** — logic thật được đẻ **song song** thay vì lấp vào stub cũ (Fill-before-create bị trượt)? → **critical**
|
|
244
|
-
- [ ] Mỗi stub/seam **mới** sinh trong lần này có đủ tag (`@trace.stub` + `@trace.stub_owner` + `@trace.stub_for`, hoặc `@trace.seam_pending` + `@trace.seam_port`) **và** một dòng `PENDING` trong sổ? → thiếu = **major** (nợ không ghi sổ = nợ tàng hình)
|
|
245
|
-
|
|
246
|
-
> `SEAM_PENDING` / `STUB_PENDING` (owner UC chưa gen) là **bình thường** — chỉ nhắc, không tạo finding.
|
|
247
|
-
|
|
248
|
-
## Output
|
|
249
|
-
|
|
250
|
-
**Đọc `.agent/steps/report-footer.md`** và áp đúng khuôn footer trong đó (Status Badge ·
|
|
251
|
-
Output Artifacts · Next) cho report cuối, kèm khối bên dưới.
|
|
252
|
-
|
|
253
|
-
```
|
|
254
|
-
/review-code Report — {UC-ID}
|
|
255
|
-
Critical: {X} | Major: {Y} | Minor: {Z}
|
|
256
|
-
|
|
257
|
-
### Critical
|
|
258
|
-
| # | File | Line | Issue | Suggested Fix |
|
|
259
|
-
|
|
260
|
-
### Major
|
|
261
|
-
| # | File | Line | Issue | Suggested Fix |
|
|
262
|
-
|
|
263
|
-
### Minor
|
|
264
|
-
| # | File | Line | Issue | Suggested Fix |
|
|
265
|
-
|
|
266
|
-
Output Artifacts: none (read-only)
|
|
267
|
-
|
|
268
|
-
Verdict: APPROVED ✅ | NEEDS_FIX ❌
|
|
269
|
-
(Bất kỳ finding critical nào ở lăng kính 5 → NEEDS_FIX, KỂ CẢ khi build xanh
|
|
270
|
-
và test từng-UC xanh — đó chính là loại lỗi hai thứ đó không bắt được.)
|
|
271
|
-
|
|
272
|
-
Nếu APPROVED ✅:
|
|
273
|
-
Next: /dev-gen-test {UC-ID}
|
|
274
|
-
|
|
275
|
-
Nếu NEEDS_FIX ❌:
|
|
276
|
-
- Fix nhỏ (1–3 dòng, không đổi logic) → fix inline → chạy lại /review-code {UC-ID}
|
|
277
|
-
- Thiếu tag version / @trace.source sai → bổ sung tại chỗ (giá trị lấy từ header .feature
|
|
278
|
-
+ tech-doc), rồi chạy lại /validate-traces {UC-ID}
|
|
279
|
-
- Tag mồ côi (TRACE_ORPHAN) → sửa sc_id cho đúng SC hiện có, hoặc xoá code/test
|
|
280
|
-
nếu behavior không còn cần
|
|
281
|
-
- SEAM_UNWIRED 🔴 → trỏ binding sang class thật, xoá/thay stub, build lại
|
|
282
|
-
- STUB_UNRESOLVED 🔴 → /generate-code {owner_uc} (lấp logic TẠI CHỖ vào
|
|
283
|
-
method trắng, xoá hàm song song)
|
|
284
|
-
- Vấn đề logic / kiến trúc → /fix-bug {TICKET_ID}
|
|
285
|
-
- Spec mismatch (code ≠ scenario) → /generate-code {feature-file} (gen lại UC bị ảnh hưởng)
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
---
|
|
289
|
-
|
|
290
|
-
## Đề xuất ghi Lessons (tuỳ chọn)
|
|
291
|
-
|
|
292
|
-
Với mỗi finding **Critical/Major** thể hiện một **lỗi AI lặp lại** trong quá trình sinh code
|
|
293
|
-
(một vi phạm kiến trúc/standards mà AI có khả năng làm lại — KHÔNG phải typo một lần hay nguyên nhân bên ngoài), hỏi:
|
|
294
|
-
|
|
295
|
-
```
|
|
296
|
-
Finding "{issue}" trông như một lỗi lặp lại.
|
|
297
|
-
Ghi nó thành project lesson để /generate-code không lặp lại? (Y/N)
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
Nếu `Y` → chạy quy trình capture bên dưới với `category=code-gen`, `source=/review-code {UC-ID}`,
|
|
301
|
-
`scope` = domain hoặc file glob bị ảnh hưởng.
|
|
302
|
-
|
|
303
|
-
# Capture Lesson — Ghi lại lỗi lặp lại thành một Guardrail
|
|
304
|
-
|
|
305
|
-
Quy trình tái sử dụng để lưu một "lesson" nhằm tránh AI lặp lại lỗi trong dự án này.
|
|
306
|
-
Dùng bởi `/learn` (thủ công) và được đề xuất bởi `/review-code`, `/fix-bug`, `/debug` (tự động).
|
|
307
|
-
|
|
308
|
-
> **Bộ nhớ dự án, không phải huấn luyện model.** Một lesson là văn bản thuần được inject vào context ở
|
|
309
|
-
> đầu mỗi lệnh (context-loader Bước 6.7). Về mặt chức năng, điều này chặn việc lặp lại — AI thấy
|
|
310
|
-
> guardrail trước khi sinh nội dung. Không có trọng số model nào thay đổi.
|
|
311
|
-
|
|
312
|
-
## L1 — Phân giải file lessons
|
|
313
|
-
|
|
314
|
-
Phân giải `lessons_path` theo thứ tự sau:
|
|
315
|
-
1. `paths.lessons_file` từ context đã nạp (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
316
|
-
2. Mặc định `specs/domain-knowledge/lessons-learned.md` (single-service)
|
|
317
|
-
3. Ở chế độ umbrella/service (khi `service_root` được set) mặc định `{service_root}/.agent/project-lessons.md`
|
|
318
|
-
|
|
319
|
-
## L2 — Dựng lesson
|
|
320
|
-
|
|
321
|
-
Thu thập các field sau — từ `$ARGUMENTS` (cho `/learn`) hoặc từ findings của lệnh gọi
|
|
322
|
-
(cho `/review-code`, `/fix-bug`, `/debug`):
|
|
323
|
-
|
|
324
|
-
| Field | Ý nghĩa |
|
|
325
|
-
|-------|---------|
|
|
326
|
-
| `category` | một trong: `code-gen` \| `bdd` \| `tech-docs` \| `tests` \| `prd` \| `general` |
|
|
327
|
-
| `title` | cụm từ ngắn đặt tên cho lỗi |
|
|
328
|
-
| `mistake` | cụ thể, AI đã làm sai điều gì |
|
|
329
|
-
| `rule` | câu sửa mệnh lệnh — "Luôn …" / "Không bao giờ …" — testable, không mơ hồ |
|
|
330
|
-
| `scope` | phạm vi áp dụng: một domain, một file glob (vd `*Controller.*`), hoặc `all` |
|
|
331
|
-
| `source` | cách ghi nhận: `/learn` \| `/review-code {UC-ID}` \| `/fix-bug {TICKET}` \| `/debug` |
|
|
332
|
-
|
|
333
|
-
Nếu `rule` mơ hồ (vd "cẩn thận"), viết lại thành chỉ dẫn cụ thể, kiểm tra được trước khi lưu.
|
|
334
|
-
|
|
335
|
-
## L3 — Khử trùng lặp
|
|
336
|
-
|
|
337
|
-
Đọc các lesson hiện có trong `lessons_path`. Nếu đã có một lesson cùng lỗi:
|
|
338
|
-
- **Tinh chỉnh** entry đó (siết chặt Rule, mở rộng/thu hẹp Scope, cập nhật Date, thêm Source mới) — KHÔNG thêm bản trùng.
|
|
339
|
-
|
|
340
|
-
Nếu không, gán id kế tiếp `L-{NNN}` = (số lớn nhất hiện có + 1), pad 0 đủ 3 chữ số.
|
|
341
|
-
|
|
342
|
-
## L4 — Ghi
|
|
343
|
-
|
|
344
|
-
Nếu `lessons_path` chưa tồn tại, tạo file với header sau trước:
|
|
345
|
-
|
|
346
|
-
```markdown
|
|
347
|
-
# Project Lessons — Learned Guardrails
|
|
348
|
-
|
|
349
|
-
> Các lỗi AI KHÔNG được lặp lại trong dự án này. Được nạp bởi context-loader ở đầu
|
|
350
|
-
> mỗi lệnh và coi như ràng buộc cứng (cùng mức ưu tiên với coding standards trong CLAUDE.md).
|
|
351
|
-
> Thêm bằng /learn, hoặc chấp nhận prompt trong /review-code, /fix-bug, /debug.
|
|
352
|
-
> Rà lại định kỳ bằng `/learn --review`. Commit file này để cả team dùng chung guardrail.
|
|
353
|
-
|
|
354
|
-
| Category | Áp dụng cho |
|
|
355
|
-
|----------|-----------|
|
|
356
|
-
| code-gen | output của /generate-code |
|
|
357
|
-
| bdd | output của /generate-bdd |
|
|
358
|
-
| tech-docs | output của /generate-tech-docs |
|
|
359
|
-
| tests | output của /dev-gen-test |
|
|
360
|
-
| prd | output của /generate-prd, /refine-prd |
|
|
361
|
-
| general | mọi lệnh |
|
|
362
|
-
|
|
363
|
-
**Status:** `active` = đang là ràng buộc cứng · `retired` = đã hết đúng, GIỮ LẠI làm lịch sử
|
|
364
|
-
nhưng context-loader **không nạp nữa**. Lesson không ghi `Status` được coi là `active`.
|
|
365
|
-
|
|
366
|
-
---
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
Chèn lesson mới ngay dưới dấu phân cách `---` (**mới nhất lên đầu**), theo đúng dạng:
|
|
370
|
-
|
|
371
|
-
```markdown
|
|
372
|
-
### L-{NNN} — [{category}] {title}
|
|
373
|
-
- **Status**: active
|
|
374
|
-
- **Date**: {hôm nay YYYY-MM-DD}
|
|
375
|
-
- **Scope**: {scope}
|
|
376
|
-
- **Mistake**: {mistake}
|
|
377
|
-
- **Rule**: {rule}
|
|
378
|
-
- **Source**: {source}
|
|
379
|
-
|
|
380
|
-
```
|
|
381
|
-
|
|
382
|
-
### Retire — đường ra của một lesson *(GAPS-v3 G46)*
|
|
383
|
-
|
|
384
|
-
Một lesson là **giả thuyết rằng AI sẽ lặp lại một lỗi**. Giả thuyết đó hết đúng khi code nó canh
|
|
385
|
-
không còn tồn tại, hoặc khi quy ước dự án đã đổi. Lúc đó nó phải bị **hạ xuống**, không được giữ.
|
|
386
|
-
|
|
387
|
-
Retire = đổi `Status` và ghi lý do — **KHÔNG xoá dòng**:
|
|
388
|
-
|
|
389
|
-
```markdown
|
|
390
|
-
### L-003 — [code-gen] Dùng WebClient thay RestTemplate
|
|
391
|
-
- **Status**: retired
|
|
392
|
-
- **Retired**: 2027-03-15 — project đổi tầng HTTP, RestTemplate không còn trong repo
|
|
393
|
-
- **Date**: 2026-08-19
|
|
394
|
-
…giữ nguyên phần còn lại…
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
Giữ lại vì nó là **lịch sử**: người sau đọc được *"vì sao dự án này từng có luật đó"*, thứ mà xoá
|
|
398
|
-
đi là mất vĩnh viễn.
|
|
399
|
-
|
|
400
|
-
> **Vì sao cần đường ra:** trước G46 file này **chỉ có đường vào**. Lesson được nạp làm *"ràng buộc
|
|
401
|
-
> cứng, cùng mức ưu tiên với CLAUDE.md"* — vĩnh viễn, kể cả khi code nó canh đã bị xoá. Không cờ
|
|
402
|
-
> nào nhắc, không lệnh nào gỡ; cách duy nhất là có người tự nhớ ra rồi xoá tay.
|
|
403
|
-
> Đây đúng lớp lỗi của **G28** (*"giữ một `pass` đã hết hiệu lực là báo cáo sai"*) và luật
|
|
404
|
-
> `rules/workflow.md` §Trace Contract — **"làm mất hiệu lực ≠ ghi đè"** — chỉ là ở hàng đợi này
|
|
405
|
-
> chưa ai áp luật đó.
|
|
406
|
-
>
|
|
407
|
-
> **Ba trong bốn lệnh ghi lesson là lệnh phản ứng khi có sự cố** (`/review-code`, `/fix-bug`,
|
|
408
|
-
> `/debug`), nên file phình nhanh nhất đúng lúc dự án đang trục trặc — và lesson sinh ra lúc đó
|
|
409
|
-
> hay gắn với một sự cố cụ thể hơn là một quy tắc bền.
|
|
410
|
-
|
|
411
|
-
## L5 — Xác nhận
|
|
412
|
-
|
|
413
|
-
In: `📝 Đã ghi lesson {id} → {lessons_path} ([{category}] {title})`
|
|
414
|
-
Rồi nhắc: `Commit {lessons_path} để cả team dùng chung guardrail này.`
|
|
415
|
-
|