--- title: "Sprint Description Format (Sprint Planning PRD Style)" type: "sprint_plan" version: "1.0" created_by: "AI Development Assistant" last_updated: "" --- # Sprint Description Format Template ## ๐Ÿ“Š Sprint Metadata ```yaml sprint_id: "_S" sprint_name: "" mvp_parent: "" sprint_number: status: "planned|in_progress|completed|blocked" priority: "critical|high|medium|low" timeline: planned_start: "" planned_end: "" duration_estimate: "" actual_start: "" actual_end: "" stakeholders: sprint_lead: "" developers: ["", ""] reviewers: ["", ""] ai_assistant: "claude|cursor|other" context: development_approach: "ai_assisted_coding" coding_standards: "ruff_black_mypy_pytest" commit_convention: "conventional_commits" ``` ## ๐ŸŽฏ Sprint Goal & Value Proposition ### **Sprint Objective** **Primary Goal:** ### **Problem Context** **What We're Building On:** **What We're Solving:** **Why Now:** ### **Success Criteria** **Demo-able Outcome:** **Technical Milestone:** **Quality Standard:** ## ๐Ÿ—๏ธ Technical Architecture & Implementation ### **Architecture Focus** **Core Components:** **Integration Points:** **Data Flow Changes:** ### **Technical Approach** ```yaml implementation_strategy: "" design_patterns: ["", ""] technology_choices: primary_languages: ["Python", "JavaScript"] frameworks: ["FastAPI", "Gradio", "etc"] testing_frameworks: ["pytest", "etc"] development_tools: ["ruff", "mypy", "black"] ``` ### **Key Technical Decisions** 1. **Decision:** - **Rationale:** - **Alternatives:** - **Impact:** 2. **Decision:** - **Rationale:** - **Alternatives:** - **Impact:** ## ๐Ÿ“‹ Task Breakdown & Implementation Plan ### **Task Organization** ```yaml total_tasks: task_methodology: "tdd_with_ai_assistance" parallel_workstreams: task_size_target: " (X_hours each)" ``` ### **Task List** | Task ID | Task Name | Priority | Estimate | Dependencies | Owner | Type | |---------|-----------|----------|----------|--------------|-------|------| | | | | | [, ] | | | | | | | | [, ] | | | | | | | | [, ] | | | ### **Task Details** #### **Task : ** ```yaml status: "todo|in_progress|done|blocked" priority: "critical|high|medium|low" estimated_hours: dependencies: ["", ""] type: "foundation|feature|integration|testing|documentation" ``` **Objective:** **Implementation Approach:** - **Files to Modify:** [``, ``, ``] - **Key Classes/Functions:** - **Testing Strategy:** **Acceptance Criteria:** - [ ] - [ ] - [ ] - [ ] Code quality gates passed (`ruff check`, `mypy`, `pytest`) **AI Assistant Guidance:** ``` For Claude/Cursor IDE: - Focus areas: - Key patterns to follow: - Testing approach: - Integration points: ``` #### **Task : ** ## ๐Ÿงช Testing & Quality Strategy ### **Testing Approach for This Sprint** ```yaml unit_testing: framework: "pytest" coverage_target: ">=80%" mock_strategy: "" tdd_approach: "write_tests_first_with_ai_assistance" integration_testing: scope: "" critical_flows: ["", ""] automation_level: "manual|automated|hybrid" manual_testing: ui_testing: "" edge_cases: ["", ""] browser_compatibility: "" ``` ### **Quality Gates for Sprint** - [ ] **Code Quality:** All tasks pass ruff linting and mypy type checking - [ ] **Test Coverage:** Sprint additions maintain >=80% overall coverage - [ ] **Functionality:** All acceptance criteria verified through testing - [ ] **Integration:** New components integrate seamlessly with existing system - [ ] **Performance:** No regression in performance metrics - [ ] **Documentation:** Code changes are properly documented ### **Definition of Done (Sprint Level)** - [ ] All sprint tasks completed and merged - [ ] Sprint objective demonstrated and validated - [ ] Quality gates passed for all new code - [ ] Documentation updated (README, API docs, code comments) - [ ] CI/CD pipeline green with all checks passing - [ ] Sprint retrospective completed and lessons captured ## ๐Ÿ”„ Dependencies & Assumptions ### **Prerequisites (What We Need Before Starting)** - **Previous Sprint Deliverables:** - **External Dependencies:** - **Environment Setup:** - **Access/Permissions:** ### **Dependencies Within Sprint** ```yaml critical_path_tasks: [, , ] parallel_workstreams: stream_1: [, ] stream_2: [, ] blocking_dependencies: - task: blocks: [, ] reason: "" ``` ### **Assumptions** - **Technical Assumptions:** - **Resource Assumptions:** - **External Service Assumptions:** - **Timeline Assumptions:** ## โš ๏ธ Risk Assessment & Mitigation ### **Risk Matrix** | Risk | Probability | Impact | Mitigation Strategy | Contingency Plan | |------|-------------|--------|-------------------|------------------| | | | | | | | | | | | | ### **Technical Risks** - **Integration Complexity:** โ†’ - **API Dependencies:** โ†’ - **Performance Issues:** โ†’ ### **Timeline Risks** - **Task Estimation:** โ†’ - **Blocking Dependencies:** โ†’ - **External Delays:** โ†’ ## ๐Ÿ“ˆ Progress Tracking & Metrics ### **Daily Progress Indicators** ```yaml completion_metrics: - tasks_completed: "/" - hours_spent: "/" - code_lines_added: "" - tests_written: "" quality_metrics: - test_coverage: "" - linting_errors: "" - type_coverage: "" velocity_metrics: - tasks_per_day: "" - blockers_encountered: "" - ai_assist_efficiency: "" ``` ### **Sprint Burndown Tracking** - **Day 1 Target:** - **Day 2 Target:** - **Day 3 Target:** - **Final Target:** ### **Success Metrics** - **Primary KPI:** - **Quality KPI:** - **Velocity KPI:** ## ๐Ÿ”— Deliverables & Handoffs ### **Sprint Deliverables** ```yaml code_deliverables: - component: "" files: ["", ""] status: "created|modified|refactored" documentation_deliverables: - document: "" type: "api|user|technical" status: "created|updated" testing_deliverables: - test_suite: "" coverage: "" type: "unit|integration|e2e" ``` ### **Integration Points** - **With Previous Sprints:** - **With Parallel Work:** - **For Next Sprint:** ### **Handoff Documentation** - **Technical Handoff:** `docs/sprints/mvp_s_technical_summary.md` - **User Guide Updates:** `docs/user/mvp_s_features.md` - **API Changes:** `docs/api/mvp_s_api_updates.md` - **Known Issues:** `docs/sprints/mvp_s_known_issues.md` ## ๐Ÿ“š Resources & References ### **Development Resources** - **Code Standards:** `.cursor/rules/` directory - **Testing Patterns:** `tests/` directory examples - **Architecture Docs:** `docs/architecture/` - **API Documentation:** `docs/api/` ### **AI Assistant Resources** - **Cursor Rules:** `.cursor/rules/python_development.mdc` - **Code Patterns:** `docs/patterns/` directory - **Testing Helpers:** `tests/helpers/` directory ### **External References** - **Framework Documentation:** - **Best Practices:** - **Technical Specifications:** --- ## ๐Ÿ“ Template Usage Guidelines ### **When to Use This Format** - Sprint planning sessions - Task breakdown and estimation - Risk assessment and mitigation planning - Progress tracking and daily standups - Sprint retrospectives and lessons learned ### **Customization Instructions** 1. Replace all `` values with sprint-specific information 2. Adjust task count and structure based on sprint complexity 3. Add sprint-specific sections (e.g., UI design, data migration) 4. Update risk assessment based on sprint-specific challenges 5. Ensure dependencies and assumptions are accurately captured ### **Integration with Development Workflow** - Use this document for sprint planning meetings - Reference task details during daily development - Track progress against defined metrics - Use for sprint retrospectives and continuous improvement - Link to individual task files in `docs/tasks/mvp/` ### **AI Assistant Integration** - Include AI assistant guidance in each task - Use for prompt engineering and context setting - Reference for code quality and testing standards - Integrate with Cursor IDE workflows --- **Document Status:** Template **Next Review:** Before sprint planning **Approval Required:** Sprint Lead + MVP Owner