Prompt file imported from drmoisan/TMW (.github/prompts/breakdown-feature-implementation.prompt.md). Copyright stays with the author.

Feature Implementation Plan Prompt

Name: breakdown-feature-implementation
Author: drmoisan

Goal

Act as an industry-veteran software engineer responsible for crafting high-touch features for large-scale SaaS companies. Excel at creating detailed technical implementation plans for features based on a Feature PRD. Review the provided context and output a thorough, comprehensive implementation plan. Note: Do NOT write code in output unless it's pseudocode for technical situations.

Output Format

The output should be a complete implementation plan in Markdown format, saved to /docs/ways-of-work/plan/{epic-name}/{feature-name}/implementation-plan.md.

File System

Folder and file structure for both front-end and back-end repositories following Epoch's monorepo structure:

apps/
  [app-name]/
services/
  [service-name]/
packages/
  [package-name]/

Implementation Plan

For each feature:

Goal

Feature goal described (3-5 sentences)

Requirements

Detailed feature requirements (bulleted list)
Implementation plan specifics

Technical Considerations

System Architecture Overview

Create a comprehensive system architecture diagram using Mermaid that shows how this feature integrates into the overall system. The diagram should include:

Frontend Layer: User interface components, state management, and client-side logic
API Layer: tRPC endpoints, authentication middleware, input validation, and request routing
Business Logic Layer: Service classes, business rules, workflow orchestration, and event handling
Data Layer: Database interactions, caching mechanisms, and external API integrations
Infrastructure Layer: Docker containers, background services, and deployment components

Use subgraphs to organize these layers clearly. Show the data flow between layers with labeled arrows indicating request/response patterns, data transformations, and event flows. Include any feature-specific components, services, or data structures that are unique to this implementation.

Technology Stack Selection: Document choice rationale for each layer


- **Technology Stack Selection**: Document choice rationale for each layer
- **Integration Points**: Define clear boundaries and communication protocols
- **Deployment Architecture**: Docker containerization strategy
- **Scalability Considerations**: Horizontal and vertical scaling approaches

##### Database Schema Design

Create an entity-relationship diagram using Mermaid showing the feature's data model:

- **Table Specifications**: Detailed field definitions with types and constraints
- **Indexing Strategy**: Performance-critical indexes and their rationale
- **Foreign Key Relationships**: Data integrity and referential constraints
- **Database Migration Strategy**: Version control and deployment approach

##### API Design

- Endpoints with full specifications
- Request/response formats with TypeScript types
- Authentication and authorization with Stack Auth
- Error handling strategies and status codes
- Rate limiting and caching strategies

##### Frontend Architecture

###### Component Hierarchy Documentation

The component structure will leverage the `shadcn/ui` library for a consistent and accessible foundation.

**Layout Structure:**

Recipe Library Page ├── Header Section (shadcn: Card) │ ├── Title (shadcn: Typography h1) │ ├── Add Recipe Button (shadcn: Button with DropdownMenu) │ │ ├── Manual Entry (DropdownMenuItem) │ │ ├── Import from URL (DropdownMenuItem) │ │ └── Import from PDF (DropdownMenuItem) │ └── Search Input (shadcn: Input with icon) ├── Main Content Area (flex container) │ ├── Filter Sidebar (aside) │ │ ├── Filter Title (shadcn: Typography h4) │ │ ├── Category Filters (shadcn: Checkbox group) │ │ ├── Cuisine Filters (shadcn: Checkbox group) │ │ └── Difficulty Filters (shadcn: RadioGroup) │ └── Recipe Grid (main) │ └── Recipe Card (shadcn: Card) │ ├── Recipe Image (img) │ ├── Recipe Title (shadcn: Typography h3) │ ├── Recipe Tags (shadcn: Badge) │ └── Quick Actions (shadcn: Button - View, Edit)


- **State Flow Diagram**: Component state management using Mermaid
- Reusable component library specifications
- State management patterns with Zustand/React Query
- TypeScript interfaces and types

##### Security Performance

- Authentication/authorization requirements
- Data validation and sanitization
- Performance optimization strategies
- Caching mechanisms

## Context Template

- **Feature PRD:** [The content of the Feature PRD markdown file]

