Rails Business

Discussing Documentation

Episode 14

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

People on this episode

Podcasts we love

Check out these other fine podcasts recommended by us, not an algorithm.

Code with Jason Artwork

Code with Jason

Jason Swett
Standing in the Fire Artwork

Standing in the Fire

Very Good Software
Remote Ruby Artwork

Remote Ruby

Chris Oliver, Andrew Mason
IndieRails Artwork

IndieRails

Jess Brown & Jeremy Smith