UNPKG

@stillrivercode/agentic-workflow-template

Version:

NPM package to create AI-powered GitHub workflow automation projects

277 lines (190 loc) 8.78 kB
# roadmap **Category**: Workflow Commands **Definition**: When a user issues a `roadmap` command, they are asking you to create a strategic development roadmap that outlines the evolution path of a project, feature, or system over time. This command takes in context to understand the current state and generate a roadmap with phases and milestones. ## Example Prompts - `roadmap this project based on the current codebase and requirements` - `roadmap this API development considering these user stories and technical constraints` - `roadmap this migration from monolith to microservices using these architecture docs` ## Expected Output Format ````markdown # Roadmap: [Project/System Name] ## Executive Summary Brief overview of the strategic vision and key transformation goals ## Current State Assessment - **Current Architecture**: Brief description of existing system - **Key Strengths**: What's working well - **Pain Points**: Current limitations and challenges - **Technical Debt**: Areas requiring attention ## Strategic Vision - **Long-term Goals**: Where we want to be in 12-18 months - **Success Metrics**: How success will be measured - **Value Proposition**: Benefits and impact of the roadmap ## Roadmap Phases ### Phase 1: Foundation (Months 1-3) **Theme**: Stabilization and Core Infrastructure #### Objectives - Establish solid foundation for future development - Address critical technical debt - Implement essential tooling and processes #### Key Initiatives 1. **Infrastructure Modernization** (Priority: Critical) - Upgrade core dependencies - Implement CI/CD pipeline - Establish monitoring and observability 2. **Code Quality Improvements** (Priority: High) - Implement linting and formatting standards - Add comprehensive test coverage - Refactor legacy components #### Deliverables - Modernized development environment - Automated testing and deployment pipeline - Improved code quality metrics #### Success Criteria - 90% test coverage achieved - Zero critical security vulnerabilities - Deployment time reduced by 50% ### Phase 2: Enhancement (Months 4-6) **Theme**: Feature Development and User Experience #### Objectives - Deliver high-impact user features - Improve system performance and scalability - Enhance developer experience #### Key Initiatives 1. **User Experience Improvements** (Priority: High) - Redesign core user workflows - Implement responsive design - Add accessibility features 2. **Performance Optimization** (Priority: Medium) - Database query optimization - Caching layer implementation - API response time improvements #### Deliverables - Enhanced user interface - Performance benchmarks met - Developer documentation updated ### Phase 3: Scale (Months 7-12) **Theme**: Growth and Advanced Features #### Objectives - Prepare system for scale - Implement advanced capabilities - Expand integration ecosystem #### Key Initiatives 1. **Scalability Improvements** (Priority: High) - Microservices architecture migration - Horizontal scaling capabilities - Load balancing implementation 2. **Advanced Features** (Priority: Medium) - Machine learning integration - Real-time collaboration features - Advanced analytics and reporting #### Deliverables - Scalable architecture - Advanced feature set - Integration platform ## Timeline Overview ```text Q1 Q2 Q3 Q4 ├── Phase 1 ────┼── Phase 2 ────┼── Phase 3 ────────────────┤ Foundation Enhancement Scale ├── Stabilize ├── UX Redesign ├── Microservices ├── CI/CD ├── Performance ├── ML Integration └── Testing └── Mobile └── Analytics ``` ```` ## Dependencies and Prerequisites ### External Dependencies - Third-party service integrations - Vendor product roadmaps - Regulatory compliance requirements ### Internal Dependencies - Team skill development and training - Infrastructure capacity planning - Budget allocation and approval ### Technical Prerequisites - Current system documentation - Performance baseline establishment - Security audit completion ## Risk Assessment ### High Risk Items - **Legacy System Migration**: Complex data migration with potential downtime - **Mitigation**: Phased migration approach with rollback capabilities - **Third-party Integration Changes**: External API deprecations - **Mitigation**: Multi-vendor strategy and abstraction layers ### Medium Risk Items - **Team Capacity**: Limited expertise in new technologies - **Mitigation**: Training programs and external consultants - **Performance Targets**: Ambitious scalability goals - **Mitigation**: Incremental improvements with regular benchmarking ## Resource Requirements ### Team Composition - **Backend Engineers**: 3-4 developers for infrastructure work - **Frontend Engineers**: 2-3 developers for UI improvements - **DevOps Engineers**: 1-2 engineers for infrastructure automation - **Product Managers**: 1 PM for coordination and stakeholder management ### Technology Investments - Cloud infrastructure scaling - Development and testing tools - Third-party service subscriptions - Training and certification programs ## Success Metrics and KPIs ### Technical Metrics - System uptime: 99.9% availability - Response times: <200ms for API calls - Test coverage: >90% code coverage - Security: Zero critical vulnerabilities ### Business Metrics - User satisfaction: >4.5/5 rating - Feature adoption: >80% of users using new features - Developer productivity: 30% faster feature delivery - Cost efficiency: 20% reduction in infrastructure costs ## Review and Adaptation ### Quarterly Reviews - Progress assessment against milestones - Risk evaluation and mitigation updates - Resource allocation adjustments - Timeline and scope refinements ### Feedback Loops - Monthly stakeholder check-ins - Bi-weekly development team retrospectives - Continuous user feedback collection - Regular competitive analysis updates ## Communication Plan ### Stakeholder Updates - **Executive Leadership**: Quarterly business reviews - **Development Teams**: Sprint planning and retrospectives - **End Users**: Feature announcements and training - **External Partners**: Integration roadmap sharing ```markdown ## Roadmap Considerations 1. **Strategic Alignment**: Ensure roadmap aligns with business objectives and market needs 2. **Technical Feasibility**: Balance ambitious goals with realistic technical constraints 3. **Resource Planning**: Account for team capacity, skills, and availability 4. **Risk Management**: Identify and plan for potential obstacles and dependencies 5. **Flexibility**: Build in adaptation points for changing requirements and market conditions 6. **Stakeholder Buy-in**: Ensure all key stakeholders understand and support the roadmap ## Roadmap Types - **Product Roadmap**: Feature development and user experience evolution - **Technical Roadmap**: Infrastructure, architecture, and platform improvements - **Migration Roadmap**: System transitions, technology upgrades, and modernization - **Integration Roadmap**: Third-party integrations and ecosystem expansion - **Scaling Roadmap**: Performance, capacity, and growth preparation ## Context Integration When provided with context files or documentation, the roadmap should: - **Analyze Current State**: Extract insights from existing code, documentation, and requirements - **Identify Gaps**: Compare current capabilities with desired future state - **Leverage Strengths**: Build upon existing successful patterns and technologies - **Address Weaknesses**: Plan systematic improvements for identified pain points - **Maintain Continuity**: Ensure roadmap aligns with existing architectural decisions and constraints ## Usage Notes - Roadmaps should be living documents that evolve with changing requirements - Include both technical and business perspectives in planning - Consider market timing and competitive factors - Plan for regular review and adjustment cycles - Balance innovation with stability and risk management ## Related Commands - [**plan this**](plan-this.md) - Create detailed implementation plans for roadmap phases - [**spec this**](spec-this.md) - Develop technical specifications for roadmap initiatives - [**analyze this**](../development/analyze-this.md) - Assess current state before roadmap creation - [**research this**](../documentation/research-this.md) - Gather market and technical insights for roadmap planning ```