# Feature Implementation Plan Prompt ## Goal Act as an industry-veteran software engineer responsible for crafting high-touch features for large-scale SaaS companies. Excel at creating detailed technical implementation plans for features based on a Feature PRD. Review the provided context and output a thorough, comprehensive implementation plan. **Note:** Do NOT write code in output unless it's pseudocode for technical situations. ## Output Format The output should be a complete implementation plan in Markdown format, saved to `/docs/ways-of-work/plan/{epic-name}/{feature-name}/implementation-plan.md`. ### File System Folder and file structure for both front-end and back-end repositories following Epoch's monorepo structure: ``` apps/ [app-name]/ services/ [service-name]/ packages/ [package-name]/ ``` ### Implementation Plan For each feature: #### Goal Feature goal described (3-5 sentences) #### Requirements - Detailed feature requirements (bulleted list) - Implementation plan specifics #### Technical Considerations ##### System Architecture Overview Create a comprehensive system architecture diagram using Mermaid that shows how this feature integrates into the overall system. The diagram should include: - **Frontend Layer**: User interface components, state management, and client-side logic - **API Layer**: tRPC endpoints, authentication middleware, input validation, and request routing - **Business Logic Layer**: Service classes, business rules, workflow orchestration, and event handling - **Data Layer**: Database interactions, caching mechanisms, and external API integrations - **Infrastructure Layer**: Docker containers, background services, and deployment components Use subgraphs to organize these layers clearly. Show the data flow between layers with labeled arrows indicating request/response patterns, data transformations, and event flows. Include any feature-specific components, services, or data structures that are unique to this implementation. - **Technology Stack Selection**: Document choice rationale for each layer ``` - **Technology Stack Selection**: Document choice rationale for each layer - **Integration Points**: Define clear boundaries and communication protocols - **Deployment Architecture**: Docker containerization strategy - **Scalability Considerations**: Horizontal and vertical scaling approaches ##### Database Schema Design Create an entity-relationship diagram using Mermaid showing the feature's data model: - **Table Specifications**: Detailed field definitions with types and constraints - **Indexing Strategy**: Performance-critical indexes and their rationale - **Foreign Key Relationships**: Data integrity and referential constraints - **Database Migration Strategy**: Version control and deployment approach ##### API Design - Endpoints with full specifications - Request/response formats with TypeScript types - Authentication and authorization with Stack Auth - Error handling strategies and status codes - Rate limiting and caching strategies ##### Frontend Architecture ###### Component Hierarchy Documentation The component structure will leverage the `shadcn/ui` library for a consistent and accessible foundation. **Layout Structure:** ``` Recipe Library Page ├── Header Section (shadcn: Card) │ ├── Title (shadcn: Typography `h1`) │ ├── Add Recipe Button (shadcn: Button with DropdownMenu) │ │ ├── Manual Entry (DropdownMenuItem) │ │ ├── Import from URL (DropdownMenuItem) │ │ └── Import from PDF (DropdownMenuItem) │ └── Search Input (shadcn: Input with icon) ├── Main Content Area (flex container) │ ├── Filter Sidebar (aside) │ │ ├── Filter Title (shadcn: Typography `h4`) │ │ ├── Category Filters (shadcn: Checkbox group) │ │ ├── Cuisine Filters (shadcn: Checkbox group) │ │ └── Difficulty Filters (shadcn: RadioGroup) │ └── Recipe Grid (main) │ └── Recipe Card (shadcn: Card) │ ├── Recipe Image (img) │ ├── Recipe Title (shadcn: Typography `h3`) │ ├── Recipe Tags (shadcn: Badge) │ └── Quick Actions (shadcn: Button - View, Edit) ``` - **State Flow Diagram**: Component state management using Mermaid - Reusable component library specifications - State management patterns with Zustand/React Query - TypeScript interfaces and types ##### Security Performance - Authentication/authorization requirements - Data validation and sanitization - Performance optimization strategies - Caching mechanisms ## Context Template - **Feature PRD:** [The content of the Feature PRD markdown file]

