Documentation Platform... Built for Engineers

By Code Story • Issue #93 • View online

This newsletter is sponsored by Swimm.

Let’s face it, most documentation systems are broken, leading to incomplete, outdated, and hard to find docs. As a result, scaling your product or your team takes enormous effort.

Swimm aims to change all that.

Bonus: Omer Rosenbaum, Swimm

Despite the skill level of engineers these days, Omer found that the onboarding processes of many companies were too costly. After discussing this issue with many end users, they confirmed that the world of knowledge sharing was broken… and they wanted to fix it.

codestory.co • Share

Swimm—built for and designed by developers—is on a mission to change the way developers share knowledge. Swimm’s platform can be set-up in minutes and gives engineering teams usable, discoverable, and auto-synced documentation. All without interrupting their regular workflow.

With Swimm, developers can:

Create new, cope-coupled, auto-synced docs in just a few seconds

With Swimm, it’s incredibly easy to get started with documentation. Developers have access to code-walkthroughs and docs from PRs, code snippets, and templates. Plus, Swimm’s code-coupled editor is language agnostic.

swimm.io • Share

Keep docs synced to the codebase seamlessly with Live Snippets

Swimm docs are never out-of-date, even when your codebase changes. Developers can use our GitHub integration and auto-sync algorithm to keep docs up-to-date as the code evolves, even through refactoring and reorganization. When docs are out-of-date, Swimm keeps you notified. (Note: currently Swimm supports GitHub only).

swimm.io • Share

Access docs in the IDE, the moment they’re needed. No more context switching.

Swimm doesn’t interrupt the developer’s flow. With VS Code and JetBrains integrations, developers can access docs the moment they need them, right in their IDE. Plus, Swimm docs are in Markdown! Developers can also use Swimm to search the entire codebase with ease.

swimm.io • Share

Make onboarding and knowledge sharing a breeze

Swimm makes onboarding, standardizing your documentation, and centralizing know-how easy and painless for your team. All teammates benefit from Swimm Playlists, which are collections of code-coupled docs and external links. New hires use them to dive right in and make onboarding a breeze; more seasoned team members rely on them to tackle a code refactor or work on a part of the code base they’re less familiar with.

swimm.io • Share

Join the Swimm Team on Slack!

Join the Swimm Team on Slack! We’re excited to chat with our beta users to share best practices, answer questions, and share product updates.

Did you enjoy this issue?

By Code Story

Code Story is a podcast, interviewing tech leaders about the roads they travelled creating world changing products. Monthly, we look back at the episodes highlights, happenings for the show and opportunities for support. Stay tuned, and sign up today.

Tweet

Share

In order to unsubscribe, click here.

If you were forwarded this newsletter and you like it, you can subscribe here.

Powered by Revue

Documentation Platform... Built for Engineers

Older messages

The industry's first Hyper Converged Console

Code Story - May 2022

Code Story - April 2022

Most destructive? Ransomware.

What impacts YOUR revenue? Find out with Dreamdata.

You Might Also Like

AI search engine startup Perplexity eyes a $3B valuation

🎞️ We Tried 3D Printing a Photo — You'll Love This Secret Samsung Galaxy Bluetooth Feature

You're invited – product sense, prioritization, careers

CTRL-C, Exceptions, Ruff Speed-up, and More

Writing Contests Just Landed On Product Hunt 🔥

Daily Coding Problem: Problem #1421 [Hard]

Ranked | The Top 10 EV Battery Manufacturers 🔋

Bringing PGO to the build pipeline

Noonification: Leetcode: Two-sum an Intuitive Approach

The best AI chatbot for coding