Talking Documentation with Laurie Barth on Real Talk Javascript #104

Laurie Barth is back to talk with John and Ward about documentation. What are some organizing principles of docs? What to do if people don't understand a term in your docs? Where should you start when writing docs for a new project? And how do you deal with SEO for documentation?

Talking Documentation

const podcast = { 
  episode: 104,
  title: 'Just What the Doc-ter Ordered with Laurie Barth',
  topics: [ 
    'docs', 'documentation', 'seo'
  ],
  guest: 'Laurie Barth'
  hosts: [
    'John Papa','Ward Bell'
  ]
};

Recording date: 2020-05-14

John Papa @John_Papa

Ward Bell @WardBell

Dan Wahlin @DanWahlin

Craig Shoemaker @craigshoemaker

Laurie Barth @LaurieOnTech

Brought to you by

• ag-Grid

• Raygun

Actionable error, crash and performance monitoring. Raygun gives you visibility into how users are really experiencing your software. Detect, diagnose and resolve issues with greater speed and accuracy.

Resources:

• Gatsby
• Angular Docs
• Marcy Sutton
• Node.js
• Gatsby Docs
• Gatsby Cloud
• Peacock docs
• Documentation template
• Stripe docs
• MDN docs
• Drink a v8
• Vue Router
• Yarn docs
• 2ality
• Alligator
• V8
• Lauries course on Vue Router at Egghead
• UnifiHD wifi networking

Timejumps

• 01:13 Guest introduction
• 02:31 What do you do at Gatsby?
• 04:35 Organizing principles of docs
• 12:02 Sponsor: Ag Grid
• 13:06 Do people know the terms in a doc?
• 21:48 How can people learn to write better docs?
• 29:55 Sponsor: Raygun
• 30:27 What's the first thing you should do with docs?
• 40:50 How do you do SEO for docs?
• 46:08 Final thoughts

Podcast editing on this episode done by Chris Enns of Lemon Productions.