Playing: 073: Hasty Treat - Reading Documentation
Potluck - Editor Fonts × Portfolios × Meetup Tips × Switching to Windows × Freelancing Sources
Potluck EP × Remote Work × Headless WordPress × Good Client Questions × Alternate Careers × React API Credentials
Potluck EP × Is Redux Dead × Learning Quickly × Developing Solo × Specialist vs Generalist × Funnest Projects × Wes’ BBQ Course
Potluck EP × Vue.js × Headless WP × Typescript & Flow × Productivity × Server Side Rendering × Yeoman
Wes and Scott's Lives - Breakdancing, BBQ, Wives, Work/Life Balance, Problem Solving, YouTube Subscriptions
Snack Pack — CSS Frameworks, React HOC, Render Props, Coding Designers, Early Career Advice and a sound board!
Hosting & Servers — Heroku, Now, Galaxy, Digital Ocean, Linode, Docker, Netlify and more!
Sep 10th, 2018
Hasty Treat - Reading Documentation👇 Download Show✏️ Edit Show Notes
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".
5:10 - What are the different kinds of documentation?
- API references
Examples of good documentation
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