Ladybug Podcast

How to Create Great Documentation


Listen Later

It’s easy to overlook documentation when building an application, but documentation can make or break a consumer’s experience. Today we’re diving into the world of documentation to discuss what it takes to write good documentation, the ethics of documentation, and some popular tools you can use to get started.

Show Notes
  • [01:58] Why does a company or app need good documentation?
  • [04:09] Who do we write documentation for?
  • [06:01] What makes good documentation?
  • [11:05] Ethics of documentation
  • [32:47] The structure of your documentation
  • [34:35] What types of documentation should I write?
  • [40:22] Documentation tools
  • [44:51] Shoutouts
  • Resources
    • Alex.js
    • Carolyn’s talk
    • Self Defined
    • Hemingway
    • Bookstack
    • Storybook
    • Writing Technical Documentation video
    • Notion
    • Nuclino
    • Docusaurus
    • Next.js
    • Nuxt.js
    • Gatsby
    • Jekyll
    • Transcript

      Here is this week's transcript.

      ...more
      View all episodesView all episodes
      Download on the App Store

      Ladybug PodcastBy Emma Bostian, Sidney Buckner, Kelly Vaughn, and Ali Spittel

      • 4.7
      • 4.7
      • 4.7
      • 4.7
      • 4.7

      4.7

      159 ratings


      More shows like Ladybug Podcast

      View all
      Hidden Brain by Hidden Brain, Shankar Vedantam

      Hidden Brain

      43,624 Listeners

      The Changelog: Software Development, Open Source by Changelog Media

      The Changelog: Software Development, Open Source

      290 Listeners

      Software Engineering Daily by Software Engineering Daily

      Software Engineering Daily

      625 Listeners

      Talk Python To Me by Michael Kennedy

      Talk Python To Me

      588 Listeners

      Soft Skills Engineering by Jamison Dance and Dave Smith

      Soft Skills Engineering

      283 Listeners

      The Daily by The New York Times

      The Daily

      112,327 Listeners

      Up First from NPR by NPR

      Up First from NPR

      56,375 Listeners

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

      Syntax - Tasty Web Development Treats

      986 Listeners

      The freeCodeCamp Podcast by freeCodeCamp.org

      The freeCodeCamp Podcast

      485 Listeners

      CoRecursive: Coding Stories by Adam Gordon Bell - Software Developer

      CoRecursive: Coding Stories

      188 Listeners

      Today, Explained by Vox

      Today, Explained

      10,223 Listeners

      The Stack Overflow Podcast by The Stack Overflow Podcast

      The Stack Overflow Podcast

      62 Listeners

      Hard Fork by The New York Times

      Hard Fork

      5,466 Listeners

      Business Breakdowns by Colossus | Investing & Business Podcasts

      Business Breakdowns

      349 Listeners

      The AI Daily Brief: Artificial Intelligence News and Analysis by Nathaniel Whittemore

      The AI Daily Brief: Artificial Intelligence News and Analysis

      561 Listeners