PROJECT.md Template

# PROJECT.md

## Project Overview
**Project Name:** [Your project name]
**Type:** [Portfolio site / Dashboard / Landing page / etc.]
**Target Launch:** [Date or timeframe]

## Purpose
[Why are you building this? What problem does it solve?]

## Target Audience
[Who will use this? Be specific about their needs and context]

## Key Features (MVP)
1. [Feature 1]
2. [Feature 2]
3. [Feature 3]

## Success Criteria
- [What does "done" look like?]
- [How will you know it's working?]
- [What metrics matter?]

## Technical Stack
- Frontend: [React, Vue, vanilla HTML/CSS/JS]
- Styling: [Tailwind, CSS modules, etc.]
- Deployment: [Vercel, Netlify, etc.]

## Design System
- Colors: [Primary, secondary, accent]
- Typography: [Fonts and sizes]
- Spacing: [System you're using]
- Breakpoints: [Mobile, tablet, desktop sizes]

## Out of Scope (Not in MVP)
- [Feature you're saving for later]
- [Nice-to-have that can wait]
- [Complex functionality for v2]

Example: Portfolio Site

# PROJECT.md

## Project Overview
**Project Name:** Priya's Portfolio 2024
**Type:** Personal portfolio website
**Target Launch:** End of week

## Purpose
Showcase my product design work to potential employers. Simple, clean, fast-loading. Demonstrates attention to detail and understanding of user experience.

## Target Audience
Hiring managers and recruiters in tech companies. They're busy, viewing on various devices, looking for clear evidence of design thinking and execution.

## Key Features (MVP)
1. Homepage with hero section and featured projects
2. Project case studies (3 projects with images and descriptions)
3. About page with bio and contact info
4. Mobile-responsive design

## Success Criteria
- Loads in under 3 seconds
- Works perfectly on mobile (375px), tablet (768px), desktop (1440px)
- All images display correctly with fallbacks
- Contact form submits successfully
- No broken links or 404 errors

## Technical Stack
- Frontend: React with Vite
- Styling: Tailwind CSS
- Deployment: Vercel

## Design System
- Colors: #1a1a1a (text), #f5f5f5 (background), #3b82f6 (accent)
- Typography: Inter for body, Space Grotesk for headings
- Spacing: 4px base unit (Tailwind default)
- Breakpoints: 375px (mobile), 768px (tablet), 1440px (desktop)

## Out of Scope (Not in MVP)
- Blog section
- Dark mode toggle
- Animation transitions between pages
- Filter/sort projects by category
- Testimonials section