ai-project-planner / README.md
Codemon's picture
Update README.md
f384d7a verified
|
Raw History Blame Contribute Delete
4.75 kB
---
title: AI Project Planner
emoji: πŸš€
colorFrom: purple
colorTo: blue
sdk: gradio
sdk_version: 6.2.0
app_file: app.py
pinned: true
license: mit
short_description: Transform product specs into project plans via AI
---
# πŸš€ AI Project Planner
**Transform product specifications into comprehensive project plans using orchestrated AI agents.**
[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
## What This Does
Upload any product specification and watch as specialized AI agents collaborate to generate:
- **πŸ‘€ User Stories** - Persona-based requirements in "As a... I want... So that..." format
- **πŸ“¦ Product Features** - Logically grouped capabilities with descriptions and user benefits
- **πŸ”§ Engineering Tasks** - Detailed development work breakdown with dependencies and estimates
## How It Works
```
Product Spec β†’ Action Planner β†’ Routing Agent β†’ Specialized Teams β†’ Project Plan
β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
↓ ↓ ↓
Product Manager Program Manager Dev Engineer
(User Stories) (Features) (Tasks)
β”‚ β”‚ β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Ίβ”‚β—„β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
Evaluation Agents
(Quality Assurance Loop)
```
### The Agent Architecture
| Agent | Role | Output |
|-------|------|--------|
| **Action Planning Agent** | Breaks down high-level goals into workflow steps | Task sequence |
| **Routing Agent** | Directs each step to the appropriate specialist using semantic similarity | Agent selection |
| **Product Manager Team** | Knowledge Agent + Evaluation Agent for user stories | Validated stories |
| **Program Manager Team** | Knowledge Agent + Evaluation Agent for features | Validated features |
| **Dev Engineer Team** | Knowledge Agent + Evaluation Agent for tasks | Validated tasks |
## Quick Start
1. **Enter your OpenAI API key** (required for AI agents to function)
2. **Upload or paste** a product specification (or use an example)
3. **Click Generate** and watch the workflow execute
4. **Download** your project plan in Markdown or JSON format
## Example Output
### User Story
```
As a Customer Support Representative, I want the Email Router system
to automate responses to routine inquiries so that I can focus on
addressing complex customer issues efficiently.
```
### Product Feature
```
Feature Name: Intelligent Email Classification
Description: NLP-powered analysis for categorizing incoming emails
Key Functionality: Content analysis, intent detection, priority assignment
User Benefit: Reduced manual triage time by 70%
```
### Engineering Task
```
Task ID: EMAIL-001
Task Title: Implement NLP classification engine
Related User Story: US-001
Description: Develop ML pipeline for email content analysis
Acceptance Criteria: Classification accuracy >95%
Estimated Effort: 3 weeks
Dependencies: Email preprocessing module
```
## Technical Details
- **Model**: GPT-3.5-turbo for text generation
- **Embeddings**: text-embedding-3-large for semantic routing
- **Framework**: Gradio for the web interface
- **Quality Control**: Iterative evaluation loops with up to 5 refinement cycles
## Use Cases
- **Product Managers**: Quickly generate user stories from feature ideas
- **Technical Program Managers**: Create comprehensive project plans
- **Engineering Leads**: Break down requirements into actionable tasks
- **Startups**: Transform product vision into development roadmaps
## Privacy & Security
- Your API key is **never stored** - it's only used for the current session
- Product specifications are **not retained** after processing
- All processing happens in real-time with no data persistence
## Built With
- [Gradio](https://gradio.app/) - Web interface framework
- [OpenAI API](https://openai.com/) - AI capabilities
- [NumPy](https://numpy.org/) - Vector operations for semantic routing
## Author
Built as part of the Udacity AI Programming curriculum, extended with production deployment capabilities.
## License
MIT License - feel free to use, modify, and distribute.
---
**⭐ If you find this useful, please star the repository!**