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

30 ratings


More shows like Maintainable

View all
Hanselminutes with Scott Hanselman by Scott Hanselman

Hanselminutes with Scott Hanselman

378 Listeners

Software Engineering Radio - the podcast for professional software developers by se-radio@computer.org

Software Engineering Radio - the podcast for professional software developers

262 Listeners

The Changelog: Software Development, Open Source by Changelog Media

The Changelog: Software Development, Open Source

286 Listeners

Thoughtworks Technology Podcast by Thoughtworks

Thoughtworks Technology Podcast

42 Listeners

Talk Python To Me by Michael Kennedy

Talk Python To Me

584 Listeners

Software Engineering Daily by Software Engineering Daily

Software Engineering Daily

630 Listeners

Soft Skills Engineering by Jamison Dance and Dave Smith

Soft Skills Engineering

271 Listeners

Go Time: Golang, Software Engineering by Changelog Media

Go Time: Golang, Software Engineering

128 Listeners

JS Party: JavaScript, CSS, Web Development by Changelog Media

JS Party: JavaScript, CSS, Web Development

91 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

212 Listeners

CoRecursive: Coding Stories by Adam Gordon Bell - Software Developer

CoRecursive: Coding Stories

185 Listeners

The Stack Overflow Podcast by The Stack Overflow Podcast

The Stack Overflow Podcast

63 Listeners

Oxide and Friends by Oxide Computer Company

Oxide and Friends

47 Listeners

The Pragmatic Engineer by Gergely Orosz

The Pragmatic Engineer

48 Listeners