The One About Writing Great Tech Docs episode artwork

EPISODE · Jan 6, 2023 · 45 MIN

The One About Writing Great Tech Docs

from Runtime Rundown - JavaScript and Web Development · host Joe Boyle and Evan Cooper

In this episode, we talk about "Writing docs well: why should a software engineer care" by Lorin Hochstein. We cover the importance of technical writing, how to structure your docs for maximum impact, and some of the secondary benefits of writing things down. No matter where you are in your career in software, there's something in here to help you improve how you put your ideas on paper.  In other news: Joe isn't learning anything and Evan is starting an evil plan to break the blogging industry. Oh, and use Hemmingway Editor to make your writing punchier. Happy New Year! 

In this episode, we talk about "Writing docs well: why should a software engineer care" by Lorin Hochstein. We cover the importance of technical writing, how to structure your docs for maximum impact, and some of the secondary benefits of writing things down. No matter where you are in your career in software, there's something in here to help you improve how you put your ideas on paper.  In other news: Joe isn't learning anything and Evan is starting an evil plan to break the blogging industry. Oh, and use Hemmingway Editor to make your writing punchier. Happy New Year!

NOW PLAYING

The One About Writing Great Tech Docs

0:00 45:25

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.

MG Show MG Show The MG Show, hosted by Jeffrey Pedersen and Shannon Townsend, is a leading alternative media platform dedicated to uncovering the truth behind today’s most pressing political issues. Launched in 2019, the show has grown exponentially, offering unfiltered insights, comprehensive research, and real-time analysis. With a commitment to independent journalism and factual integrity, the MG Show empowers its audience with knowledge and encourages active participation in the political discourse. Breaking News Show | eTurboNews Juergen Thomas Steinmetz News is relevant to the global travel and tourism industry, human rights and global issues.Breaking news when it happens and only from the source. 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?

Frequently Asked Questions

How long is this episode of Runtime Rundown - JavaScript and Web Development?

This episode is 45 minutes long.

When was this Runtime Rundown - JavaScript and Web Development episode published?

This episode was published on January 6, 2023.

What is this episode about?

In this episode, we talk about "Writing docs well: why should a software engineer care" by Lorin Hochstein. We cover the importance of technical writing, how to structure your docs for maximum impact, and some of the secondary benefits of writing...

Can I download this Runtime Rundown - JavaScript and Web Development 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!