Episode 501: Bob Ducharme on Creating Technical Documentation for Software Proje...
source link: https://www.se-radio.net/2022/03/episode-501-bob-ducharme-on-creating-technical-documentation-for-software-projects/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Episode 501: Bob Ducharme on Creating Technical Documentation for Software Projects
Bob DuCharme, an experienced technical writer and author talks about writing documentation for software products. In this episode we discuss the various types of documentation that one creates for software products. Host Nikhil Krishna spoke with Bob in depth about the difference between these types of documentation and the audiences they target; importance of using proper grammar and clarity in writing good documentation that people want to read; other forms of documentation (images, video and audio); challenges of maintaining and updating documentation; keeping documentation in sync with products; toolchains for building documentation; history of software documentation tooling and standards.
This episode sponsored by OpenZiti.
Related Links
SE Radio theme: “Broken Reality” by Kevin MacLeod (incompetech.com)
Licensed under Creative Commons: By Attribution 3.0
Podcast: Play in new window | Download
Subscribe: Apple Podcasts | RSS
Recommend
-
72
Photo by
-
33
Announcing Docsy: A Website Theme for Technical Documentation 2019-07-...
-
3
Episode #102: Creating and Evolving Technical Content with Amy Arambulo Negrette May 24, 2021 • 58 minutes On this episode, Jeremy chats with Amy Arambulo Negrette about what makes a good conference ta...
-
5
Beam is a simple tool that allows members to write posts to share across your organization. Think of it like a lightweight internal blog. Features include a simple Markdown-based editor with preview, image drag and dr...
-
5
Java News Roundup: WildFly 27, Spring Release Candidates, JEPs for JDK 20, Project Reactor Nov 14, 2022...
-
4
-
7
Baby Doge Coin News Offers Possible Insights Into The Future For AI Crypto Projects March 16, 2023
-
5
Microsoft's Xbox division is celebrating Earth Day with new sustainability projects...
-
6
-
7
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK