🚀 DocuGen AI 🚀

Shifting from Manual to Automated Documentation

Perfect for developers, project managers, and new team members looking to understand business logic faster

A powerful AI powered VS Code extension that scans your repository and generates a markdown based documentation of your code!

✨ To Setup DocuGen

• Open VSCode settings
• Search for DocuGen AI
• Enter the Model Provider, Model name, Model Endpoint, API version, API key

Note: When using Ollama, Model version can be set to ollama

✨ Usage

• Open the project in VSCode
• Run the command Generate Document by scanning repository

✨ Where did the idea come from?

• Tired of messy, outdated & incomplete documentation

✨ Why do we care about this idea?

• Creating & updating documentation manually is a pain staking effort & we wanted to automate this process using Azure Open AI

✨ How does this relate to your day jobs, if at all?

• We spend everyday delivering so many features & releases on daily basis to our customers including painful & manual documentation. Imagine a newly onboarded team member asking you to explain the code 😰

✨ Who is this project for?

• Developers, Project Managers & Newly onboarded team members

✨ Why is this solution different and compelling for the customer?

• Standardization of documentation across multiple projects throughout the organization provides a greater value addition on daily basis

✨ Key Features:

• Automatically generates & updated documentation from your code
• Summarizes code using OpenAI models or Ollama integration
• Seamless VS Code integration with real-time updates

⚙️ Upcoming Releases:

• Generate business logic documentation from multiple repositories
• Standardized, AI-powered documentation templates

👩‍💻 Make software development more efficient with instant, consistent code documents, whether you're onboarding, reviewing, or managing projects!

👉 Join us on this exciting journey! We’d love your feedback and support.

👉 Don’t forget to like, bookmark, and spread the word if you’re excited for automated documentation with DocuGen! 💡