Inspiration
I love learning new things every day and often find myself exploring new technologies. Experimentation is something I really enjoy. However, when I’m following a guide to learn a new technology—especially if I don’t have any prior hands-on experience—I often get stuck at certain points. This leads me to spend more time than necessary trying to figure things out, which ultimately causes me to lose focus.
I've always wished there was some kind of AI assistant that I could turn to whenever I get stuck. Imagine being on the seventh step of a guide and hitting a roadblock. With this AI, I could ask my question right then and there, get an immediate answer, and seamlessly continue to the eighth step. This way, I wouldn’t waste time or lose my momentum, making my learning process much more efficient and enjoyable.
That's what inspired me to build ClarifyMe, the AI Co-pilot. It sticks with me as I follow a documentation guide, helping me learn more efficiently. This way, I spend less time searching the internet for answers or writing prompts to ask ChatGPT for help, and more time learning, understanding concepts, and grasping things more effectively.
What it does
The current vision for ClarifyMe is to function like the Beside-Co-pilot app, acting as a helpful assistant within an application. It will contain all the details of a developer's getting-started guide for a product or technology, such as Azure Cosmos DB. Using RAG, the co-pilot will help users answer questions, clarify doubts, and resolve any issues they encounter while following the documentation. For instance, if a developer is building something and encounters an SSL: Certificate Verify Failed error while using Azure Cosmos DB for the first time, the co-pilot will provide quick and easy instructions right there in the guide to help them resolve the error.
How we built it
Challenges we ran into
Accomplishments that we're proud of
What we learned
What's next for ClarifyMe
The next phase for ClarifyMe is to enhance its personalization features for a wide range of product developer guides. This will involve incorporating detailed insights from various sources, such as:
Granular Issue Resolution: Including specific examples of issues faced by developers, along with step-by-step solutions or workarounds, to provide more context and practical guidance.
Community Knowledge Sharing: Leveraging community forums, blogs, and other platforms to gather insights from developers who have encountered similar challenges, fostering a collaborative learning environment.
Integration with GitHub: Providing visibility into open issues, bug reports, and feature requests related to the product, sourced directly from GitHub repositories, to keep users informed about the latest developments and potential pitfalls.
Real-time Updates: Offering timely updates about product changes, new features, and best practices, ensuring that developers have access to the most up-to-date information while working on their projects.
Interactive Learning Experiences: Implementing interactive elements, such as quizzes, coding challenges, and simulations, to enhance engagement and facilitate hands-on learning within the documentation guide.
AI-driven Recommendations: Utilizing AI algorithms to analyze user interactions and preferences, providing personalized recommendations for relevant documentation sections, tutorials, and resources.
Feedback Loop: Establishing a feedback mechanism for users to share their experiences, suggest improvements, and report issues, enabling continuous enhancement of the ClarifyMe platform based on user insights and preferences.
By incorporating these elements, ClarifyMe aims to become a comprehensive and user-centric platform that empowers developers to learn, troubleshoot, and collaborate more effectively while working with complex technologies and products.
Built With
- azurecosmosdb
- azureopenaiservice
- python
Log in or sign up for Devpost to join the conversation.