@forwardimpact/pathway 0.3.0 → 0.5.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/app/commands/agent.js +1 -1
- package/app/commands/behaviour.js +1 -1
- package/app/commands/command-factory.js +2 -2
- package/app/commands/discipline.js +1 -1
- package/app/commands/driver.js +1 -1
- package/app/commands/grade.js +1 -1
- package/app/commands/index.js +4 -3
- package/app/commands/serve.js +2 -2
- package/app/commands/site.js +22 -2
- package/app/commands/skill.js +57 -3
- package/app/commands/stage.js +1 -1
- package/app/commands/tool.js +112 -0
- package/app/commands/track.js +1 -1
- package/app/components/card.js +11 -1
- package/app/components/checklist.js +6 -4
- package/app/components/code-display.js +153 -0
- package/app/components/markdown-textarea.js +153 -0
- package/app/css/bundles/app.css +14 -0
- package/app/css/components/badges.css +15 -8
- package/app/css/components/forms.css +55 -0
- package/app/css/components/layout.css +12 -0
- package/app/css/components/surfaces.css +71 -3
- package/app/css/components/typography.css +1 -2
- package/app/css/pages/agent-builder.css +11 -102
- package/app/css/pages/detail.css +60 -0
- package/app/css/pages/job-builder.css +0 -42
- package/app/css/tokens.css +3 -0
- package/app/formatters/agent/dom.js +26 -71
- package/app/formatters/agent/profile.js +67 -10
- package/app/formatters/agent/skill.js +48 -6
- package/app/formatters/grade/dom.js +6 -6
- package/app/formatters/job/description.js +21 -16
- package/app/formatters/job/dom.js +9 -70
- package/app/formatters/json-ld.js +1 -1
- package/app/formatters/shared.js +58 -0
- package/app/formatters/skill/dom.js +70 -3
- package/app/formatters/skill/markdown.js +18 -0
- package/app/formatters/skill/shared.js +14 -4
- package/app/formatters/stage/microdata.js +2 -2
- package/app/formatters/stage/shared.js +3 -3
- package/app/formatters/tool/shared.js +78 -0
- package/app/handout-main.js +19 -18
- package/app/index.html +16 -3
- package/app/lib/card-mappers.js +91 -17
- package/app/lib/render.js +4 -0
- package/app/lib/yaml-loader.js +12 -1
- package/app/main.js +4 -0
- package/app/model/agent.js +47 -23
- package/app/model/checklist.js +2 -2
- package/app/model/derivation.js +5 -5
- package/app/model/levels.js +4 -2
- package/app/model/loader.js +12 -1
- package/app/model/validation.js +77 -11
- package/app/pages/agent-builder.js +121 -77
- package/app/pages/landing.js +35 -15
- package/app/pages/self-assessment.js +7 -5
- package/app/pages/skill.js +5 -17
- package/app/pages/stage.js +12 -8
- package/app/pages/tool.js +50 -0
- package/app/slide-main.js +1 -1
- package/app/slides/chapter.js +8 -8
- package/app/slides/index.js +26 -26
- package/app/slides/overview.js +8 -8
- package/app/slides/skill.js +1 -0
- package/bin/pathway.js +31 -16
- package/examples/capabilities/business.yaml +18 -18
- package/examples/capabilities/delivery.yaml +54 -37
- package/examples/capabilities/people.yaml +1 -1
- package/examples/capabilities/reliability.yaml +130 -115
- package/examples/capabilities/scale.yaml +39 -37
- package/examples/disciplines/engineering_management.yaml +1 -1
- package/examples/framework.yaml +21 -9
- package/examples/grades.yaml +5 -7
- package/examples/self-assessments.yaml +1 -1
- package/examples/stages.yaml +18 -10
- package/package.json +2 -1
- package/templates/agent.template.md +47 -17
- package/templates/job.template.md +8 -8
- package/templates/skill.template.md +33 -11
- package/examples/agents/.claude/skills/architecture-design/SKILL.md +0 -130
- package/examples/agents/.claude/skills/cloud-platforms/SKILL.md +0 -131
- package/examples/agents/.claude/skills/code-quality-review/SKILL.md +0 -108
- package/examples/agents/.claude/skills/devops-cicd/SKILL.md +0 -142
- package/examples/agents/.claude/skills/full-stack-development/SKILL.md +0 -134
- package/examples/agents/.claude/skills/sre-practices/SKILL.md +0 -163
- package/examples/agents/.claude/skills/technical-debt-management/SKILL.md +0 -164
- package/examples/agents/.github/agents/se-platform-code.agent.md +0 -132
- package/examples/agents/.github/agents/se-platform-plan.agent.md +0 -131
- package/examples/agents/.github/agents/se-platform-review.agent.md +0 -136
- package/examples/agents/.vscode/settings.json +0 -8
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: code-quality-review
|
|
3
|
-
description: |
|
|
4
|
-
Guide for reviewing code quality, identifying issues, and suggesting
|
|
5
|
-
improvements. Use when asked to review code, check for best practices,
|
|
6
|
-
or conduct code reviews.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Code Quality & Review
|
|
10
|
-
|
|
11
|
-
## Stage Guidance
|
|
12
|
-
|
|
13
|
-
### Plan Stage
|
|
14
|
-
|
|
15
|
-
**Focus:** Understand code review scope and establish review criteria. Consider
|
|
16
|
-
what quality standards apply.
|
|
17
|
-
|
|
18
|
-
**Activities:**
|
|
19
|
-
|
|
20
|
-
- Identify code review scope
|
|
21
|
-
- Understand applicable standards
|
|
22
|
-
- Plan review approach
|
|
23
|
-
- Consider risk level
|
|
24
|
-
|
|
25
|
-
**Ready for Code when:**
|
|
26
|
-
|
|
27
|
-
- [ ] Review scope is clear
|
|
28
|
-
- [ ] Standards are understood
|
|
29
|
-
- [ ] Review approach is planned
|
|
30
|
-
- [ ] Risk level is assessed
|
|
31
|
-
|
|
32
|
-
### Code Stage
|
|
33
|
-
|
|
34
|
-
**Focus:** Write clean, maintainable, tested code. Follow project conventions
|
|
35
|
-
and ensure adequate coverage.
|
|
36
|
-
|
|
37
|
-
**Activities:**
|
|
38
|
-
|
|
39
|
-
- Write readable, well-structured code
|
|
40
|
-
- Add appropriate tests
|
|
41
|
-
- Follow project conventions
|
|
42
|
-
- Document non-obvious logic
|
|
43
|
-
|
|
44
|
-
**Ready for Review when:**
|
|
45
|
-
|
|
46
|
-
- [ ] Code compiles and passes all tests
|
|
47
|
-
- [ ] Changes are covered by tests
|
|
48
|
-
- [ ] Code follows project conventions
|
|
49
|
-
- [ ] No unnecessary complexity
|
|
50
|
-
|
|
51
|
-
### Review Stage
|
|
52
|
-
|
|
53
|
-
**Focus:** Verify correctness, maintainability, and adherence to standards.
|
|
54
|
-
Ensure no code is shipped that isn't understood.
|
|
55
|
-
|
|
56
|
-
**Activities:**
|
|
57
|
-
|
|
58
|
-
- Verify code does what it claims
|
|
59
|
-
- Check test coverage
|
|
60
|
-
- Review for maintainability
|
|
61
|
-
- Confirm style compliance
|
|
62
|
-
|
|
63
|
-
**Ready for Complete when:**
|
|
64
|
-
|
|
65
|
-
- [ ] No obvious security vulnerabilities
|
|
66
|
-
- [ ] Error handling is appropriate
|
|
67
|
-
- [ ] Documentation updated if needed
|
|
68
|
-
- [ ] No code you don't fully understand
|
|
69
|
-
|
|
70
|
-
## Reference
|
|
71
|
-
|
|
72
|
-
## Review Process
|
|
73
|
-
|
|
74
|
-
### 1. Correctness First
|
|
75
|
-
|
|
76
|
-
Before anything else, verify the code does what it claims:
|
|
77
|
-
|
|
78
|
-
- Does it implement the intended behavior?
|
|
79
|
-
- Are there logic errors or off-by-one bugs?
|
|
80
|
-
- Does it handle all specified requirements?
|
|
81
|
-
- Are error conditions handled appropriately?
|
|
82
|
-
|
|
83
|
-
### 2. Test Coverage
|
|
84
|
-
|
|
85
|
-
Check that changes are properly tested:
|
|
86
|
-
|
|
87
|
-
- Unit tests for new functionality
|
|
88
|
-
- Edge cases and error conditions
|
|
89
|
-
- Integration tests where appropriate
|
|
90
|
-
- Tests are readable and maintainable
|
|
91
|
-
|
|
92
|
-
### 3. Maintainability
|
|
93
|
-
|
|
94
|
-
Evaluate long-term code health:
|
|
95
|
-
|
|
96
|
-
- Clear naming (variables, functions, classes)
|
|
97
|
-
- Appropriate abstraction levels
|
|
98
|
-
- No unnecessary duplication (DRY)
|
|
99
|
-
- Single responsibility principle applied
|
|
100
|
-
|
|
101
|
-
### 4. Code Style
|
|
102
|
-
|
|
103
|
-
Verify consistency with project standards:
|
|
104
|
-
|
|
105
|
-
- Follows project coding conventions
|
|
106
|
-
- Consistent formatting and indentation
|
|
107
|
-
- Appropriate comments for non-obvious logic
|
|
108
|
-
- Documentation updated if needed
|
|
@@ -1,142 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: devops-cicd
|
|
3
|
-
description: |
|
|
4
|
-
Guide for building CI/CD pipelines, managing infrastructure as code, and
|
|
5
|
-
implementing deployment best practices. Use when setting up pipelines,
|
|
6
|
-
containerizing applications, or configuring infrastructure.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# DevOps & CI/CD
|
|
10
|
-
|
|
11
|
-
## Stage Guidance
|
|
12
|
-
|
|
13
|
-
### Plan Stage
|
|
14
|
-
|
|
15
|
-
**Focus:** Plan CI/CD pipeline architecture and infrastructure requirements.
|
|
16
|
-
Consider deployment strategies and monitoring needs.
|
|
17
|
-
|
|
18
|
-
**Activities:**
|
|
19
|
-
|
|
20
|
-
- Define pipeline stages (build, test, deploy)
|
|
21
|
-
- Identify infrastructure requirements
|
|
22
|
-
- Plan deployment strategy (rolling, blue-green, canary)
|
|
23
|
-
- Consider monitoring and alerting needs
|
|
24
|
-
- Plan secret management approach
|
|
25
|
-
|
|
26
|
-
**Ready for Code when:**
|
|
27
|
-
|
|
28
|
-
- [ ] Pipeline architecture is documented
|
|
29
|
-
- [ ] Deployment strategy is chosen and justified
|
|
30
|
-
- [ ] Infrastructure requirements are identified
|
|
31
|
-
- [ ] Monitoring approach is defined
|
|
32
|
-
|
|
33
|
-
### Code Stage
|
|
34
|
-
|
|
35
|
-
**Focus:** Implement CI/CD pipelines and infrastructure as code. Follow best
|
|
36
|
-
practices for containerization and deployment automation.
|
|
37
|
-
|
|
38
|
-
**Activities:**
|
|
39
|
-
|
|
40
|
-
- Configure CI/CD pipeline stages
|
|
41
|
-
- Implement infrastructure as code (Terraform, CloudFormation)
|
|
42
|
-
- Create Dockerfiles with security best practices
|
|
43
|
-
- Set up monitoring and alerting
|
|
44
|
-
- Configure secret management
|
|
45
|
-
- Implement deployment automation
|
|
46
|
-
|
|
47
|
-
**Ready for Review when:**
|
|
48
|
-
|
|
49
|
-
- [ ] Pipeline runs on every commit
|
|
50
|
-
- [ ] Tests run before deployment
|
|
51
|
-
- [ ] Deployments are automated
|
|
52
|
-
- [ ] Infrastructure is version controlled
|
|
53
|
-
- [ ] Secrets are managed securely
|
|
54
|
-
- [ ] Monitoring is in place
|
|
55
|
-
|
|
56
|
-
### Review Stage
|
|
57
|
-
|
|
58
|
-
**Focus:** Verify pipeline reliability, security, and operational readiness.
|
|
59
|
-
Ensure rollback procedures work and documentation is complete.
|
|
60
|
-
|
|
61
|
-
**Activities:**
|
|
62
|
-
|
|
63
|
-
- Verify pipeline runs successfully end-to-end
|
|
64
|
-
- Test rollback procedures
|
|
65
|
-
- Review security configurations
|
|
66
|
-
- Validate monitoring and alerts
|
|
67
|
-
- Check documentation completeness
|
|
68
|
-
|
|
69
|
-
**Ready for Complete when:**
|
|
70
|
-
|
|
71
|
-
- [ ] Pipeline is tested and reliable
|
|
72
|
-
- [ ] Rollback procedure is documented and tested
|
|
73
|
-
- [ ] Alerts are configured and tested
|
|
74
|
-
- [ ] Runbooks exist for common issues
|
|
75
|
-
|
|
76
|
-
## Reference
|
|
77
|
-
|
|
78
|
-
## CI/CD Pipeline Stages
|
|
79
|
-
|
|
80
|
-
### Build
|
|
81
|
-
|
|
82
|
-
- Install dependencies
|
|
83
|
-
- Compile/transpile code
|
|
84
|
-
- Generate artifacts
|
|
85
|
-
- Cache dependencies for speed
|
|
86
|
-
|
|
87
|
-
### Test
|
|
88
|
-
|
|
89
|
-
- Run unit tests
|
|
90
|
-
- Run integration tests
|
|
91
|
-
- Static analysis and linting
|
|
92
|
-
- Security scanning
|
|
93
|
-
|
|
94
|
-
### Deploy
|
|
95
|
-
|
|
96
|
-
- Deploy to staging environment
|
|
97
|
-
- Run smoke tests
|
|
98
|
-
- Deploy to production
|
|
99
|
-
- Verify deployment health
|
|
100
|
-
|
|
101
|
-
## Infrastructure as Code
|
|
102
|
-
|
|
103
|
-
### Terraform
|
|
104
|
-
|
|
105
|
-
```hcl
|
|
106
|
-
# Define resources declaratively
|
|
107
|
-
resource "aws_instance" "example" {
|
|
108
|
-
ami = "ami-0c55b159cbfafe1f0"
|
|
109
|
-
instance_type = "t2.micro"
|
|
110
|
-
}
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### Docker
|
|
114
|
-
|
|
115
|
-
```dockerfile
|
|
116
|
-
FROM node:18-alpine
|
|
117
|
-
WORKDIR /app
|
|
118
|
-
COPY package*.json ./
|
|
119
|
-
RUN npm ci --only=production
|
|
120
|
-
COPY . .
|
|
121
|
-
CMD ["node", "server.js"]
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
## Deployment Strategies
|
|
125
|
-
|
|
126
|
-
### Rolling Deployment
|
|
127
|
-
|
|
128
|
-
- Gradual replacement of instances
|
|
129
|
-
- Zero downtime
|
|
130
|
-
- Easy rollback
|
|
131
|
-
|
|
132
|
-
### Blue-Green Deployment
|
|
133
|
-
|
|
134
|
-
- Two identical environments
|
|
135
|
-
- Switch traffic atomically
|
|
136
|
-
- Fast rollback
|
|
137
|
-
|
|
138
|
-
### Canary Deployment
|
|
139
|
-
|
|
140
|
-
- Route small percentage to new version
|
|
141
|
-
- Monitor for issues
|
|
142
|
-
- Gradually increase traffic
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: full-stack-development
|
|
3
|
-
description: |
|
|
4
|
-
Guide for building complete solutions across the full technology stack.
|
|
5
|
-
Use when asked to implement features spanning frontend, backend, database,
|
|
6
|
-
and infrastructure layers.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Full-Stack Development
|
|
10
|
-
|
|
11
|
-
## Stage Guidance
|
|
12
|
-
|
|
13
|
-
### Plan Stage
|
|
14
|
-
|
|
15
|
-
**Focus:** Design the full-stack solution architecture. Define API contracts and
|
|
16
|
-
plan layer interactions.
|
|
17
|
-
|
|
18
|
-
**Activities:**
|
|
19
|
-
|
|
20
|
-
- Define the API contract first
|
|
21
|
-
- Plan frontend and backend responsibilities
|
|
22
|
-
- Design database schema
|
|
23
|
-
- Plan infrastructure requirements
|
|
24
|
-
|
|
25
|
-
**Ready for Code when:**
|
|
26
|
-
|
|
27
|
-
- [ ] API contract is defined
|
|
28
|
-
- [ ] Layer responsibilities are clear
|
|
29
|
-
- [ ] Database schema is planned
|
|
30
|
-
- [ ] Infrastructure approach is decided
|
|
31
|
-
|
|
32
|
-
### Code Stage
|
|
33
|
-
|
|
34
|
-
**Focus:** Build vertically—complete one feature end-to-end before starting
|
|
35
|
-
another. Validates assumptions early.
|
|
36
|
-
|
|
37
|
-
**Activities:**
|
|
38
|
-
|
|
39
|
-
- Implement API endpoints
|
|
40
|
-
- Build frontend integration
|
|
41
|
-
- Create database schema and queries
|
|
42
|
-
- Configure infrastructure as needed
|
|
43
|
-
- Test across layers
|
|
44
|
-
|
|
45
|
-
**Ready for Review when:**
|
|
46
|
-
|
|
47
|
-
- [ ] Frontend connects to backend correctly
|
|
48
|
-
- [ ] Database schema supports the feature
|
|
49
|
-
- [ ] Error handling spans all layers
|
|
50
|
-
- [ ] Feature works end-to-end
|
|
51
|
-
- [ ] Deployment is automated
|
|
52
|
-
|
|
53
|
-
### Review Stage
|
|
54
|
-
|
|
55
|
-
**Focus:** Verify integration across layers and ensure deployment readiness.
|
|
56
|
-
|
|
57
|
-
**Activities:**
|
|
58
|
-
|
|
59
|
-
- Test integration across all layers
|
|
60
|
-
- Verify error handling end-to-end
|
|
61
|
-
- Check deployment configuration
|
|
62
|
-
- Review documentation
|
|
63
|
-
|
|
64
|
-
**Ready for Complete when:**
|
|
65
|
-
|
|
66
|
-
- [ ] Integration tests pass
|
|
67
|
-
- [ ] Deployment verified
|
|
68
|
-
- [ ] Documentation is complete
|
|
69
|
-
- [ ] Feature is production-ready
|
|
70
|
-
|
|
71
|
-
## Reference
|
|
72
|
-
|
|
73
|
-
## Technology Stack
|
|
74
|
-
|
|
75
|
-
### Primary Languages
|
|
76
|
-
|
|
77
|
-
- **JavaScript/TypeScript**: Frontend and Node.js backend
|
|
78
|
-
- **Python**: Backend APIs and data processing
|
|
79
|
-
|
|
80
|
-
### Infrastructure
|
|
81
|
-
|
|
82
|
-
- **Terraform**: Cloud infrastructure as code
|
|
83
|
-
- **CloudFormation**: AWS-specific infrastructure
|
|
84
|
-
- **Docker**: Containerization
|
|
85
|
-
|
|
86
|
-
## Layer Responsibilities
|
|
87
|
-
|
|
88
|
-
### Frontend
|
|
89
|
-
|
|
90
|
-
- User interface and experience
|
|
91
|
-
- Client-side validation
|
|
92
|
-
- API integration
|
|
93
|
-
- State management
|
|
94
|
-
|
|
95
|
-
### Backend API
|
|
96
|
-
|
|
97
|
-
- Business logic
|
|
98
|
-
- Data validation
|
|
99
|
-
- Authentication/authorization
|
|
100
|
-
- External service integration
|
|
101
|
-
|
|
102
|
-
### Database
|
|
103
|
-
|
|
104
|
-
- Data persistence
|
|
105
|
-
- Query optimization
|
|
106
|
-
- Schema migrations
|
|
107
|
-
- Data integrity
|
|
108
|
-
|
|
109
|
-
### Infrastructure
|
|
110
|
-
|
|
111
|
-
- Deployment pipelines
|
|
112
|
-
- Environment configuration
|
|
113
|
-
- Scaling and reliability
|
|
114
|
-
- Monitoring and logging
|
|
115
|
-
|
|
116
|
-
## Development Process
|
|
117
|
-
|
|
118
|
-
### 1. Start with the Interface
|
|
119
|
-
|
|
120
|
-
- Define the API contract first
|
|
121
|
-
- Frontend and backend can work in parallel
|
|
122
|
-
- Clear interface = fewer integration issues
|
|
123
|
-
|
|
124
|
-
### 2. Build Vertically
|
|
125
|
-
|
|
126
|
-
- Complete one feature end-to-end before starting another
|
|
127
|
-
- Validates assumptions early
|
|
128
|
-
- Delivers demonstrable progress
|
|
129
|
-
|
|
130
|
-
### 3. Test Across Layers
|
|
131
|
-
|
|
132
|
-
- Unit tests per layer
|
|
133
|
-
- Integration tests across layers
|
|
134
|
-
- End-to-end tests for critical paths
|
|
@@ -1,163 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: sre-practices
|
|
3
|
-
description: |
|
|
4
|
-
Guide for ensuring system reliability through observability, incident
|
|
5
|
-
response, and capacity planning. Use when designing monitoring, handling
|
|
6
|
-
incidents, setting SLOs, or improving system resilience.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Site Reliability Engineering
|
|
10
|
-
|
|
11
|
-
## Stage Guidance
|
|
12
|
-
|
|
13
|
-
### Plan Stage
|
|
14
|
-
|
|
15
|
-
**Focus:** Define reliability requirements, SLIs/SLOs, and observability
|
|
16
|
-
strategy. Plan for resilience and capacity needs.
|
|
17
|
-
|
|
18
|
-
**Activities:**
|
|
19
|
-
|
|
20
|
-
- Define SLIs for key user journeys
|
|
21
|
-
- Set SLOs with stakeholder agreement
|
|
22
|
-
- Plan observability strategy (metrics, logs, traces)
|
|
23
|
-
- Identify failure modes and resilience patterns
|
|
24
|
-
- Define alerting thresholds
|
|
25
|
-
|
|
26
|
-
**Ready for Code when:**
|
|
27
|
-
|
|
28
|
-
- [ ] SLIs defined for key user journeys
|
|
29
|
-
- [ ] SLOs set with stakeholder agreement
|
|
30
|
-
- [ ] Monitoring strategy is planned
|
|
31
|
-
- [ ] Failure modes are identified
|
|
32
|
-
- [ ] Alerting thresholds are defined
|
|
33
|
-
|
|
34
|
-
### Code Stage
|
|
35
|
-
|
|
36
|
-
**Focus:** Implement observability, resilience patterns, and operational
|
|
37
|
-
tooling. Build systems that fail gracefully and recover quickly.
|
|
38
|
-
|
|
39
|
-
**Activities:**
|
|
40
|
-
|
|
41
|
-
- Implement metrics, logging, and tracing
|
|
42
|
-
- Configure alerts based on SLOs
|
|
43
|
-
- Implement resilience patterns (timeouts, retries, circuit breakers)
|
|
44
|
-
- Create runbooks for common issues
|
|
45
|
-
- Set up error budget tracking
|
|
46
|
-
|
|
47
|
-
**Ready for Review when:**
|
|
48
|
-
|
|
49
|
-
- [ ] Comprehensive monitoring is in place
|
|
50
|
-
- [ ] Alerts are actionable and low-noise
|
|
51
|
-
- [ ] Resilience patterns are implemented
|
|
52
|
-
- [ ] Runbooks exist for common issues
|
|
53
|
-
- [ ] Error budget tracking is in place
|
|
54
|
-
|
|
55
|
-
### Review Stage
|
|
56
|
-
|
|
57
|
-
**Focus:** Verify reliability implementation meets SLOs and operational
|
|
58
|
-
readiness. Ensure incident response procedures are in place.
|
|
59
|
-
|
|
60
|
-
**Activities:**
|
|
61
|
-
|
|
62
|
-
- Validate SLOs are measurable
|
|
63
|
-
- Test failure scenarios
|
|
64
|
-
- Review runbook completeness
|
|
65
|
-
- Verify incident response procedures
|
|
66
|
-
- Check alert quality and coverage
|
|
67
|
-
|
|
68
|
-
**Ready for Complete when:**
|
|
69
|
-
|
|
70
|
-
- [ ] SLOs are measurable and validated
|
|
71
|
-
- [ ] Failure scenarios are tested
|
|
72
|
-
- [ ] Incident response process documented
|
|
73
|
-
- [ ] Post-mortem culture established
|
|
74
|
-
- [ ] Disaster recovery approach is tested
|
|
75
|
-
|
|
76
|
-
## Reference
|
|
77
|
-
|
|
78
|
-
## Service Level Concepts
|
|
79
|
-
|
|
80
|
-
### SLI (Service Level Indicator)
|
|
81
|
-
|
|
82
|
-
Quantitative measure of service behavior:
|
|
83
|
-
|
|
84
|
-
- Request latency (p50, p95, p99)
|
|
85
|
-
- Error rate (% of failed requests)
|
|
86
|
-
- Availability (% of successful requests)
|
|
87
|
-
- Throughput (requests per second)
|
|
88
|
-
|
|
89
|
-
### SLO (Service Level Objective)
|
|
90
|
-
|
|
91
|
-
Target value for an SLI:
|
|
92
|
-
|
|
93
|
-
- "99.9% of requests complete in < 200ms"
|
|
94
|
-
- "Error rate < 0.1% over 30 days"
|
|
95
|
-
- "99.95% availability monthly"
|
|
96
|
-
|
|
97
|
-
### Error Budget
|
|
98
|
-
|
|
99
|
-
Allowed unreliability: 100% - SLO
|
|
100
|
-
|
|
101
|
-
- 99.9% SLO = 0.1% error budget
|
|
102
|
-
- ~43 minutes downtime per month
|
|
103
|
-
- Spend on features or reliability
|
|
104
|
-
|
|
105
|
-
## Observability
|
|
106
|
-
|
|
107
|
-
### Three Pillars
|
|
108
|
-
|
|
109
|
-
- **Metrics**: Aggregated numeric data (counters, gauges, histograms)
|
|
110
|
-
- **Logs**: Discrete event records with context
|
|
111
|
-
- **Traces**: Request flow across services
|
|
112
|
-
|
|
113
|
-
### Alerting Principles
|
|
114
|
-
|
|
115
|
-
- Alert on symptoms, not causes
|
|
116
|
-
- Every alert should be actionable
|
|
117
|
-
- Reduce noise ruthlessly
|
|
118
|
-
- Page only for user-impacting issues
|
|
119
|
-
- Use severity levels appropriately
|
|
120
|
-
|
|
121
|
-
## Incident Response
|
|
122
|
-
|
|
123
|
-
### Incident Lifecycle
|
|
124
|
-
|
|
125
|
-
1. **Detection**: Automated alerts or user reports
|
|
126
|
-
2. **Triage**: Assess severity and impact
|
|
127
|
-
3. **Mitigation**: Stop the bleeding first
|
|
128
|
-
4. **Resolution**: Fix the underlying issue
|
|
129
|
-
5. **Post-mortem**: Learn and improve
|
|
130
|
-
|
|
131
|
-
### During an Incident
|
|
132
|
-
|
|
133
|
-
- Communicate early and often
|
|
134
|
-
- Focus on mitigation before root cause
|
|
135
|
-
- Document actions in real-time
|
|
136
|
-
- Escalate when needed
|
|
137
|
-
- Update stakeholders regularly
|
|
138
|
-
|
|
139
|
-
## Post-Mortem Process
|
|
140
|
-
|
|
141
|
-
### Blameless Culture
|
|
142
|
-
|
|
143
|
-
- Focus on systems, not individuals
|
|
144
|
-
- Assume good intentions
|
|
145
|
-
- Ask "how did the system allow this?"
|
|
146
|
-
- Share findings openly
|
|
147
|
-
|
|
148
|
-
### Post-Mortem Template
|
|
149
|
-
|
|
150
|
-
1. Incident summary
|
|
151
|
-
2. Timeline of events
|
|
152
|
-
3. Root cause analysis
|
|
153
|
-
4. What went well
|
|
154
|
-
5. What could be improved
|
|
155
|
-
6. Action items with owners
|
|
156
|
-
|
|
157
|
-
## Resilience Patterns
|
|
158
|
-
|
|
159
|
-
- **Timeouts**: Don't wait forever
|
|
160
|
-
- **Retries**: With exponential backoff
|
|
161
|
-
- **Circuit breakers**: Fail fast when downstream is unhealthy
|
|
162
|
-
- **Bulkheads**: Isolate failures
|
|
163
|
-
- **Graceful degradation**: Partial functionality over total failure
|
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: technical-debt-management
|
|
3
|
-
description: |
|
|
4
|
-
Guide for identifying, prioritizing, and addressing technical debt. Use
|
|
5
|
-
when assessing code quality issues, planning refactoring work, or making
|
|
6
|
-
build vs fix decisions.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Technical Debt Management
|
|
10
|
-
|
|
11
|
-
## Stage Guidance
|
|
12
|
-
|
|
13
|
-
### Plan Stage
|
|
14
|
-
|
|
15
|
-
**Focus:** Assess technical debt and prioritize based on impact and effort.
|
|
16
|
-
Decide whether to accept, defer, or address debt.
|
|
17
|
-
|
|
18
|
-
**Activities:**
|
|
19
|
-
|
|
20
|
-
- Identify and document technical debt
|
|
21
|
-
- Assess impact and effort for each item
|
|
22
|
-
- Prioritize using impact/effort matrix
|
|
23
|
-
- Decide accept, defer, or address
|
|
24
|
-
|
|
25
|
-
**Ready for Code when:**
|
|
26
|
-
|
|
27
|
-
- [ ] Debt is documented with context
|
|
28
|
-
- [ ] Impact and effort are assessed
|
|
29
|
-
- [ ] Prioritization criteria are clear
|
|
30
|
-
- [ ] Decision is documented
|
|
31
|
-
|
|
32
|
-
### Code Stage
|
|
33
|
-
|
|
34
|
-
**Focus:** Address debt incrementally while delivering features. Document
|
|
35
|
-
intentional debt clearly.
|
|
36
|
-
|
|
37
|
-
**Activities:**
|
|
38
|
-
|
|
39
|
-
- Apply Boy Scout Rule (leave code better)
|
|
40
|
-
- Refactor while adding features
|
|
41
|
-
- Document new intentional debt
|
|
42
|
-
- Track debt in backlog
|
|
43
|
-
|
|
44
|
-
**Ready for Review when:**
|
|
45
|
-
|
|
46
|
-
- [ ] Debt work is visible in planning
|
|
47
|
-
- [ ] New debt is intentional and documented
|
|
48
|
-
- [ ] Code quality improved where touched
|
|
49
|
-
- [ ] Technical debt backlog updated
|
|
50
|
-
|
|
51
|
-
### Review Stage
|
|
52
|
-
|
|
53
|
-
**Focus:** Validate debt reduction and ensure new debt is intentional and
|
|
54
|
-
documented.
|
|
55
|
-
|
|
56
|
-
**Activities:**
|
|
57
|
-
|
|
58
|
-
- Review debt reduction progress
|
|
59
|
-
- Verify new debt is documented
|
|
60
|
-
- Check debt backlog currency
|
|
61
|
-
- Assess overall technical health
|
|
62
|
-
|
|
63
|
-
**Ready for Complete when:**
|
|
64
|
-
|
|
65
|
-
- [ ] Debt reduction validated
|
|
66
|
-
- [ ] New debt justified and documented
|
|
67
|
-
- [ ] Backlog is current
|
|
68
|
-
- [ ] Metrics track debt trends
|
|
69
|
-
|
|
70
|
-
## Reference
|
|
71
|
-
|
|
72
|
-
## Types of Technical Debt
|
|
73
|
-
|
|
74
|
-
### Code Debt
|
|
75
|
-
|
|
76
|
-
- Duplicated code (DRY violations)
|
|
77
|
-
- Complex, hard-to-understand code
|
|
78
|
-
- Missing or inadequate tests
|
|
79
|
-
- Inconsistent coding patterns
|
|
80
|
-
- Dead or unused code
|
|
81
|
-
|
|
82
|
-
### Architecture Debt
|
|
83
|
-
|
|
84
|
-
- Tight coupling between components
|
|
85
|
-
- Missing abstractions
|
|
86
|
-
- Inappropriate technology choices
|
|
87
|
-
- Scalability limitations
|
|
88
|
-
- Security vulnerabilities
|
|
89
|
-
|
|
90
|
-
### Dependency Debt
|
|
91
|
-
|
|
92
|
-
- Outdated libraries and frameworks
|
|
93
|
-
- Unsupported dependencies
|
|
94
|
-
- Version conflicts
|
|
95
|
-
- License compliance issues
|
|
96
|
-
|
|
97
|
-
### Documentation Debt
|
|
98
|
-
|
|
99
|
-
- Missing or outdated docs
|
|
100
|
-
- Undocumented APIs
|
|
101
|
-
- Tribal knowledge not captured
|
|
102
|
-
- Stale comments in code
|
|
103
|
-
|
|
104
|
-
## Debt Assessment
|
|
105
|
-
|
|
106
|
-
### Impact Dimensions
|
|
107
|
-
|
|
108
|
-
- **Velocity**: How much does it slow development?
|
|
109
|
-
- **Risk**: What could go wrong?
|
|
110
|
-
- **Scope**: How much code is affected?
|
|
111
|
-
- **Effort**: How hard is it to fix?
|
|
112
|
-
|
|
113
|
-
### Prioritization Matrix
|
|
114
|
-
|
|
115
|
-
| Impact | Effort | Priority |
|
|
116
|
-
| ------ | ------ | -------------- |
|
|
117
|
-
| High | Low | Do first |
|
|
118
|
-
| High | High | Plan carefully |
|
|
119
|
-
| Low | Low | Quick wins |
|
|
120
|
-
| Low | High | Defer |
|
|
121
|
-
|
|
122
|
-
## Strategic Debt Decisions
|
|
123
|
-
|
|
124
|
-
### When to Accept Debt
|
|
125
|
-
|
|
126
|
-
- Time-to-market is critical
|
|
127
|
-
- Requirements are uncertain
|
|
128
|
-
- Short-lived code (prototypes, experiments)
|
|
129
|
-
- Clear plan to address later
|
|
130
|
-
- Business value justifies risk
|
|
131
|
-
|
|
132
|
-
### When to Avoid Debt
|
|
133
|
-
|
|
134
|
-
- Core system components
|
|
135
|
-
- Security-sensitive code
|
|
136
|
-
- High-change-frequency areas
|
|
137
|
-
- No plan to address later
|
|
138
|
-
- Debt compounds existing issues
|
|
139
|
-
|
|
140
|
-
## Debt Reduction Strategies
|
|
141
|
-
|
|
142
|
-
### Incremental Improvement
|
|
143
|
-
|
|
144
|
-
- Boy Scout Rule: Leave code better than you found it
|
|
145
|
-
- Refactor while adding features
|
|
146
|
-
- Small, continuous improvements
|
|
147
|
-
- Low risk, steady progress
|
|
148
|
-
|
|
149
|
-
### Dedicated Investment
|
|
150
|
-
|
|
151
|
-
- Scheduled refactoring sprints
|
|
152
|
-
- Tech debt percentage in each sprint
|
|
153
|
-
- Major rewrites when justified
|
|
154
|
-
- Higher risk, larger improvements
|
|
155
|
-
|
|
156
|
-
## Documentation Template
|
|
157
|
-
|
|
158
|
-
For each debt item:
|
|
159
|
-
|
|
160
|
-
- **Description**: What is the debt?
|
|
161
|
-
- **Impact**: How does it affect us?
|
|
162
|
-
- **Effort**: How hard to fix (T-shirt size)?
|
|
163
|
-
- **Owner**: Who can address it?
|
|
164
|
-
- **Plan**: When/how will it be fixed?
|