EPISODE · Jul 31, 2025 · 39 MIN
Discussing Documentation
from Rails Business
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 Greetings00:26 Diving into Documentation02:48 Defining Documentation05:12 User Stories and Documentation08:12 Internal vs External Documentation15:54 Organizing Documentation21:09 Centralizing Resources with Trello23:02 Balancing Multiple Documentation Tools23:40 Challenges with Search Functionality24:41 Effective Use of Trello Tags and Labels27:54 The Importance of Code Comments and Commit Messages29:28 Rebase vs. Merge: A Developer's Dilemma30:16 Interactive Rebase: Cleaning Up Commit History36:02 Concluding Thoughts on Rebase and Merge- Thoughtbot Rebase Workflow- Ryan's Website- Brendan's X/Twitter- Brendan's BlueskySend us Fan Mail
What this episode covers
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 0...
NOW PLAYING
Discussing Documentation
No transcript for this episode yet
Similar Episodes
Feb 4, 2026 ·18m
Apr 22, 2025 ·32m
Feb 27, 2025 ·0m
Sep 20, 2024 ·57m