How to Use Swimm

Getting started with Swimm

With Swimm, you'll create and maintain up-to-date documentation for your codebase in just a few minutes. This guide will walk you through setting up your account, creating your first documentation piece, and tips for making the most of the tool.

Step 1: Sign up and set up

1. Go to swimm.io.
2. Click on the Get Started for Free button on the homepage.
3. Enter your email address and create a password, or sign up using your GitHub account for quicker access.
4. Confirm your email if prompted, then log in to your new Swimm account.

Step 2: Your first documentation piece

1. Once logged in, click on the New Doc button in the top right corner of the dashboard.
2. Select a project or create a new one by clicking on Create New Project.
3. Name your documentation piece and provide a brief description.
4. Use the Code Snippet button in the editor toolbar to link specific code sections to your documentation. This allows you to select code directly from your codebase.
5. Write your documentation in the editor, ensuring you describe the code snippets clearly.
6. Click Save when finished. Your documentation is now synced with your code!

Step 3: Get better results

1. Use the Version Control feature in the sidebar to track changes in your documentation alongside your code changes.
2. Regularly update your documentation by clicking on the Sync button whenever you make changes to your codebase.
3. Incorporate Code Comments directly in your code, as these can be automatically pulled into your documentation, keeping it relevant and up-to-date.

Pro tip

Use the Templates feature to create standardised documentation formats that you can reuse across different projects. This saves time and ensures consistency in your documentation style.

Common mistake to avoid

Avoid skipping the initial setup of linking code snippets. Many users forget to connect their documentation to the actual code, which results in standalone docs that are not helpful. Always ensure your documentation is linked to the relevant code sections for maximum effectiveness.