How to Get Started with Technical Writing Mini Course
Your quick start guide to learn how to write documentation about software products
Are you looking for a way to get started as a technical writer? Would you like to learn what are the steps you should follow as a technical writer in a software development team?
If yes, I can help.
My name is Jordan Stanchev. I've been working in the field of software development and technical communications in the last 20 years. I've made a successful career as a technical writer in one of the largest software development companies in the world. I am the founder and lead instruction in the JPDocu School of Technical Writing.
In this course, you will find the details around the deliverables you should develop as a technical writer specialist. You will also find the process steps that you should use to design and develop software documentation.
No matter if you are re working already as a technical writer, as a software developer or you are the lead of a software development team, this course is a must-know basis for your team.
You will learn:
- What do we call technical writing?
- Which are the key deliverables from the work of the technical writer?
- Where would you fit in the software development team?
- Which are the steps you should follow to create software documentation?
You will learn that technical writing can be easy - after all, it's just plain docu!
StartWho is a Technical Writer and What Technical Writers Do (4:04)
StartWho Does Technical Writing? (5:49)
StartWhat is the Result from Technical Writing? (2:03)
StartThe Job of the Technical Writer (4:22)
StartTypes of Documentation (1:03)
StartFunctional Documentation (2:58)
StartFunctional Documentation Example (2:22)
StartFunctional Documentation in Software Documentation (7:53)
StartStrategy for Writing Functional Documentation (4:06)
StartTask Oriented Documentation (4:29)
StartStrategy for Writing Task-Oriented Documentation (10:55)
StartTask Oriented Documentation Example (6:17)