Search a title or topic

Over 20 million podcasts, powered by 

Player FM logo
Artwork

Content provided by Brendan Buckingham & Ryan Frisch, Brendan Buckingham, and Ryan Frisch. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Brendan Buckingham & Ryan Frisch, Brendan Buckingham, and Ryan Frisch or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://podcastplayer.com/legal.
Player FM - Podcast App
Go offline with the Player FM app!

Discussing Documentation

39:11
 
Share
 

Manage episode 497534866 series 3651962
Content provided by Brendan Buckingham & Ryan Frisch, Brendan Buckingham, and Ryan Frisch. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Brendan Buckingham & Ryan Frisch, Brendan Buckingham, and Ryan Frisch or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://podcastplayer.com/legal.

In this episode, Ryan and Brendan discuss the importance of documentation within a business and development context. They cover various types of documentation, including internal, user-facing, and code comments, and highlight the necessity of clear communication from story writing to feature documentation. They also share insights on tools and methods for keeping documentation organized and accessible within their teams.

00:00 Introduction and Greetings

00:26 Diving into Documentation

02:48 Defining Documentation

05:12 User Stories and Documentation

08:12 Internal vs External Documentation

15:54 Organizing Documentation

21:09 Centralizing Resources with Trello

23:02 Balancing Multiple Documentation Tools

23:40 Challenges with Search Functionality

24:41 Effective Use of Trello Tags and Labels

27:54 The Importance of Code Comments and Commit Messages

29:28 Rebase vs. Merge: A Developer's Dilemma

30:16 Interactive Rebase: Cleaning Up Commit History

36:02 Concluding Thoughts on Rebase and Merge

- Thoughtbot Rebase Workflow

- Ryan's Website

- Brendan's X/Twitter

- Brendan's Bluesky

Send us a text

  continue reading

16 episodes

Artwork
iconShare
 
Manage episode 497534866 series 3651962
Content provided by Brendan Buckingham & Ryan Frisch, Brendan Buckingham, and Ryan Frisch. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Brendan Buckingham & Ryan Frisch, Brendan Buckingham, and Ryan Frisch or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://podcastplayer.com/legal.

In this episode, Ryan and Brendan discuss the importance of documentation within a business and development context. They cover various types of documentation, including internal, user-facing, and code comments, and highlight the necessity of clear communication from story writing to feature documentation. They also share insights on tools and methods for keeping documentation organized and accessible within their teams.

00:00 Introduction and Greetings

00:26 Diving into Documentation

02:48 Defining Documentation

05:12 User Stories and Documentation

08:12 Internal vs External Documentation

15:54 Organizing Documentation

21:09 Centralizing Resources with Trello

23:02 Balancing Multiple Documentation Tools

23:40 Challenges with Search Functionality

24:41 Effective Use of Trello Tags and Labels

27:54 The Importance of Code Comments and Commit Messages

29:28 Rebase vs. Merge: A Developer's Dilemma

30:16 Interactive Rebase: Cleaning Up Commit History

36:02 Concluding Thoughts on Rebase and Merge

- Thoughtbot Rebase Workflow

- Ryan's Website

- Brendan's X/Twitter

- Brendan's Bluesky

Send us a text

  continue reading

16 episodes

All episodes

×
 
Loading …

Welcome to Player FM!

Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.

 

Copyright 2025 | Privacy Policy | Terms of Service | | Copyright
Listen to this show while you explore
Play