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

00:00

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

Transcript
Play full episode

The AI-powered Podcast Player

Save insights by tapping your headphones, chat with episodes, discover the best highlights - and more!
App store bannerPlay store banner
Get the app