lasserh/DeutschLernen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
DeutschLernen/docs/features/template.md
Lasse Rune Hansen 76e8af4987 Add complete solution: documentation, frontend, and project files 
- Add comprehensive documentation in docs/ (architecture, features, roadmap)
- Add german-app-frontend with Vite, TypeScript, ESLint configuration
- Add AGENTS.md and .gitignore

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2026-05-31 18:20:53 +02:00

3.9 KiB
Raw Permalink Blame History

Feature: [Feature Name]

Status: ⏳ Planned
Priority: Medium
Complexity: Medium
Estimate: 3 days
Assignee: [Your Name]
Created: [YYYY-MM-DD]
Target Completion: [YYYY-MM-DD]
PR: [Link to Pull Request]
Related Features: [List of dependent/related features]

📌 Overview

Purpose

[Brief description of what this feature does and why it's needed]

User Story

[As a [user type], I want to [action] so that [benefit]]

Acceptance Criteria

  • Criterion 1
  • Criterion 2
  • Criterion 3

📋 Requirements

Functional Requirements

ID Requirement Priority
FR-001 [Requirement description] High
FR-002 [Requirement description] Medium

Non-Functional Requirements

  • Performance: [e.g., API response < 200ms]
  • Security: [e.g., Role-based access control]
  • Compatibility: [e.g., Works on mobile and desktop]

🏗️ Technical Design

Architecture Diagram

Components Involved

  • Backend: [List controllers, services, repositories]
  • Frontend: [List components, hooks, stores]
  • Database: [List tables, changes needed]
  • External Services: [List any third-party services]

Data Flow

  1. User action → Frontend → API call
  2. API endpoint → Application service → Domain logic
  3. Repository → Database
  4. Return response → Frontend update

API Changes

Endpoint Method Description
/api/new-endpoint POST [Description]

Database Changes

-- SQL schema changes if applicable

🚀 Implementation Plan

Phase 1: Setup & Foundation

  • Task 1
  • Task 2

Phase 2: Core Implementation

  • Task 3
  • Task 4

Phase 3: Testing & Polish

  • Write unit tests
  • Write integration tests
  • Manual testing

Milestones

Milestone Date Status
Design Complete [Date] ⏳
Backend Complete [Date] ⏳
Frontend Complete [Date] ⏳
Testing Complete [Date] ⏳

✅ Tasks

Backend

  • Create domain entity/models
  • Create repository interface
  • Implement repository
  • Create application service
  • Create API endpoints
  • Add validation
  • Write unit tests
  • Write integration tests

Frontend

  • Create components
  • Add state management
  • Create hooks
  • Add API client calls
  • Implement UI/UX
  • Write component tests

Database

  • Update schema
  • Create migrations
  • Seed data (if needed)

DevOps

  • Update CI/CD pipeline
  • Update deployment scripts

🔗 Dependencies

Feature Dependencies

Technical Dependencies

  • Library/Package: Version - Purpose
  • External API: Documentation link

Blockers

  • Blocker 1 - Description
  • Blocker 2 - Description

📝 Notes & Decisions

Decisions Made

Date Decision Rationale
[Date] [Decision] [Why this approach]

Technical Notes

  • Note 1: [Important implementation detail]
  • Note 2: [Workaround for limitation]

Gotchas

  • ⚠️ [Potential pitfall and how to avoid it]

Lessons Learned

  • [What you learned during implementation]

📊 Progress History

Date Status Change Notes
[Date] Created Initial plan
[Date] In Progress Started development
[Date] Code Review PR submitted
[Date] Completed Feature deployed

📎 Related Files & Links

  • Backend: [Link to code or describe location]
  • Frontend: [Link to code or describe location]
  • Tests: [Link to tests]
  • PR: [Link to pull request]
  • Design Mockups: [Link to Figma/design files]

Template last updated: May 31, 2025