Greg DeVore

By: Greg DeVore on August 12th, 2015

Print/Save as PDF

How to Evaluate your Documentation

Software Documentation Tips | Documentation Managers

How do you know if your online documentation is making an impact? How do you know what you need to improve? In this article, we are going to give you a a few questions you can use to evaluate how well your documentation site is prepared to help your customers.

We are going to discuss this in the terms of training and customer support as outlined in our article, The Customer Education Lifecycle.

1. Is it optimized for customer support?

Remember that in customer support situations your customers and support agents will be primarily searching for answers.

  1. Are your article titles optimized for search?
  2. Does each article answer one primary question or does it try to answer multiple questions in Customer_Documentationthe same article?
  3. Is each article accessible through a unique URL?
  4. Are screenshots used to help customers orient themselves?

2. Is it optimized for training?

  1. Are your training areas organized by customer use cases?
  2. Can your customers easily navigate through your training guides to the sections that they need to reference?
  3. Are your training guides maintaining the proper balance between scope and detail?
  4. Are your training guides trying to double as support resources or vice versa?

Answering these questions can give you a good idea of where and how you need to improve your content.

Displaying How to evaluate your documentation.

Free Course: How to Create B2B Software Documentation  Learn how to create B2B documentation that drives business results and  productivity Sign Up Now

About Greg DeVore

CEO of ScreenSteps