Compiler cover image

Why Should You Write Technical Documentation?

Compiler

CHAPTER

Technical Documentation

Ben: My boss told me I should write the manual for Koha. We didn't have any documentation for Koha before that. So I took my materials for training on how to use the software and I started from scratch. It's just clicking away, you know, how to install,. How to set up, how to use it every day. And that was the beginning of my technical writing background... Ben: Don't jump into a project and start writing giant blocks of text. Remember that the people that are going to be reading the documentation will be from all different levels of technical skill or from various fields.

00:00
Transcript
Play full episode

Remember Everything You Learn from Podcasts

Save insights instantly, chat with episodes, and build lasting knowledge - all powered by AI.
App store bannerPlay store banner