meta_pixel
Tapesearch Logo
Log in
Syntax - Tasty Web Development Treats

Hasty Treat - Reading Documentation

Syntax - Tasty Web Development Treats

Wes Bos

Tech News, Technology, News

4.9 • 1.2K Ratings

🗓️ 10 September 2018

⏱️ 33 minutes

🧾️ Download transcript

Summary

In this Hasty Treat, Scott and Wes dive into documentation - how to avoid common pitfalls and overwhelm, as well as how to read, understand and get the most out of documentation. Sentry - Sponsor If you want to know what’s happening with your errors, track them with Sentry. Sentry is open-source error tracking that helps developers monitor and fix crashes in real time. Cut your time on error resolution from five hours to five minutes. It works with any language and integrates with dozens of other services. Syntax listeners can get two months for free by visiting Sentry.io and using the coupon code “tastytreat”. Show Notes 5:10 - What are the different kinds of documentation? Tutorials Docs API references Video docs Examples of good documentation Stripe Next.js Examples New PayPal Docs Gatsby Jest Meteor 14:34 - How to read documentation Understanding how you learn will save you lots of time 16:03 - Understanding Parameters Parameter types Required / Optional Parameter order 22:45 - How do you tackle learning something new? Look at some examples Scan the entire docs to get an idea of the surface area Have something specific in mind that you want to build 27:34 - What to do when the docs suck? Look at other people’s code Chat rooms Tests for examples Read the source code Github search Contribute Tweet us your tasty treats! Scott’s Instagram LevelUpTutorials Instagram Wes’ Instagram Wes’ Twitter Wes’ Facebook Scott’s Twitter Make sure to include @SyntaxFM in your tweets

Transcript

Click on a timestamp to play from that location

0:00.0

Monday, Monday, Monday,

0:02.0

Open wide Dev fans.

0:04.0

Get ready to stuff your face

0:06.0

with JavaScript, CSS, node modules, barbecue tips,

0:09.0

get workflows,

0:10.0

break dancing, soft skills,

0:11.0

web development, the hastiest, the craziest, the craziest, the tastiest development the hastiest the craziest the tastiest web development treats coming in hot here is

0:18.1

Wes Barracuda bars and Scott Toro Loco Tolinsky.

0:25.0

Welcome to Syntax.

0:28.6

In this Monday edition of Syntax, which is also known as the hasty treat.

0:34.0

We're going to be talking all about documentation,

0:37.0

how to read documentation, how to understand documentation,

0:41.0

how to better parse it,

0:42.0

how things are sort of organized and maybe you know how

0:45.1

some of stuff is.

0:46.4

As always I am Scott Tolinsky aka Tilok aka El Toro Loco as with me as always is the Barracuda Boss was boss.

0:56.8

You know what I went down a rabbit hole of watching Barracuda fishing videos.

1:02.6

Oh man.

1:03.6

Those things are so nasty.

1:05.6

I would be so afraid to catch one of those.

1:07.8

Yeah, I mean the Blue Barracuda is on legends of the Hidden Temple.

1:12.2

Is that what it was?

...

Please login to see the full transcript.

Disclaimer: The podcast and artwork embedded on this page are from Wes Bos, and are the property of its owner and not affiliated with or endorsed by Tapesearch.

Generated transcripts are the property of Wes Bos and are distributed freely under the Fair Use doctrine. Transcripts generated by Tapesearch are not guaranteed to be accurate.

Copyright © Tapesearch 2026.