Repository
VibeDoc
π Your AI Product Manager & Architect - Transform ideas into complete development plans with AI coding prompts in 60-180 seconds
- Metric
- Performance
- Generation Speed
- Generation Speed
- Success Rate
- Success Rate
- Content Quality
- Content Quality
Specs
- MetricPerformance
- Generation SpeedGeneration Speed
- Success RateSuccess Rate
- Content QualityContent Quality
- Export FormatsExport Formats
README
π VibeDoc: Your AI Product Manager & Architect
β¨ Why VibeDoc?
As a developer, product manager, or entrepreneur, you face these challenges:
- π Great Ideas, No Plan? You have ideas but don't know how to turn them into actionable development plans
- β° Documentation Takes Forever? Writing technical specs and architecture docs consumes massive time
- π€ AI Tools Confusing? You want AI-assisted coding but struggle with effective prompt engineering
- π Missing Professional Diagrams? You need architecture, flow, and Gantt charts but lack design tools expertise
VibeDoc Solves Everything!
π― Core Features
π Intelligent Development Plan Generation
Enter your product idea - AI generates a complete plan in 60-180 seconds:
- Product Overview - Background, target users, core value proposition
- Technical Solution - Tech stack selection, architecture design, technology comparison
- Development Plan - Phased implementation, timeline, resource allocation
- Deployment Strategy - Environment setup, CI/CD pipeline, operations monitoring
- Growth Strategy - Market positioning, operations advice, growth tactics
π€ AI Coding Prompt Generation
Generate ready-to-use prompts for each feature module, supporting:
- β Claude - Code generation, architecture design
- β GitHub Copilot - Intelligent code completion
- β ChatGPT - Technical consultation, code optimization
- β Cursor - AI-assisted programming
π Auto-Generated Visual Diagrams
Professional diagrams using Mermaid:
- ποΈ System Architecture - Component relationships visualization
- π Business Flowcharts - Business logic visualization
- π Gantt Charts - Project timeline at a glance
- π Tech Comparison Tables - Technology decision reference
π Multi-Format Export
One-click export for different scenarios:
- Markdown (.md) - Version control friendly, GitHub display
- Word (.docx) - Business documents, project reports
- PDF (.pdf) - Formal proposals, print archives
- HTML (.html) - Web display, online sharing
π‘ Real-World Example
Input Idea
Develop an AR sign language translation app that can translate sign language
into voice and text in real-time, and also translate voice and text into
sign language gestures displayed in AR
Generated Output
π View Complete Development Plan (10,000+ words)
The AI-generated plan includes:
1. Product Overview
- Target users (deaf community, healthcare workers, educators)
- Core features (real-time translation, multi-language support, AR visualization)
- Market positioning and competitive analysis
2. Technical Architecture
Complete system architecture with Mermaid diagrams showing:
- User interface components
- Backend services
- ML model integration
- Database design
- AR rendering pipeline
3. Technology Stack
- Frontend: React Native (cross-platform)
- Backend: Node.js + Express
- ML Models: TensorFlow for sign language recognition
- NLP: spaCy for natural language processing
- AR: ARKit (iOS) / ARCore (Android)
- Database: MongoDB
4. Development Timeline
6-month plan with 3 major milestones:
- Month 1-2: Core recognition & translation engine
- Month 3-4: AR integration & UI development
- Month 5-6: Testing, optimization & deployment
5. 12+ AI Coding Prompts
Ready-to-use prompts for each module. Example:
Feature: Hand Gesture Recognition Model
Context:
Building a real-time hand gesture recognition system for sign language translation.
Need to detect and classify hand positions, movements, and facial expressions.
Requirements:
- Process video frames at 30+ FPS
- Recognize 500+ sign language gestures
- Support continuous gesture sequences
- Handle varying lighting conditions
Tech Stack:
- TensorFlow/Keras for model training
- MediaPipe for hand landmark detection
- OpenCV for image preprocessing
Constraints:
- Must run on mobile devices (iOS/Android)
- Model size < 50MB for mobile deployment
- Inference time < 100ms per frame
Expected Output:
- Model architecture code
- Training pipeline
- Data preprocessing functions
- Mobile optimization strategies
π Quick Start
π Online Demo (Recommended)
π Try VibeDoc Now - No installation required!
Experience the full functionality:
- Enter your product idea (e.g., "Build a smart fitness app")
- Optionally add reference URLs for context
- Click generate and wait 60-180 seconds
- Get complete development plan with AI coding prompts
- Export to Markdown/Word/PDF/HTML formats
π» Local Installation
Prerequisites
- Python 3.11+
- pip package manager
- SiliconFlow API Key (free to obtain)
Installation Steps
# 1. Clone the repository
git clone https://github.com/JasonRobertDestiny/VibeDoc.git
cd VibeDoc
# 2. Create virtual environment (recommended)
python -m venv venv
# Activate virtual environment
# Windows:
venv\Scripts\activate
# macOS/Linux:
source venv/bin/activate
# 3. Install dependencies
pip install -r requirements.txt
# 4. Configure environment variables
cp .env.example .env
# Edit .env file and add your API Key
Configuration
In .env file:
# Required: SiliconFlow API Key (free registration)
SILICONFLOW_API_KEY=your_api_key_here
# Optional: Advanced Configuration
API_TIMEOUT=300
LOG_LEVEL=INFO
ENVIRONMENT=production
Run Application
python app.py
Application starts at:
- Local: http://localhost:7860
- Network: http://0.0.0.0:7860
π³ Docker Deployment (Optional)
# Build image
docker build -t vibedoc .
# Run container
docker run -p 7860:7860 \
-e SILICONFLOW_API_KEY=your_key \
vibedoc
ποΈ Technical Architecture
Modular architecture design:
βββββββββββββββββββββββββββββββββββββββββββ
β Gradio Web Interface β
β (User Interaction + UI + Export) β
βββββββββββββββββββ¬ββββββββββββββββββββββββ
β
βββββββββββββββββββΌββββββββββββββββββββββββ
β Core Processing Engine β
βββββββββββββββββββββββββββββββββββββββββββ€
β β’ Input Validation & Optimization β
β β’ AI Generation Coordination β
β β’ Content Quality Control β
β β’ Multi-format Export β
ββββ¬βββββββββ¬βββββββββββ¬ββββββββββ¬βββββββββ
β β β β
βΌ βΌ βΌ βΌ
ββββββββ ββββββββββ ββββββββ ββββββββββββ
β AI β βPrompt β βContentβ βExport β
βModel β βOptimizerβ βValidatorβ βManager β
ββββββββ ββββββββββ ββββββββ ββββββββββββ
Technology Stack
- Frontend: Gradio 5.34.1 - Fast AI app interface
- AI Model: Qwen2.5-72B-Instruct - Alibaba Cloud
- Chart Rendering: Mermaid.js - Code-based diagrams
- Document Export: python-docx, reportlab
- Async Processing: asyncio, aiofiles
π Performance Metrics
| Metric | Performance |
|---|---|
| Generation Speed | 60-180 seconds |
| Success Rate | >95% |
| Content Quality | 85/100 average |
| Export Formats | 4 formats |
π¨ Use Cases
π¨βπ» Developers
- β Validate technical feasibility quickly
- β Generate project documentation
- β Get AI coding prompts
- β Learn architecture best practices
π Product Managers
- β Transform requirements into technical solutions
- β Create project planning documents
- β Estimate development cycles
- β Build project proposals
π Students & Learners
- β Learn software development best practices
- β Understand architecture design
- β Prepare for technical interviews
- β Plan graduation projects
π Entrepreneurs
- β Validate product ideas quickly
- β Generate technical plans for investors
- β Plan MVP development
- β Assess implementation costs
π€ Contributing
We welcome all contributions:
- π Report Bugs
- π‘ Suggest Features
- π Improve Documentation
- π§ Submit Code
Steps
- Fork this project
- Create feature branch (
git checkout -b feature/AmazingFeature) - Commit changes (
git commit -m 'Add AmazingFeature') - Push to branch (
git push origin feature/AmazingFeature) - Submit Pull Request
See CONTRIBUTING.md for details.
π¬ Join Community
Join the VibeDoc community to share experiences, get support, and discuss ideas!
**Scan to Join VibeDoc Community**
Share Experiences | Get Support | Join Discussions
π Documentation
- User Guide - Detailed instructions
- Technical Docs - Architecture & development
- Deployment Guide - Production deployment
- Security Policy - Security best practices
π― Roadmap
v2.1 (Planned)
- [ ] More AI models (GPT-4, Claude, etc.)
- [ ] Team collaboration features
- [ ] Version management
- [ ] Online editor
v2.2 (Planned)
- [ ] Mobile support
- [ ] Multi-language (English, Japanese)
- [ ] Template marketplace
- [ ] API interface
π Acknowledgments
- Qwen2.5-72B-Instruct by Alibaba Cloud
- Gradio team
- SiliconFlow API services
- All contributors and users β€οΈ
π License
π Contact
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: [emailΒ protected]
- Demo: Bilibili
β Star History
If this project helps you, give us a Star β!