You are an expert software architect and technical project planner. Your task is to create a comprehensive technical implementation plan for a software project based on the provided inputs.
do you know googly python-fire? Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object. I want a similar library, but instead of a CLI it generates amazing web apps for any python project!
Generate the following sections:
Generate a project name that is:
- Memorable and relevant
- Available as an npm package
- Has available common domain names
- Reflects the core functionality
Create a project hook that:
- Clearly states the value proposition
- Uses engaging, technical language
- Highlights unique features
- Is suitable for a technical README
- Includes an emoji that represents the project
Transform the project meta data into the following format:
project:
project_name: "Project Name 🚀" # Include emoji
core_concept: |
Brief description of the main project idea
project_hook: |
Project hook for catching users
key_features:
- Feature 1
- Feature 2
technical_constraints:
- "Must be web-based"
- Constraint 2
target_users: |
Description of who will use this system
Break down the system into core components:
architecture:
frontend:
core_ui_components:
- Component 1
- Component 2
state_management: |
Description of state management approach
data_flow_patterns:
- Pattern 1
- Pattern 2
user_interactions:
- Interaction 1
- Interaction 2
backend:
services_structure:
- Service 1
- Service 2
api_design:
endpoints:
- Endpoint 1
- Endpoint 2
data_processing:
- Process 1
- Process 2
external_integrations:
- Integration 1
- Integration 2
data:
storage_solutions:
- Solution 1
- Solution 2
data_models:
- Model 1
- Model 2
caching_strategy: |
Description of caching approach
data_flow: |
Description of data flow
infrastructure:
deployment_requirements:
- Requirement 1
- Requirement 2
scaling_considerations:
- Consideration 1
- Consideration 2
service_dependencies:
- Dependency 1
- Dependency 2
For each major component, specify:
components:
- name: "Component Name"
purpose: |
Clear statement of component's role
technical_requirements:
libraries:
- Library 1
- Library 2
performance:
- Performance requirement 1
security:
- Security requirement 1
integration_points:
- Integration point 1
implementation_details:
data_structures:
- Structure 1
algorithms:
- Algorithm 1
api_contracts:
- Contract 1
error_handling:
- Strategy 1
Convert the implementation components into concrete tasks:
tasks:
- id: "TASK-001"
category: "frontend/backend/infrastructure"
description: |
Specific, actionable task description
context_requirements:
interfaces_needed: [] # List of interfaces this task needs
technical_constraints: [] # Constraints that must be followed
state_dependencies: [] # What state/data this task needs
summary_requirements: # NEW SECTION
required_interface_details:
- name: "What interfaces must be documented"
- description: "What aspects of the interface are critical"
- example: "Example of required interface documentation"
required_decisions:
- category: "Architecture/Performance/Security/etc"
- impact_scope: "What areas are affected by decisions here"
- preservation_needs: "What decisions must be preserved for future tasks"
required_constraints:
- type: "Technical/Business/Performance/etc"
- verification: "How to verify constraint is met"
- downstream_impact: "What future tasks depend on this constraint"
required_data_structures:
- scope: "What data structures must be documented"
- format: "Required format for documentation"
- relationships: "Required relationship documentation"
technical_details:
required_technologies:
- Technology 1
- Technology 2
implementation_approach: |
Detailed implementation approach
expected_challenges:
- Challenge 1
- Challenge 2
acceptance_criteria:
- Criterion 1
- Criterion 2
complexity:
estimated_loc: 150 # Must be < 200
estimated_hours: 6 # Must be < 8
dependencies:
- "TASK-000"
Input:
project:
core_concept: |
A web application that analyzes GitHub repositories and generates AI-ready documentation.
key_features:
- Repository analysis
- Documentation generation
- AI context creation
technical_constraints:
- Must be web-based
- Support large repositories
- Generate structured output
target_users: |
Developers integrating repositories with LLMs
-
Technical Depth
- Every component should have clear technical specifications
- Include specific libraries and tools where relevant
- Define interfaces and data structures
- Specify performance requirements
-
Modularity
- Break down components into independent modules
- Define clear interfaces between components
- Enable parallel development
- Consider future extensibility
-
Implementation Focus
- Provide actionable technical details
- Include specific methodologies and patterns
- Define clear acceptance criteria
- Specify testing requirements
-
Task Specificity
- Tasks should be atomic and measurable
- Include technical requirements
- Specify dependencies clearly
- Define completion criteria
Your response should follow this structure:
- Project Identity (name and hook)
- Technical Architecture Overview
- Detailed Component Specifications
- Task Breakdown
- Implementation Dependencies
- Focus on technical implementation details
- Provide specific, actionable information
- Include concrete examples where helpful
- Define clear interfaces and contracts
- Specify exact technical requirements
- Include performance constraints
- Define error handling approaches
- Specify testing requirements
- MAKE THE BEST APP POSSIBLE
- Analyze the topic and the idea at hand and deeply analyze it for "genius ideas & eureka" moments
- If similar apps already exist think of ways on how to improve on them to make our app stand out
- If the user forgot important use cases or ideas feel free to add them as you see fit
- End your report by a short section about why you think this app is going to be amazing
The goal is to generate a technical plan that can be immediately used to begin implementation, with clear tasks that can be assigned to developers.