VibeDoc acts as an AI Product Manager and Software Architect, rapidly transforming product ideas into comprehensive development plans, technical documentation, and AI coding prompts. It targets developers, product managers, and entrepreneurs, aiming to automate initial project planning and technical specification within 60-180 seconds.

How It Works

Utilizing the Qwen2.5-72B-Instruct LLM, VibeDoc generates detailed plans covering product overview, technical solutions, roadmaps, and growth strategies. It automatically creates professional diagrams via Mermaid (architecture, flow, Gantt) and produces ready-to-use AI coding prompts for tools like Claude, Copilot, and ChatGPT. Outputs are exportable in Markdown, Word, PDF, and HTML formats, streamlining the documentation process.

Quick Start & Requirements

An online demo is available for immediate use without installation. For local setup, Python 3.11+ and a free SiliconFlow API Key are required. Installation involves cloning the repo, setting up a virtual environment, installing dependencies (pip install -r requirements.txt), and configuring the API key in .env. Docker deployment is also supported.

• Online Demo: https://modelscope.cn/studios/JasonRobert/Vibedocs
• Local Setup: Python 3.11+, pip, SiliconFlow API Key.
• Primary Install: pip install -r requirements.txt (after cloning and venv setup).
• Run Command: python app.py (local), docker run ... (Docker).

Highlighted Details

• Generation Speed: Plans are generated in 60-180 seconds.
• Comprehensiveness: Produces detailed development plans, AI coding prompts, and visual diagrams using Mermaid.
• Export Options: Supports Markdown, Word (.docx), PDF, and HTML formats.
• AI Prompt Generation: Tailored prompts are generated for multiple AI coding assistants (Claude, Copilot, ChatGPT, Cursor).

Maintenance & Community

Community engagement is encouraged via GitHub Discussions. A roadmap details planned features for v2.1 (e.g., more AI models, team collaboration) and v2.2 (e.g., mobile support, API interface).

• Community: GitHub Discussions
• Roadmap: Planned features for v2.1 and v2.2.

Licensing & Compatibility

Released under the MIT License, which is permissive for commercial use and integration into closed-source projects.

Limitations & Caveats

Local/Docker installations necessitate an external SiliconFlow API Key. Key features like team collaboration, mobile support, and a public API are planned for future releases (v2.1/v2.2) and are not currently implemented.