4min 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

What's the Difference Between Technical and User Facing Documentation?

There's three basic types of user documentation. A reference guide should explain physically everything somebody sees in the product. The other big one would be the user guide, which is aimed at someone who doesn't know the product. And that brings me to a third category of documentation, along with reference guide and user guides, would be, i might call it a quick start, buta atutorial. Sometimes i've seen getting started to cover installation as well. But a te tutorial for someone who's never used the product was almost like giving a demo to yourself. You know, step one, click here. Step two, click here,. Step four, this comes up. Step five: Click here

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