@stillrivercode/information-dense-keywords
Version:
Information Dense Keywords Dictionary - A curated vocabulary for instructing AI assistants
486 lines (320 loc) • 13.9 kB
Markdown
# Real-World Scenarios
This document presents detailed, realistic scenarios showing how the Information Dense Keywords Dictionary commands are used in actual software development situations.
## Scenario 1: E-commerce Platform Performance Crisis
**Context**: Online store experiencing slow page loads during Black Friday traffic
### Initial Problem Discovery
```bash
analyze this website performance during high traffic periods
```bash
**AI Response** (following analyze-this.md format):
```markdown
# Analysis Report: E-commerce Performance During High Traffic
## Summary of Findings
Website response times increased from 200ms to 8+ seconds during peak traffic. Database queries and image loading are primary bottlenecks.
## Potential Issues
### Performance
- Database connection pool exhaustion (99% utilization)
- Unoptimized product image loading (2MB+ images)
- Missing database indexes on search queries
- Frontend bundle size causing render blocking (1.5MB JS)
### Architecture
- Single database instance handling all reads/writes
- No CDN implementation for static assets
- Synchronous processing blocking user requests
## Actionable Recommendations
### High Priority
- Implement connection pooling and read replicas
- Add CDN for image and static asset delivery
- Optimize database indexes for search functionality
### Medium Priority
- Implement lazy loading for product images
- Split frontend bundles for faster initial load
- Add Redis caching layer for frequently accessed data
```bash
### Deep Dive Investigation
```bash
debug this database connection pool exhaustion then research this database scaling patterns
```bash
**Chain Execution**:
1. **Debug Investigation**: Found connection leaks in payment processing service
2. **Research Results**: Identified read replica and connection pooling solutions
### Solution Implementation
```bash
spec this database scaling solution then plan this performance optimization implementation
```bash
**Specification Created**: Comprehensive database scaling plan with read replicas, connection pooling, and caching strategy
**Implementation Plan**: 3-phase rollout over 2 weeks with monitoring and rollback procedures
### Validation and Documentation
```bash
test this performance improvements then document this optimization guide
```bash
**Outcome**: Page load times reduced to 300ms under peak load, system stability improved 99.9%
## Scenario 2: Security Vulnerability Discovery
**Context**: Security researcher reports potential SQL injection in user search functionality
### Initial Security Assessment
```bash
analyze this user search functionality for security vulnerabilities
```bash
**AI Response**:
```markdown
# Analysis Report: User Search Security
## Summary of Findings
Critical SQL injection vulnerability found in product search with potential for data breach.
## Potential Issues
### Security (Critical)
- SQL injection in search parameter (line 45, search.php)
- Missing input sanitization on user queries
- Direct database query construction with user input
- No rate limiting on search endpoint
### Architecture (High)
- Search functionality bypasses ORM safety features
- Admin search interface uses same vulnerable code path
- Error messages reveal database schema information
## Actionable Recommendations
### High Priority (Immediate)
- Implement parameterized queries for all search functions
- Add input validation and sanitization
- Implement rate limiting on search endpoints
```bash
### Vulnerability Investigation
```bash
debug this SQL injection vulnerability then research this secure coding practices for search functionality
```bash
**Debug Results**: Confirmed injection point and assessed potential data exposure scope
**Research Findings**: Industry best practices for secure search implementation
### Security Hardening Plan
```bash
spec this security remediation plan then plan this security patches deployment
```bash
**Security Specification**: Comprehensive security hardening with input validation, parameterized queries, and monitoring
### Implementation and Validation
```bash
FIX this SQL injection vulnerability then test this security measures then review this security implementation
```bash
**Outcome**: Vulnerability patched within 4 hours, no data breach occurred, comprehensive security audit completed
## Scenario 3: Legacy System Modernization
**Context**: 10-year-old PHP monolith needs migration to microservices architecture
### System Analysis Phase
```bash
analyze this legacy monolith architecture then research this microservices migration patterns
```bash
**Analysis Results**: Identified 15 major components, database dependencies, and integration points
**Research Findings**: Strangler Fig pattern recommended for gradual migration
### Planning and Specification
```bash
spec this microservices migration strategy then plan this legacy system modernization
```bash
**Migration Specification**:
- 18-month timeline with 5 phases
- Service boundaries defined by business domains
- Data migration strategy with zero downtime
- API gateway implementation plan
### Implementation Approach
```bash
CREATE migration assessment tools then test this service extraction process
```bash
**Tools Created**:
- Dependency analyzer for service boundaries
- Database migration scripts with rollback
- API compatibility testing suite
### Execution and Monitoring
```bash
document this migration procedures then review this modernization progress
```bash
**Outcome**: Successfully migrated 3 services in first phase, 40% performance improvement, reduced deployment time from 2 hours to 15 minutes
## Scenario 4: New Developer Onboarding
**Context**: Junior developer joining team needs to understand complex authentication system
### Knowledge Transfer Process
```bash
SELECT the authentication system components then explain this OAuth2 implementation
```bash
**Code Selection**: Identified 8 key files across auth service, middleware, and frontend integration
**Explanation Provided**:
```markdown
# Explanation: OAuth2 Authentication System
## What It Is
Enterprise-grade authentication using OAuth2 with JWT tokens, supporting SSO and multi-tenant access.
## How It Works
### Step-by-Step Breakdown
1. **User Login**: Redirects to identity provider (Auth0)
2. **Token Exchange**: Receives authorization code and exchanges for JWT
3. **Token Validation**: Middleware validates JWT on each request
4. **Permission Check**: Role-based access control validates permissions
## Why It's Used
- Centralized authentication across multiple applications
- Industry-standard security practices
- Support for single sign-on (SSO)
- Scalable multi-tenant architecture
```bash
### Hands-On Learning
```bash
CREATE simple authentication example then test this authentication flow then document this learning process
```bash
**Learning Project**: Built simplified auth example with clear comments and tests
**Outcome**: New developer productive in authentication-related tasks within 3 days instead of typical 2 weeks
## Scenario 5: Production Data Pipeline Failure
**Context**: Daily ETL pipeline failing, affecting business intelligence dashboards
### Incident Response
```bash
debug this ETL pipeline failure then analyze this data processing errors
```bash
**Debug Results**:
- Pipeline failing at data transformation step
- Memory exhaustion processing large CSV files
- Data format changes from upstream API breaking parser
**Analysis Findings**:
- Need for streaming processing instead of batch loading
- Missing data validation causing parser crashes
- No monitoring alerts for pipeline health
### Solution Development
```bash
research this streaming data processing patterns then spec this pipeline redesign
```bash
**Research Results**: Identified Apache Kafka and stream processing solutions
**Pipeline Specification**: Event-driven architecture with real-time processing and error handling
### Implementation and Recovery
```bash
CREATE pipeline monitoring system then plan this data pipeline migration then test this recovery procedures
```bash
**Recovery Plan**:
- Immediate fix for current pipeline
- Gradual migration to streaming architecture
- Comprehensive monitoring and alerting
**Outcome**: Pipeline restored in 6 hours, new architecture prevents similar failures, 99.5% uptime achieved
## Scenario 6: Mobile App API Integration
**Context**: Mobile team needs new API endpoints for social features
### Requirements Analysis
```bash
research this mobile API best practices then spec this social features API
```bash
**Research Results**: RESTful design with GraphQL for flexible data fetching, offline support patterns
**API Specification**:
```markdown
# Technical Specification: Social Features API
## Overview
REST API with GraphQL endpoint for mobile social features including friends, posts, and real-time messaging.
## Requirements
### Functional Requirements
- Friend connection management
- Social post creation and discovery
- Real-time messaging with push notifications
- Offline data synchronization
### Non-functional Requirements
- Sub-200ms response times for social feeds
- Support for 10K concurrent users
- 99.9% uptime during peak usage
```bash
### Development Process
```bash
CREATE social API endpoints then test this mobile integration then document this API usage
```bash
**Implementation**:
- RESTful endpoints with GraphQL overlay
- WebSocket connections for real-time features
- Comprehensive OpenAPI documentation
### Quality Assurance
```bash
review this API security then optimize this API performance
```bash
**Security Review**: OAuth2 scopes, rate limiting, data validation implemented
**Performance Optimization**: Response caching, database query optimization, CDN integration
**Outcome**: API delivered on time, mobile app features launched successfully with 95% user satisfaction
## Scenario 7: Automated Testing Implementation
**Context**: Team needs comprehensive test coverage for microservices architecture
### Testing Strategy Development
```bash
analyze this current test coverage then research this microservices testing patterns
```bash
**Coverage Analysis**:
- Unit tests: 45% coverage
- Integration tests: Limited API testing only
- E2E tests: Manual testing only
- No contract testing between services
**Research Results**: Test pyramid with contract testing, service virtualization, and chaos engineering
### Test Suite Design
```bash
spec this testing strategy then plan this test automation implementation
```bash
**Testing Specification**:
- Unit tests targeting 80%+ coverage
- Contract testing with Pact for service boundaries
- Integration testing with test containers
- E2E testing with Cypress for critical user journeys
### Implementation and Execution
```bash
CREATE automated test suites then test this testing infrastructure then review this test effectiveness
```bash
**Test Infrastructure**:
- Parallel test execution reducing runtime by 70%
- Automated test data management
- Integration with CI/CD pipeline
- Test reporting dashboard
**Outcome**: Test coverage increased to 85%, bug detection improved by 60%, deployment confidence significantly increased
## Scenario 8: Database Migration Challenge
**Context**: Migrating from PostgreSQL to distributed database for scalability
### Migration Planning
```bash
analyze this current database architecture then research this distributed database options
```bash
**Architecture Analysis**:
- Single PostgreSQL instance at capacity
- Complex foreign key relationships
- Heavy read workload during business hours
- Critical uptime requirements (99.99%)
**Database Research**: Evaluated CockroachDB, MongoDB, and Cassandra options
### Migration Strategy
```bash
spec this database migration plan then plan this zero-downtime migration
```bash
**Migration Specification**:
- Dual-write strategy during transition
- Data validation and consistency checks
- Rollback procedures at each stage
- Performance benchmarking throughout
### Execution and Validation
```bash
CREATE migration scripts then test this data consistency then optimize this query performance
```bash
**Migration Tools**:
- Custom data replication utilities
- Automated consistency checking
- Performance monitoring dashboards
- Query optimization analysis
**Outcome**: Successful migration with zero downtime, 300% performance improvement, supports 10x user growth
## Cross-Scenario Patterns
### Common Command Sequences
**Investigation Pattern**:
```bash
analyze this → debug this → research this → spec this
```bash
**Implementation Pattern**:
```bash
spec this → plan this → CREATE → test this → review this
```bash
**Quality Assurance Pattern**:
```bash
test this → review this → optimize this → document this
```bash
**Crisis Response Pattern**:
```bash
debug this → FIX this → test this → document this
```bash
### Success Factors
1. **Systematic Approach**: Following command sequences ensures thorough coverage
2. **Documentation**: Each scenario produces artifacts for future reference
3. **Quality Gates**: Review and testing steps prevent issues in production
4. **Knowledge Sharing**: Documentation enables team learning and replication
### Lessons Learned
- **Start with Analysis**: Understanding the problem deeply before implementing solutions
- **Chain Commands Logically**: Each command output informs the next step
- **Include Quality Steps**: Testing and review prevent costly mistakes
- **Document Everything**: Future teams benefit from detailed scenario documentation
These real-world scenarios demonstrate how the IDK commands create structured, repeatable approaches to complex software development challenges, resulting in better outcomes and team learning.