ScreenStepsAdministering Your Account Additional TopicsThe 2 Most Important Kind of Help Articles In Your Knowledge Base [Webinar]

The 2 Most Important Kind of Help Articles In Your Knowledge Base [Webinar]

This article contains portions of the webinar that was held on April 27, 2015. The recorded webinar was broken up by topic to make it easier to understand.

Goal of the webinar

The goal of the webinar was to help you know what to write. One of the biggest struggles you will face is writer's block. This webinar will help you know what kind of documentation to write, and how to write it.

To know what users need and how to format your documentation, we use two frameworks. Click the links to below to learn what your users need and how to format your documentation.

Know how to write it (and format the article)

You can format the article in hundreds of ways. But to keep it simple, we'll focus on two:

  1. Road Block Remover Article
  2. Road Map Article

A road block removing article is a simple article with a few screenshots, and answers a very specific question. A road map is more like a standard operating procedure, and may be more in-depth.

The SaaS Education Lifecycle

We came up with a framework to help us understand what SaaS users need, which helps us know what to write about. Go through the links below to see each stage of the SaaS Education Lifecycle.

Onboarding
Getting screenshots for an onboarding article

We'll use a road block removing article to onboard. It's quick, simple, and can get a new user up in your SaaS product in very little time.

Training
Creating a training article

We use a road map article to explain lengthier processes. If an article is gong to be more than four or five screenshots and steps, you may want to consider creating a road map article to make it easier on your users.

Teaching
Creating (and viewing) a teaching article

You can use either a road block removing article (short and simple) or a road map (lengthier article with more content). It depends on what concepts you are trying to teach.

Create your knowledge base!

Now that you know how to create great articles, start writing! After you get a few articles written up, you will want to begin organizing your documentation to make it easier for browsing. Check out >> Organizing your knowledge base for tips and ideas on how to group content together.

0 Comments

Add your comment

E-Mail me when someone replies to this comment