VoV 052: Documentation with Natalia Tepluhina
In this episode of Views on Vue, the panelists talk to Natalia Tepluhina, Senior Frontend Developer at GitLab, about the importance of good documentation and the value of its contribution to open source in comparison to that of actual code. Natalia talks about the projects she has written documentation for, and they discuss the challenges in producing good docs. She explains three rules in making documentation comprehensive and the process involved in its creation.
Special Guests:
Natalia Tepluhina
Show Notes
Sponsors
- Sentry use the code “devchat” for $100 credit
- Triplebyte
- CacheFly
Panel
- Divya Sasidharan
- Erik Hanchett
- Charles Max Wood
Joined by special guest: Natalia Tepluhina
Episode Summary
In this episode of Views on Vue, the panelists talk to Natalia Tepluhina, Senior Frontend Developer at GitLab, about the importance of good documentation and the value of its contribution to open source in comparison to that of actual code. Natalia talks about the projects she has written documentation for, and they discuss the challenges in producing good docs. She explains three rules in making documentation comprehensive and the process involved in its creation.
They then go into specifics about Vue documentation and discuss plugins, differences between cookbooks and guides, ways for developers to contribute to the projects, resources that they can use to learn stuff effectively and Vue Vixens curriculum vs official Vue documentation. Natalia gives an overview of Vue Vixens’ workshops (catered exclusively to women in software development) and mentions some locations around the world where they are held. She gives details about them including reasons why they choose to build mobile apps, their content and curriculum, and technical level of attendees. She also encourages women listeners to join their Slack channel (given in the links section) for more information about Vue Vixens. The panelists finally discuss representation of various groups in software development in general and the benefits of attending such workshops.
Links
- Vue.js
- Vue cookbook
- Awesome Vue
- Twitter poll on Documentation vs Code contribution
- Vue Vixens
- Vue Vixens Slack channel
- Workshop at VueConf US
- Building a Desktop App with Vue
- Natalia’s Twitter
- Natalia’s GitHub
- https://www.facebook.com/ViewsonVue/
- https://twitter.com/viewsonvue
Picks
Erik Hanchett:
Divya Sasidharan:
Natalia Tepluhina:
- Vue 2.6
Charles Max Wood:
- Regularly spend time with just your significant other
- Honey - Chrome Plugin
- Withings weighing scale
Special Guest: Natalia Tepluhina.
VoV 052: Documentation with Natalia Tepluhina
0:00
Playback Speed: