47 min

39: Making Documentation Sexy - Juan Luis Cano| Read the Docs Data For Future

    • Technology

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-

hello@juanlu.space

twitter

linkedin



Related Resources-

-Why you should document your work as a data scientist

-Surveys about documentation


Digital Ocean

State of API

Postman

Technical Communication

Developer Documentation Trends


-Diátaxis Framework for documentation

- Readme Checklist

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-

hello@juanlu.space

twitter

linkedin



Related Resources-

-Why you should document your work as a data scientist

-Surveys about documentation


Digital Ocean

State of API

Postman

Technical Communication

Developer Documentation Trends


-Diátaxis Framework for documentation

- Readme Checklist

47 min

Top Podcasts In Technology