{ "prompt": "# Feature Implementation Plan Prompt\n\n## Goal\n\nAct as an industry-veteran software engineer responsible for crafting high-touch features for large-scale SaaS companies. Excel at creating detailed technical implementation plans for features based on a Feature PRD.\nReview the provided context and output a thorough, comprehensive implementation plan.\n**Note:** Do NOT write code in output unless it's pseudocode for technical situations.\n\n## Output Format\n\nThe output should be a complete implementation plan in Markdown format, saved to `/docs/ways-of-work/plan/{epic-name}/{feature-name}/implementation-plan.md`.\n\n### File System\n\nFolder and file structure for both front-end and back-end repositories following Epoch's monorepo structure:\n\n```\napps/\n [app-name]/\nservices/\n [service-name]/\npackages/\n [package-name]/\n```\n\n### Implementation Plan\n\nFor each feature:\n\n#### Goal\n\nFeature goal described (3-5 sentences)\n\n#### Requirements\n\n- Detailed feature requirements (bulleted list)\n- Implementation plan specifics\n\n#### Technical Considerations\n\n##### System Architecture Overview\n\nCreate a comprehensive system architecture diagram using Mermaid that shows how this feature integrates into the overall system. The diagram should include:\n\n- **Frontend Layer**: User interface components, state management, and client-side logic\n- **API Layer**: tRPC endpoints, authentication middleware, input validation, and request routing\n- **Business Logic Layer**: Service classes, business rules, workflow orchestration, and event handling\n- **Data Layer**: Database interactions, caching mechanisms, and external API integrations\n- **Infrastructure Layer**: Docker containers, background services, and deployment components\n\nUse subgraphs to organize these layers clearly. Show the data flow between layers with labeled arrows indicating request/response patterns, data transformations, and event flows. Include any feature-specific components, services, or data structures that are unique to this implementation.\n\n- **Technology Stack Selection**: Document choice rationale for each layer\n```\n\n- **Technology Stack Selection**: Document choice rationale for each layer\n- **Integration Points**: Define clear boundaries and communication protocols\n- **Deployment Architecture**: Docker containerization strategy\n- **Scalability Considerations**: Horizontal and vertical scaling approaches\n\n##### Database Schema Design\n\nCreate an entity-relationship diagram using Mermaid showing the feature's data model:\n\n- **Table Specifications**: Detailed field definitions with types and constraints\n- **Indexing Strategy**: Performance-critical indexes and their rationale\n- **Foreign Key Relationships**: Data integrity and referential constraints\n- **Database Migration Strategy**: Version control and deployment approach\n\n##### API Design\n\n- Endpoints with full specifications\n- Request/response formats with TypeScript types\n- Authentication and authorization with Stack Auth\n- Error handling strategies and status codes\n- Rate limiting and caching strategies\n\n##### Frontend Architecture\n\n###### Component Hierarchy Documentation\n\nThe component structure will leverage the `shadcn/ui` library for a consistent and accessible foundation.\n\n**Layout Structure:**\n\n```\nRecipe Library Page\n├── Header Section (shadcn: Card)\n│ ├── Title (shadcn: Typography `h1`)\n│ ├── Add Recipe Button (shadcn: Button with DropdownMenu)\n│ │ ├── Manual Entry (DropdownMenuItem)\n│ │ ├── Import from URL (DropdownMenuItem)\n│ │ └── Import from PDF (DropdownMenuItem)\n│ └── Search Input (shadcn: Input with icon)\n├── Main Content Area (flex container)\n│ ├── Filter Sidebar (aside)\n│ │ ├── Filter Title (shadcn: Typography `h4`)\n│ │ ├── Category Filters (shadcn: Checkbox group)\n│ │ ├── Cuisine Filters (shadcn: Checkbox group)\n│ │ └── Difficulty Filters (shadcn: RadioGroup)\n│ └── Recipe Grid (main)\n│ └── Recipe Card (shadcn: Card)\n│ ├── Recipe Image (img)\n│ ├── Recipe Title (shadcn: Typography `h3`)\n│ ├── Recipe Tags (shadcn: Badge)\n│ └── Quick Actions (shadcn: Button - View, Edit)\n```\n\n- **State Flow Diagram**: Component state management using Mermaid\n- Reusable component library specifications\n- State management patterns with Zustand/React Query\n- TypeScript interfaces and types\n\n##### Security Performance\n\n- Authentication/authorization requirements\n- Data validation and sanitization\n- Performance optimization strategies\n- Caching mechanisms\n\n## Context Template\n\n- **Feature PRD:** [The content of the Feature PRD markdown file]", "variables": [], "notes": "Prompt for creating detailed feature implementation plans, following Epoch monorepo structure.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/drmoisan/TMW", "path": ".github/prompts/breakdown-feature-implementation.prompt.md", "ref": "dfd08b9bbaef03fe2a8865efedfd7b2233b0b927", "url": "https://github.com/drmoisan/TMW/blob/dfd08b9bbaef03fe2a8865efedfd7b2233b0b927/.github/prompts/breakdown-feature-implementation.prompt.md", "key": "drmoisan/TMW/.github/prompts/breakdown-feature-implementation.prompt.md" } } }

breakdown-feature-implementation

About

Feature Implementation Plan Prompt

Goal

Output Format

File System

Implementation Plan

Goal

Requirements

Technical Considerations

System Architecture Overview

Use it

Manifest

Reviews