@educa-corp/sdd-framework 0.6.0 → 0.7.0
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 +391 -30
- package/core/FRAMEWORK_VERSION +1 -1
- package/{commands/extend-prd.md → core/commands/amend-prd.md} +205 -173
- package/core/commands/dev-run-test.md +47 -9
- package/core/commands/extend-prd.md +39 -12
- package/core/commands/generate-bdd.md +43 -4
- package/core/commands/generate-code.md +33 -0
- package/core/commands/generate-tech-docs.md +34 -2
- 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 +284 -11
- package/core/rules/workflow.md +34 -0
- package/core/steps/context-loader.md +26 -5
- package/core/templates/feature.template +1 -1
- package/docs/02-concepts/architecture.md +36 -0
- package/docs/04-reference/commands.md +148 -134
- package/docs/04-reference/trace-schema.md +39 -0
- package/docs/explain/02b-extend-prd.md +1 -1
- package/docs/explain/02c-amend-prd.md +152 -0
- 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/fix-bug.tmpl
DELETED
|
@@ -1,197 +0,0 @@
|
|
|
1
|
-
# /fix-bug — Workflow Fix Bug đầy đủ
|
|
2
|
-
|
|
3
|
-
## Gate
|
|
4
|
-
{{include:steps/gate.md}}
|
|
5
|
-
|
|
6
|
-
*Lưu ý: Với lệnh này, target ở Bước 1 là một ticket ID (vd `PROJ-123`), một **bug đã file `{BUG-ID}`** (một `{paths.bug_reports_dir}/{BUG-ID}.md` từ `/report-bug` — vd một QC product-gap), hoặc một mô tả bug từ `$ARGUMENTS`. Nếu cho `{BUG-ID}`, phân giải & đọc report đó để lấy spec context; ngược lại tiếp tục sang context loading.*
|
|
7
|
-
|
|
8
|
-
## Context
|
|
9
|
-
{{include:steps/context-loader.md}}
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Phase 1 — Gather Info
|
|
14
|
-
Nếu cho `{BUG-ID}`: đọc `{paths.bug_reports_dir}/{BUG-ID}.md` để lấy spec context, AC bị vi phạm, expected-vs-actual, và layer gợi ý — dùng làm chi tiết bug (không cần hỏi lại).
|
|
15
|
-
Nếu ticket: fetch chi tiết (hoặc nhờ user dán).
|
|
16
|
-
Nếu không có ticket / BUG-ID — CHECKPOINT:
|
|
17
|
-
1. Bug xảy ra ở đâu? (module, endpoint, flow)
|
|
18
|
-
2. Các bước tái hiện?
|
|
19
|
-
3. Expected vs Actual?
|
|
20
|
-
4. Error log / stack trace?
|
|
21
|
-
|
|
22
|
-
## Phase 2 — Root Cause Analysis
|
|
23
|
-
|
|
24
|
-
Dùng `active_module` từ context để chọn bảng liên quan.
|
|
25
|
-
|
|
26
|
-
### Nếu `platform_type = backend`
|
|
27
|
-
|
|
28
|
-
#### java-spring / golang / dotnet / php-laravel
|
|
29
|
-
|
|
30
|
-
| Bug Type | Vị trí thường gặp | Cách kiểm tra |
|
|
31
|
-
|----------|----------------|--------------|
|
|
32
|
-
| Wrong response data | Mapping layer | Kiểm tra field mapping, DTO conversion |
|
|
33
|
-
| 400 Bad Request | Input validation | Kiểm tra DTO constraint / validator |
|
|
34
|
-
| 401 Unauthorized | Auth filter | Kiểm tra token config, thứ tự filter |
|
|
35
|
-
| 403 Forbidden | Auth config | Kiểm tra rule role-based access |
|
|
36
|
-
| 404 Not Found | Repository query | Kiểm tra find method, kiểu ID |
|
|
37
|
-
| N+1 Query | Data access | Kiểm tra thiếu JOIN FETCH / eager load |
|
|
38
|
-
| Null Pointer | Optional chưa xử lý | Kiểm tra Optional.orElseThrow, null guard |
|
|
39
|
-
| Transaction rollback | Thiếu @Transactional | Kiểm tra transaction scope, propagation |
|
|
40
|
-
| Stale cache | Thiếu eviction | Kiểm tra trigger cache invalidation |
|
|
41
|
-
| Type mismatch | Filter / specification | Kiểm tra kiểu field trong predicate |
|
|
42
|
-
|
|
43
|
-
#### context-engineering (AI/LLM pipelines)
|
|
44
|
-
|
|
45
|
-
| Bug Type | Vị trí thường gặp | Cách kiểm tra |
|
|
46
|
-
|----------|----------------|--------------|
|
|
47
|
-
| Wrong pipeline output | Prompt template | Kiểm tra nội dung prompt; verify biến được substitute đúng |
|
|
48
|
-
| Missing context in output | Context assembly | Verify mọi context block bắt buộc có mặt và không rỗng |
|
|
49
|
-
| Schema validation failure | Output parser | So raw LLM output vs schema kỳ vọng; thêm output instruction chặt hơn |
|
|
50
|
-
| Flaky / non-deterministic results | LLM temperature | Kiểm tra temperature; dùng fixed seed/mock trong test |
|
|
51
|
-
| API rate limit errors | LLM client | Implement backoff; kiểm tra quota trên dashboard provider |
|
|
52
|
-
| Token limit exceeded | Prompt assembly | Giảm kích thước context; thêm chiến lược chunking |
|
|
53
|
-
|
|
54
|
-
### Nếu `platform_type = web-frontend`
|
|
55
|
-
|
|
56
|
-
| Bug Type | Vị trí thường gặp | Cách kiểm tra |
|
|
57
|
-
|----------|----------------|--------------|
|
|
58
|
-
| Wrong data displayed | State / store | Kiểm tra logic update state, selector |
|
|
59
|
-
| UI not re-rendering | Thiếu reactive dep | Kiểm tra deps array, state immutability |
|
|
60
|
-
| API data not loading | HTTP client / hook | Kiểm tra network tab, error handler |
|
|
61
|
-
| 401 on API call | Auth token | Kiểm tra token refresh, header injection |
|
|
62
|
-
| Form not submitting | Validation / handler | Kiểm tra form state, field bắt buộc, error |
|
|
63
|
-
| Route not found | Router config | Kiểm tra route definition, lazy import |
|
|
64
|
-
| Build / type error | TypeScript types | So type definition vs shape API thực tế |
|
|
65
|
-
|
|
66
|
-
### Nếu `platform_type = mobile`
|
|
67
|
-
|
|
68
|
-
| Bug Type | Vị trí thường gặp | Cách kiểm tra |
|
|
69
|
-
|----------|----------------|--------------|
|
|
70
|
-
| Screen shows stale data | State / BLoC / ViewModel | Kiểm tra event dispatch, state emit đúng |
|
|
71
|
-
| Crash on navigation | Thiếu route param | Kiểm tra param truyền, null safety |
|
|
72
|
-
| API call not firing | Repository / service layer | Thêm log trong repo method, kiểm tra network |
|
|
73
|
-
| UI not reflecting state | Widget không observe stream | Kiểm tra setup `BlocBuilder` / `StateObserver` |
|
|
74
|
-
| Crash on app resume | Lifecycle handler | Kiểm tra logic `onResume` / `viewDidAppear` |
|
|
75
|
-
| Auth token expired | Token refresh logic | Kiểm tra refresh flow, token storage |
|
|
76
|
-
| Permission denied | OS permission | Kiểm tra code request runtime permission |
|
|
77
|
-
|
|
78
|
-
CHECKPOINT — Root Cause Report:
|
|
79
|
-
```
|
|
80
|
-
Bug: {description} | Module: {name}
|
|
81
|
-
Root cause: {analysis}
|
|
82
|
-
Affected files: {list}
|
|
83
|
-
Proposed fix: {what to change}
|
|
84
|
-
Regression risk: Low / Medium / High
|
|
85
|
-
Proceed? (Y/N)
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
## Phase 3 — Fix
|
|
89
|
-
|
|
90
|
-
*Umbrella mode: code lỗi sống trong **service submodule** phân giải ở context-loader Bước 1.6 — tạo branch và chạy mọi bước git/build từ **trong** `{service_root}`. Single-service: bỏ `cd`.*
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
cd {service_root} # umbrella: the service submodule; single-service: omit
|
|
94
|
-
git checkout -b fix/{TICKET_ID}-{description}
|
|
95
|
-
```
|
|
96
|
-
Áp dụng fix. Thêm trace annotation nếu file có `@trace.implements`:
|
|
97
|
-
```
|
|
98
|
-
@trace.fixes={BUG-ID nếu fix từ một bug report đã file · else TICKET_ID}
|
|
99
|
-
@trace.root_cause={brief description}
|
|
100
|
-
```
|
|
101
|
-
*(Ưu tiên `{BUG-ID}`: khi fix bắt nguồn từ `/report-bug` thì thường **không có** ticket ID nào, và `{BUG-ID}` mới là thứ trace ngược được về spec context + AC bị vi phạm.)*
|
|
102
|
-
|
|
103
|
-
## Phase 4 — Regression Test
|
|
104
|
-
```
|
|
105
|
-
// @trace.verifies={UC-ID}
|
|
106
|
-
// @trace.regression={TICKET_ID}
|
|
107
|
-
Test: "Regression {TICKET_ID}: {bug description}"
|
|
108
|
-
```
|
|
109
|
-
Chạy test. Nếu fail → debug và fix (tối đa 3 vòng).
|
|
110
|
-
|
|
111
|
-
## Phase 4.5 — Cập nhật sổ trace
|
|
112
|
-
|
|
113
|
-
*Bỏ qua nếu fix không chạm SC nào có row trace (vd fix hạ tầng/config).*
|
|
114
|
-
|
|
115
|
-
Đây là lệnh **duy nhất** sinh test mà trước đây không ghi sổ — hệ quả: `test_count` under-report vĩnh viễn (SC đứng `GAP` dù vừa có regression test, rồi `/validate-traces` khuyên `/dev-gen-test` → dev sinh test trùng), và `dev_selftest` giữ `pass` cũ **trên code đã đổi**.
|
|
116
|
-
|
|
117
|
-
Định vị sổ platform `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` — `{platform}` = platform của code vừa fix; không rõ → glob `{UC-ID}-*.tsv` tìm sổ nào chứa `sc_id` đó, khớp nhiều sổ → **hỏi** (cùng luật với `/report-bug` Step 5.5).
|
|
118
|
-
|
|
119
|
-
Với mỗi SC mà regression test phủ (theo `@trace.verifies` của test vừa viết):
|
|
120
|
-
|
|
121
|
-
| Cột | Giá trị |
|
|
122
|
-
|---|---|
|
|
123
|
-
| `test_count` | **+=** số test method regression vừa thêm (cộng dồn, không ghi đè) |
|
|
124
|
-
| `test_classes` | **append** tên test class/describe mới, giữ nguyên tên cũ |
|
|
125
|
-
| `dev_selftest` | `not_run` — code vừa đổi nên tín hiệu self-test cũ hết hiệu lực |
|
|
126
|
-
| `dev_selftest_at` | `—` |
|
|
127
|
-
| `last_updated` | hôm nay `YYYY-MM-DD` |
|
|
128
|
-
|
|
129
|
-
Giữ nguyên mọi cột khác. Đặc biệt:
|
|
130
|
-
- **KHÔNG** đụng `qc_status`/`qc_run_at`/`qc_owner`/`qc_blocked_by` — QC sở hữu; `/qc-run-test` sẽ flip khi re-verify (và chính nó đóng `{BUG-ID}` → `🟢 Closed`).
|
|
131
|
-
- **KHÔNG** đụng `spec_ver`/`gen_ver` — fix bug **không** đổi spec, nên không được tạo tín hiệu DRIFT giả.
|
|
132
|
-
|
|
133
|
-
Rồi làm mới panel mirror:
|
|
134
|
-
{{include:steps/trace-mirror.md}}
|
|
135
|
-
```bash
|
|
136
|
-
{conventions.build_command} # tối đa 3 retry — chạy trong {service_root} ở umbrella mode
|
|
137
|
-
# Tầng 1 — push fix branch trong service submodule (nơi code sống):
|
|
138
|
-
git add {files}
|
|
139
|
-
git commit -m "fix({TICKET_ID}): {description}"
|
|
140
|
-
git push -u origin fix/{TICKET_ID}-{slug} # rồi mở PR vào branch được track của service
|
|
141
|
-
```
|
|
142
|
-
> **Umbrella mode — Tầng 2 (bump umbrella pointer):** umbrella ghi một *commit* của service
|
|
143
|
-
> submodule, không phải branch. Sau khi PR fix-branch **merge** vào branch được track của service, bump
|
|
144
|
-
> pointer để đồng đội pull umbrella không gặp "commit not found":
|
|
145
|
-
> ```bash
|
|
146
|
-
> cd - # back to umbrella root
|
|
147
|
-
> git add {service_root} && git commit -m "chore: bump {service_root} pointer (fix {TICKET_ID})"
|
|
148
|
-
> git push
|
|
149
|
-
> ```
|
|
150
|
-
> Single-service mode: không có umbrella pointer — Tầng 1 là toàn bộ push. Quy tắc đầy đủ: Sync & Update §4.4 (commit 2 tầng).
|
|
151
|
-
|
|
152
|
-
## Phase 5.5 — Đóng bug report (nếu fix một `{BUG-ID}` đã file)
|
|
153
|
-
|
|
154
|
-
*Bỏ qua nếu target là ticket/mô tả thường (không có file `{BUG-ID}`).*
|
|
155
|
-
|
|
156
|
-
Sau khi fix được commit, cập nhật `{paths.bug_reports_dir}/{BUG-ID}.md`:
|
|
157
|
-
- Set `State` → `🟡 Fixed` và thêm một **Resolution** ngắn (root cause + link commit/PR).
|
|
158
|
-
- Nó **chưa** `Closed` — QC sở hữu verification: khi `/qc-run-test` chạy lại và `qc_status`
|
|
159
|
-
của SC liên kết flip thành `pass`, nó thành `🟢 Closed` (và `qc_owner`/`qc_blocked_by` clear).
|
|
160
|
-
- Commit report đã cập nhật vào spec repo (cùng push 2 tầng như `/report-bug`) để view
|
|
161
|
-
"waiting-on" của PO/PM phản ánh nó trên `/sync`.
|
|
162
|
-
|
|
163
|
-
Đây là lần ghi duy nhất `/fix-bug` làm tới khu feedback — nó vẫn chỉ fix **code**,
|
|
164
|
-
không bao giờ sửa PRD/BDD (thay đổi spec là việc PO/Dev theo BUG_FLOW Case 2–4).
|
|
165
|
-
|
|
166
|
-
## Phase 6 — Đề xuất ghi Lesson (tuỳ chọn)
|
|
167
|
-
|
|
168
|
-
Nếu root cause là một **lỗi AI gây ra khi sinh và có thể lặp lại**
|
|
169
|
-
(vd nó sinh code skip layer, thiếu null guard, dùng sai pattern —
|
|
170
|
-
KHÔNG phải nguyên nhân bên ngoài như outage third-party hay input data sai), hỏi:
|
|
171
|
-
|
|
172
|
-
```
|
|
173
|
-
Root cause này trông như một lỗi AI lặp lại.
|
|
174
|
-
Ghi nó thành project lesson để không bị sinh lại? (Y/N)
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
Nếu `Y` → chạy quy trình capture bên dưới với `source=/fix-bug {TICKET_ID}`, một
|
|
178
|
-
`category` phù hợp (thường `code-gen`), và `scope` = domain hoặc file glob bị ảnh hưởng.
|
|
179
|
-
|
|
180
|
-
{{include:steps/capture-lesson.md}}
|
|
181
|
-
|
|
182
|
-
## Output
|
|
183
|
-
|
|
184
|
-
{{include:steps/report-footer.md}}
|
|
185
|
-
|
|
186
|
-
```
|
|
187
|
-
/fix-bug Hoàn tất — {TICKET_ID}
|
|
188
|
-
Root Cause: {analysis}
|
|
189
|
-
Changes: {list}
|
|
190
|
-
✅ Regression test added | ✅ Build: SUCCESS
|
|
191
|
-
{Trace: {UC-ID}-{platform}.tsv updated — test_count +{n}, dev_selftest → not_run | nếu có chạm row trace}
|
|
192
|
-
{🐞 BUG-{id} → State: Fixed (pushed) — Closed sau khi /qc-run-test re-verify pass | nếu fix một bug đã file}
|
|
193
|
-
{📝 Lesson L-NNN recorded (nếu đã capture)}
|
|
194
|
-
Branch: fix/{TICKET_ID}-{slug}
|
|
195
|
-
Next: /dev-run-test {UC-ID} ← dev_selftest vừa bị reset về not_run, chạy để lấy lại tín hiệu xanh
|
|
196
|
-
Rồi tạo PR và link tới ticket. {QC: chạy lại /qc-run-test {UC-ID} để verify + đóng bug | nếu áp dụng}
|
|
197
|
-
```
|
|
@@ -1,354 +0,0 @@
|
|
|
1
|
-
# /generate-architecture — Sinh / làm mới Architecture Context (SSOT)
|
|
2
|
-
|
|
3
|
-
> **Mô hình phạm vi:** MỘT `architecture.md` cho mỗi codebase — nguồn chân lý (SSOT)
|
|
4
|
-
> cross-cutting cho kiến trúc, dùng cho cả AI code-gen lẫn ops. Lệnh **thu thập từ mọi
|
|
5
|
-
> nguồn sẵn có (config + tài liệu + code) → phỏng vấn lấp chỗ trống → draft → bàn giao
|
|
6
|
-
> cho người verify**. Tách khỏi `/setup-ai-first` để SA chạy lại nhiều lần (refresh /
|
|
7
|
-
> điền dần). Nó KHÔNG tự ký duyệt — con người là trust-gate.
|
|
8
|
-
>
|
|
9
|
-
> **Triết lý điền:** ưu tiên **hút cái đã biết**, chỉ **hỏi cái chưa biết**. SA không phải
|
|
10
|
-
> điền tay 140 ô — chỉ trả lời vài câu dễ hiểu về phần chưa nguồn nào trả lời được.
|
|
11
|
-
>
|
|
12
|
-
> **Khác `/generate-tech-docs`:** tech-docs là thiết kế **per-PRD/feature**; lệnh này mô tả
|
|
13
|
-
> **kiến trúc toàn hệ thống dùng chung**. Chi tiết per-repo (thư mục, namespace) vẫn ở
|
|
14
|
-
> `.ai-project-guide.md` / CLAUDE.md của từng repo — lệnh này chỉ lo phần cross-cutting.
|
|
15
|
-
|
|
16
|
-
## Gate
|
|
17
|
-
|
|
18
|
-
*Checkpoint: **chặn CỨNG** — ghi đè architecture.md đã verified_by một người thật. `--yes` KHÔNG bỏ qua được (gate Bước 3a).*
|
|
19
|
-
|
|
20
|
-
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
21
|
-
|
|
22
|
-
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ó.
|
|
23
|
-
|
|
24
|
-
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
25
|
-
|
|
26
|
-
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
27
|
-
|
|
28
|
-
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
29
|
-
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
30
|
-
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
31
|
-
- Đặt target file = `payload.target_file`
|
|
32
|
-
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
33
|
-
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
34
|
-
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
35
|
-
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
36
|
-
- Đi thẳng tới phần logic riêng của lệnh.
|
|
37
|
-
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).
|
|
38
|
-
|
|
39
|
-
## Bước 0-B — Ghi nhận Model *(KHÔNG chặn)*
|
|
40
|
-
|
|
41
|
-
*Bỏ qua nếu `_agent_mode: true` (sub-agent — orchestrator đã ghi nhận rồi).*
|
|
42
|
-
|
|
43
|
-
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
|
|
44
|
-
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
|
|
45
|
-
model Opus, gắn thêm cảnh báo ngay ở dòng đó.
|
|
46
|
-
|
|
47
|
-
**KHÔNG hỏi người dùng. KHÔNG chờ. KHÔNG dừng.**
|
|
48
|
-
|
|
49
|
-
> **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
|
|
50
|
-
> `⚙️ MODEL CHECK` rồi chờ `Y/S/N`. Ba vấn đề cùng chỉ một hướng:
|
|
51
|
-
> **(1)** nó hỏi người dùng thứ mà **agent đã biết chính xác**;
|
|
52
|
-
> **(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
|
|
53
|
-
> gì phát hiện;
|
|
54
|
-
> **(3)** **cả `Y` lẫn `S` đều đi tiếp** — cách duy nhất để nó dừng là tự nguyện gõ `N`.
|
|
55
|
-
> 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
|
|
56
|
-
> 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
|
|
57
|
-
> 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.
|
|
58
|
-
>
|
|
59
|
-
> Khai báo trong report **mạnh hơn** hỏi: đúng nguồn (agent, không phải người), và nằm
|
|
60
|
-
> **cạnh kết quả** để cân nhắc, thay vì nằm trước khi có kết quả để bấm cho xong.
|
|
61
|
-
|
|
62
|
-
**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;
|
|
63
|
-
model nhỏ hơn dễ bỏ sót edge case và vi phạm kiến trúc. Đổi: `/model` → chọn Opus.
|
|
64
|
-
|
|
65
|
-
## Bước 1 — Xác định Target File
|
|
66
|
-
|
|
67
|
-
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.)
|
|
68
|
-
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.
|
|
69
|
-
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/`):
|
|
70
|
-
- **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 đó.
|
|
71
|
-
- **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.)*
|
|
72
|
-
- **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:
|
|
73
|
-
- `$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`.
|
|
74
|
-
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
75
|
-
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
76
|
-
- 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.
|
|
77
|
-
*(Đừ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`.)*
|
|
78
|
-
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
79
|
-
|
|
80
|
-
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.
|
|
81
|
-
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
82
|
-
- 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).
|
|
83
|
-
- 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)"
|
|
84
|
-
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
85
|
-
|
|
86
|
-
## Bước 2 — Chạy Context Loader
|
|
87
|
-
|
|
88
|
-
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`.
|
|
89
|
-
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.
|
|
90
|
-
|
|
91
|
-
## Bước 3 — CHECKPOINT
|
|
92
|
-
|
|
93
|
-
*Bỏ qua nếu `_agent_mode: true`.*
|
|
94
|
-
|
|
95
|
-
### 3a — Lệnh này có phải chặn không?
|
|
96
|
-
|
|
97
|
-
| Mức | Lệnh nào | `--yes` bỏ qua được? |
|
|
98
|
-
|---|---|:---:|
|
|
99
|
-
| **Không chặn** | Lệnh read-only: `/review-code` · `/validate-traces` · `/debug` · `/review-context` · `/review-tech-docs` | — (vốn không có) |
|
|
100
|
-
| **Chặn thường** | Mọi lệnh sinh/sửa artifact | ✅ |
|
|
101
|
-
| **Chặn CỨNG** | Ghi đè file đã tồn tại · `--resume` áp findings · migrate · prune | ❌ **không bao giờ** |
|
|
102
|
-
|
|
103
|
-
`--yes` trong `$ARGUMENTS` → bỏ qua CHECKPOINT mức *chặn thường*. (Bước 1 đã tách mọi token
|
|
104
|
-
`--` 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
|
|
105
|
-
headless: `claude -p "/generate-code UC1 --yes"`.
|
|
106
|
-
|
|
107
|
-
> **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: …*`
|
|
108
|
-
> 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
|
|
109
|
-
> **nghĩa là gì**.
|
|
110
|
-
> Nguồn máy đọc: `bin/trace-schema.json` → `gate.checkpoint_levels`; `self-check` **R11** fail
|
|
111
|
-
> 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.
|
|
112
|
-
> *(Lệnh không có dòng nào = mức **chặn thường**, mặc định.)*
|
|
113
|
-
|
|
114
|
-
> **Mức *không chặn* là thực thi đúng miễn trừ mà `rules/workflow.md` đã cấp từ trước** —
|
|
115
|
-
> trước G41 file đó viết *"read-only commands may skip CHECKPOINT"* còn gate thì luôn đòi.
|
|
116
|
-
> 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.
|
|
117
|
-
|
|
118
|
-
### 3b — In gì
|
|
119
|
-
|
|
120
|
-
**KHÔNG lặp lại những gì `[CTX LOADED]` vừa in.** Recap của context-loader (Bước 7) đã hiện
|
|
121
|
-
Stack · Platform · Layers · CLAUDE.md · Dict · Entities · Lessons · Service · Status ngay phía
|
|
122
|
-
trên. CHECKPOINT chỉ thêm **một** thông tin mới là `Target`.
|
|
123
|
-
|
|
124
|
-
**Mọi thứ sạch** — recap báo `Status: FULL`, không cờ nào bật → in đúng hai dòng:
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
CHECKPOINT — Target: {resolved file path}
|
|
128
|
-
Tiếp tục? (Y/N)
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
**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:
|
|
132
|
-
|
|
133
|
-
```
|
|
134
|
-
CHECKPOINT
|
|
135
|
-
🔴 Service : unresolved — {lý do context-loader đã ghi}
|
|
136
|
-
⚠️ CLAUDE.md: service overlay THIẾU — dùng root (code sinh ra có thể sai stack)
|
|
137
|
-
⚠️ Target : resolve bằng wildcard — {n} file khớp, chọn {file}
|
|
138
|
-
⚠️ Module : not configured — code sinh ra sẽ dùng default
|
|
139
|
-
Status : PARTIAL — thiếu: {danh sách}
|
|
140
|
-
Target : {resolved file path}
|
|
141
|
-
Tiếp tục? (Y/N)
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### 3c — Cờ nào bật, cờ nào KHÔNG
|
|
145
|
-
|
|
146
|
-
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
|
|
147
|
-
đ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:
|
|
148
|
-
|
|
149
|
-
| Bật cờ khi | Nguồn | Mức |
|
|
150
|
-
|---|---|:---:|
|
|
151
|
-
| `active_service = unresolved` | context-loader Bước 2b/2c/Fallback | 🔴 |
|
|
152
|
-
| `Status = MINIMAL` | recap Bước 7 | 🔴 |
|
|
153
|
-
| `Status = PARTIAL` | recap Bước 7 | ⚠️ |
|
|
154
|
-
| CLAUDE.md thiếu, hoặc service overlay thiếu | context-loader Bước 3 | ⚠️ |
|
|
155
|
-
| Target resolve qua wildcard, hoặc nhiều file khớp mà lệnh tự chọn | Bước 1 ở trên | ⚠️ |
|
|
156
|
-
| `module` không cấu hình | recap Bước 7 | ⚠️ |
|
|
157
|
-
|
|
158
|
-
**KHÔNG bật cờ cho:** `Lessons: chưa có` · `Dict: missing` · `Entities: missing`. Đó là
|
|
159
|
-
*"dự án chưa điền"*, không phải *"có gì đó sai"* — chúng ở lại trong recap.
|
|
160
|
-
|
|
161
|
-
> **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**,
|
|
162
|
-
> 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ư
|
|
163
|
-
> 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.
|
|
164
|
-
|
|
165
|
-
### 3d — Chờ trả lời
|
|
166
|
-
|
|
167
|
-
- "Y" → tiếp tục sang các bước riêng của lệnh.
|
|
168
|
-
- "N" → dừng, hỏi người dùng muốn thay đổi gì.
|
|
169
|
-
- Có `--yes` và mức *chặn thường* → coi như "Y", **nhưng vẫn IN khối CHECKPOINT** nếu có cờ
|
|
170
|
-
🔴/⚠️ (không chặn ≠ không báo — người đọc log sau này vẫn cần thấy).
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
*Với lệnh này — **bỏ qua Gate Bước 1** (không có input feature-file). `$ARGUMENTS` là **tuỳ chọn**, có thể gồm:
|
|
174
|
-
- **service path** (chế độ umbrella, vd `user-service`) → target là `architecture.md` của service đó, scan giới hạn trong `{service}/`.
|
|
175
|
-
- `--from=<path/glob,...>` → danh sách **tài liệu có sẵn** để hút nội dung (README, wiki, ADR, doc thiết kế cũ). Vd `--from=docs/**/*.md,README.md`.
|
|
176
|
-
- `--section=<slug>` → chỉ lấp/refresh **đúng một mục** (điền dần). Danh sách slug ở Bước 5.
|
|
177
|
-
- `--interview` → ép chạy phỏng vấn kể cả brownfield.
|
|
178
|
-
Vẫn chạy Bước 0-B (model check) và Context Loader.*
|
|
179
|
-
|
|
180
|
-
## Context
|
|
181
|
-
**BẮT BUỘC — đọc `.agent/steps/context-loader.md` và thực thi TOÀN BỘ quy trình trong đó**,
|
|
182
|
-
rồi mới tiếp tục phần bên dưới.
|
|
183
|
-
|
|
184
|
-
Bỏ qua bước này thì `{paths.*}`, `{tech_stack.*}`, `{conventions.*}`, guardrail từ
|
|
185
|
-
`project-lessons`, và routing service (chế độ umbrella) đều **chưa được phân giải** — mọi
|
|
186
|
-
placeholder bên dưới sẽ rỗng và lệnh sẽ đọc/ghi sai chỗ.
|
|
187
|
-
|
|
188
|
-
---
|
|
189
|
-
|
|
190
|
-
## Bước 1 — Phân giải target, chế độ & tham số
|
|
191
|
-
|
|
192
|
-
1. **Target file:**
|
|
193
|
-
- Mặc định → `{paths.specs_dir}/architecture.md` (thường `specs/architecture.md`). Umbrella: context-loader đã trỏ `specs_dir`/`service_root` về service active → target nằm cạnh code service.
|
|
194
|
-
- `$ARGUMENTS` có **service path** → `target = {service}/specs/architecture.md`, scan giới hạn trong `{service}/`.
|
|
195
|
-
- **Umbrella mà không truyền service path** → DỪNG, hỏi: *"Umbrella không có một stack đơn. Chạy `/generate-architecture {service-path}` cho từng service."*
|
|
196
|
-
|
|
197
|
-
2. **Parse cờ:** `--from` (danh sách nguồn tài liệu), `--section=<slug>` (chế độ 1-mục → nhảy Bước 5), `--interview` (ép phỏng vấn).
|
|
198
|
-
|
|
199
|
-
3. **Chế độ code:** brownfield (có build/manifest: `pom.xml`/`*.csproj`/`package.json`/`go.mod`/`pubspec.yaml`/`build.gradle`/`Cargo.toml`) vs greenfield (không có code để scan).
|
|
200
|
-
|
|
201
|
-
4. **File đã tồn tại?**
|
|
202
|
-
- Chưa → tạo mới.
|
|
203
|
-
- `verified_by: AI-draft` (hoặc trống) → được regenerate (xác nhận: *"architecture.md đang là AI-draft chưa verify — regenerate đè lên? (Y/N)"*).
|
|
204
|
-
- `verified_by: {người thật}` → **KHÔNG đè** → nhảy **Bước 6** (refresh có kiểm soát).
|
|
205
|
-
|
|
206
|
-
---
|
|
207
|
-
|
|
208
|
-
## Bước 2 — Thu thập từ mọi nguồn (điền cái đã biết)
|
|
209
|
-
|
|
210
|
-
Gom dữ kiện cho từng section/field theo **thứ tự ưu tiên**. Với mỗi giá trị điền được, ghi lại **nguồn** + **độ chắc chắn** (chắc / cần xác nhận). KHÔNG bịa ngoài bằng chứng.
|
|
211
|
-
|
|
212
|
-
**Thứ tự nguồn:**
|
|
213
|
-
|
|
214
|
-
1. **Config dự án** (luôn có) — đọc `project-context.yaml` + `CLAUDE.md`:
|
|
215
|
-
| Field template | Nguồn |
|
|
216
|
-
|---|---|
|
|
217
|
-
| Tech Stack (language/framework/db/build/test) | `project-context.yaml → tech_stack`, `conventions` |
|
|
218
|
-
| Các tầng + rules kiến trúc | `CLAUDE.md §2` |
|
|
219
|
-
| Quy ước đặt tên, response wrapper, error handling | `CLAUDE.md §3, §5` |
|
|
220
|
-
| Quy ước Git/DB nếu có | `CLAUDE.md §6, §7` |
|
|
221
|
-
|
|
222
|
-
2. **Tài liệu có sẵn** (nếu có `--from`, hoặc hỏi 1 lần: *"Có tài liệu kiến trúc/thiết kế sẵn không? Trỏ path — README, wiki, ADR, doc cũ. Enter để bỏ qua."*) — đọc từng tài liệu, rút fact và **map vào section/field** tương ứng của template. Ghi chú nguồn theo dạng `<!-- nguồn: {đường-dẫn} -->` ở section được điền.
|
|
223
|
-
|
|
224
|
-
3. **Scan code** (chỉ brownfield) — quét có mục tiêu:
|
|
225
|
-
| Nguồn quét | Section suy ra |
|
|
226
|
-
|---|---|
|
|
227
|
-
| build/manifest (dependencies) | **Tech Stack** |
|
|
228
|
-
| cây thư mục + tên project/layer (`*.Domain`/`*.Application`… hoặc `controller/service/repository`) | **Các tầng** + chiều phụ thuộc |
|
|
229
|
-
| DI registration (`Program.cs`/`Startup`/`*ServiceExtensions`) | **Đăng ký DI**, danh mục service/repo, **Ranh giới truy cập dữ liệu** |
|
|
230
|
-
| middleware / filter / interceptor | **Luồng Xác thực**, correlation-id, gateway |
|
|
231
|
-
| `appsettings*`/`application.yml`/`.env.example` | **Caching** (TTL), **Event Bus/Sharding**, **Feature Toggle** (chỉ ghi *tên* cấu hình, KHÔNG copy secret) |
|
|
232
|
-
| response wrapper / base controller / global exception handler | **Response API chuẩn** |
|
|
233
|
-
| entity/model (DbSet/@Entity) vs POCO/DTO từ API client | **Phân loại Entity**, **Identity Resolution** (nếu có external-id) |
|
|
234
|
-
| CI (`.github/workflows`, `Jenkinsfile`…), Dockerfile, k8s | **Triển khai & DevOps** |
|
|
235
|
-
|
|
236
|
-
**Xử lý xung đột:** nếu ≥2 nguồn nói khác nhau (vd doc cũ "Redis TTL 10m" nhưng config "5m") → **KHÔNG tự chọn**. Đưa vào danh sách cần hỏi (Bước 3) hoặc gắn ⚠️ vào draft. Quy tắc chung: fact máy móc (tech stack, TTL, DI) ưu tiên **code/config**; phần ý đồ/narrative (data flow, rules, NFR) ưu tiên **tài liệu**.
|
|
237
|
-
|
|
238
|
-
**Sản phẩm Bước 2:** với mỗi section — trạng thái `đã-điền` (kèm nguồn) / `còn-trống` / `xung-đột`. Đây là đầu vào cho phỏng vấn (chỉ hỏi phần còn-trống/xung-đột).
|
|
239
|
-
|
|
240
|
-
---
|
|
241
|
-
|
|
242
|
-
## Bước 3 — Phỏng vấn thích ứng (chỉ hỏi cái chưa biết)
|
|
243
|
-
|
|
244
|
-
### 3.0 — Báo cáo coverage trước khi hỏi
|
|
245
|
-
|
|
246
|
-
```
|
|
247
|
-
Đã điền từ config/tài liệu/code : {X}/{tổng} mục
|
|
248
|
-
Còn cần hỏi : §{A}, §{B}, §{C}
|
|
249
|
-
Xung đột cần xác nhận : §{D} (nguồn 1 nói …, nguồn 2 nói …)
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
### 3.1 — Cách đặt câu hỏi (BẮT BUỘC: dễ hiểu, không thuật ngữ trần)
|
|
253
|
-
|
|
254
|
-
Mỗi câu là một **thẻ giải thích**: tên mục + 1–2 câu nghĩa + ví dụ cụ thể + Có/Không nghĩa là gì. Ví dụ mẫu:
|
|
255
|
-
```
|
|
256
|
-
【 Hệ thống có Multi-tenant không? 】
|
|
257
|
-
Một hệ thống phục vụ NHIỀU khách hàng/chi nhánh, dữ liệu mỗi bên tách riêng,
|
|
258
|
-
không bên nào thấy của bên kia (vd: app SaaS bán hàng — mỗi shop chỉ thấy đơn của mình).
|
|
259
|
-
• CÓ → phục vụ nhiều bên, cần cách ly dữ liệu
|
|
260
|
-
• KHÔNG → chỉ phục vụ một tổ chức duy nhất
|
|
261
|
-
```
|
|
262
|
-
Áp dụng phong cách này cho MỌI câu. Tuyệt đối không hỏi kiểu "Multi-tenant? [Y/N]" trơ trọi.
|
|
263
|
-
|
|
264
|
-
### 3.2 — Pha 1: Sàng lọc (quyết mục conditional nào bật)
|
|
265
|
-
|
|
266
|
-
Hỏi các thẻ dưới đây, **BỎ câu nào đã có đáp án** từ Bước 2 (config/tài liệu/code). Mỗi thẻ quyết định (các) section:
|
|
267
|
-
|
|
268
|
-
| Thẻ hỏi (diễn đạt dễ hiểu như 3.1) | Bật section |
|
|
269
|
-
|---|---|
|
|
270
|
-
| Kiểu kiến trúc? (Layered/Clean/Hexagonal/Component-based) | §Các tầng (chọn sơ đồ mẫu) |
|
|
271
|
-
| Backend có expose REST API cho client gọi? | §Response API + §Quy ước API |
|
|
272
|
-
| Multi-tenant (nhiều khách hàng, dữ liệu tách riêng)? | §Multi-tenant |
|
|
273
|
-
| Có tích hợp hệ ngoài có ID riêng (partner/hệ cũ)? | §Phân loại Entity + §Identity Resolution + §Nguồn dữ liệu + §Ranh giới truy cập dữ liệu |
|
|
274
|
-
| Có xử lý bất đồng bộ qua message bus (Kafka/RabbitMQ…)? | §Event Bus |
|
|
275
|
-
| Dữ liệu chia nhiều DB / sharding? | §Sharding |
|
|
276
|
-
| Có bật/tắt tính năng bằng feature flag lúc chạy? | §Feature Toggle |
|
|
277
|
-
| Có API Gateway đứng trước các service? | §API Gateway |
|
|
278
|
-
| Có cache riêng (Redis…) để tăng tốc? | §Caching |
|
|
279
|
-
| Nhiều repo / nhiều service? | §Repos + §Trách nhiệm service + §Giao tiếp giữa service |
|
|
280
|
-
|
|
281
|
-
Trả lời KHÔNG → section tương ứng để **STUB** (không hỏi thêm về nó nữa).
|
|
282
|
-
|
|
283
|
-
### 3.3 — Pha 2: Đào sâu (drill loop, tới khi ĐỦ-ĐỂ-VIẾT)
|
|
284
|
-
|
|
285
|
-
Với **mỗi mục được bật (CÓ)** mà nội dung còn thiếu để viết đúng, hỏi tiếp bằng thẻ dễ hiểu — **lặp tới khi đủ**. Ví dụ sau khi CÓ multi-tenant:
|
|
286
|
-
```
|
|
287
|
-
Bạn nói CÓ multi-tenant. Để viết đúng phần này, cho hỏi thêm:
|
|
288
|
-
1. Mỗi bản ghi phân biệt khách hàng bằng cột nào? (vd TenantId, MerchantId, OrgId)
|
|
289
|
-
2. Cách ly kiểu gì? [tự động lọc mọi truy vấn / mỗi khách một DB riêng / khác]
|
|
290
|
-
(Chưa rõ thì gõ "để sau" — mục này để trống, bổ sung sau bằng --section=multi-tenant)
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
**Ràng buộc loop (BẮT BUỘC — tránh lan man/phiền):**
|
|
294
|
-
- **Chỉ đào sâu trong phạm vi mục SA đã trả lời CÓ.** KHÔNG tự mở chủ đề mới. Mục SA nói KHÔNG → không bao giờ hỏi lại.
|
|
295
|
-
- **Chỉ hỏi khi mơ hồ THỰC SỰ cản việc viết đúng** mục đó — không hỏi chi tiết "cho vui".
|
|
296
|
-
- **Gộp 2–3 câu/lượt** theo cụm, không hỏi lắt nhắt từng cái.
|
|
297
|
-
- **Luôn có lối thoát:** SA gõ "để sau / chưa rõ" → mục đó thành **STUB**, dừng đào sâu ngay. → Loop chắc chắn kết thúc.
|
|
298
|
-
- Follow-up cũng **skip-if-answered**: nếu tài liệu/config/code đã trả lời thì không hỏi.
|
|
299
|
-
|
|
300
|
-
**Kết thúc phỏng vấn khi:** mọi mục CÓ đều (a) đủ để viết, hoặc (b) SA chủ động hoãn (→ stub). Xung đột ở 3.0 cũng được hỏi xác nhận trong pha này.
|
|
301
|
-
|
|
302
|
-
---
|
|
303
|
-
|
|
304
|
-
## Bước 4 — Lắp ráp theo tier
|
|
305
|
-
|
|
306
|
-
Nguồn khung: `.agent/templates/architecture.template.md` (đọc marker `<!-- tier: core|conditional|ops -->` mỗi mục).
|
|
307
|
-
|
|
308
|
-
1. **core** → **luôn viết**, pre-fill từ Bước 2 + đáp án. Field nào vẫn chưa rõ → giữ `{{PLACEHOLDER}}` + comment (không stub cả mục core).
|
|
309
|
-
2. **conditional** → nếu mục được bật (Bước 2 có nguồn HOẶC phỏng vấn CÓ) → viết đầy đủ; ngược lại → **STUB**:
|
|
310
|
-
```
|
|
311
|
-
## {Tên mục} <!-- tier: conditional --> <!-- status: stub -->
|
|
312
|
-
> ⏳ Chưa tài liệu hoá. Chạy `/generate-architecture --section={slug}` khi cần, hoặc điền tay.
|
|
313
|
-
```
|
|
314
|
-
3. **ops** → mặc định **STUB** (không ép điền upfront). Chỉ điền nếu Bước 2 đã có nguồn rõ ràng (vd CI config, logging setup) — khi đó điền luôn, bỏ stub.
|
|
315
|
-
4. **Provenance:** mỗi section điền từ tài liệu ngoài → chèn `<!-- nguồn: {path} -->`. Section có xung đột chưa giải → chèn `<!-- ⚠️ xung đột: … -->`.
|
|
316
|
-
5. **Frontmatter — trust-gate:** `last_verified: {hôm nay}`; `verified_by: AI-draft` (khi có bất kỳ nội dung do AI hút/suy) hoặc `{{AUTHOR}}` (greenfield thuần tay chưa có gì).
|
|
317
|
-
6. Nhất quán thuật ngữ với `business-dictionary.md` + tên entity `core-entities.md`; KHÔNG dùng banned term.
|
|
318
|
-
7. Ghi ra `target`.
|
|
319
|
-
|
|
320
|
-
---
|
|
321
|
-
|
|
322
|
-
## Bước 5 — Chế độ `--section=<slug>` (điền dần một mục)
|
|
323
|
-
|
|
324
|
-
Khi `$ARGUMENTS` có `--section=<slug>`: bỏ qua lắp ráp toàn bộ, **chỉ** lấp/refresh đúng mục đó.
|
|
325
|
-
1. Định vị mục theo bảng slug bên dưới trong `target`.
|
|
326
|
-
2. Chạy thu thập (Bước 2) + phỏng vấn đào sâu (Bước 3.3) **giới hạn cho mục này**.
|
|
327
|
-
3. Thay khối stub bằng nội dung đã điền, gỡ `<!-- status: stub -->`. Nếu mục đã có nội dung → refresh theo chênh lệch, giữ chỉnh tay của người.
|
|
328
|
-
4. Cập nhật `last_verified`; nếu file đang `verified_by: {người}` → chỉ đề xuất diff (không tự đè).
|
|
329
|
-
|
|
330
|
-
**Bảng slug ↔ mục:** `tech-stack` · `layers` · `naming` · `api-response` · `api-conventions` · `database` (core) — `data-flow` · `repositories` · `entity-classification` · `data-access` · `service-responsibilities` · `di` · `multi-tenant` · `identity-resolution` · `api-gateway` · `caching` · `event-bus` · `sharding` · `feature-toggle` · `auth` (conditional) — `observability` · `deployment` · `testing` · `nfr` (ops).
|
|
331
|
-
|
|
332
|
-
---
|
|
333
|
-
|
|
334
|
-
## Bước 6 — Refresh có kiểm soát (khi file đã verify bởi người)
|
|
335
|
-
|
|
336
|
-
Nếu Bước 1.4 xác định `verified_by: {người thật}`:
|
|
337
|
-
- KHÔNG ghi đè. Chạy lại thu thập (Bước 2) và **so sánh** với nội dung hiện tại.
|
|
338
|
-
- Xuất **danh sách chênh lệch** (drift): mục nào trong code/config/tài liệu đã khác doc.
|
|
339
|
-
- Với mỗi drift, đề xuất câu chữ cập nhật để SA tự áp; KHÔNG tự đổi `verified_by`.
|
|
340
|
-
|
|
341
|
-
---
|
|
342
|
-
|
|
343
|
-
## Bước 7 — Bàn giao cho người verify
|
|
344
|
-
|
|
345
|
-
> Nếu frontmatter ghi `verified_by: AI-draft`:
|
|
346
|
-
> 1. Tech Lead/Architect **duyệt từng section**, sửa chỗ AI đoán sai (đối chiếu `<!-- nguồn: … -->` và `<!-- ⚠️ xung đột -->`).
|
|
347
|
-
> 2. Điền nốt `{{PLACEHOLDER}}` còn lại; lấp các mục STUB cần thiết bằng `--section=<slug>`.
|
|
348
|
-
> 3. Đổi `verified_by: AI-draft` → **tên bạn**, cập nhật `last_verified`. Commit.
|
|
349
|
-
>
|
|
350
|
-
> Chỉ khi `verified_by` là người thật, `/generate-tech-docs` (Bước 0.5 [ARCH]) mới coi doc là **ràng buộc kiến trúc chính thức**. Còn `AI-draft` thì bị gắn ⚠️ và ưu tiên CLAUDE.md/BDD khi mâu thuẫn.
|
|
351
|
-
|
|
352
|
-
## Output
|
|
353
|
-
**Đọc `.agent/steps/report-footer.md`** và áp đúng khuôn footer trong đó (Status Badge ·
|
|
354
|
-
Output Artifacts · Next) cho report cuối, kèm khối bên dưới.
|