Skillshare

Get Started with Technical Writing: Learn to Write Software Documentation (Skillshare)

Offered by Skillshare,
Get Started with Technical Writing: Learn to Write Software Documentation (Skillshare)

Is the ability to provide relevant information about using your software essential for your customers? Do you find yourself spending hours and hours trying to explain how to use the software? Or are you getting feedback from your clients that your documentation is hard to be followed, inconsistent or may be even.... confusing? If you answered with "Yes!" to any of these questions, then this course is for you!

You will learn how to quickly prepare and deliver guidance for your users in the form of software documentation. Learn what it takes to become a technical writer today!
In the course of the years, the core activities of the technical writing professionals have been constantly evolving. We've started off as technical writers, focused solely on technical writing. We transformed into information developers, that also take into account the graphical aspects and design of the content.
Today, we need to bundle together the writing skills, design and graphics, video creation, multimedia, metadata and software development to meet the expectations of our users. All these assets, put together can be described together as user assistance.
For several years now, I have been delivering training on user assistance for:

  • technical writers (information developers)
  • information architects
  • software developers

I have personally trained hundreds of people in the classroom, online courses, several universities, and internally at a Fortune 500 company! The goal for me has always been to deliver practical information, make sure my trainees get ready for delivering real content, right after the course is over.
What will you learn?
As this course is designed for beginner technical writers, usually students in IT, I cover the following subjects:

  • What is technical writing all about?
  • What are the basics of technical writing?

By the end of this course you will be able to:

  • explain what is technical writing,
  • name the specific deliverables from the work of the technical writer in the software development industry,
  • describe the process a technical writers follow to create software documentation for the user.
Go to Class
MOOC List is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

Related Courses

Validating product ideas with interviews for Product Managers (Skillshare) Skillshare
Skillshare

Validating product ideas with interviews for Product Managers (Skillshare)

CS: Design & Product

I designed this course for Product Managers who have new product or feature ideas and would like to talk to customers and learn whether their idea will fly. This is the first and ultimate question in product development: do customers need my product? Do they need it so dearly that they would actually pay for it? So, how do you figure this out before actually building the product? Well, user research has your back covered. You can find out whether customers need a product or a feature even before you wrote a single line of code.

Self Paced
Self-Paced
Product Management UX Design UI Design
Details
Designing for Inclusivity: A Primer on Gender-Neutral Product Design (Skillshare) Skillshare
Skillshare

Designing for Inclusivity: A Primer on Gender-Neutral Product Design (Skillshare)

CS: Design & Product

The heartbeat of all great design is empathy—and understanding the process of gender-neutral product design is a crucial skill for all designers! At a time when technology connects us more than ever, prioritizing inclusivity in your product design approach is crucial. You want your products to be accessible, usable, and inspirational to all users. This is the core of great design.

Self Paced
Self-Paced
Prototyping Technology Creativity
Details
Create an RSS Feed Reader with Node and Vue.js (Skillshare) Skillshare
Skillshare

Create an RSS Feed Reader with Node and Vue.js (Skillshare)

CS: Information & Technology

In this class, you will build an RSS feed reader with Node and Vue.js. We’ll cover using command-line utilities to scaffold out a project, and use Github in tandem with Netlify to deploy our app to a live environment. We will also use “serverless” technology afforded to us by Netlify which can deploy functions to AWS Lambda. We’ll use this to write a service that will consume RSS feeds that can be used in our application.

Self Paced
Self-Paced
Javascript Technology Node.js
Details
Product Analytics Essentials: 3 Reports to Drive Impact | Learn with Mixpanel (Skillshare) Skillshare
Skillshare

Product Analytics Essentials: 3 Reports to Drive Impact | Learn with Mixpanel (Skillshare)

CS: Design & Product

Learn how to create a smart, deliberate analytics strategy for your app or website with Mixpanel product manager Veronica Pinchin! Product analytics helps you understand how users engage with products you build. When you understand the data behind your product, you can make informed hypotheses, better understand your users, and prioritize changes to better your business.

Self Paced
Self-Paced
Analytics Product Management Mixpanel
Details
Building a basic portfolio website using HTML, CSS and JavaScript (Skillshare) Skillshare
Skillshare

Building a basic portfolio website using HTML, CSS and JavaScript (Skillshare)

CS: Programming

Ever wanted to create your own website but don't know where to begin? Start your web development journey here with Dr Simon Rose. In this free practical class, you'll build and publish your own portfolio website from scratch in under 2 hours using HTML, CSS and JavaScript. The class is taught by a university lecturer and is adapted from an Intro to Web Development university module.

Self Paced
Self-Paced
HTML Javascript CSS
Details
Make Your WordPress Website Mobile Friendly (Skillshare) Skillshare
Skillshare

Make Your WordPress Website Mobile Friendly (Skillshare)

CS: Information & Technology

The rise of mobile devices has been among the most dramatic changes on the Internet. In recent years mobile phones and tablets have overtaken desktop computers as the primary devices to access the web. One of the consequences of this trend is that today any website that hopes to be successful needs to cater to the needs of these mobile visitors.

Self Paced
Self-Paced
Technology Web Development Website
Details