omgkit 2.9.0 → 2.10.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/README.md +48 -1
- package/lib/cli.js +3 -1
- package/package.json +1 -1
- package/plugin/workflows/ai-engineering/agent-development.md +240 -0
- package/plugin/workflows/ai-engineering/fine-tuning.md +212 -0
- package/plugin/workflows/ai-engineering/model-evaluation.md +203 -0
- package/plugin/workflows/ai-engineering/prompt-engineering.md +192 -0
- package/plugin/workflows/ai-engineering/rag-development.md +203 -0
- package/plugin/workflows/api/api-design.md +152 -0
- package/plugin/workflows/api/api-testing.md +152 -0
- package/plugin/workflows/content/marketing.md +118 -0
- package/plugin/workflows/content/technical-docs.md +146 -0
- package/plugin/workflows/database/migration.md +153 -0
- package/plugin/workflows/database/optimization.md +136 -0
- package/plugin/workflows/database/schema-design.md +148 -0
- package/plugin/workflows/development/bug-fix.md +159 -0
- package/plugin/workflows/development/code-review.md +119 -0
- package/plugin/workflows/development/feature.md +171 -0
- package/plugin/workflows/development/refactor.md +155 -0
- package/plugin/workflows/fullstack/authentication.md +153 -0
- package/plugin/workflows/fullstack/full-feature.md +217 -0
- package/plugin/workflows/omega/1000x-innovation.md +167 -0
- package/plugin/workflows/omega/100x-architecture.md +150 -0
- package/plugin/workflows/omega/10x-improvement.md +228 -0
- package/plugin/workflows/quality/performance-optimization.md +157 -0
- package/plugin/workflows/research/best-practices.md +140 -0
- package/plugin/workflows/research/technology-research.md +130 -0
- package/plugin/workflows/security/penetration-testing.md +150 -0
- package/plugin/workflows/security/security-audit.md +176 -0
- package/plugin/workflows/sprint/sprint-execution.md +168 -0
- package/plugin/workflows/sprint/sprint-retrospective.md +168 -0
- package/plugin/workflows/sprint/sprint-setup.md +153 -0
- package/templates/CLAUDE.md +84 -0
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: api-design
|
|
3
|
+
description: Design RESTful or GraphQL APIs
|
|
4
|
+
category: api
|
|
5
|
+
complexity: medium
|
|
6
|
+
estimated-time: 2-6 hours
|
|
7
|
+
agents:
|
|
8
|
+
- api-designer
|
|
9
|
+
- planner
|
|
10
|
+
- docs-manager
|
|
11
|
+
- code-reviewer
|
|
12
|
+
skills:
|
|
13
|
+
- api-architecture
|
|
14
|
+
commands:
|
|
15
|
+
- /planning:plan
|
|
16
|
+
- /quality:api-gen
|
|
17
|
+
- /planning:doc
|
|
18
|
+
- /dev:review
|
|
19
|
+
prerequisites:
|
|
20
|
+
- API requirements defined
|
|
21
|
+
- Technology stack selected
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
# API Design Workflow
|
|
25
|
+
|
|
26
|
+
## Overview
|
|
27
|
+
|
|
28
|
+
The API Design workflow guides you through designing well-structured, documented, and consistent APIs following REST or GraphQL best practices.
|
|
29
|
+
|
|
30
|
+
## When to Use
|
|
31
|
+
|
|
32
|
+
- Creating new APIs
|
|
33
|
+
- Redesigning existing APIs
|
|
34
|
+
- Adding API endpoints
|
|
35
|
+
- Standardizing API patterns
|
|
36
|
+
|
|
37
|
+
## Steps
|
|
38
|
+
|
|
39
|
+
### Step 1: Requirements Analysis
|
|
40
|
+
**Agent:** planner
|
|
41
|
+
**Command:** `/planning:plan "API requirements"`
|
|
42
|
+
**Duration:** 30-60 minutes
|
|
43
|
+
|
|
44
|
+
Analyze requirements:
|
|
45
|
+
- Identify resources
|
|
46
|
+
- Define operations
|
|
47
|
+
- Specify data models
|
|
48
|
+
- Document constraints
|
|
49
|
+
|
|
50
|
+
**Output:** API requirements
|
|
51
|
+
|
|
52
|
+
### Step 2: API Design
|
|
53
|
+
**Agent:** api-designer
|
|
54
|
+
**Duration:** 1-2 hours
|
|
55
|
+
|
|
56
|
+
Design API:
|
|
57
|
+
- Resource design
|
|
58
|
+
- Endpoint structure
|
|
59
|
+
- Request/response formats
|
|
60
|
+
- Error handling
|
|
61
|
+
|
|
62
|
+
**Output:** API design document
|
|
63
|
+
|
|
64
|
+
### Step 3: OpenAPI Specification
|
|
65
|
+
**Agent:** api-designer
|
|
66
|
+
**Command:** `/quality:api-gen`
|
|
67
|
+
**Duration:** 30-60 minutes
|
|
68
|
+
|
|
69
|
+
Create specification:
|
|
70
|
+
- OpenAPI/Swagger spec
|
|
71
|
+
- Schema definitions
|
|
72
|
+
- Security schemes
|
|
73
|
+
- Example payloads
|
|
74
|
+
|
|
75
|
+
**Output:** OpenAPI spec
|
|
76
|
+
|
|
77
|
+
### Step 4: Design Review
|
|
78
|
+
**Agent:** code-reviewer
|
|
79
|
+
**Command:** `/dev:review`
|
|
80
|
+
**Duration:** 30-60 minutes
|
|
81
|
+
|
|
82
|
+
Review design:
|
|
83
|
+
- Consistency check
|
|
84
|
+
- Best practices
|
|
85
|
+
- Security review
|
|
86
|
+
- Performance considerations
|
|
87
|
+
|
|
88
|
+
**Output:** Review feedback
|
|
89
|
+
|
|
90
|
+
### Step 5: Documentation
|
|
91
|
+
**Agent:** docs-manager
|
|
92
|
+
**Command:** `/planning:doc`
|
|
93
|
+
**Duration:** 30-60 minutes
|
|
94
|
+
|
|
95
|
+
Generate docs:
|
|
96
|
+
- API reference
|
|
97
|
+
- Authentication guide
|
|
98
|
+
- Code examples
|
|
99
|
+
- Rate limits
|
|
100
|
+
|
|
101
|
+
**Output:** API documentation
|
|
102
|
+
|
|
103
|
+
### Step 6: Implementation Guidance
|
|
104
|
+
**Agent:** api-designer
|
|
105
|
+
**Duration:** 30-60 minutes
|
|
106
|
+
|
|
107
|
+
Create guidance:
|
|
108
|
+
- Implementation notes
|
|
109
|
+
- Testing strategy
|
|
110
|
+
- Versioning plan
|
|
111
|
+
- Deprecation policy
|
|
112
|
+
|
|
113
|
+
**Output:** Implementation guide
|
|
114
|
+
|
|
115
|
+
## Quality Gates
|
|
116
|
+
|
|
117
|
+
- [ ] Requirements documented
|
|
118
|
+
- [ ] API designed per standards
|
|
119
|
+
- [ ] OpenAPI spec complete
|
|
120
|
+
- [ ] Design reviewed
|
|
121
|
+
- [ ] Documentation generated
|
|
122
|
+
- [ ] Implementation guide ready
|
|
123
|
+
|
|
124
|
+
## REST Design Principles
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
REST API Best Practices
|
|
128
|
+
=======================
|
|
129
|
+
- Use nouns for resources
|
|
130
|
+
- HTTP verbs for actions
|
|
131
|
+
- Consistent naming
|
|
132
|
+
- Proper status codes
|
|
133
|
+
- HATEOAS where applicable
|
|
134
|
+
- Versioning strategy
|
|
135
|
+
- Pagination for lists
|
|
136
|
+
- Filtering and sorting
|
|
137
|
+
- Rate limiting
|
|
138
|
+
- Authentication/Authorization
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Example Usage
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
/workflow:api-design "user management API with CRUD and search"
|
|
145
|
+
/workflow:api-design "payment processing API with webhooks"
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Related Workflows
|
|
149
|
+
|
|
150
|
+
- `api-testing` - For testing APIs
|
|
151
|
+
- `full-feature` - For implementation
|
|
152
|
+
- `technical-docs` - For documentation
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: api-testing
|
|
3
|
+
description: Comprehensive API testing
|
|
4
|
+
category: api
|
|
5
|
+
complexity: medium
|
|
6
|
+
estimated-time: 2-6 hours
|
|
7
|
+
agents:
|
|
8
|
+
- tester
|
|
9
|
+
- security-auditor
|
|
10
|
+
skills:
|
|
11
|
+
- api-architecture
|
|
12
|
+
- owasp
|
|
13
|
+
commands:
|
|
14
|
+
- /dev:test
|
|
15
|
+
- /quality:security-scan
|
|
16
|
+
prerequisites:
|
|
17
|
+
- API implemented
|
|
18
|
+
- Test environment ready
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# API Testing Workflow
|
|
22
|
+
|
|
23
|
+
## Overview
|
|
24
|
+
|
|
25
|
+
The API Testing workflow ensures comprehensive testing of APIs including functional, security, and performance testing.
|
|
26
|
+
|
|
27
|
+
## When to Use
|
|
28
|
+
|
|
29
|
+
- After API implementation
|
|
30
|
+
- Before releases
|
|
31
|
+
- Regression testing
|
|
32
|
+
- Performance validation
|
|
33
|
+
|
|
34
|
+
## Steps
|
|
35
|
+
|
|
36
|
+
### Step 1: Test Planning
|
|
37
|
+
**Agent:** tester
|
|
38
|
+
**Duration:** 30-60 minutes
|
|
39
|
+
|
|
40
|
+
Plan testing:
|
|
41
|
+
- Identify test cases
|
|
42
|
+
- Define coverage
|
|
43
|
+
- Setup test data
|
|
44
|
+
- Configure environment
|
|
45
|
+
|
|
46
|
+
**Output:** Test plan
|
|
47
|
+
|
|
48
|
+
### Step 2: Unit Testing
|
|
49
|
+
**Agent:** tester
|
|
50
|
+
**Duration:** 1-2 hours
|
|
51
|
+
|
|
52
|
+
Write unit tests:
|
|
53
|
+
- Handler tests
|
|
54
|
+
- Validation tests
|
|
55
|
+
- Business logic tests
|
|
56
|
+
- Error handling tests
|
|
57
|
+
|
|
58
|
+
**Output:** Unit tests
|
|
59
|
+
|
|
60
|
+
### Step 3: Integration Testing
|
|
61
|
+
**Agent:** tester
|
|
62
|
+
**Duration:** 1-2 hours
|
|
63
|
+
|
|
64
|
+
Write integration tests:
|
|
65
|
+
- End-to-end flows
|
|
66
|
+
- Database interactions
|
|
67
|
+
- External service mocks
|
|
68
|
+
- Authentication flows
|
|
69
|
+
|
|
70
|
+
**Output:** Integration tests
|
|
71
|
+
|
|
72
|
+
### Step 4: Security Testing
|
|
73
|
+
**Agent:** security-auditor
|
|
74
|
+
**Command:** `/quality:security-scan`
|
|
75
|
+
**Duration:** 30-60 minutes
|
|
76
|
+
|
|
77
|
+
Security tests:
|
|
78
|
+
- Authentication bypass
|
|
79
|
+
- Authorization checks
|
|
80
|
+
- Input validation
|
|
81
|
+
- Injection attempts
|
|
82
|
+
|
|
83
|
+
**Output:** Security test results
|
|
84
|
+
|
|
85
|
+
### Step 5: Performance Testing
|
|
86
|
+
**Agent:** tester
|
|
87
|
+
**Duration:** 30-60 minutes
|
|
88
|
+
|
|
89
|
+
Performance tests:
|
|
90
|
+
- Load testing
|
|
91
|
+
- Latency benchmarks
|
|
92
|
+
- Throughput tests
|
|
93
|
+
- Resource usage
|
|
94
|
+
|
|
95
|
+
**Output:** Performance report
|
|
96
|
+
|
|
97
|
+
### Step 6: Report Generation
|
|
98
|
+
**Agent:** tester
|
|
99
|
+
**Duration:** 30-60 minutes
|
|
100
|
+
|
|
101
|
+
Generate report:
|
|
102
|
+
- Coverage summary
|
|
103
|
+
- Test results
|
|
104
|
+
- Issues found
|
|
105
|
+
- Recommendations
|
|
106
|
+
|
|
107
|
+
**Output:** Test report
|
|
108
|
+
|
|
109
|
+
## Quality Gates
|
|
110
|
+
|
|
111
|
+
- [ ] Test plan complete
|
|
112
|
+
- [ ] Unit tests passing
|
|
113
|
+
- [ ] Integration tests passing
|
|
114
|
+
- [ ] Security tests passed
|
|
115
|
+
- [ ] Performance acceptable
|
|
116
|
+
- [ ] Report generated
|
|
117
|
+
|
|
118
|
+
## Test Coverage
|
|
119
|
+
|
|
120
|
+
```
|
|
121
|
+
API Test Coverage
|
|
122
|
+
=================
|
|
123
|
+
FUNCTIONAL:
|
|
124
|
+
- Happy path scenarios
|
|
125
|
+
- Error scenarios
|
|
126
|
+
- Edge cases
|
|
127
|
+
- Validation rules
|
|
128
|
+
|
|
129
|
+
SECURITY:
|
|
130
|
+
- Authentication
|
|
131
|
+
- Authorization
|
|
132
|
+
- Input validation
|
|
133
|
+
- Rate limiting
|
|
134
|
+
|
|
135
|
+
PERFORMANCE:
|
|
136
|
+
- Response time
|
|
137
|
+
- Throughput
|
|
138
|
+
- Scalability
|
|
139
|
+
- Resource usage
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Example Usage
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
/workflow:api-testing "user API endpoints"
|
|
146
|
+
/workflow:api-testing "payment API with security focus"
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## Related Workflows
|
|
150
|
+
|
|
151
|
+
- `api-design` - For API design
|
|
152
|
+
- `security-audit` - For security focus
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: marketing
|
|
3
|
+
description: Create marketing content and materials
|
|
4
|
+
category: content
|
|
5
|
+
complexity: low
|
|
6
|
+
estimated-time: 1-4 hours
|
|
7
|
+
agents:
|
|
8
|
+
- copywriter
|
|
9
|
+
- brainstormer
|
|
10
|
+
- researcher
|
|
11
|
+
skills: []
|
|
12
|
+
commands:
|
|
13
|
+
- /planning:brainstorm
|
|
14
|
+
- /planning:research
|
|
15
|
+
prerequisites:
|
|
16
|
+
- Product/feature defined
|
|
17
|
+
- Target audience known
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Marketing Content Workflow
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
The Marketing Content workflow helps create compelling marketing materials including landing page copy, product descriptions, and promotional content.
|
|
25
|
+
|
|
26
|
+
## When to Use
|
|
27
|
+
|
|
28
|
+
- Launching new products
|
|
29
|
+
- Creating landing pages
|
|
30
|
+
- Writing promotional content
|
|
31
|
+
- Developing messaging
|
|
32
|
+
|
|
33
|
+
## Steps
|
|
34
|
+
|
|
35
|
+
### Step 1: Research
|
|
36
|
+
**Agent:** researcher
|
|
37
|
+
**Command:** `/planning:research`
|
|
38
|
+
**Duration:** 30-60 minutes
|
|
39
|
+
|
|
40
|
+
Research phase:
|
|
41
|
+
- Target audience
|
|
42
|
+
- Competitor analysis
|
|
43
|
+
- Market positioning
|
|
44
|
+
- Key messages
|
|
45
|
+
|
|
46
|
+
**Output:** Research findings
|
|
47
|
+
|
|
48
|
+
### Step 2: Ideation
|
|
49
|
+
**Agent:** brainstormer
|
|
50
|
+
**Command:** `/planning:brainstorm`
|
|
51
|
+
**Duration:** 30-60 minutes
|
|
52
|
+
|
|
53
|
+
Generate ideas:
|
|
54
|
+
- Messaging angles
|
|
55
|
+
- Headlines options
|
|
56
|
+
- Value propositions
|
|
57
|
+
- Call-to-actions
|
|
58
|
+
|
|
59
|
+
**Output:** Content ideas
|
|
60
|
+
|
|
61
|
+
### Step 3: Copy Writing
|
|
62
|
+
**Agent:** copywriter
|
|
63
|
+
**Duration:** 1-2 hours
|
|
64
|
+
|
|
65
|
+
Write copy:
|
|
66
|
+
- Headlines
|
|
67
|
+
- Body copy
|
|
68
|
+
- Features/benefits
|
|
69
|
+
- CTAs
|
|
70
|
+
|
|
71
|
+
**Output:** Marketing copy
|
|
72
|
+
|
|
73
|
+
### Step 4: Review
|
|
74
|
+
**Agent:** copywriter
|
|
75
|
+
**Duration:** 30-60 minutes
|
|
76
|
+
|
|
77
|
+
Review and refine:
|
|
78
|
+
- Tone consistency
|
|
79
|
+
- Clarity
|
|
80
|
+
- Persuasiveness
|
|
81
|
+
- Grammar
|
|
82
|
+
|
|
83
|
+
**Output:** Refined copy
|
|
84
|
+
|
|
85
|
+
## Quality Gates
|
|
86
|
+
|
|
87
|
+
- [ ] Audience researched
|
|
88
|
+
- [ ] Ideas generated
|
|
89
|
+
- [ ] Copy written
|
|
90
|
+
- [ ] Copy reviewed
|
|
91
|
+
|
|
92
|
+
## Copy Frameworks
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
Marketing Copy Frameworks
|
|
96
|
+
=========================
|
|
97
|
+
AIDA:
|
|
98
|
+
- Attention: Hook
|
|
99
|
+
- Interest: Benefits
|
|
100
|
+
- Desire: Value
|
|
101
|
+
- Action: CTA
|
|
102
|
+
|
|
103
|
+
PAS:
|
|
104
|
+
- Problem: Pain point
|
|
105
|
+
- Agitate: Emphasize
|
|
106
|
+
- Solution: Your product
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Example Usage
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
/workflow:marketing "product launch landing page"
|
|
113
|
+
/workflow:marketing "feature announcement email"
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Related Workflows
|
|
117
|
+
|
|
118
|
+
- `technical-docs` - For documentation
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: technical-docs
|
|
3
|
+
description: Create comprehensive technical documentation
|
|
4
|
+
category: content
|
|
5
|
+
complexity: medium
|
|
6
|
+
estimated-time: 2-8 hours
|
|
7
|
+
agents:
|
|
8
|
+
- docs-manager
|
|
9
|
+
- architect
|
|
10
|
+
- copywriter
|
|
11
|
+
- code-reviewer
|
|
12
|
+
skills:
|
|
13
|
+
- writing-plans
|
|
14
|
+
commands:
|
|
15
|
+
- /planning:doc
|
|
16
|
+
- /dev:review
|
|
17
|
+
prerequisites:
|
|
18
|
+
- Codebase accessible
|
|
19
|
+
- Documentation scope defined
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# Technical Documentation Workflow
|
|
23
|
+
|
|
24
|
+
## Overview
|
|
25
|
+
|
|
26
|
+
The Technical Documentation workflow helps create comprehensive, well-structured documentation including API references, architecture guides, and tutorials.
|
|
27
|
+
|
|
28
|
+
## When to Use
|
|
29
|
+
|
|
30
|
+
- Documenting new features
|
|
31
|
+
- Creating API references
|
|
32
|
+
- Writing architecture guides
|
|
33
|
+
- Building tutorials
|
|
34
|
+
|
|
35
|
+
## Steps
|
|
36
|
+
|
|
37
|
+
### Step 1: Documentation Planning
|
|
38
|
+
**Agent:** docs-manager
|
|
39
|
+
**Duration:** 30-60 minutes
|
|
40
|
+
|
|
41
|
+
Plan documentation:
|
|
42
|
+
- Define scope
|
|
43
|
+
- Identify audiences
|
|
44
|
+
- Create outline
|
|
45
|
+
- Set standards
|
|
46
|
+
|
|
47
|
+
**Output:** Documentation plan
|
|
48
|
+
|
|
49
|
+
### Step 2: API Documentation
|
|
50
|
+
**Agent:** docs-manager
|
|
51
|
+
**Duration:** 1-2 hours
|
|
52
|
+
|
|
53
|
+
Generate API docs:
|
|
54
|
+
- Extract from code
|
|
55
|
+
- Add descriptions
|
|
56
|
+
- Include examples
|
|
57
|
+
- Document errors
|
|
58
|
+
|
|
59
|
+
**Output:** API reference
|
|
60
|
+
|
|
61
|
+
### Step 3: Architecture Guide
|
|
62
|
+
**Agent:** architect
|
|
63
|
+
**Duration:** 1-2 hours
|
|
64
|
+
|
|
65
|
+
Write architecture:
|
|
66
|
+
- System overview
|
|
67
|
+
- Component diagrams
|
|
68
|
+
- Design decisions
|
|
69
|
+
- Integration points
|
|
70
|
+
|
|
71
|
+
**Output:** Architecture guide
|
|
72
|
+
|
|
73
|
+
### Step 4: Tutorials
|
|
74
|
+
**Agent:** docs-manager
|
|
75
|
+
**Duration:** 1-2 hours
|
|
76
|
+
|
|
77
|
+
Create tutorials:
|
|
78
|
+
- Getting started
|
|
79
|
+
- Step-by-step guides
|
|
80
|
+
- Code examples
|
|
81
|
+
- Common patterns
|
|
82
|
+
|
|
83
|
+
**Output:** Tutorial content
|
|
84
|
+
|
|
85
|
+
### Step 5: Review
|
|
86
|
+
**Agent:** code-reviewer
|
|
87
|
+
**Command:** `/dev:review`
|
|
88
|
+
**Duration:** 30-60 minutes
|
|
89
|
+
|
|
90
|
+
Review documentation:
|
|
91
|
+
- Technical accuracy
|
|
92
|
+
- Completeness
|
|
93
|
+
- Working examples
|
|
94
|
+
- Clarity
|
|
95
|
+
|
|
96
|
+
**Output:** Review feedback
|
|
97
|
+
|
|
98
|
+
### Step 6: Publishing
|
|
99
|
+
**Agent:** docs-manager
|
|
100
|
+
**Duration:** 30-60 minutes
|
|
101
|
+
|
|
102
|
+
Publish docs:
|
|
103
|
+
- Format for platform
|
|
104
|
+
- Add navigation
|
|
105
|
+
- Configure search
|
|
106
|
+
- Deploy
|
|
107
|
+
|
|
108
|
+
**Output:** Published docs
|
|
109
|
+
|
|
110
|
+
## Quality Gates
|
|
111
|
+
|
|
112
|
+
- [ ] Documentation planned
|
|
113
|
+
- [ ] API documented
|
|
114
|
+
- [ ] Architecture explained
|
|
115
|
+
- [ ] Tutorials complete
|
|
116
|
+
- [ ] Review passed
|
|
117
|
+
- [ ] Docs published
|
|
118
|
+
|
|
119
|
+
## Documentation Structure
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
Documentation Structure
|
|
123
|
+
=======================
|
|
124
|
+
docs/
|
|
125
|
+
├── getting-started/
|
|
126
|
+
│ ├── installation.md
|
|
127
|
+
│ └── quickstart.md
|
|
128
|
+
├── guides/
|
|
129
|
+
│ ├── architecture.md
|
|
130
|
+
│ └── tutorials/
|
|
131
|
+
├── api/
|
|
132
|
+
│ └── reference.md
|
|
133
|
+
└── changelog.md
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Example Usage
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
/workflow:technical-docs "API documentation for v2"
|
|
140
|
+
/workflow:technical-docs "developer onboarding guide"
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Related Workflows
|
|
144
|
+
|
|
145
|
+
- `api-design` - For API specs
|
|
146
|
+
- `marketing` - For marketing content
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: migration
|
|
3
|
+
description: Safe database migrations with rollback
|
|
4
|
+
category: database
|
|
5
|
+
complexity: high
|
|
6
|
+
estimated-time: 1-4 hours
|
|
7
|
+
agents:
|
|
8
|
+
- database-admin
|
|
9
|
+
- planner
|
|
10
|
+
- tester
|
|
11
|
+
skills:
|
|
12
|
+
- database-migration
|
|
13
|
+
commands:
|
|
14
|
+
- /planning:plan
|
|
15
|
+
- /dev:test
|
|
16
|
+
prerequisites:
|
|
17
|
+
- Schema changes defined
|
|
18
|
+
- Backup strategy ready
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# Database Migration Workflow
|
|
22
|
+
|
|
23
|
+
## Overview
|
|
24
|
+
|
|
25
|
+
The Database Migration workflow ensures safe, zero-downtime database migrations with proper rollback capabilities.
|
|
26
|
+
|
|
27
|
+
## When to Use
|
|
28
|
+
|
|
29
|
+
- Schema changes required
|
|
30
|
+
- Data transformations
|
|
31
|
+
- Index modifications
|
|
32
|
+
- Constraint updates
|
|
33
|
+
|
|
34
|
+
## Steps
|
|
35
|
+
|
|
36
|
+
### Step 1: Migration Planning
|
|
37
|
+
**Agent:** planner
|
|
38
|
+
**Command:** `/planning:plan "migration"`
|
|
39
|
+
**Duration:** 30-60 minutes
|
|
40
|
+
|
|
41
|
+
Plan migration:
|
|
42
|
+
- Identify changes
|
|
43
|
+
- Assess impact
|
|
44
|
+
- Plan rollback
|
|
45
|
+
- Schedule execution
|
|
46
|
+
|
|
47
|
+
**Output:** Migration plan
|
|
48
|
+
|
|
49
|
+
### Step 2: Backup
|
|
50
|
+
**Agent:** database-admin
|
|
51
|
+
**Duration:** 15-30 minutes
|
|
52
|
+
|
|
53
|
+
Create backup:
|
|
54
|
+
- Full backup
|
|
55
|
+
- Verify backup
|
|
56
|
+
- Document state
|
|
57
|
+
- Test restore
|
|
58
|
+
|
|
59
|
+
**Output:** Backup completed
|
|
60
|
+
|
|
61
|
+
### Step 3: Migration Script
|
|
62
|
+
**Agent:** database-admin
|
|
63
|
+
**Duration:** 30-60 minutes
|
|
64
|
+
|
|
65
|
+
Write migration:
|
|
66
|
+
- Create migration file
|
|
67
|
+
- Write up migration
|
|
68
|
+
- Write down migration
|
|
69
|
+
- Add validation
|
|
70
|
+
|
|
71
|
+
**Output:** Migration script
|
|
72
|
+
|
|
73
|
+
### Step 4: Staging Test
|
|
74
|
+
**Agent:** tester
|
|
75
|
+
**Duration:** 30-60 minutes
|
|
76
|
+
|
|
77
|
+
Test in staging:
|
|
78
|
+
- Run migration
|
|
79
|
+
- Test application
|
|
80
|
+
- Verify data
|
|
81
|
+
- Test rollback
|
|
82
|
+
|
|
83
|
+
**Output:** Staging verified
|
|
84
|
+
|
|
85
|
+
### Step 5: Production Migration
|
|
86
|
+
**Agent:** database-admin
|
|
87
|
+
**Duration:** 15-60 minutes
|
|
88
|
+
|
|
89
|
+
Execute migration:
|
|
90
|
+
- Run migration
|
|
91
|
+
- Monitor progress
|
|
92
|
+
- Verify completion
|
|
93
|
+
- Update status
|
|
94
|
+
|
|
95
|
+
**Output:** Migration complete
|
|
96
|
+
|
|
97
|
+
### Step 6: Verification
|
|
98
|
+
**Agent:** tester
|
|
99
|
+
**Command:** `/dev:test`
|
|
100
|
+
**Duration:** 30-60 minutes
|
|
101
|
+
|
|
102
|
+
Verify migration:
|
|
103
|
+
- Application testing
|
|
104
|
+
- Data integrity
|
|
105
|
+
- Performance check
|
|
106
|
+
- Document completion
|
|
107
|
+
|
|
108
|
+
**Output:** Verification report
|
|
109
|
+
|
|
110
|
+
## Quality Gates
|
|
111
|
+
|
|
112
|
+
- [ ] Migration planned
|
|
113
|
+
- [ ] Backup verified
|
|
114
|
+
- [ ] Rollback tested
|
|
115
|
+
- [ ] Staging validated
|
|
116
|
+
- [ ] Production migrated
|
|
117
|
+
- [ ] Verification passed
|
|
118
|
+
|
|
119
|
+
## Migration Checklist
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
Migration Checklist
|
|
123
|
+
===================
|
|
124
|
+
PRE-MIGRATION:
|
|
125
|
+
[ ] Backup created and verified
|
|
126
|
+
[ ] Rollback script ready
|
|
127
|
+
[ ] Stakeholders notified
|
|
128
|
+
[ ] Maintenance window scheduled
|
|
129
|
+
|
|
130
|
+
MIGRATION:
|
|
131
|
+
[ ] Migration executed
|
|
132
|
+
[ ] Progress monitored
|
|
133
|
+
[ ] Errors handled
|
|
134
|
+
[ ] Completion verified
|
|
135
|
+
|
|
136
|
+
POST-MIGRATION:
|
|
137
|
+
[ ] Application tested
|
|
138
|
+
[ ] Data verified
|
|
139
|
+
[ ] Performance checked
|
|
140
|
+
[ ] Documentation updated
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Example Usage
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
/workflow:migration "add user preferences table"
|
|
147
|
+
/workflow:migration "split orders table for sharding"
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Related Workflows
|
|
151
|
+
|
|
152
|
+
- `schema-design` - For initial design
|
|
153
|
+
- `database-optimization` - For performance
|