Skip to main content

Welcome to Swimm

All your engineering knowledge — available in the IDE, integrated with code, and automatically updated.

What is Swimm​

Swimm is a documentation tool designed for engineering teams to meet documentation challenges.

With Swimm, you can streamline internal code documentation and share developer knowledge across teams and repositories.

Swimm enables developers to create documentation that is:

  • Code-coupled
  • Always up to date
  • Easily created
  • Consumed when and where needed

This site is also automatically kept up to date using Swimm 😎

Watch a 1-minute video about Swimm:

Why Swimm​

Many companies have given up on documentation, saying things like:

“Our docs quickly become obsolete.”
“We just don't have time for documentation.”
“When you need a document it's too hard to find it.”
“Developers don't like to write it.”
“It's too much work to maintain and update docs.”

We know documentation is broken. That's why we're here to fix it.

info

Why Swimm? The connection between good documentation and higher developer productivity is now well established (GitHub's Octoverse study). At Swimm, we have seen firsthand that developer documentation is really a game changer for companies.

Swimm's approach​

Swimm's entire solution is built for engineering teams by engineers.

We treat documentation like code (Docs as code) to streamline the process so that documentation and code are created and maintained together. Swimm saves all documentation as code so that your docs are easy to read as Markdown files.

Swimm has many integrations with other tools: VS Code, IntelliJ, Slack and more to come.

How Swimm is different​

If you are asking what are the Swimm differentiators - what makes Swimm different - here's your answer:

Swimm's patented Auto-sync feature
With “Auto-sync,” documentation is always up to date. One of Swimm’s core unique capabilities with Auto-sync is ensuring that your documentation will stay synced with the code as it evolves and changes.

Our code-coupled editor
Swimm created the world's first editor with all the capabilities of rich text, Markdown, and live code snippets embedded in your docs.

IDE integrations
With Swimm, you will consume documentation directly from the IDE. Accessing documentation at the right time means that you have it exactly when you need it. You’ll no longer need to switch contexts from the IDE and an external location for your docs.

tip

Ready to get started?​

This document is automatically kept up to date using Swimm.