What makes for good documentation? In this episode, we dive into one of the most important yet overlooked facets of coding. With us are Omer Rosenbaum and Tim Post of Swimm.io. Swimm is an app that allows you to create docs coupled with your code, which are auto-synced and integrated into your workflow. It makes for much more efficient, elegant, and accessible documentation.
Omer is the CTO of Swimm, and Tim is Principal Development Relations and User Advocate. They are the experts who will guide us through good code documentation practices and tools, as well as share some fascinating real-life examples and stories.
Show Notes
What makes for good documentation? In this episode, we dive into one of the most important yet overlooked facets of coding. With us are Omer Rosenbaum and Tim Post of Swimm.io. Swimm is an app that allows you to create docs coupled with your code, which are auto-synced and integrated into your workflow. It makes for much more efficient, elegant, and accessible documentation.
Omer is the CTO of Swimm, and Tim is Principal Development Relations and User Advocate. They are the experts who will guide us through good code documentation practices and tools, as well as share some fascinating real-life examples and stories.
This episode touches on the following key topics and ideas:
00:03:28 Omer: learning tech while in the military
00:12:15 Tim: the consulting career route
00:18:15 Stack Overflow elected moderator
00:22:49 What is good code documentation?
00:46:59 Signs of bad code documentation
01:01:16 Code documentation horror stories
01:07:26 Swimm offers for open-source projects and enterprises
Resources mentioned in this episode:
Tools
Catch Swimm on:
If you’ve enjoyed this podcast, you can listen to more programming news and updates like this one on Programming Throwdown’s website:
https://www.programmingthrowdown.com/, or send us an email at programmingthrowdown@gmail.com.
You can also follow Programming Throwdown on
You can also help support Programming Throwdown through our
Patreon.
★ Support this podcast on Patreon ★