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
Planet Money by NPR

Planet Money

30,666 Listeners

Software Engineering Radio by se-radio@computer.org

Software Engineering Radio

271 Listeners

The Changelog: Software Development, Open Source by Changelog Media

The Changelog: Software Development, Open Source

290 Listeners

The Bike Shed by thoughtbot

The Bike Shed

121 Listeners

Software Engineering Daily by Software Engineering Daily

Software Engineering Daily

623 Listeners

Soft Skills Engineering by Jamison Dance and Dave Smith

Soft Skills Engineering

289 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

Darknet Diaries by Jack Rhysider

Darknet Diaries

8,054 Listeners

Tech Brew Ride Home by Morning Brew

Tech Brew Ride Home

960 Listeners

Remote Ruby by Chris Oliver, Andrew Mason

Remote Ruby

34 Listeners

The Stack Overflow Podcast by The Stack Overflow Podcast

The Stack Overflow Podcast

63 Listeners

This Day in AI Podcast by Michael Sharkey, Chris Sharkey

This Day in AI Podcast

228 Listeners

Code and the Coding Coders who Code it by Drew Bragg

Code and the Coding Coders who Code it

6 Listeners

The Pragmatic Engineer by Gergely Orosz

The Pragmatic Engineer

63 Listeners