Keeping Documentation Up to Date with Swimm's Visual Studio Plugin

On this page

Note: This is the Preview version of the Visual Studio plugin.

Auto-sync: Documentation That Stays Current​

One of the core features of Swimm's Visual Studio plugin is Auto-sync, which helps keep your documentation up to date as your code evolves. Auto-sync works by:

1. Detecting changes to code that is referenced in documentation
2. Automatically updating the documentation to reflect those changes
3. Alerting you when manual intervention is needed

This ensures that your documentation remains accurate and useful, even as your codebase changes over time.

How Auto-sync Works in Visual Studio​

When you make changes to code that is referenced in Swimm documentation, the plugin will:

1. Identify which documents are affected by your changes
2. Attempt to automatically update the documentation
3. Show you the status of each document (up to date, auto-synced, or needs attention)

You can see the status of your documentation in the Swimm panel, where documents are marked with different icons to indicate their current state.

Handling Documents That Need Attention​

Sometimes, code changes are too complex for Auto-sync to handle automatically. In these cases, the plugin will alert you that a document needs attention. You can:

1. Open the document to see what needs to be updated
2. Make the necessary changes to bring the documentation up to date
3. Save the updated document

By addressing these alerts promptly, you can ensure that your documentation remains accurate and useful for your team.

---

This document is automatically kept up to date using Swimm.

• Auto-sync: Documentation That Stays Current
• How Auto-sync Works in Visual Studio
• Handling Documents That Need Attention

---

Read this article on Swimm's official docsite