Changelog Master Feed

What up, docs? 🥕 (JS Party #50)

Listen Later

Safia, Nick, Jerod, and Chris get together to talk about documentation. Documentation is essential in our work but it can be difficult to get buy-in. The crew talks about how you can get others to care about it in your organization, tools that make documentation easier, and some examples of companies doing it right.

Join the discussion

Changelog++ members support our work, get closer to the metal, and make the ads disappear. Join today!

Sponsors:

  • Gauge – Low maintenance test automation! Gauge is free and open source test automation framework that takes the pain out of acceptance testing.
  • Rollbar – We catch our errors before our users do because of Rollbar. Resolve errors in minutes, and deploy your code with confidence. Learn more at rollbar.com/changelog.
  • .TECH domains – There’s a new top level domain to consider when purchasing your next domain for your next big idea. Get your .tech for 90% off when you use code CHANGELOG on get.tech
  • DigitalOcean – DigitalOcean is simplicity at scale. Whether your business is running one virtual machine or ten thousand, DigitalOcean gets out of your way so your team can build, deploy, and scale faster and more efficiently. New accounts get $100 in credit to use in your first 60 days.

    • Featuring:

    • Safia Abdalla – Website, GitHub, X
    • Nick Nisi – Website, GitHub, Bluesky, Mastodon, X
    • Jerod Santo – Website, GitHub, LinkedIn, Mastodon, X
    • Christopher Hiller – Website, GitHub, Mastodon, X

    Show Notes:

    • @kahliltweets on Twitter
    • Safia loves the React Styleguidist
    • Read about Literate Programming on Wikipedia
    • Jeremy Ashkenas’ Literate CoffeeScript
    • Docco is a tool for literate programming
    • Stripe’s API docs are 👌
    • So are Twilio’s
    • Nick likes Chai’s docs
    • Jerod mentions UmbrellaJS, everyone is impressed
    • Dash is 💣 for macOS docs
    • Maybe Velocity is just as cool for Windows?
    • In terms of guides, check out Ruby on Rails and GitHub’s Open Source Guides

      • Something missing or broken? PRs welcome!

      ...more
      View all episodesView all episodes
      Download on the App Store
      Changelog Master FeedBy Changelog Media
      • 4.4
      • 4.4
      • 4.4
      • 4.4
      • 4.4

      4.4

      29 ratings

      More shows like Changelog Master Feed

      View all
      Software Engineering Radio - the podcast for professional software developers by team@se-radio.net (SE-Radio Team)

      Software Engineering Radio - the podcast for professional software developers

      273 Listeners

      Hanselminutes with Scott Hanselman by Scott Hanselman

      Hanselminutes with Scott Hanselman

      382 Listeners

      The Changelog: Software Development, Open Source by Changelog Media

      The Changelog: Software Development, Open Source

      288 Listeners

      Software Engineering Daily by Software Engineering Daily

      Software Engineering Daily

      626 Listeners

      Talk Python To Me by Michael Kennedy

      Talk Python To Me

      583 Listeners

      Soft Skills Engineering by Jamison Dance and Dave Smith

      Soft Skills Engineering

      287 Listeners

      Thoughtworks Technology Podcast by Thoughtworks

      Thoughtworks Technology Podcast

      44 Listeners

      The TWIML AI Podcast (formerly This Week in Machine Learning & Artificial Intelligence) by Sam Charrington

      The TWIML AI Podcast (formerly This Week in Machine Learning & Artificial Intelligence)

      443 Listeners

      Syntax - Tasty Web Development Treats by Wes Bos & Scott Tolinski - Full Stack JavaScript Web Developers

      Syntax - Tasty Web Development Treats

      985 Listeners

      CoRecursive: Coding Stories by Adam Gordon Bell - Software Developer

      CoRecursive: Coding Stories

      189 Listeners

      Kubernetes Podcast from Google by Abdel Sghiouar, Kaslin Fields

      Kubernetes Podcast from Google

      180 Listeners

      Practical AI by Practical AI LLC

      Practical AI

      212 Listeners

      The Stack Overflow Podcast by The Stack Overflow Podcast

      The Stack Overflow Podcast

      63 Listeners

      Big Technology Podcast by Alex Kantrowitz

      Big Technology Podcast

      512 Listeners

      Oxide and Friends by Oxide Computer Company

      Oxide and Friends

      67 Listeners