mirror of
https://github.com/cjo4m06/mcp-shrimp-task-manager.git
synced 2025-07-26 07:52:25 +08:00
368 lines
10 KiB
Plaintext
368 lines
10 KiB
Plaintext
---
|
|
description: "CursorRIPER Framework - START Phase"
|
|
globs:
|
|
alwaysApply: false
|
|
version: "1.0.1"
|
|
date_created: "2025-04-05"
|
|
last_updated: "2025-04-06"
|
|
framework_component: "start_phase"
|
|
priority: "high"
|
|
scope: "initialization"
|
|
archive_after_completion: true
|
|
---
|
|
<!-- Note: Cursor will strip out all the other header information and only keep the first three. -->
|
|
# CursorRIPER Framework - START Phase
|
|
# Version 1.0.1
|
|
|
|
## AI PROCESSING INSTRUCTIONS
|
|
This file defines the START phase component of the CursorRIPER Framework. As an AI assistant, you MUST:
|
|
- Load this file when PROJECT_PHASE is "UNINITIATED" or "INITIALIZING"
|
|
- Guide the user through project initialization in a step-by-step manner
|
|
- Create all required memory bank files with proper formatting
|
|
- Update state.mdc as each step is completed
|
|
- Archive this component once initialization is complete
|
|
|
|
## START PHASE OVERVIEW
|
|
|
|
The START phase is a one-time preprocessing phase that runs at the beginning of a new project or major component. It focuses on project initialization, scaffolding, and setting up the Memory Bank with baseline information.
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
Start[BEGIN START PHASE] --> Req[Requirements Gathering]
|
|
Req --> Tech[Technology Selection]
|
|
Tech --> Arch[Architecture Definition]
|
|
Arch --> Scaffold[Project Scaffolding]
|
|
Scaffold --> Setup[Environment Setup]
|
|
Setup --> Memory[Memory Bank Initialization]
|
|
Memory --> End[TRANSITION TO RIPER]
|
|
```
|
|
|
|
## START PHASE PROCESS
|
|
|
|
[PHASE: START]
|
|
- **Purpose**: Project initialization and scaffolding
|
|
- **Permitted**: Requirements gathering, technology selection, architecture definition, project structure setup
|
|
- **Entry Point**: User command "BEGIN START PHASE" or "/start"
|
|
- **Exit Point**: Automatic transition to RESEARCH mode after setup is complete
|
|
|
|
## STEP-BY-STEP INITIALIZATION
|
|
|
|
### Step 1: Requirements Gathering
|
|
- Collect and document core project requirements
|
|
- Define project scope, goals, and constraints
|
|
- Identify key stakeholders and their needs
|
|
- Document success criteria
|
|
- **Key Questions**:
|
|
- What problem is this project trying to solve?
|
|
- Who are the primary users or stakeholders?
|
|
- What are the must-have features?
|
|
- What are the nice-to-have features?
|
|
- What are the technical constraints?
|
|
- What is the timeline for completion?
|
|
- **Output**: Create projectbrief.md with gathered requirements
|
|
|
|
### Step 2: Technology Selection
|
|
- Assess technology options based on requirements
|
|
- Evaluate frameworks, libraries, and tools
|
|
- Make recommendations with clear rationales
|
|
- Document technology decisions
|
|
- **Key Questions**:
|
|
- What programming language(s) best fit this project?
|
|
- What frameworks or libraries would be most appropriate?
|
|
- What database technology should be used?
|
|
- What deployment environment is targeted?
|
|
- Are there any specific performance requirements?
|
|
- What testing frameworks should be used?
|
|
- **Output**: Add technology decisions to techContext.md
|
|
|
|
### Step 3: Architecture Definition
|
|
- Define high-level system architecture
|
|
- Identify key components and their relationships
|
|
- Create initial architectural diagrams
|
|
- Document architectural decisions
|
|
- **Key Questions**:
|
|
- What architectural pattern is most appropriate?
|
|
- How will the application be structured?
|
|
- What are the key components and their responsibilities?
|
|
- How will data flow through the system?
|
|
- How will the system scale?
|
|
- What security considerations need to be addressed?
|
|
- **Output**: Create systemPatterns.md with architecture definition
|
|
|
|
### Step 4: Project Scaffolding
|
|
- Set up initial folder structure
|
|
- Create configuration files
|
|
- Initialize version control
|
|
- Set up package management
|
|
- Create initial README and documentation
|
|
- **Key Actions**:
|
|
- Create the basic folder structure
|
|
- Initialize git repository
|
|
- Set up package manager (npm, pip, etc.)
|
|
- Create initial configuration files
|
|
- Set up basic build process
|
|
- **Output**: Create project scaffold according to defined structure
|
|
|
|
### Step 5: Environment Setup
|
|
- Configure development environment
|
|
- Set up testing framework
|
|
- Establish CI/CD pipeline configuration
|
|
- Define deployment strategy
|
|
- **Key Actions**:
|
|
- Set up local development environment
|
|
- Configure testing framework
|
|
- Create initial test cases
|
|
- Define CI/CD pipeline
|
|
- Document deployment process
|
|
- **Output**: Update techContext.md with environment setup details
|
|
|
|
### Step 6: Memory Bank Initialization
|
|
- Create and populate all core memory files:
|
|
- projectbrief.md (if not already created)
|
|
- systemPatterns.md (if not already created)
|
|
- techContext.md (if not already created)
|
|
- activeContext.md
|
|
- progress.md
|
|
- Establish initial project intelligence files
|
|
- **Key Actions**:
|
|
- Create memory-bank directory structure
|
|
- Create and populate all core memory files
|
|
- Document initial state in activeContext.md
|
|
- Set up progress.md with initial tasks
|
|
- **Output**: Complete memory bank with all required files
|
|
|
|
## MEMORY BANK TEMPLATES
|
|
|
|
### projectbrief.md Template
|
|
```markdown
|
|
# Project Brief: [PROJECT_NAME]
|
|
*Version: 1.0*
|
|
*Created: [CURRENT_DATE]*
|
|
*Last Updated: [CURRENT_DATE]*
|
|
|
|
## Project Overview
|
|
[Brief description of the project, its purpose, and main goals]
|
|
|
|
## Core Requirements
|
|
- [REQUIREMENT_1]
|
|
- [REQUIREMENT_2]
|
|
- [REQUIREMENT_3]
|
|
|
|
## Success Criteria
|
|
- [CRITERION_1]
|
|
- [CRITERION_2]
|
|
- [CRITERION_3]
|
|
|
|
## Scope
|
|
### In Scope
|
|
- [IN_SCOPE_ITEM_1]
|
|
- [IN_SCOPE_ITEM_2]
|
|
|
|
### Out of Scope
|
|
- [OUT_OF_SCOPE_ITEM_1]
|
|
- [OUT_OF_SCOPE_ITEM_2]
|
|
|
|
## Timeline
|
|
- [MILESTONE_1]: [DATE]
|
|
- [MILESTONE_2]: [DATE]
|
|
- [MILESTONE_3]: [DATE]
|
|
|
|
## Stakeholders
|
|
- [STAKEHOLDER_1]: [ROLE]
|
|
- [STAKEHOLDER_2]: [ROLE]
|
|
|
|
---
|
|
|
|
*This document serves as the foundation for the project and informs all other memory files.*
|
|
```
|
|
|
|
### systemPatterns.md Template
|
|
```markdown
|
|
# System Patterns: [PROJECT_NAME]
|
|
*Version: 1.0*
|
|
*Created: [CURRENT_DATE]*
|
|
*Last Updated: [CURRENT_DATE]*
|
|
|
|
## Architecture Overview
|
|
[High-level description of the system architecture]
|
|
|
|
## Key Components
|
|
- [COMPONENT_1]: [PURPOSE]
|
|
- [COMPONENT_2]: [PURPOSE]
|
|
- [COMPONENT_3]: [PURPOSE]
|
|
|
|
## Design Patterns in Use
|
|
- [PATTERN_1]: [USAGE_CONTEXT]
|
|
- [PATTERN_2]: [USAGE_CONTEXT]
|
|
- [PATTERN_3]: [USAGE_CONTEXT]
|
|
|
|
## Data Flow
|
|
[Description or diagram of how data flows through the system]
|
|
|
|
## Key Technical Decisions
|
|
- [DECISION_1]: [RATIONALE]
|
|
- [DECISION_2]: [RATIONALE]
|
|
- [DECISION_3]: [RATIONALE]
|
|
|
|
## Component Relationships
|
|
[Description of how components interact with each other]
|
|
|
|
---
|
|
|
|
*This document captures the system architecture and design patterns used in the project.*
|
|
```
|
|
|
|
### techContext.md Template
|
|
```markdown
|
|
# Technical Context: [PROJECT_NAME]
|
|
*Version: 1.0*
|
|
*Created: [CURRENT_DATE]*
|
|
*Last Updated: [CURRENT_DATE]*
|
|
|
|
## Technology Stack
|
|
- Frontend: [FRONTEND_TECHNOLOGIES]
|
|
- Backend: [BACKEND_TECHNOLOGIES]
|
|
- Database: [DATABASE_TECHNOLOGIES]
|
|
- Infrastructure: [INFRASTRUCTURE_TECHNOLOGIES]
|
|
|
|
## Development Environment Setup
|
|
[Instructions for setting up the development environment]
|
|
|
|
## Dependencies
|
|
- [DEPENDENCY_1]: [VERSION] - [PURPOSE]
|
|
- [DEPENDENCY_2]: [VERSION] - [PURPOSE]
|
|
- [DEPENDENCY_3]: [VERSION] - [PURPOSE]
|
|
|
|
## Technical Constraints
|
|
- [CONSTRAINT_1]
|
|
- [CONSTRAINT_2]
|
|
- [CONSTRAINT_3]
|
|
|
|
## Build and Deployment
|
|
- Build Process: [BUILD_PROCESS]
|
|
- Deployment Procedure: [DEPLOYMENT_PROCEDURE]
|
|
- CI/CD: [CI_CD_SETUP]
|
|
|
|
## Testing Approach
|
|
- Unit Testing: [UNIT_TESTING_APPROACH]
|
|
- Integration Testing: [INTEGRATION_TESTING_APPROACH]
|
|
- E2E Testing: [E2E_TESTING_APPROACH]
|
|
|
|
---
|
|
|
|
*This document describes the technologies used in the project and how they're configured.*
|
|
```
|
|
|
|
### activeContext.md Template
|
|
```markdown
|
|
# Active Context: [PROJECT_NAME]
|
|
*Version: 1.0*
|
|
*Created: [CURRENT_DATE]*
|
|
*Last Updated: [CURRENT_DATE]*
|
|
*Current RIPER Mode: [MODE_NAME]*
|
|
|
|
## Current Focus
|
|
[Description of what we're currently working on]
|
|
|
|
## Recent Changes
|
|
- [CHANGE_1]: [DATE] - [DESCRIPTION]
|
|
- [CHANGE_2]: [DATE] - [DESCRIPTION]
|
|
- [CHANGE_3]: [DATE] - [DESCRIPTION]
|
|
|
|
## Active Decisions
|
|
- [DECISION_1]: [STATUS] - [DESCRIPTION]
|
|
- [DECISION_2]: [STATUS] - [DESCRIPTION]
|
|
- [DECISION_3]: [STATUS] - [DESCRIPTION]
|
|
|
|
## Next Steps
|
|
1. [NEXT_STEP_1]
|
|
2. [NEXT_STEP_2]
|
|
3. [NEXT_STEP_3]
|
|
|
|
## Current Challenges
|
|
- [CHALLENGE_1]: [DESCRIPTION]
|
|
- [CHALLENGE_2]: [DESCRIPTION]
|
|
- [CHALLENGE_3]: [DESCRIPTION]
|
|
|
|
## Implementation Progress
|
|
- [✓] [COMPLETED_TASK_1]
|
|
- [✓] [COMPLETED_TASK_2]
|
|
- [ ] [PENDING_TASK_1]
|
|
- [ ] [PENDING_TASK_2]
|
|
|
|
---
|
|
|
|
*This document captures the current state of work and immediate next steps.*
|
|
```
|
|
|
|
### progress.md Template
|
|
```markdown
|
|
# Progress Tracker: [PROJECT_NAME]
|
|
*Version: 1.0*
|
|
*Created: [CURRENT_DATE]*
|
|
*Last Updated: [CURRENT_DATE]*
|
|
|
|
## Project Status
|
|
Overall Completion: [PERCENTAGE]%
|
|
|
|
## What Works
|
|
- [FEATURE_1]: [COMPLETION_STATUS] - [NOTES]
|
|
- [FEATURE_2]: [COMPLETION_STATUS] - [NOTES]
|
|
- [FEATURE_3]: [COMPLETION_STATUS] - [NOTES]
|
|
|
|
## What's In Progress
|
|
- [FEATURE_4]: [PROGRESS_PERCENTAGE]% - [NOTES]
|
|
- [FEATURE_5]: [PROGRESS_PERCENTAGE]% - [NOTES]
|
|
- [FEATURE_6]: [PROGRESS_PERCENTAGE]% - [NOTES]
|
|
|
|
## What's Left To Build
|
|
- [FEATURE_7]: [PRIORITY] - [NOTES]
|
|
- [FEATURE_8]: [PRIORITY] - [NOTES]
|
|
- [FEATURE_9]: [PRIORITY] - [NOTES]
|
|
|
|
## Known Issues
|
|
- [ISSUE_1]: [SEVERITY] - [DESCRIPTION] - [STATUS]
|
|
- [ISSUE_2]: [SEVERITY] - [DESCRIPTION] - [STATUS]
|
|
- [ISSUE_3]: [SEVERITY] - [DESCRIPTION] - [STATUS]
|
|
|
|
## Milestones
|
|
- [MILESTONE_1]: [DUE_DATE] - [STATUS]
|
|
- [MILESTONE_2]: [DUE_DATE] - [STATUS]
|
|
- [MILESTONE_3]: [DUE_DATE] - [STATUS]
|
|
|
|
---
|
|
|
|
*This document tracks what works, what's in progress, and what's left to build.*
|
|
```
|
|
|
|
## TRANSITION TO RIPER WORKFLOW
|
|
|
|
Once all six steps are completed:
|
|
1. Verify all memory files are properly created and populated
|
|
2. Update state.mdc with:
|
|
- PROJECT_PHASE = "DEVELOPMENT"
|
|
- START_PHASE_STATUS = "COMPLETED"
|
|
- START_PHASE_STEP = 6
|
|
- INITIALIZATION_DATE = [current date/time]
|
|
3. Archive this component to .cursor/rules/archive/start-phase.mdc.archive
|
|
4. Automatically transition to RESEARCH mode
|
|
5. Inform the user: "Project initialization complete. Entering RESEARCH mode to begin development."
|
|
|
|
## DELIVERABLES CHECKLIST
|
|
|
|
At the end of the START phase, ensure the following are complete:
|
|
|
|
- [ ] Project requirements documented in projectbrief.md
|
|
- [ ] Technology stack selected and documented in techContext.md
|
|
- [ ] System architecture defined in systemPatterns.md
|
|
- [ ] Project scaffold created
|
|
- [ ] Development environment configured and documented
|
|
- [ ] Memory Bank initialized with all core files
|
|
- [ ] Initial tasks documented in progress.md
|
|
|
|
Once all items are checked, the system will automatically transition to the RIPER workflow.
|
|
|
|
---
|
|
|
|
*This file guides project initialization through the START phase. It will be automatically archived once initialization is complete.*
|