Snorkell.ai logo
Snorkell.ai
Snorkell, PWA

Unveiling the Best AI Tools for Documenting your code - Snorkell.ai

Unveiling the Best AI Tools for Documenting your code - Snorkell.ai
0 views
3 min read
#Snorkell, PWA

In the ever-evolving world of software development, the need for efficient and accurate tools is paramount. Today, I am thrilled to share a groundbreaking development in this space - an Automatic Documentation Generator for repositories, a project that’s not just a tool, but a significant shift in the field of clean software development.

The Genesis

The journey began with a common frustration in the software world: the relentless task of updating documentation. As developers, we've all been there—code changes, and the documentation lags, leading to outdated information and a myriad of inconsistencies. That's when the idea struck me. Inspired by tools like GitHub Co-pilot, I envisioned a tool that could seamlessly sync documentation with every code update, a tool that moves in rhythm with the development process. This vision marked the birth of Snorkell.ai.

The Building Blocks

The mission was clear: create a tool that integrates effortlessly, monitors code changes, and updates documentation automatically. I dove into the world of Large Language Models (LLMs), determined to craft a system that doesn’t just understand code but translates it into clear, accurate, and coherent documentation.

GPT-4

At the heart of Snorkell.ai is a Finetuned GPT-4 model, capable of parsing code, identifying key components, and generating comprehensive documentation. This AI doesn’t just comprehend syntax; it grasps the context, ensuring the documentation is as informative as it is precise.

Seamless Generation and Continuous Updating

Our tool operates discreetly in the background. Here’s how it works:

  1. Code Merge Detection: Snorkell.ai detects new code merged into the ‘main’ branch, focusing on modifications in functions and classes.
  2. Documentation Generation: It then automatically generates updated documentation, reflecting the latest changes with precision and clarity.
  3. Pull Request Creation: Snorkell.ai creates a pull request with this updated documentation for review and integration.
  4. Review and Merge: Developers can review and merge the documentation, ensuring it stays synced with the latest code.

Currently, Snorkell.ai supports projects hosted on GitHub.

The Outcome

Snorkell.ai revolutionizes documentation management. It saves hours, minimizes errors, and ensures everyone on the team has access to the latest insights. This tool doesn't just update documentation; it transforms the approach to documentation in software development.

Gratitude and Looking Ahead

The development of Snorkell.ai wouldn't have been possible without the invaluable feedback and support from the developer community. As we move forward, I am eager to continue improving and expanding this tool, helping more teams streamline their software development processes.

I invite you to share your experiences with software project documentation and how AI tools like Snorkell.ai could impact your work.


Stay connected for more updates and insights in the world of software development, AI, and technological innovation. Your feedback and experiences fuel our journey towards creating tools that not only meet but exceed the evolving needs of the software development community.

#SoftwareDevelopment #GitHub #Documentation #AI #MachineLearning #TechInnovation #OpenAI #ChatGPT #Python #Coding #Javascript #Typescript #Java