Code Documentation with Omer Rosenbaum and Tim Post

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:01:20 Introducing Omer and Tim 00:03:28 Omer: learning tech while in the military 00:06:36 Israel Tech Challenge 00:08:32 Impostor Syndrome 00:12:15 Tim: the consulting career route 00:18:15 Stack Overflow elected moderator 00:20:59 ZFS and Btrfs  00:22:49 What is good code documentation? 00:34:48 Documentation and remote work 00:36:99 Good practices 00:40:37 Code comments 00:45:20 How to write documentation 00:46:59 Signs of bad code documentation 00:48:05 Swimm overview 00:53:21 PyTorch documentation 00:54:45 PHP documentation 00:56:34 Swimm’s CLI tools 01:01:16 Code documentation horror stories 01:07:26 Swimm offers for open-source projects and enterprises 01:13:47 Working at Swimm 01:19:54 The value of remote work Resources mentioned in this episode: ToolsSwimm https://swimm.io/ReiserFS https://en.wikipedia.org/wiki/ReiserFSPyTorch https://pytorch.org/docs/stable/index.htmlElectron https://www.electronjs.org/Git https://git-scm.com/Stack Overflow https://stackoverflow.com/ Catch Swimm on: Twitter | Facebook | LinkedIn 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  Facebook | Apple Podcasts | Spotify | Player.FM  You can also help support Programming Throwdown through our Patreon. ★ Support this podcast on Patreon ★