owflow 0.1.3 → 0.1.5
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/README.md +169 -169
- package/dist/agents/e2e-test-verifier.md +1 -1
- package/dist/commands/diagrams-mermaid.md +37 -0
- package/dist/commands/html-renderer.md +37 -0
- package/dist/commands/quick-plan.md +9 -9
- package/dist/skills/development/SKILL.md +15 -0
- package/dist/skills/diagrams-mermaid/SKILL.md +156 -0
- package/dist/skills/diagrams-mermaid/references/reference.md +148 -0
- package/dist/skills/docs-manager/SKILL.md +10 -10
- package/dist/skills/flow-init/SKILL.md +15 -0
- package/dist/skills/html-renderer/SKILL.md +159 -0
- package/dist/skills/html-renderer/references/index.html +318 -0
- package/dist/skills/html-renderer/references/styles.css +388 -0
- package/dist/skills/html-renderer/references/tokens.json +104 -0
- package/dist/skills/migration/SKILL.md +12 -0
- package/dist/skills/migration/references/migration-strategies.md +65 -32
- package/dist/skills/migration/references/migration-types.md +80 -27
- package/dist/skills/performance/SKILL.md +12 -0
- package/dist/skills/quick-bugfix/SKILL.md +4 -4
- package/dist/skills/research/SKILL.md +8 -0
- package/dist/skills/standards-discover/references/docs-extractor-prompt.md +1 -1
- package/package.json +1 -1
- /package/dist/skills/docs-manager/references/{claude-md-template.md → agents-md-template.md} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Migration Types Reference
|
|
2
2
|
|
|
3
|
-
> **Design Documentation**: This file serves as **design documentation** for developers and
|
|
3
|
+
> **Design Documentation**: This file serves as **design documentation** for developers and Agents implementing migration workflows. It provides guidance for identifying migration types and adapting workflows accordingly.
|
|
4
4
|
|
|
5
5
|
**Purpose:** Pattern guide for the three migration types: Code, Data, and Architecture
|
|
6
6
|
|
|
@@ -23,16 +23,17 @@ This reference provides characteristics, detection patterns, and workflow adapta
|
|
|
23
23
|
|
|
24
24
|
Migration types classify migrations based on **what** is being changed:
|
|
25
25
|
|
|
26
|
-
| Type
|
|
27
|
-
|
|
28
|
-
| **Code**
|
|
29
|
-
| **Data**
|
|
30
|
-
| **Architecture** | Patterns, structure
|
|
31
|
-
| **General**
|
|
26
|
+
| Type | Focus | Examples | Risk Profile |
|
|
27
|
+
| ---------------- | ---------------------------- | ----------------------------------------- | ------------ |
|
|
28
|
+
| **Code** | Language, framework, library | Vue 2→3, Python 2→3, Express→Fastify | Medium |
|
|
29
|
+
| **Data** | Database, storage, schema | MySQL→PostgreSQL, MongoDB→DynamoDB | High |
|
|
30
|
+
| **Architecture** | Patterns, structure | REST→GraphQL, Monolith→Microservices | High |
|
|
31
|
+
| **General** | Mixed or unclear | Complex refactoring with multiple aspects | Variable |
|
|
32
32
|
|
|
33
33
|
### Why Type Matters
|
|
34
34
|
|
|
35
35
|
Different types require different:
|
|
36
|
+
|
|
36
37
|
- **Risk assessments**: Data migrations are highest risk (data loss potential)
|
|
37
38
|
- **Verification approaches**: Data needs integrity checks, code needs functional tests
|
|
38
39
|
- **Rollback strategies**: Data rollback more complex than code rollback
|
|
@@ -47,6 +48,7 @@ Different types require different:
|
|
|
47
48
|
**What**: Changing programming language, framework, library, or major version with breaking changes
|
|
48
49
|
|
|
49
50
|
**Characteristics**:
|
|
51
|
+
|
|
50
52
|
- Source code modifications (syntax, APIs, patterns)
|
|
51
53
|
- Dependency updates (package.json, requirements.txt, pom.xml)
|
|
52
54
|
- No data transformation (data structures unchanged or minimal changes)
|
|
@@ -55,17 +57,20 @@ Different types require different:
|
|
|
55
57
|
### Examples
|
|
56
58
|
|
|
57
59
|
**Framework Migrations**:
|
|
60
|
+
|
|
58
61
|
- Vue 2 → Vue 3 (composition API, breaking changes)
|
|
59
62
|
- Angular 8 → Angular 15 (modules to standalone components)
|
|
60
63
|
- React Class Components → Hooks
|
|
61
64
|
- Express 4 → Express 5
|
|
62
65
|
|
|
63
66
|
**Language Migrations**:
|
|
67
|
+
|
|
64
68
|
- Python 2 → Python 3 (print statements, unicode)
|
|
65
69
|
- JavaScript → TypeScript (type annotations)
|
|
66
70
|
- Java 8 → Java 17 (new syntax, APIs)
|
|
67
71
|
|
|
68
72
|
**Library Migrations**:
|
|
73
|
+
|
|
69
74
|
- Moment.js → Day.js (date handling library change)
|
|
70
75
|
- Axios → Fetch API (HTTP client change)
|
|
71
76
|
- Lodash → Native JavaScript (utility functions)
|
|
@@ -73,11 +78,13 @@ Different types require different:
|
|
|
73
78
|
### Detection Keywords
|
|
74
79
|
|
|
75
80
|
**Primary Indicators**:
|
|
81
|
+
|
|
76
82
|
- Framework/library names: React, Vue, Angular, Express, Flask, Django, Spring, Rails
|
|
77
83
|
- Version terms: "upgrade", "migrate from X to Y", "move to version N"
|
|
78
84
|
- Language names: Python, Java, JavaScript, TypeScript, Go, Rust
|
|
79
85
|
|
|
80
86
|
**Example Descriptions**:
|
|
87
|
+
|
|
81
88
|
- "Migrate from Vue 2 to Vue 3" → Code migration (framework)
|
|
82
89
|
- "Upgrade Express to v5" → Code migration (major version)
|
|
83
90
|
- "Convert JavaScript to TypeScript" → Code migration (language)
|
|
@@ -85,28 +92,34 @@ Different types require different:
|
|
|
85
92
|
### Workflow Adaptations
|
|
86
93
|
|
|
87
94
|
**Phase 1 (Current State Analysis)**:
|
|
95
|
+
|
|
88
96
|
- Focus: Locate all source files using old framework/library
|
|
89
97
|
- Analyze: Dependency tree, API usage patterns, deprecated features used
|
|
90
98
|
|
|
91
99
|
**Phase 2 (Target State Planning)**:
|
|
100
|
+
|
|
92
101
|
- Focus: Breaking changes between versions, API equivalents
|
|
93
102
|
- Output: Breaking changes list, API migration map
|
|
94
103
|
|
|
95
104
|
**Phase 3 (Specification)**:
|
|
105
|
+
|
|
96
106
|
- Include: Compatibility shim requirements (if needed)
|
|
97
107
|
- Rollback: Simple (revert code via git)
|
|
98
108
|
|
|
99
109
|
**Phase 5 (Execution)**:
|
|
110
|
+
|
|
100
111
|
- Strategy: Incremental (by module/component)
|
|
101
112
|
- Testing: Functional tests per module
|
|
102
113
|
|
|
103
114
|
**Phase 6 (Verification)**:
|
|
115
|
+
|
|
104
116
|
- Focus: Functional equivalence (behavior unchanged)
|
|
105
117
|
- Tests: Full test suite, manual testing of critical flows
|
|
106
118
|
|
|
107
119
|
### Risk Profile
|
|
108
120
|
|
|
109
121
|
**Medium Risk**:
|
|
122
|
+
|
|
110
123
|
- **Risk**: Breaking changes causing bugs, build failures
|
|
111
124
|
- **Mitigation**: Comprehensive test coverage, incremental migration
|
|
112
125
|
- **Rollback**: Relatively easy (git revert)
|
|
@@ -120,6 +133,7 @@ Different types require different:
|
|
|
120
133
|
**What**: Changing database platform, storage system, or schema structure
|
|
121
134
|
|
|
122
135
|
**Characteristics**:
|
|
136
|
+
|
|
123
137
|
- Data transformation (format, structure, relationships)
|
|
124
138
|
- Schema changes (tables, columns, indexes, constraints)
|
|
125
139
|
- Data integrity critical (no data loss tolerated)
|
|
@@ -128,17 +142,20 @@ Different types require different:
|
|
|
128
142
|
### Examples
|
|
129
143
|
|
|
130
144
|
**Platform Migrations**:
|
|
145
|
+
|
|
131
146
|
- MySQL → PostgreSQL (SQL database change)
|
|
132
147
|
- MongoDB → DynamoDB (document to key-value)
|
|
133
148
|
- Redis → Memcached (caching layer change)
|
|
134
149
|
- On-premise DB → Cloud DB (AWS RDS, Azure SQL)
|
|
135
150
|
|
|
136
151
|
**Schema Migrations**:
|
|
152
|
+
|
|
137
153
|
- Normalize database (split tables, add relationships)
|
|
138
154
|
- Denormalize for performance (merge tables)
|
|
139
155
|
- Add partitioning/sharding
|
|
140
156
|
|
|
141
157
|
**Storage Migrations**:
|
|
158
|
+
|
|
142
159
|
- Local files → S3 (file storage migration)
|
|
143
160
|
- S3 → GCS (cloud provider change)
|
|
144
161
|
- SQL → NoSQL (data model change)
|
|
@@ -146,11 +163,13 @@ Different types require different:
|
|
|
146
163
|
### Detection Keywords
|
|
147
164
|
|
|
148
165
|
**Primary Indicators**:
|
|
166
|
+
|
|
149
167
|
- Database names: MySQL, PostgreSQL, MongoDB, Redis, DynamoDB, Cassandra, Oracle
|
|
150
168
|
- Data terms: "schema change", "data migration", "database migration", "move data"
|
|
151
169
|
- Storage terms: "S3", "blob storage", "file migration"
|
|
152
170
|
|
|
153
171
|
**Example Descriptions**:
|
|
172
|
+
|
|
154
173
|
- "Migrate database from MySQL to PostgreSQL" → Data migration (platform)
|
|
155
174
|
- "Move from MongoDB to DynamoDB" → Data migration (NoSQL change)
|
|
156
175
|
- "Migrate schema to normalized structure" → Data migration (schema)
|
|
@@ -158,23 +177,28 @@ Different types require different:
|
|
|
158
177
|
### Workflow Adaptations
|
|
159
178
|
|
|
160
179
|
**Phase 1 (Current State Analysis)**:
|
|
180
|
+
|
|
161
181
|
- Focus: Database schema, row counts, data volume, stored procedures
|
|
162
182
|
- Analyze: Data relationships, foreign keys, indexes, constraints
|
|
163
183
|
|
|
164
184
|
**Phase 2 (Target State Planning)**:
|
|
185
|
+
|
|
165
186
|
- Focus: Data transformation requirements, data mapping (old → new schema)
|
|
166
187
|
- Output: Data transformation specification, estimated migration time
|
|
167
188
|
|
|
168
189
|
**Phase 3 (Specification)**:
|
|
190
|
+
|
|
169
191
|
- Include: Data validation procedures, integrity checks, rollback procedures
|
|
170
192
|
- Rollback: Complex (requires backup/restore strategies)
|
|
171
193
|
- Dual-Run: Often required (zero-downtime)
|
|
172
194
|
|
|
173
195
|
**Phase 5 (Execution)**:
|
|
196
|
+
|
|
174
197
|
- Strategy: Incremental + Dual-Run (high confidence in strategy choice)
|
|
175
198
|
- Testing: Data integrity checks after each batch
|
|
176
199
|
|
|
177
200
|
**Phase 6 (Verification)**:
|
|
201
|
+
|
|
178
202
|
- Focus: Data integrity (100% row count match, checksums, data validation)
|
|
179
203
|
- Tests: Full test suite + data integrity tests + performance benchmarks
|
|
180
204
|
- Critical: If data integrity fails, HALT (don't auto-fix, prompt user)
|
|
@@ -182,11 +206,13 @@ Different types require different:
|
|
|
182
206
|
### Risk Profile
|
|
183
207
|
|
|
184
208
|
**High Risk**:
|
|
209
|
+
|
|
185
210
|
- **Risk**: Data loss, data corruption, downtime
|
|
186
211
|
- **Mitigation**: Backups before migration, dual-run, incremental batches, 100% data validation
|
|
187
212
|
- **Rollback**: Complex (restore from backup, may lose data written during migration)
|
|
188
213
|
|
|
189
214
|
**Special Requirements**:
|
|
215
|
+
|
|
190
216
|
- **Backup**: Full backup before starting (non-negotiable)
|
|
191
217
|
- **Data Validation**: 100% row count match, checksums, business rule validation
|
|
192
218
|
- **Dual-Run**: Strongly recommended (old and new databases in parallel)
|
|
@@ -202,6 +228,7 @@ Different types require different:
|
|
|
202
228
|
**What**: Changing fundamental system structure, communication patterns, or architectural style
|
|
203
229
|
|
|
204
230
|
**Characteristics**:
|
|
231
|
+
|
|
205
232
|
- System-wide changes (affects multiple components/services)
|
|
206
233
|
- Changes how components interact (APIs, communication patterns)
|
|
207
234
|
- May affect both code and data (comprehensive migration)
|
|
@@ -210,17 +237,20 @@ Different types require different:
|
|
|
210
237
|
### Examples
|
|
211
238
|
|
|
212
239
|
**API Style Migrations**:
|
|
240
|
+
|
|
213
241
|
- REST API → GraphQL (query language change)
|
|
214
242
|
- SOAP → REST (API pattern modernization)
|
|
215
243
|
- RPC → REST (communication pattern change)
|
|
216
244
|
|
|
217
245
|
**Architecture Pattern Migrations**:
|
|
246
|
+
|
|
218
247
|
- Monolith → Microservices (decomposition)
|
|
219
248
|
- Microservices → Monolith (consolidation)
|
|
220
249
|
- MVC → Component-Based (frontend architecture change)
|
|
221
250
|
- Layered → Hexagonal (backend architecture change)
|
|
222
251
|
|
|
223
252
|
**Infrastructure Migrations**:
|
|
253
|
+
|
|
224
254
|
- On-Premise → Cloud (infrastructure change)
|
|
225
255
|
- Single Server → Distributed (scalability)
|
|
226
256
|
- Synchronous → Event-Driven (async patterns)
|
|
@@ -228,11 +258,13 @@ Different types require different:
|
|
|
228
258
|
### Detection Keywords
|
|
229
259
|
|
|
230
260
|
**Primary Indicators**:
|
|
261
|
+
|
|
231
262
|
- Pattern names: REST, GraphQL, gRPC, SOAP, RPC
|
|
232
263
|
- Architecture styles: Monolith, Microservices, Serverless, Event-Driven, Hexagonal
|
|
233
264
|
- Refactoring terms: "refactor to", "change architecture", "restructure"
|
|
234
265
|
|
|
235
266
|
**Example Descriptions**:
|
|
267
|
+
|
|
236
268
|
- "Refactor REST API to GraphQL" → Architecture migration (API style)
|
|
237
269
|
- "Migrate monolith to microservices" → Architecture migration (decomposition)
|
|
238
270
|
- "Change from MVC to component-based architecture" → Architecture migration (pattern)
|
|
@@ -240,34 +272,41 @@ Different types require different:
|
|
|
240
272
|
### Workflow Adaptations
|
|
241
273
|
|
|
242
274
|
**Phase 1 (Current State Analysis)**:
|
|
275
|
+
|
|
243
276
|
- Focus: System components, communication patterns, dependencies between components
|
|
244
277
|
- Analyze: Coupling/cohesion, service boundaries, data flow
|
|
245
278
|
|
|
246
279
|
**Phase 2 (Target State Planning)**:
|
|
280
|
+
|
|
247
281
|
- Focus: New architecture structure, component boundaries, communication patterns
|
|
248
282
|
- Output: Architecture diagram, component mapping (old → new)
|
|
249
283
|
|
|
250
284
|
**Phase 3 (Specification)**:
|
|
285
|
+
|
|
251
286
|
- Include: Strangler fig pattern (if applicable), component interaction diagrams
|
|
252
287
|
- Rollback: Moderate to complex (depends on dual-run feasibility)
|
|
253
288
|
- Dual-Run: Often required (old and new architectures in parallel)
|
|
254
289
|
|
|
255
290
|
**Phase 5 (Execution)**:
|
|
291
|
+
|
|
256
292
|
- Strategy: Incremental (by component/service) + Dual-Run (if possible)
|
|
257
293
|
- Testing: Integration tests, end-to-end tests, performance tests
|
|
258
294
|
|
|
259
295
|
**Phase 6 (Verification)**:
|
|
296
|
+
|
|
260
297
|
- Focus: System-level behavior (end-to-end flows work), performance comparison
|
|
261
298
|
- Tests: Full test suite + integration tests + E2E tests
|
|
262
299
|
|
|
263
300
|
### Risk Profile
|
|
264
301
|
|
|
265
302
|
**High Risk**:
|
|
303
|
+
|
|
266
304
|
- **Risk**: System-wide breakage, performance degradation, complex rollback
|
|
267
305
|
- **Mitigation**: Strangler fig pattern, incremental component migration, dual-run
|
|
268
306
|
- **Rollback**: Moderate to complex (depends on how well old/new coexist)
|
|
269
307
|
|
|
270
308
|
**Special Patterns**:
|
|
309
|
+
|
|
271
310
|
- **Strangler Fig**: Gradually replace old system with new (route traffic to new incrementally)
|
|
272
311
|
- **Branch by Abstraction**: Create abstraction layer, switch implementations behind it
|
|
273
312
|
- **Parallel Run**: Run old and new architectures in parallel, compare results
|
|
@@ -281,6 +320,7 @@ Different types require different:
|
|
|
281
320
|
**What**: Migrations that don't fit cleanly into Code/Data/Architecture, or mix multiple types
|
|
282
321
|
|
|
283
322
|
**Characteristics**:
|
|
323
|
+
|
|
284
324
|
- Ambiguous description ("modernize", "refactor" without specifics)
|
|
285
325
|
- Multiple aspects (code + data + architecture)
|
|
286
326
|
- Catch-all for unclear migrations
|
|
@@ -294,11 +334,13 @@ Different types require different:
|
|
|
294
334
|
### Workflow Adaptations
|
|
295
335
|
|
|
296
336
|
**Phase 1-2 (Analysis + Planning)**:
|
|
337
|
+
|
|
297
338
|
- Spend extra time clarifying scope
|
|
298
339
|
- Prompt user to specify what's changing (code, data, architecture, or all)
|
|
299
340
|
- May reclassify after analysis
|
|
300
341
|
|
|
301
342
|
**General Approach**:
|
|
343
|
+
|
|
302
344
|
- Use conservative defaults (high risk, incremental + rollback + dual-run)
|
|
303
345
|
- Prompt user more frequently for decisions
|
|
304
346
|
- Extra verification steps
|
|
@@ -316,6 +358,7 @@ Migration type detection uses keyword matching with confidence scoring.
|
|
|
316
358
|
**Input**: `"Migrate from Vue 2 to Vue 3"`
|
|
317
359
|
|
|
318
360
|
**Steps**:
|
|
361
|
+
|
|
319
362
|
1. **Extract Keywords**: `["migrate", "Vue", "2", "3"]`
|
|
320
363
|
2. **Match Against Patterns**:
|
|
321
364
|
- Code: `["Vue"]` → 1 match
|
|
@@ -331,6 +374,7 @@ Migration type detection uses keyword matching with confidence scoring.
|
|
|
331
374
|
### Keyword Categories
|
|
332
375
|
|
|
333
376
|
**Code Migration Keywords**:
|
|
377
|
+
|
|
334
378
|
```
|
|
335
379
|
Frameworks: React, Vue, Angular, Express, Flask, Django, Rails, Spring, Laravel
|
|
336
380
|
Languages: Python, Java, JavaScript, TypeScript, Go, Rust, C++, C#, Ruby, PHP
|
|
@@ -338,12 +382,14 @@ Terms: "upgrade", "migrate from X to Y", "version", "framework migration"
|
|
|
338
382
|
```
|
|
339
383
|
|
|
340
384
|
**Data Migration Keywords**:
|
|
385
|
+
|
|
341
386
|
```
|
|
342
387
|
Databases: MySQL, PostgreSQL, MongoDB, Redis, DynamoDB, Cassandra, Oracle, SQL Server
|
|
343
388
|
Terms: "database", "schema", "data migration", "move data", "storage", "S3", "blob"
|
|
344
389
|
```
|
|
345
390
|
|
|
346
391
|
**Architecture Migration Keywords**:
|
|
392
|
+
|
|
347
393
|
```
|
|
348
394
|
Patterns: REST, GraphQL, gRPC, SOAP, Monolith, Microservices, Serverless, Event-Driven
|
|
349
395
|
Terms: "refactor to", "architecture", "pattern", "system design", "restructure"
|
|
@@ -352,24 +398,26 @@ Terms: "refactor to", "architecture", "pattern", "system design", "restructure"
|
|
|
352
398
|
### Ambiguity Handling
|
|
353
399
|
|
|
354
400
|
**Multiple Matches** (e.g., "Migrate MySQL database to PostgreSQL and refactor to microservices"):
|
|
401
|
+
|
|
355
402
|
- Scores: Code=0, Data=2 ("MySQL", "PostgreSQL"), Architecture=1 ("microservices")
|
|
356
403
|
- Primary Type: Data (highest score)
|
|
357
404
|
- Classification: Data + Architecture (mixed)
|
|
358
405
|
- Prompt user: "Detected primary type: Data. Also includes architecture changes. Proceed as data migration? [Y/n/specify]"
|
|
359
406
|
|
|
360
407
|
**No Clear Matches** (e.g., "Modernize application"):
|
|
408
|
+
|
|
361
409
|
- Scores: Code=0, Data=0, Architecture=0
|
|
362
410
|
- Classification: General
|
|
363
411
|
- Prompt user: "Unable to detect migration type. Please specify: [Code/Data/Architecture/Mixed]"
|
|
364
412
|
|
|
365
413
|
### Confidence Levels
|
|
366
414
|
|
|
367
|
-
| Score
|
|
368
|
-
|
|
369
|
-
| Single category with matches
|
|
370
|
-
| Primary category (>50% of matches) | 70-90%
|
|
371
|
-
| Tied categories
|
|
372
|
-
| No matches
|
|
415
|
+
| Score | Confidence | Action |
|
|
416
|
+
| ---------------------------------- | ---------- | ----------------------------------- |
|
|
417
|
+
| Single category with matches | 100% | Auto-detect, confirm in interactive |
|
|
418
|
+
| Primary category (>50% of matches) | 70-90% | Auto-detect, prompt to confirm |
|
|
419
|
+
| Tied categories | 50% | Prompt user to choose |
|
|
420
|
+
| No matches | 0% | Classify as General, prompt user |
|
|
373
421
|
|
|
374
422
|
---
|
|
375
423
|
|
|
@@ -377,14 +425,14 @@ Terms: "refactor to", "architecture", "pattern", "system design", "restructure"
|
|
|
377
425
|
|
|
378
426
|
External research is automatically triggered by the gap-analyzer during Phase 2 (Target State Planning). The level of research depends on migration type.
|
|
379
427
|
|
|
380
|
-
| Migration Type
|
|
381
|
-
|
|
382
|
-
| **Code** (Version Upgrade) | **Required**
|
|
383
|
-
| **Code** (Library Swap)
|
|
384
|
-
| **Data** (Platform Change) | **Recommended**
|
|
385
|
-
| **Data** (Schema Change)
|
|
386
|
-
| **Architecture**
|
|
387
|
-
| **General**
|
|
428
|
+
| Migration Type | External Research | Query Focus | Priority Sources |
|
|
429
|
+
| -------------------------- | ----------------- | ------------------------------------------------- | ------------------------------------------------- |
|
|
430
|
+
| **Code** (Version Upgrade) | **Required** | Migration guides, breaking changes, API changes | Official docs, release notes, upgrade guides |
|
|
431
|
+
| **Code** (Library Swap) | **Required** | Comparison guides, migration paths, compatibility | Official docs, community migration stories |
|
|
432
|
+
| **Data** (Platform Change) | **Recommended** | Compatibility, data transformation, tooling | Official docs, DBA resources, cloud provider docs |
|
|
433
|
+
| **Data** (Schema Change) | **Optional** | Best practices only | Internal docs preferred |
|
|
434
|
+
| **Architecture** | **Recommended** | Pattern implementation, migration strategies | Architecture blogs, official docs |
|
|
435
|
+
| **General** | **Optional** | Clarification research | N/A |
|
|
388
436
|
|
|
389
437
|
### When to Skip External Research
|
|
390
438
|
|
|
@@ -396,26 +444,29 @@ External research is automatically triggered by the gap-analyzer during Phase 2
|
|
|
396
444
|
|
|
397
445
|
### Research Depth by Complexity
|
|
398
446
|
|
|
399
|
-
| Complexity
|
|
400
|
-
|
|
401
|
-
| Simple (<10 files)
|
|
402
|
-
| Moderate (10-30 files)
|
|
403
|
-
| Complex (>30 files)
|
|
404
|
-
| Data migration (any size) | Expanded
|
|
447
|
+
| Complexity | Research Depth | Queries | Focus |
|
|
448
|
+
| ------------------------- | -------------- | ------- | ------------------------------------------------ |
|
|
449
|
+
| Simple (<10 files) | Essential | 2-3 | Official migration guide only |
|
|
450
|
+
| Moderate (10-30 files) | Essential | 2-3 | Migration guide + breaking changes |
|
|
451
|
+
| Complex (>30 files) | Expanded | 4-6 | Guide + breaking changes + community experiences |
|
|
452
|
+
| Data migration (any size) | Expanded | 4-6 | Guide + compatibility + data transformation |
|
|
405
453
|
|
|
406
454
|
### Example Research Queries
|
|
407
455
|
|
|
408
456
|
**Code Migration (Vue 2 → Vue 3)**:
|
|
457
|
+
|
|
409
458
|
- Primary: "Vue 2 to Vue 3 migration guide"
|
|
410
459
|
- Secondary: "Vue 3 breaking changes 2024"
|
|
411
460
|
- Expanded: "Vue 3 composition API migration examples"
|
|
412
461
|
|
|
413
462
|
**Data Migration (MySQL → PostgreSQL)**:
|
|
463
|
+
|
|
414
464
|
- Primary: "MySQL to PostgreSQL migration guide"
|
|
415
465
|
- Secondary: "PostgreSQL migration tools 2024"
|
|
416
466
|
- Expanded: "MySQL PostgreSQL syntax differences"
|
|
417
467
|
|
|
418
468
|
**Architecture Migration (REST → GraphQL)**:
|
|
469
|
+
|
|
419
470
|
- Primary: "REST to GraphQL migration guide"
|
|
420
471
|
- Secondary: "GraphQL migration best practices"
|
|
421
472
|
- Expanded: "REST GraphQL coexistence patterns"
|
|
@@ -425,12 +476,14 @@ External research is automatically triggered by the gap-analyzer during Phase 2
|
|
|
425
476
|
## Summary
|
|
426
477
|
|
|
427
478
|
**Key Takeaways**:
|
|
479
|
+
|
|
428
480
|
1. **Code**: Focus on functional equivalence, incremental migration, medium risk
|
|
429
481
|
2. **Data**: Focus on data integrity, dual-run often required, high risk
|
|
430
482
|
3. **Architecture**: Focus on system-level behavior, strangler fig pattern, high risk
|
|
431
483
|
4. **General**: Conservative defaults, extra clarification with user
|
|
432
484
|
|
|
433
485
|
**References in SKILL.md**:
|
|
486
|
+
|
|
434
487
|
- Initialization (Step 2): Type detection algorithm
|
|
435
488
|
- Phase 1 (Analysis): Type-specific analysis focus
|
|
436
489
|
- Phase 2 (Target Planning): Type-specific gap analysis + external research
|
|
@@ -168,6 +168,12 @@ question - "Performance analysis complete. [N] bottlenecks identified ([P0 count
|
|
|
168
168
|
|
|
169
169
|
**SELF-CHECK**: Did you just invoke the Task tool with `specification-creator`? Or did you start writing spec.md yourself? If the latter, STOP and invoke the Task tool.
|
|
170
170
|
|
|
171
|
+
**Part C — Diagram Refinement (Skill, content-preserving)**:
|
|
172
|
+
|
|
173
|
+
5. Invoke Skill tool: `diagrams-mermaid` to refine `implementation/spec.md`
|
|
174
|
+
6. Add diagrams that clarify bottleneck flows and optimization boundaries without replacing specification text.
|
|
175
|
+
7. If context for a diagram is missing, document gaps and avoid speculative dependencies.
|
|
176
|
+
|
|
171
177
|
→ Pause
|
|
172
178
|
|
|
173
179
|
question - Display executive summary before asking. Read `implementation/spec.md` and extract: optimization targets, approach chosen, number of changes planned, expected impact. Format as brief overview then "Continue to specification audit?"
|
|
@@ -217,6 +223,12 @@ question - Display executive summary before asking. Read `verification/spec-audi
|
|
|
217
223
|
|
|
218
224
|
**SELF-CHECK**: Did you just invoke the Task tool with `implementation-planner`? Or did you start writing the plan yourself? If the latter, STOP and invoke the Task tool.
|
|
219
225
|
|
|
226
|
+
**Post-plan diagram refinement (Skill, content-preserving)**:
|
|
227
|
+
|
|
228
|
+
- Invoke Skill tool: `diagrams-mermaid` for `implementation/implementation-plan.md`
|
|
229
|
+
- Add one compact optimization execution flow (task-group dependency or state flow).
|
|
230
|
+
- Keep plan steps authoritative; diagrams are explanatory additions only.
|
|
231
|
+
|
|
220
232
|
→ Pause
|
|
221
233
|
|
|
222
234
|
question - Display executive summary before asking. Read `implementation/implementation-plan.md` and extract: number of task groups, total steps, key dependencies, optimization sequence. Format as brief overview then "Continue to implementation?"
|
|
@@ -120,7 +120,7 @@ Use question:
|
|
|
120
120
|
|
|
121
121
|
### Step 4: Enter Planning Mode
|
|
122
122
|
|
|
123
|
-
**Use the `
|
|
123
|
+
**Use the `Plan Agent` to present the fix plan for user approval.**
|
|
124
124
|
|
|
125
125
|
Standards context from Step 2 and analysis from Step 3 MUST inform the plan.
|
|
126
126
|
|
|
@@ -151,9 +151,9 @@ If no standards exist: "No AI SDLC standards found. Consider running `/flow-init
|
|
|
151
151
|
- [ ] [Guideline from standard file] (from `standards/[path]`)
|
|
152
152
|
```
|
|
153
153
|
|
|
154
|
-
###
|
|
154
|
+
### User approval gate: Mandatory Sections
|
|
155
155
|
|
|
156
|
-
**BLOCKING: Do NOT
|
|
156
|
+
**BLOCKING: Do NOT ask for user approval until the plan file contains:**
|
|
157
157
|
|
|
158
158
|
1. **"## Bug Analysis"** — root cause hypothesis with evidence
|
|
159
159
|
2. **"## Proposed Fix"** — what changes and why
|
|
@@ -161,7 +161,7 @@ If no standards exist: "No AI SDLC standards found. Consider running `/flow-init
|
|
|
161
161
|
4. **"## Applicable Standards"** — standards read and key guidelines
|
|
162
162
|
5. **"## Standards Compliance Checklist"** — checkboxes for applicable guidelines
|
|
163
163
|
|
|
164
|
-
If any section is missing, add it before
|
|
164
|
+
If any section is missing, add it before asking for user approval.
|
|
165
165
|
|
|
166
166
|
### Step 5: TDD Red Gate
|
|
167
167
|
|
|
@@ -326,6 +326,14 @@ question - "Brainstorming complete. Continue to high-level design?"
|
|
|
326
326
|
- Key decision highlights (1 line each)
|
|
327
327
|
- Integration points with existing system (if applicable)
|
|
328
328
|
|
|
329
|
+
**Part D — Diagram Refinement (Skill, content-preserving)**:
|
|
330
|
+
|
|
331
|
+
5. Invoke Skill tool: `diagrams-mermaid` to refine visual communication in `outputs/high-level-design.md`
|
|
332
|
+
6. Add diagrams that supplement (not replace) existing architecture content:
|
|
333
|
+
- one architecture view (`C4Container` preferred, `C4Component` only if needed),
|
|
334
|
+
- one interaction/state view (`sequenceDiagram` or `flowchart`) for the critical flow.
|
|
335
|
+
7. If minimum context for a diagram is missing, record explicit gaps in the document and avoid speculative components/relationships.
|
|
336
|
+
|
|
329
337
|
→ Pause
|
|
330
338
|
|
|
331
339
|
question - "Design complete. Continue to output generation?"
|
|
@@ -12,7 +12,7 @@ Find and parse documentation files, extract explicitly stated standards, return
|
|
|
12
12
|
2. **CONTRIBUTING.md** — PR requirements, commit conventions, testing requirements, code review standards
|
|
13
13
|
3. **ARCHITECTURE.md** / `docs/architecture/` — Design patterns, architectural decisions
|
|
14
14
|
4. **ADRs** (Architecture Decision Records) — `adr/`, `decisions/`, `docs/decisions/` directories
|
|
15
|
-
5. **AGENTS.md** /
|
|
15
|
+
5. **AGENTS.md** / `AGENTS.md` — AI-specific coding instructions and project conventions
|
|
16
16
|
6. **Code of Conduct**, **STYLEGUIDE.md** — If present
|
|
17
17
|
|
|
18
18
|
## What to Extract
|
package/package.json
CHANGED
/package/dist/skills/docs-manager/references/{claude-md-template.md → agents-md-template.md}
RENAMED
|
File without changes
|