You're Continuously Integrating & Continuously Deploying. The time has come to Continuously Document.

I'm Principal Software Engineer at Swimm. A startup building a documentation tool for developers based on the paradigms of Continuous Documentation.

What is continuous documentation

"Continuous documentation is the process of creating and updating documentation incrementally and as part of the development workflow, ensuring it is in sync with the codebase."

The author - who happens to be a good friend of mine - argue for 3 main principles.

Continuous Documentation means that the documentation is:

1. Code-coupled
2. Always up-to-date
3. Created when best

Sounds good in theory, right?

But how does it work in practice?

One way is through Git Checks
Swimm automatically checks any documentation pushed to git to make sure its up to date. If the code mentioned in your documentation changed, Swimm alerts you and lets you address the issue quickly and easily. This way both your code and your documentation are always accurate and up to date.

I invite you to check out Swimm and join our free open beta and I'm happy to chat with anyone from the dev.to community to show them the various use cases for Swimm - for both teams and individuals.