Wes Bos & Scott Tolinski - Full Stack JavaScript Web Developers

Zpravodajství

Technologické zprávy

Technika

Hasty Treat - Reading Documentation

Syntax - Tasty Web Development Treats

Full Stack Developers Wes Bos and Scott Tolinski dive deep into web development topics, explaining how they work and talking about their own experiences. They cover from JavaScript frameworks like React, to the latest advancements in CSS to simplifying web tooling.

<p>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.</p> <h2><a id="Sentry__Sponsor_9" name="Sentry__Sponsor_9"></a>Sentry - Sponsor</h2> <p>If you want to know what’s happening with your errors, track them with <a href="https://sentry.io/">Sentry</a>. 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 <a href= "https://sentry.io/">Sentry.io</a> and using the coupon code “tastytreat”.</p> <h2><a id="Show_Notes_13" name="Show_Notes_13"></a>Show Notes</h2> <p>5:10 - What are the different kinds of documentation?</p> <ul> <li> <p>Tutorials</p> </li> <li> <p>Docs</p> </li> <li> <p>API references</p> </li> <li> <p>Video docs</p> </li> <li> <p>Examples of good documentation</p> <ul> <li><a href="https://stripe.com/docs">Stripe</a></li> <li><a href= "https://github.com/zeit/next.js/tree/canary/examples">Next.js Examples</a></li> <li><a href="https://developer.paypal.com/docs/">New PayPal Docs</a></li> <li><a href= "https://www.gatsbyjs.org/tutorial/part-two/">Gatsby</a></li> <li><a href= "https://jestjs.io/docs/en/getting-started">Jest</a></li> <li><a href="https://docs.meteor.com/#/basic/">Meteor</a></li> </ul> </li> </ul> <p>14:34 - How to read documentation</p> <ul> <li>Understanding how you learn will save you lots of time</li> </ul> <p>16:03 - Understanding Parameters</p> <ul> <li>Parameter types</li> <li>Required / Optional</li> <li>Parameter order</li> </ul> <p>22:45 - How do you tackle learning something new?</p> <ul> <li>Look at some examples</li> <li>Scan the entire docs to get an idea of the surface area</li> <li>Have something specific in mind that you want to build</li> </ul> <p>27:34 - What to do when the docs suck?</p> <ul> <li>Look at other people’s code</li> <li>Chat rooms</li> <li>Tests for examples</li> <li>Read the source code</li> <li>Github search</li> <li>Contribute</li> </ul> <h2><a id="Tweet_us_your_tasty_treats_56" name= "Tweet_us_your_tasty_treats_56"></a>Tweet us your tasty treats!</h2> <ul> <li><a href="https://www.instagram.com/stolinski/">Scott’s Instagram</a></li> <li><a href= "https://www.instagram.com/LevelUpTutorials/">LevelUpTutorials Instagram</a></li> <li><a href="https://www.instagram.com/wesbos/">Wes’ Instagram</a></li> <li><a href="https://twitter.com/wesbos">Wes’ Twitter</a></li> <li><a href="https://www.facebook.com/wesbos.developer">Wes’ Facebook</a></li> <li><a href="https://twitter.com/stolinski">Scott’s Twitter</a></li> <li>Make sure to include <a href= "https://twitter.com/SyntaxFM">@SyntaxFM</a> in your tweets</li> </ul>

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

Aplikace Youradio Talk

Hasty Treat - Reading Documentation

Poslechněte si podcast