Maintainable

Daniela Baron - About Those Docs


Listen Later

Robby has a chat with Senior Staff Engineer, Daniela Baron (she/her). Daniela starts by listing the following things about the characteristics of well-maintained software; it should be easy for new people to join and get the project running on their laptops just by following the README, it should have conventions in place for what kind of code goes where, and several less obvious aspects like how to integrate with third parties and how to deploy to a test environment.

Daniela will share ways to improve the onboarding experience for new developers to a project, examples of reliable traceability from code to tests to business goals across repositories and project management tools, how to avoid bikeshedding in pull-requests, and approaches to managing maintenance tasks within your team's workflow.

In addition, Robby and Daniela will discuss the importance of having a process for addressing deprecation warnings, documenting the non-obvious aspects of the system, tips on how to start documenting how to test and/or debug integrations with third-party services, and moving documentation about edge case scenarios under a Troubleshooting heading. They will also reference to Daniela's blog post, About Those Docs. Tune in for all that and more! You’ll get tons of valuable insights out of it.

Book Recommendations:
  • WHEN: The Scientific Secrets of Perfect Timing By Daniel H. Pink
Helpful Links:
  • Slides from Daniela's talk about “When”
  • Daniela on LinkedIn
  • Daniela’s Personal Website
  • Daniela on Twitter
  • https://github.com/danielabar

Subscribe to Maintainable on:

  • Apple Podcasts
  • Overcast
  • Spotify

Or search "Maintainable" wherever you stream your podcasts.

Keep up to date with the Maintainable Podcast by joining the newsletter.

Subscribe to Maintainable on:

  • Apple Podcasts
  • Spotify

Or search "Maintainable" wherever you stream your podcasts.

Keep up to date with the Maintainable Podcast by joining the newsletter.

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

MaintainableBy Robby Russell

  • 5
  • 5
  • 5
  • 5
  • 5

5

32 ratings


More shows like Maintainable

View all
99% Invisible by Roman Mars

99% Invisible

26,168 Listeners

Hanselminutes with Scott Hanselman by Scott Hanselman

Hanselminutes with Scott Hanselman

380 Listeners

The Changelog: Software Development, Open Source by Changelog Media

The Changelog: Software Development, Open Source

291 Listeners

Software Engineering Daily by Software Engineering Daily

Software Engineering Daily

624 Listeners

Y Combinator Startup Podcast by Y Combinator

Y Combinator Startup Podcast

232 Listeners

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

Syntax - Tasty Web Development Treats

987 Listeners

REWORK by 37signals

REWORK

210 Listeners

The Indicator from Planet Money by NPR

The Indicator from Planet Money

9,517 Listeners

Tech Brew Ride Home by Morning Brew

Tech Brew Ride Home

968 Listeners

Remote Ruby by Chris Oliver, Andrew Mason

Remote Ruby

35 Listeners

.NET Rocks! by Carl Franklin and Richard Campbell

.NET Rocks!

245 Listeners

Short Wave by NPR

Short Wave

6,357 Listeners

The Real Python Podcast by Real Python

The Real Python Podcast

141 Listeners

Hard Fork by The New York Times

Hard Fork

5,475 Listeners

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

The AI Daily Brief: Artificial Intelligence News and Analysis

560 Listeners