E17: Why Software Engineers Hate Documenting (And How to Help) episode artwork

EPISODE · Oct 20, 2022 · 35 MIN

E17: Why Software Engineers Hate Documenting (And How to Help)

from De-stress Your Business · host Paddy Mann & Alexis Kingsbury

Most software engineers and managers hate documenting.   More than that… they openly distrust that the effort of documenting will ever pay off.   Why is that?   It stems from a misconception on what needs to be documented.    Engineers see beautifully maintained technical documentation and best practice documentation, and assume the goal is to replicate that.   But that’s a fools errand… by the time you’ve documented at that level of detail, you’ve cost the teams weeks of progress, and the content you’ve created is already out of date.   Instead, we need to tie all of our documentation to business processes.   Rather than having a document called “System architecture”, you might need to update your documented peer review process. Or add an “Learn about our architecture” step to the onboarding.   In this episode of De-stress Your Business, we go deep into the false beliefs that can hold back software engineering teams, and how to address them.   ---   Want to learn more? Join our weekly webinar and we'll show you how to free up 15 hours per week and remove the constant stress of running a business, without slowing down growth. Visit www.airmanual.co/webinar for all the details!

Most software engineers and managers hate documenting.   More than that… they openly distrust that the effort of documenting will ever pay off.   Why is that?   It stems from a misconception on what needs to be documented.    Engineers see beautifully maintained technical documentation and best practice documentation, and assume the goal is to replicate that.   But that’s a fools errand… by the time you’ve documented at that level of detail, you’ve cost the teams weeks of progress, and the content you’ve created is already out of date.   Instead, we need to tie all of our documentation to business processes.   Rather than having a document called “System architecture”, you might need to update your documented peer review process. Or add an “Learn about our architecture” step to the onboarding.   In this episode of De-stress Your Business, we go deep into the false beliefs that can hold back software engineering teams, and how to address them.   ---   Want to learn more? Join our weekly webinar and we'll show you how to free up 15 hours per week and remove the constant stress of running a business, without slowing down growth. Visit www.airmanual.co/webinar for all the details!

NOW PLAYING

E17: Why Software Engineers Hate Documenting (And How to Help)

0:00 35:53

No transcript for this episode yet

We transcribe on demand. Request one and we'll notify you when it's ready — usually under 10 minutes.

Eat to Live Jenna Fuhrman, Dr. Fuhrman Our health is our most precious gift and smart nutrition can change your life. Each month, join Dr. Fuhrman and his daughter, Jenna Fuhrman as they discuss important topics in the world of nutrition. Eat to Live will change the way you eat and think about food. French Your Way Jessica: Native French teacher founder of French Your Way Boost your French listening skills and test your comprehension with this one of a kind series of podcasts. Get the chance to listen to a real conversation between native speakers talking at normal speed AND customise your learning experience through carefully designed sets of questions (2 levels of difficulty) available for download at www.frenchvoicespodcast.com. All interviews also come with the transcript. French teacher Jessica interviews native speakers of French from around the world who share a bit of their life and passion. Where else would you meet in one same place a French yoga teacher based in Melbourne, a soap manufacturer from Provence, or a couple cycling around the world? Capsules d'analyse financière de Dominique Jacquet Capsules d'analyse financière de Dominique Jacquet The Small Business Startup School – Business Notes | Financial Literacy | Retail Psychology – For Professionals & Entrepreneurs The Small Business Startup School Inc. Starting or buying a small business? While personal circumstances may vary, business patterns remain timeless. On The Small Business Startup School, we explore strategies, insights, and practical solutions to help entrepreneurs confidently navigate their journey.Hosted by Ola Williams—a retail entrepreneur, fintech founder, and financial coach with over two decades of experience—this podcast marries financial awareness and retail psychology with optimism to deliver actionable takeaways.Join us to learn, grow, and connect as we uncover the keys to business success.Let’s continue to learn together and be encouraged to keep on connecting!

Frequently Asked Questions

How long is this episode of De-stress Your Business?

This episode is 35 minutes long.

When was this De-stress Your Business episode published?

This episode was published on October 20, 2022.

What is this episode about?

Most software engineers and managers hate documenting.   More than that… they openly distrust that the effort of documenting will ever pay off.   Why is that?   It stems from a misconception on what needs to be documented.    Engineers see...

Can I download this De-stress Your Business episode?

Yes, you can download this episode by clicking the download button on the episode player, or subscribe to the podcast in your preferred podcast app for automatic downloads.
URL copied to clipboard!