Introducing Swimm AI ✨. Generate code documentation from scratch and make sure that dev knowledge surfaces when needed most. Join our open beta (it’s free!) and experience the future of documentation.
Hey Product Hunt! My name is Omer and I’m the CTO and one of the Co-founders at Swimm, a documentation tool built by devs, for devs. You might remember us from January when we first launched Swimm. Thanks to you all we were voted as Product of the Day and even Product of the Week! 🙏🏻
I’m excited to be back here today to share an exciting update: the launch of Swimm AI beta.
Swimm AI represents a significant evolution of our platform. It combines our extensive knowledge and know-how of documentation best practices with GenAI technology.
But what sets Swimm AI apart and makes a splash (yeah, had to squeeze in at least one water pun) compared to other AI tools for devs, is our unique core technology: Auto-sync.
Auto-sync ensures that documentation remains up to date as part of the CI workflow. The key here is that the LLMs powering Swimm AI are continually informed by the most recent and pertinent code knowledge. The outcome? Your results are consistently accurate.
We already have great plans for additional AI features, so stay tuned for more updates.
Here’s what you can do with Swimm AI right now:
Generate documentation with AI: Eliminate the blank canvas problem with AI-powered suggestions on your docs' structure and content. Receive header suggestions, as well as full sections, that adapt and react to the code snippets and text you've added.
Generate docs from PRs: Let AI analyze pull requests and then generate documentation based on the changes made to the code.
Documentation that finds you: Utilize AI to set up doc visibility rules based on use cases. Ensure that relevant code knowledge is available and appears before mistakes are made.
We can’t wait for you to try out Swimm AI!
Let us know what you think!
Omer, Oren, Gilad, Tom, and the team at Swimm.
Can you elaborate on this: The data sent to OpenAI is not used to train or improve OpenAI’s model, though may be retained for a limited time? 👉 I'm not keen on sharing company secrets with my future AI overlord 😅
@sentry_co thanks for asking about this! This is the relevant part of OpenAIs terms, which can be found in the link at the bottom:
1. OpenAI will not use data submitted by customers via our API to train or improve our models, unless you explicitly decide to share your data with us for this purpose. You can opt-in to share data.
2. Any data sent through the API will be retained for abuse and misuse monitoring purposes for a maximum of 30 days, after which it will be deleted (unless otherwise required by law).
Please read more here: https://openai.com/policies/api-...
Needless to say, we did not opt-in to share data.
@tom_ad Thanks for the clarification. OpenAI is loosing access to reddit and twitter api's so the incentive for openAI is to then use their own user data to train models. So Im always on edge regarding what I share with them.
Congrats on the launch ! The tool looks promising, we are doing something similar at my company but for Devops to automate infra documentation. May I ask what software you used for generating the launch video? looks great :)
I have faced such the task so many times while working at tech products. So I found this product quite helpful and allowing cut the manual repetitive tasks. Awesome 👏
@xeniagoron Indeed, that's really what we had in mind while building this, how can we make it so easy it would be a no brainer (and even enjoyable) to make it part of your day2day.
With Swimm.ai, we're not just changing the way you document your code; we're making it an enjoyable experience! Imagine that – creating detailed documentation as quickly as you can code, and all thanks to AI!
@oren_toledano1@omerr huge congrats on the launch of Swimm AI - this feels like something incredibly special in modernising developer workflows. Chapeau to you and the team.
I'm definitely going to use something like this ASAP! As I am a huge fan of comments. More than half of my code is docs and comments. Question: Does it work with VSCode or Xcode?
@sentry_co Great! Using Swimm, you'll be able to create docs that describe flows that go through multiple files and repos, so far more elaborate than comments in the code.
We have plugins for VS Code and Jetbrains IDEs. We don't support X Code yet.
@sentry_co Yes. But also docs on how to do certain things, best practices, explanations about data flows, business logic and much more. Basically, any context about the code that a developer would need to work with it or contribute to it.
Swimm