ai-developer-skill-os 7.0.2 → 7.5.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/.agents/AGENTS.md +44 -88
- package/.agents/CHANGELOG.md +70 -0
- package/.agents/LICENSE +21 -0
- package/.agents/README.md +100 -0
- package/.agents/docs/CHI_TIET_SKILLS.md +126 -0
- package/.agents/docs/GOVERNANCE.md +40 -0
- package/.agents/docs/HUONG_DAN_SU_DUNG.md +120 -0
- package/.agents/docs/SPEC.md +87 -0
- package/.agents/docs/adr/0001-intent-based-architecture.md +19 -0
- package/.agents/docs/adr/0002-kernel-freeze.md +21 -0
- package/.agents/docs/adr/0003-risk-based-verification.md +20 -0
- package/.agents/docs/adr/0004-progressive-evidence.md +19 -0
- package/.agents/docs/skill-classification.md +25 -0
- package/.agents/skills/qk-access-policy/SKILL.md +179 -0
- package/.agents/skills/qk-ai-builder/SKILL.md +215 -0
- package/.agents/skills/qk-api-lifecycle/SKILL.md +176 -0
- package/.agents/skills/qk-bug-resolution/SKILL.md +307 -0
- package/.agents/skills/qk-context-loader/SKILL.md +218 -0
- package/.agents/skills/qk-data-lifecycle/SKILL.md +192 -0
- package/.agents/skills/qk-db-optimizer/SKILL.md +196 -0
- package/.agents/skills/qk-docs/SKILL.md +198 -0
- package/.agents/skills/qk-engineering-standard/SKILL.md +351 -0
- package/.agents/skills/qk-engineering-standard/rules/backend.md +122 -0
- package/.agents/skills/qk-engineering-standard/rules/database.md +3 -0
- package/.agents/skills/qk-engineering-standard/rules/frontend.md +152 -0
- package/.agents/skills/qk-engineering-standard/rules/security.md +3 -0
- package/.agents/skills/qk-engineering-standard/rules/testing.md +3 -0
- package/.agents/skills/qk-fe-api-integration/SKILL.md +326 -0
- package/.agents/skills/qk-feature-delivery/SKILL.md +305 -0
- package/.agents/skills/qk-help/SKILL.md +193 -0
- package/.agents/skills/qk-orchestrator/SKILL.md +278 -0
- package/.agents/skills/qk-orchestrator/references/routing-table.md +78 -0
- package/.agents/skills/qk-production-release/SKILL.md +284 -0
- package/.agents/skills/qk-project-bootstrap/SKILL.md +235 -0
- package/.agents/skills/qk-project-health/SKILL.md +199 -0
- package/.agents/skills/qk-project-memory/SKILL.md +218 -0
- package/.agents/skills/qk-system-evolution/SKILL.md +281 -0
- package/.agents/skills/qk-ui-audit/SKILL.md +315 -0
- package/.agents/skills/qk-ui-audit/references/anti-slop-checklist.md +136 -0
- package/.agents/skills/qk-ui-builder/SKILL.md +446 -0
- package/.agents/skills/qk-ui-builder/references/anti-patterns.md +295 -0
- package/.agents/skills/qk-ui-builder/references/color.md +115 -0
- package/.agents/skills/qk-ui-builder/references/component-cookbook.md +1194 -0
- package/.agents/skills/qk-ui-builder/references/copy.md +250 -0
- package/.agents/skills/qk-ui-builder/references/interaction-and-states.md +115 -0
- package/.agents/skills/qk-ui-builder/references/layout-and-space.md +111 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/01-bento-grid.md +48 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/02-long-document.md +50 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/03-marquee-hero.md +51 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/04-stat-led.md +49 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/05-workbench.md +44 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/06-conversational-faq.md +50 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/07-manifesto.md +51 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/08-photographic.md +50 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/09-quote-led.md +50 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/11-catalogue.md +49 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/12-letter.md +49 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/13-index-first.md +49 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/14-narrative-workflow.md +48 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/15-split-studio.md +48 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/16-feature-stack.md +51 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/17-type-specimen.md +48 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/18-portfolio-grid.md +48 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/19-map-diagram.md +50 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/20-ecosystem-index.md +48 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures/21-component-playground.md +45 -0
- package/.agents/skills/qk-ui-builder/references/macrostructures.md +38 -0
- package/.agents/skills/qk-ui-builder/references/motion.md +95 -0
- package/.agents/skills/qk-ui-builder/references/responsive.md +115 -0
- package/.agents/skills/qk-ui-builder/references/slop-test.md +135 -0
- package/.agents/skills/qk-ui-builder/references/structure.md +280 -0
- package/.agents/skills/qk-ui-builder/references/themes/atmospheric.md +53 -0
- package/.agents/skills/qk-ui-builder/references/themes/carnival.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/cobalt.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/editorial.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/garden.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/hum.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/lumen.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/midnight.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/modern-minimal.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/playful.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/specimen.md +52 -0
- package/.agents/skills/qk-ui-builder/references/themes/terminal.md +52 -0
- package/.agents/skills/qk-ui-builder/references/typography.md +129 -0
- package/.agents/skills/qk-ui-system-builder/SKILL.md +221 -0
- package/.agents/skills/qk-validation-gate/SKILL.md +359 -0
- package/.agents/skills.json +819 -0
- package/.github/workflows/ci.yml +1 -1
- package/CHANGELOG.md +2 -1
- package/CLAUDE.md +110 -0
- package/README.md +52 -10
- package/add_lang.js +21 -0
- package/add_lang.py +25 -0
- package/add_sections.py +53 -0
- package/bin/install.js +225 -170
- package/bin/lint.js +123 -0
- package/docs/CHI_TIET_SKILLS.md +27 -26
- package/docs/HUONG_DAN_SU_DUNG.md +3 -3
- package/docs/SPEC.md +70 -20
- package/framework/decision-primitives.md +2 -1
- package/framework/skill-schema.md +310 -0
- package/package.json +16 -5
- package/patch.js +15 -0
- package/patch.py +89 -0
- package/patch2.py +83 -0
- package/skills/_archive_old_skills/qk-accessibility-audit/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-agent-orchestrator/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-api-integration/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-auth-security/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-backend-architecture/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-bug-fix/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-component-generator/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-context-manager/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-database-engineer/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-deployment/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-design-system/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-form-builder/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-frontend-architecture/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-frontend-debug/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-frontend-performance/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-frontend-testing/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-git-engineer/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-help/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-migration/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-project-audit/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-refactor/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-state-management/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-table-crud-generator/SKILL.md +1 -0
- package/skills/_archive_old_skills/qk-ui-builder/SKILL.md +1 -0
- package/skills/_template/SKILL.md +239 -0
- package/skills/qk-access-policy/SKILL.md +180 -39
- package/skills/qk-ai-builder/SKILL.md +216 -40
- package/skills/qk-api-lifecycle/SKILL.md +177 -46
- package/skills/qk-bug-resolution/SKILL.md +308 -46
- package/skills/qk-context-loader/SKILL.md +219 -43
- package/skills/qk-data-lifecycle/SKILL.md +193 -44
- package/skills/qk-db-optimizer/SKILL.md +197 -41
- package/skills/qk-docs/SKILL.md +199 -40
- package/skills/qk-engineering-standard/SKILL.md +352 -42
- package/skills/qk-fe-api-integration/SKILL.md +327 -55
- package/skills/qk-feature-delivery/SKILL.md +306 -48
- package/skills/qk-help/SKILL.md +179 -23
- package/skills/qk-orchestrator/SKILL.md +279 -42
- package/skills/qk-orchestrator/references/routing-table.md +78 -0
- package/skills/qk-production-release/SKILL.md +285 -41
- package/skills/qk-project-bootstrap/SKILL.md +236 -38
- package/skills/qk-project-health/SKILL.md +200 -40
- package/skills/qk-project-memory/SKILL.md +219 -40
- package/skills/qk-system-evolution/SKILL.md +282 -40
- package/skills/qk-ui-audit/SKILL.md +316 -42
- package/skills/qk-ui-audit/references/anti-slop-checklist.md +136 -0
- package/skills/qk-ui-builder/SKILL.md +447 -0
- package/skills/qk-ui-builder/references/anti-patterns.md +295 -0
- package/skills/qk-ui-builder/references/color.md +115 -0
- package/skills/qk-ui-builder/references/component-cookbook.md +1194 -0
- package/skills/qk-ui-builder/references/copy.md +250 -0
- package/skills/qk-ui-builder/references/interaction-and-states.md +115 -0
- package/skills/qk-ui-builder/references/layout-and-space.md +111 -0
- package/skills/qk-ui-builder/references/macrostructures/01-bento-grid.md +48 -0
- package/skills/qk-ui-builder/references/macrostructures/02-long-document.md +50 -0
- package/skills/qk-ui-builder/references/macrostructures/03-marquee-hero.md +51 -0
- package/skills/qk-ui-builder/references/macrostructures/04-stat-led.md +49 -0
- package/skills/qk-ui-builder/references/macrostructures/05-workbench.md +44 -0
- package/skills/qk-ui-builder/references/macrostructures/06-conversational-faq.md +50 -0
- package/skills/qk-ui-builder/references/macrostructures/07-manifesto.md +51 -0
- package/skills/qk-ui-builder/references/macrostructures/08-photographic.md +50 -0
- package/skills/qk-ui-builder/references/macrostructures/09-quote-led.md +50 -0
- package/skills/qk-ui-builder/references/macrostructures/11-catalogue.md +49 -0
- package/skills/qk-ui-builder/references/macrostructures/12-letter.md +49 -0
- package/skills/qk-ui-builder/references/macrostructures/13-index-first.md +49 -0
- package/skills/qk-ui-builder/references/macrostructures/14-narrative-workflow.md +48 -0
- package/skills/qk-ui-builder/references/macrostructures/15-split-studio.md +48 -0
- package/skills/qk-ui-builder/references/macrostructures/16-feature-stack.md +51 -0
- package/skills/qk-ui-builder/references/macrostructures/17-type-specimen.md +48 -0
- package/skills/qk-ui-builder/references/macrostructures/18-portfolio-grid.md +48 -0
- package/skills/qk-ui-builder/references/macrostructures/19-map-diagram.md +50 -0
- package/skills/qk-ui-builder/references/macrostructures/20-ecosystem-index.md +48 -0
- package/skills/qk-ui-builder/references/macrostructures/21-component-playground.md +45 -0
- package/skills/qk-ui-builder/references/macrostructures.md +38 -0
- package/skills/qk-ui-builder/references/motion.md +95 -0
- package/skills/qk-ui-builder/references/responsive.md +115 -0
- package/skills/qk-ui-builder/references/slop-test.md +135 -0
- package/skills/qk-ui-builder/references/structure.md +280 -0
- package/skills/qk-ui-builder/references/themes/atmospheric.md +53 -0
- package/skills/qk-ui-builder/references/themes/carnival.md +52 -0
- package/skills/qk-ui-builder/references/themes/cobalt.md +52 -0
- package/skills/qk-ui-builder/references/themes/editorial.md +52 -0
- package/skills/qk-ui-builder/references/themes/garden.md +52 -0
- package/skills/qk-ui-builder/references/themes/hum.md +52 -0
- package/skills/qk-ui-builder/references/themes/lumen.md +52 -0
- package/skills/qk-ui-builder/references/themes/midnight.md +52 -0
- package/skills/qk-ui-builder/references/themes/modern-minimal.md +52 -0
- package/skills/qk-ui-builder/references/themes/playful.md +52 -0
- package/skills/qk-ui-builder/references/themes/specimen.md +52 -0
- package/skills/qk-ui-builder/references/themes/terminal.md +52 -0
- package/skills/qk-ui-builder/references/typography.md +129 -0
- package/skills/qk-ui-system-builder/SKILL.md +222 -43
- package/skills/qk-validation-gate/SKILL.md +360 -40
- package/skills.json +815 -825
- package/specs/fixtures/user-payload.json +12 -0
- package/specs/regressions/api-integration-null-fields.yaml +19 -0
- package/temp_fix.js +61 -0
- package/tests/registry.test.js +1 -1
- package/update_template.js +28 -0
- package/skills/qk-design-to-code/SKILL.md +0 -46
- package/skills/qk-policy-engine/SKILL.md +0 -39
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: qk-data-lifecycle
|
|
3
|
+
category: backend
|
|
4
|
+
version: 7.5.0
|
|
5
|
+
description: "Quản lý Schema, Migrations an toàn — schema freeze → backward-compat migration → cleanup."
|
|
6
|
+
platforms: [antigravity, claude-code, cursor, windsurf, kilo-code]
|
|
7
|
+
execution_mode: deterministic
|
|
8
|
+
cost: high
|
|
9
|
+
latency: slow
|
|
10
|
+
risk: high
|
|
11
|
+
side_effects: edit_files
|
|
12
|
+
produces: [code, schema]
|
|
13
|
+
consumes: [context-graph, user-description]
|
|
14
|
+
token_budget:
|
|
15
|
+
max_files_read: 4
|
|
16
|
+
max_lines_per_read: 100
|
|
17
|
+
max_shell_commands: 1
|
|
18
|
+
stop_early: false
|
|
19
|
+
exit_codes: [SUCCESS, BLOCKED, FAILED, PARTIAL]
|
|
20
|
+
skill_version: 7.5.0
|
|
21
|
+
runtime_version: 1
|
|
22
|
+
schema_version: 2
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
# qk-data-lifecycle — Database Schema & Repository Manager
|
|
26
|
+
|
|
27
|
+
> **Language rule:** Code, identifiers, file names ? English. Explanations, summaries ? Vietnamese.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Preconditions
|
|
32
|
+
- [ ] Existing schema is identified (ORM model files)
|
|
33
|
+
- [ ] Change intent is clear (add field / modify field / drop field)
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
On missing precondition:
|
|
37
|
+
EXIT: BLOCKED
|
|
38
|
+
Message: "Cần xác định: schema hiện tại + loại thay đổi (add/modify/drop)."
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Scope
|
|
44
|
+
- ✅ Define strict schema BEFORE writing repository code
|
|
45
|
+
- ✅ Always backward-compatible migrations (never destructive in first pass)
|
|
46
|
+
- ✅ Separate schema (models) from business logic (services)
|
|
47
|
+
|
|
48
|
+
## Non-Goals
|
|
49
|
+
- ❌ DROP columns without deprecation phase first
|
|
50
|
+
- ❌ Write complex business logic inside repositories
|
|
51
|
+
- ❌ Dynamic queries without schema definitions
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Priority Order
|
|
56
|
+
| P | Task | Skip Threshold |
|
|
57
|
+
|---|------|----------------|
|
|
58
|
+
| P1 | Read existing schema | Never |
|
|
59
|
+
| P2 | Design migration (backward-compat) | Never |
|
|
60
|
+
| P3 | Write migration file | Never |
|
|
61
|
+
| P4 | Update repository layer | Budget < 30% |
|
|
62
|
+
| P5 | Update affected service layer | Budget < 50% |
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Migration Safety Rules
|
|
67
|
+
```yaml
|
|
68
|
+
add_column:
|
|
69
|
+
strategy: nullable OR has default value (never NOT NULL without default)
|
|
70
|
+
|
|
71
|
+
modify_column:
|
|
72
|
+
strategy: add new column → migrate data → drop old column (3-phase)
|
|
73
|
+
|
|
74
|
+
drop_column:
|
|
75
|
+
strategy: Phase 1 — mark deprecated (keep in schema)
|
|
76
|
+
Phase 2 — next release — remove from queries
|
|
77
|
+
Phase 3 — next migration — DROP COLUMN
|
|
78
|
+
|
|
79
|
+
rename_table:
|
|
80
|
+
strategy: create new table → migrate → drop old (never ALTER TABLE RENAME in prod)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Workflow
|
|
86
|
+
|
|
87
|
+
### Phase 1 — Schema Read
|
|
88
|
+
1. `grep_search` for existing model/entity file
|
|
89
|
+
2. Read current schema (targeted, ≤ 100 lines)
|
|
90
|
+
3. Identify impact of proposed change
|
|
91
|
+
|
|
92
|
+
### Phase 2 — Migration Design
|
|
93
|
+
1. Choose safety strategy (see Migration Safety Rules)
|
|
94
|
+
2. Write migration file (up + down)
|
|
95
|
+
3. Verify down() is always defined (rollback support)
|
|
96
|
+
|
|
97
|
+
### Phase 3 — Repository Update
|
|
98
|
+
1. Update repository methods to use new schema
|
|
99
|
+
2. Verify no raw queries reference old column names
|
|
100
|
+
|
|
101
|
+
**Decision:**
|
|
102
|
+
```
|
|
103
|
+
IF migration is backward-compat AND down() defined → EXIT: SUCCESS
|
|
104
|
+
ELSE IF destructive migration attempted → EXIT: BLOCKED — apply 3-phase strategy
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Evidence Format
|
|
110
|
+
```
|
|
111
|
+
[SEVERITY] migration: [filename]
|
|
112
|
+
Issue: [NOT NULL without default | missing down() | direct DROP]
|
|
113
|
+
Confidence: HIGH
|
|
114
|
+
Fix: [specific safer strategy]
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Exit Codes
|
|
120
|
+
| Code | Meaning | When |
|
|
121
|
+
|------|---------|------|
|
|
122
|
+
| SUCCESS | Schema, migration, and repository complete | Validated execution |
|
|
123
|
+
| PARTIAL | Migration generated but untested | Missing DB connection |
|
|
124
|
+
| BLOCKED | Fields or relationships ambiguous | Missing entity data |
|
|
125
|
+
| FAILED | Migration involves destructive DROP without backup | Architecture violation |
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Confidence Model
|
|
130
|
+
| Level | Condition | Action |
|
|
131
|
+
|-------|-----------|--------|
|
|
132
|
+
| HIGH | Entity schema completely defined by user | Implement immediately |
|
|
133
|
+
| MEDIUM | Schema inferred from JSON or forms | Ask for review before generating migration |
|
|
134
|
+
| LOW | "Add database" request with no schema | EXIT: BLOCKED |
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## Severity
|
|
139
|
+
| Level | Definition | Example |
|
|
140
|
+
|-------|-----------|---------|
|
|
141
|
+
| CRITICAL | Data loss risk in migration | Direct `DROP TABLE` without data copy |
|
|
142
|
+
| HIGH | Missing index on foreign key | Performance degrade on JOIN |
|
|
143
|
+
| MEDIUM | N+1 query vulnerability in repository | Fetching related entities in a loop |
|
|
144
|
+
| LOW | Naming convention violation | `userId` instead of `user_id` in DB |
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Retry Policy
|
|
149
|
+
```
|
|
150
|
+
Migration generation fails
|
|
151
|
+
└─ Syntax error in SQL/ORM
|
|
152
|
+
├─ Fix syntax based on engine (Postgres/MySQL)
|
|
153
|
+
└─ Do NOT retry more than 1 time — risk of bad migration state
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Escalation Rules
|
|
159
|
+
```
|
|
160
|
+
BLOCKED: Entity schema undefined
|
|
161
|
+
Missing:
|
|
162
|
+
- List of fields (types, constraints)
|
|
163
|
+
- Relationships (1:1, 1:N, M:N)
|
|
164
|
+
Questions:
|
|
165
|
+
1. Bảng này cần lưu những trường dữ liệu nào?
|
|
166
|
+
2. Bảng này có liên kết với bảng nào khác không? (ví dụ User)
|
|
167
|
+
Recommended Assumptions:
|
|
168
|
+
- Add standard created_at, updated_at timestamps
|
|
169
|
+
- UUID primary keys
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Handoff Contract
|
|
175
|
+
### Consumes
|
|
176
|
+
```json
|
|
177
|
+
{
|
|
178
|
+
"from": "user",
|
|
179
|
+
"required_fields": ["entity_name", "fields"],
|
|
180
|
+
"optional_fields": ["relationships", "db_engine"]
|
|
181
|
+
}
|
|
182
|
+
```
|
|
183
|
+
### Produces
|
|
184
|
+
```json
|
|
185
|
+
{
|
|
186
|
+
"to": "user or db-optimizer",
|
|
187
|
+
"output_fields": ["schema_file", "migration_file", "repository_file", "exit_code"]
|
|
188
|
+
}
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: qk-db-optimizer
|
|
3
|
+
category: backend
|
|
4
|
+
version: 7.5.0
|
|
5
|
+
description: "Tối ưu Database dựa trên bằng chứng: EXPLAIN → phân tích → index/join — không đoán mò."
|
|
6
|
+
platforms: [antigravity, claude-code, cursor, windsurf, kilo-code]
|
|
7
|
+
execution_mode: deterministic
|
|
8
|
+
cost: medium
|
|
9
|
+
latency: medium
|
|
10
|
+
risk: medium
|
|
11
|
+
side_effects: edit_files
|
|
12
|
+
produces: [code, report]
|
|
13
|
+
consumes: [query-log, source-code]
|
|
14
|
+
token_budget:
|
|
15
|
+
max_files_read: 3
|
|
16
|
+
max_lines_per_read: 100
|
|
17
|
+
max_shell_commands: 2
|
|
18
|
+
stop_early: true
|
|
19
|
+
exit_codes: [SUCCESS, BLOCKED, FAILED, PARTIAL]
|
|
20
|
+
skill_version: 7.5.0
|
|
21
|
+
runtime_version: 1
|
|
22
|
+
schema_version: 2
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
# qk-db-optimizer — Database Performance Tuner
|
|
26
|
+
|
|
27
|
+
> **Language rule:** Code, identifiers, file names ? English. Explanations, summaries ? Vietnamese.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Preconditions
|
|
32
|
+
- [ ] Slow query log OR specific slow query is provided
|
|
33
|
+
- [ ] Database schema/ORM models accessible
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
On missing precondition:
|
|
37
|
+
EXIT: BLOCKED
|
|
38
|
+
Message: "Cần: slow query log hoặc query cụ thể cần tối ưu."
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Scope
|
|
44
|
+
- ✅ Analyze EXPLAIN/query plans before adding indexes
|
|
45
|
+
- ✅ Solve N+1 with Data Loaders or explicit Joins
|
|
46
|
+
- ✅ Validate performance improvement
|
|
47
|
+
|
|
48
|
+
## Non-Goals
|
|
49
|
+
- ❌ Add indexes without slow query evidence
|
|
50
|
+
- ❌ Add overlapping or redundant indexes
|
|
51
|
+
- ❌ Optimize queries not shown in slow query log
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Priority Order
|
|
56
|
+
| P | Issue Type | Action | Skip Threshold |
|
|
57
|
+
|---|-----------|--------|----------------|
|
|
58
|
+
| P1 | Sequential scan on large table (> 10k rows) | Add composite index | Never |
|
|
59
|
+
| P2 | N+1 query pattern | Eager load / DataLoader | Budget < 30% |
|
|
60
|
+
| P3 | Missing JOIN (multiple queries for related data) | Rewrite with JOIN | Budget < 50% |
|
|
61
|
+
| P4 | SELECT * (over-fetching) | Select specific columns | Budget < 60% |
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## EXPLAIN Decision Tree
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
Run EXPLAIN ANALYZE on slow query
|
|
69
|
+
|
|
70
|
+
IF "Seq Scan" on table > 10k rows
|
|
71
|
+
→ Check cardinality of filter column
|
|
72
|
+
→ IF cardinality > 100 → add B-tree index
|
|
73
|
+
→ IF low cardinality → add partial index or reconsider query
|
|
74
|
+
|
|
75
|
+
IF "Nested Loop" with many iterations
|
|
76
|
+
→ Check: is this N+1?
|
|
77
|
+
→ IF yes → rewrite as single JOIN or use DataLoader
|
|
78
|
+
|
|
79
|
+
IF "Sort" without index
|
|
80
|
+
→ Add index on ORDER BY column
|
|
81
|
+
|
|
82
|
+
IF index exists but not used ("Index Scan" missing)
|
|
83
|
+
→ Check: is WHERE clause using non-leading column of composite index?
|
|
84
|
+
→ Reorder composite index columns
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Workflow
|
|
90
|
+
|
|
91
|
+
### Phase 1 — Evidence Collection
|
|
92
|
+
1. Read slow query log or provided query
|
|
93
|
+
2. Run EXPLAIN ANALYZE (1 command) — or analyze ORM-generated SQL
|
|
94
|
+
3. Identify bottleneck pattern (seq scan / N+1 / sort / over-fetch)
|
|
95
|
+
|
|
96
|
+
### Phase 2 — Solution Design
|
|
97
|
+
1. Apply Decision Tree above
|
|
98
|
+
2. Design minimal index or query rewrite
|
|
99
|
+
|
|
100
|
+
### Phase 3 — Apply & Verify
|
|
101
|
+
1. Apply change (add index migration OR rewrite query via `replace_file_content`)
|
|
102
|
+
2. (Optional) Re-run EXPLAIN to verify improvement (2nd command)
|
|
103
|
+
|
|
104
|
+
**Decision:**
|
|
105
|
+
```
|
|
106
|
+
IF improvement verified → EXIT: SUCCESS
|
|
107
|
+
IF improvement not measurable → EXIT: PARTIAL, note "verify in production"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Evidence Format
|
|
113
|
+
```
|
|
114
|
+
[SEVERITY] query in src/repositories/[name].ts:LINE
|
|
115
|
+
Pattern: [SEQ_SCAN | N+1 | MISSING_JOIN | OVER_FETCH | UNUSED_INDEX]
|
|
116
|
+
Table: [table_name] (~N rows estimated)
|
|
117
|
+
Confidence: HIGH
|
|
118
|
+
Fix: [specific index or rewrite]
|
|
119
|
+
Estimated improvement: [X% reduction in scan rows]
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Exit Codes
|
|
125
|
+
| Code | Meaning | When |
|
|
126
|
+
|------|---------|------|
|
|
127
|
+
| SUCCESS | Index added or query rewritten, improvement verified | Post-optimization |
|
|
128
|
+
| PARTIAL | Optimization applied but could not verify via EXPLAIN | DB access blocked |
|
|
129
|
+
| BLOCKED | Log not provided or DB engine unknown | Missing inputs |
|
|
130
|
+
| FAILED | Optimization breaks existing test or query syntax | Logic error |
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Confidence Model
|
|
135
|
+
| Level | Condition | Action |
|
|
136
|
+
|-------|-----------|--------|
|
|
137
|
+
| HIGH | EXPLAIN plan shows SEQ SCAN, user confirms index is missing | Add index / rewrite |
|
|
138
|
+
| MEDIUM | Query looks inefficient but no EXPLAIN available | Ask to run EXPLAIN |
|
|
139
|
+
| LOW | "Make DB faster" with no slow query log | EXIT: BLOCKED |
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## Severity
|
|
144
|
+
| Level | Definition | Example |
|
|
145
|
+
|-------|-----------|---------|
|
|
146
|
+
| CRITICAL | Query locking table in production | Long running UPDATE |
|
|
147
|
+
| HIGH | Missing index on frequently joined table | Full scan on million rows |
|
|
148
|
+
| MEDIUM | N+1 queries due to missing JOIN | ORM fetching relations in loop |
|
|
149
|
+
| LOW | Over-fetching columns | `SELECT *` instead of specific |
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## Retry Policy
|
|
154
|
+
```
|
|
155
|
+
EXPLAIN query fails
|
|
156
|
+
└─ Check SQL syntax error vs connection error
|
|
157
|
+
├─ Syntax error → correct SQL → retry EXPLAIN
|
|
158
|
+
└─ Do NOT retry more than 1 time — risk of locking
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Escalation Rules
|
|
164
|
+
```
|
|
165
|
+
BLOCKED: Slow query log not provided
|
|
166
|
+
Missing:
|
|
167
|
+
- The actual slow query SQL
|
|
168
|
+
- Current schema of the involved tables
|
|
169
|
+
Questions:
|
|
170
|
+
1. Câu query nào đang bị chậm? (Xin SQL / ORM log)
|
|
171
|
+
2. Bảng này hiện đang có những index nào?
|
|
172
|
+
Recommended Assumptions:
|
|
173
|
+
- Do NOT assume table size or indexes blindly
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## Handoff Contract
|
|
179
|
+
### Consumes
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"from": "user",
|
|
183
|
+
"required_fields": ["slow_query"],
|
|
184
|
+
"optional_fields": ["schema", "explain_plan", "db_engine"]
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
### Produces
|
|
188
|
+
```json
|
|
189
|
+
{
|
|
190
|
+
"to": "user",
|
|
191
|
+
"output_fields": ["optimized_query", "migration_file", "explain_diff", "exit_code"]
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: qk-docs
|
|
3
|
+
category: documentation
|
|
4
|
+
version: 7.5.0
|
|
5
|
+
description: "Viết và duy trì tài liệu chính xác tuyệt đối — phải match code thực tế, cấm bịa đặt."
|
|
6
|
+
platforms: [antigravity, claude-code, cursor, windsurf, kilo-code]
|
|
7
|
+
execution_mode: deterministic
|
|
8
|
+
cost: low
|
|
9
|
+
latency: fast
|
|
10
|
+
risk: low
|
|
11
|
+
side_effects: edit_files
|
|
12
|
+
produces: [report]
|
|
13
|
+
consumes: [source-code]
|
|
14
|
+
token_budget:
|
|
15
|
+
max_files_read: 3
|
|
16
|
+
max_lines_per_read: 100
|
|
17
|
+
max_shell_commands: 0
|
|
18
|
+
stop_early: true
|
|
19
|
+
exit_codes: [SUCCESS, BLOCKED, FAILED, PARTIAL]
|
|
20
|
+
skill_version: 7.5.0
|
|
21
|
+
runtime_version: 1
|
|
22
|
+
schema_version: 2
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
# qk-docs — Technical Writer & Documentation Maintainer
|
|
26
|
+
|
|
27
|
+
> **Language rule:** Code, identifiers, file names ? English. Explanations, summaries ? Vietnamese.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Preconditions
|
|
32
|
+
- [ ] Target code file or module is specified
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
On missing precondition:
|
|
36
|
+
EXIT: BLOCKED
|
|
37
|
+
Message: "Chỉ định file cần viết docs."
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Scope
|
|
43
|
+
- ✅ Document ONLY what exists in code — never invent params/behavior
|
|
44
|
+
- ✅ Update docs whenever corresponding code changes
|
|
45
|
+
- ✅ Use living documentation (JSDoc/TSDoc/Swagger) over isolated Markdown
|
|
46
|
+
|
|
47
|
+
## Non-Goals
|
|
48
|
+
- ❌ Guess API params not in the code
|
|
49
|
+
- ❌ Write generic/useless comments (`// gets the user`)
|
|
50
|
+
- ❌ Write docs for code that hasn't been read yet
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Priority Order
|
|
55
|
+
| P | Task | Skip Threshold |
|
|
56
|
+
|---|------|----------------|
|
|
57
|
+
| P1 | Read source code first (never write before reading) | Never |
|
|
58
|
+
| P2 | Document public API (exported functions/classes) | Never |
|
|
59
|
+
| P3 | Document complex logic with WHY (not WHAT) | Budget < 40% |
|
|
60
|
+
| P4 | Update README if public interface changed | Budget < 60% |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Workflow
|
|
65
|
+
|
|
66
|
+
### Phase 1 — Read Code
|
|
67
|
+
1. `view_file[targeted]` — read function/class signatures
|
|
68
|
+
2. Identify: params, return type, side effects, error cases
|
|
69
|
+
|
|
70
|
+
**Decision:** `IF code is not readable → EXIT: BLOCKED — read code first`
|
|
71
|
+
|
|
72
|
+
### Phase 2 — Write Documentation
|
|
73
|
+
1. JSDoc/TSDoc format for functions: `@param`, `@returns`, `@throws`
|
|
74
|
+
2. Comment: WHY (not WHAT) — code already shows what
|
|
75
|
+
3. Example usage for complex APIs
|
|
76
|
+
|
|
77
|
+
### Phase 3 — Verify Accuracy
|
|
78
|
+
1. Re-read written docs vs code → spot check each param name
|
|
79
|
+
|
|
80
|
+
**Decision:**
|
|
81
|
+
```
|
|
82
|
+
IF docs match code exactly → EXIT: SUCCESS
|
|
83
|
+
IF any param name or type mismatch → fix immediately
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Documentation Templates
|
|
89
|
+
|
|
90
|
+
### Function (JSDoc)
|
|
91
|
+
```typescript
|
|
92
|
+
/**
|
|
93
|
+
* [One sentence — what it does and WHY it exists]
|
|
94
|
+
*
|
|
95
|
+
* @param {Type} paramName - [description]
|
|
96
|
+
* @returns {Type} [description of return value]
|
|
97
|
+
* @throws {ErrorType} [when this error is thrown]
|
|
98
|
+
* @example
|
|
99
|
+
* const result = functionName(arg);
|
|
100
|
+
*/
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### README Section
|
|
104
|
+
```markdown
|
|
105
|
+
## [Feature Name]
|
|
106
|
+
[What it does — user-facing description]
|
|
107
|
+
|
|
108
|
+
### Usage
|
|
109
|
+
[Code example]
|
|
110
|
+
|
|
111
|
+
### Configuration
|
|
112
|
+
| Option | Type | Default | Description |
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Evidence Format
|
|
118
|
+
```
|
|
119
|
+
[SEVERITY] path/to/file.ts:LINE
|
|
120
|
+
Issue: [MISSING_PARAM | WRONG_TYPE | STALE_DOC | GENERIC_COMMENT]
|
|
121
|
+
Confidence: HIGH
|
|
122
|
+
Fix: [specific correction]
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Exit Codes
|
|
128
|
+
| Code | Meaning | When |
|
|
129
|
+
|------|---------|------|
|
|
130
|
+
| SUCCESS | Docs written and verified against source code | Execution complete |
|
|
131
|
+
| PARTIAL | Docs written but some parts inferred (not verified) | MEDIUM confidence |
|
|
132
|
+
| BLOCKED | Target source file missing or inaccessible | Cannot read source |
|
|
133
|
+
| FAILED | Documentation fundamentally misrepresents the code | Gross error |
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Confidence Model
|
|
138
|
+
| Level | Condition | Action |
|
|
139
|
+
|-------|-----------|--------|
|
|
140
|
+
| HIGH | Target code read, behavior understood | Write docs definitively |
|
|
141
|
+
| MEDIUM | Target code too large, inferred from types/tests | Write with disclaimer |
|
|
142
|
+
| LOW | "Write docs for this feature" without pointing to code | EXIT: BLOCKED |
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Severity
|
|
147
|
+
| Level | Definition | Example |
|
|
148
|
+
|-------|-----------|---------|
|
|
149
|
+
| CRITICAL | Docs instruct user to do something dangerous | Documenting destructive API without warnings |
|
|
150
|
+
| HIGH | API params documented incorrectly | Says string instead of object |
|
|
151
|
+
| MEDIUM | Missing docs for edge cases | Doesn't explain error throws |
|
|
152
|
+
| LOW | Typo or poor formatting | Misaligned markdown table |
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Retry Policy
|
|
157
|
+
```
|
|
158
|
+
Doc verification fails
|
|
159
|
+
└─ Target code changed during doc writing
|
|
160
|
+
├─ Re-read target code
|
|
161
|
+
└─ Do NOT retry more than 1 time
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## Escalation Rules
|
|
167
|
+
```
|
|
168
|
+
BLOCKED: Target source file missing
|
|
169
|
+
Missing:
|
|
170
|
+
- Exact path to the code that needs documenting
|
|
171
|
+
Questions:
|
|
172
|
+
1. File code nào bạn muốn viết doc? (Xin đường dẫn)
|
|
173
|
+
2. Mục tiêu của doc này là cho user hay cho developer nội bộ?
|
|
174
|
+
Recommended Assumptions:
|
|
175
|
+
- Developer-facing JSDoc if inside source files
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Handoff Contract
|
|
181
|
+
### Consumes
|
|
182
|
+
```json
|
|
183
|
+
{
|
|
184
|
+
"from": "user",
|
|
185
|
+
"required_fields": ["target_file", "doc_type"],
|
|
186
|
+
"optional_fields": ["context"]
|
|
187
|
+
}
|
|
188
|
+
```
|
|
189
|
+
### Produces
|
|
190
|
+
```json
|
|
191
|
+
{
|
|
192
|
+
"to": "user",
|
|
193
|
+
"output_fields": ["updated_files", "exit_code"]
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|