Software Engineering Radio - the podcast for professional software developers Episode 501: Bob Ducharme on Creating Technical Documentation for Software Projects
36 snips
Mar 1, 2022 Chapters
Transcript
Episode notes
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Introduction
00:00 • 2min
Technical Writer
01:59 • 2min
Technical Writing - What Does a Technical Writer Bring to the Job?
03:50 • 2min
What's the Difference Between Technical and User Facing Documentation?
06:06 • 4min
How to Write Good Technical Documentation?
09:50 • 2min
Is Grammatical Accuracy Vital?
11:26 • 3min
The Importance of a Good Technical Documentation
14:56 • 4min
The Challenges of Maintaining Redio Versustecs
19:20 • 3min
Do You Think You Need to Use Goble Dogs to Maintain Documentation?
21:51 • 3min
What Is the Tool Chain for Generating Web Sites?
25:01 • 3min
SGM L, Is It a Better Way to Automate a Lot More?
28:13 • 5min
Documentation - Is RDF Really a Good Idea?
33:28 • 2min
Is There a Better Way to Generate Technical Documentation?
35:10 • 3min
Java Pi Documentation Tooling
38:25 • 2min
The Difference Between Reference Guides and User Guides
40:24 • 3min
Treating It as Code
43:49 • 2min
Marketing Communications
45:47 • 2min
Do You Think We Should Include Softre Documentation?
48:10 • 5min
The Endless Boadcast Podcast
53:07 • 2min