Data For Future
Data For Future
Tammy Liang
39: Making Documentation Sexy | Juan Luis Cano, Read the Docs
47 minutes Posted Jun 9, 2021 at 1:06 pm.
0:00
47:45
Download MP3
Show notes

Coding is cool, but badly documented codes are not. Although documentation at first glance does not seem to be the sexiest task for developers and data scientists, it is ultra essential for any project to scale and for further collaboration. Juan, the developer advocate of Read the Docs, is here with us today to introduce why we should think about documentation as an empathy, what are the tools to enable simple and clear documentation, and what are the principles to abide when documenting. Furthermore, we also touched upon the importance of open-source community, diversity in tech, and data ethics. Listen in!




Contact-


[email protected]


twitter


linkedin




Related Resources-


-Why you should document your work as a data scientist


-Surveys about documentation



-Diátaxis Framework for documentation


- Readme Checklist



This is a public episode. If you would like to discuss this with other subscribers or get access to bonus episodes, visit tammyliang.substack.com