Technical Writing: A Quick Start to Software Documentation

A quick and direct overview of the end-to-end processes for writing software documentation
Rating: 4.4 out of 5 (235 ratings)
3,592 students
English
English [Auto]
What is Software Documentation
Who is a Technical Writer and What Technical Writers Do
What is the Writing Process to Develop Software Documentation

Requirements

  • Be interested in providing documentation for software app for the end user

Description

In this quick start course, we start with a quick and direct overview of the end-to-end documentation creation processes.


By the end of this course, you should get a basic understanding of what technical writing in software documentation is all about. You will be able to name the main assets (deliverables for your customers) that you create using technical writing skills and techniques. For example, such are the software documentation itself, images, as well as instructional videos, and multimedia.


For several years now, JPDocu School of Technical Writing has been designing and delivering training on user assistance for:

  • technical writers (information developers)

  • information architects

  • software developers 


The instructor, Jordan Stanchev, a User Assistance Development Architect has personally trained hundreds of people in the classroom, online courses, universities, and internally at a Fortune 500 company! 

Jordan says: "The goal for me has always been to deliver practical information, to make sure my trainees get ready for delivering real content, right after the course is over. 

I am so proud of my students who come back to me and share how they have started their first job as a technical writer or how they have advanced in their career using what they have learned in my courses!

That's the reason I have started devoting my time to teaching technical writing skills, on top of my regular job as a User Assistance Development Architect."

So, enroll now and see how easy and simple it is to deliver help for your software app customers!

Who this course is for:

  • Beginner Technical Writers and Information Developers

Course content

2 sections18 lectures1h 11m total length
  • Introduction
    07:16
  • Who is a Technical Writer and What Technical Writers Do
    04:04
  • Who Does Technical Writing?
    05:49
  • What is the Result from Technical Writing?
    02:04
  • The Job of the Technical Writer
    04:22
  • Types of Documentation
    01:03
  • Functional Documentation
    02:58
  • Functional Documentation Example
    02:23
  • Functional Documentation in Software Documentation
    07:54
  • Strategy for Writing Functional Documentation
    04:06
  • Task Oriented Documentation
    04:29
  • Strategy for Writing Task-Oriented Documentation
    10:55
  • Task Oriented Documentation Example
    06:17
  • Technical Writers in Development Team
    02:16
  • The Technical Writing Process
    03:50
  • Exercise
    00:58
  • The Ultimate Purpose of the Technical Writer
    00:52

Instructor

WE TEACH SOFTWARE DOCUMENTATION AND DITA! 28K+ Students!
JPDocu School of Technical Writing
  • 4.3 Instructor Rating
  • 1,325 Reviews
  • 28,676 Students
  • 14 Courses

Learning technical writing is easy - after all, it's just plain docu!


JPDocu School of Technical Writing is a training company that is passionate about user assistance, technical communications, and making it a positive user experience. Our e-learning courses help us shape the next generation of technical writers and information developers, by providing them with simple to follow and practical, hands-on experiences with technical writing.


Our mission


Nowadays everyone talks about the professions of the future. People are scared that they are not prepared for the needs of the future of work. We believe that change is not to be feared. We believe that with the proper training, education, and practical experience, our customers will be ready to meet the future with joy. The best way to concur with this fear is by studying and learning.

JPDocu School of Technical Writing transforms this fear into practical knowledge, getting people ready for the job of the future - Technical Writing. Taking our programs online allows us to reach all of you across the globe!


Our Vision


JPDocu School of Technical Writing is here to deliver top-quality e-learning courses and training (both online and on-site) that help you learn the profession of the future. We bring our courses to the world using various training platforms and interactions with our students.