3min chapter

Software Engineering Radio - the podcast for professional software developers cover image

Episode 501: Bob Ducharme on Creating Technical Documentation for Software Projects

Software Engineering Radio - the podcast for professional software developers

CHAPTER

Is Grammatical Accuracy Vital?

If the grammar is bad, it's probably going to be harder to understand. If you have a plural subject with a singular verb, people reading it aren't going to stop and go back,. And punctuation, these things, i think, are importanti. I've seen people often use numbered list when they should have used a bulleted list. When you're writing an installation guide, you know, do this, tat these environment variables, run this, scrip down low this. You know, of course, those steps certainly deserve to be unnumbered list. But if i say, there are three things to remember, i find that people often are very quick to make something

00:00

Get the Snipd
podcast app

Unlock the knowledge in podcasts with the podcast player of the future.
App store bannerPlay store banner

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode

Save any
moment

Hear something you like? Tap your headphones to save it with AI-generated key takeaways

Share
& Export

Send highlights to Twitter, WhatsApp or export them to Notion, Readwise & more

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode