Skip to main content

Five Reasons Why Your Product Needs an Awesome User Guide

Macintosh User Manual - Clicking

A user guide is essentially a book-length document containing instructions for installing, using or troubleshooting a hardware or software product. A user guide can be very brief - for example, only 10 or 20 pages or it can be a full-length book of 200 pages or more. -- prismnet.com
As engineers, we give a lot of importance to product design, architecture, code quality, and UX. However, when it comes to the user manual, we often only manage to pay lip service. This is not good. A usable manual is as important as usable software because it is the first line of help for the user and the first line of customer service for the organization. Any organization that prides itself on great customer service must have an awesome user manual for the product.
In the spirit of listicles - here are at least five reasons why you should have an awesome user manual!


Enhance User Satisfaction


In my fourteen years as a software developer, I have often been in situations where something just wouldn't work in a software I was using. When this happens, I usually try a few quick hacks and if they didn't work either, I reach for the user manual. I consider the user manual to be the first line of support and I open it with part hope and part trepidation. There have been times -- God bless the team who wrote it -- when the manual pointed me to the solution immediately. The feeling I have at such times is unmistakable. There is a sense of relief; a sense of joy; and a sense of gratitude. It is very satisfying. I say a silent thank you to the team for making my life easier. I feel glad I purchased that software instead of the alternatives.
I'm sure most people feel that way and yet when it is our turn to write the manual, we somehow miss out on its importance. 
If you value user satisfaction - make sure your product has a great manual.

Reduce Support Overhead


I have also been on the other side of the table where I have had to talk with bewildered customers who were stuck with issues they couldn't fix. These calls typically took anywhere from fifteen minutes to an hour. Add to that the cost of context switching from my work and the overall cost of a sloppy User Guide is fairly heavy.
Granted that developers don't have to get on customer support calls in most organizations (although they do in most startups) it's still someone's time spent that could have been saved with a better manual.
Whether it's developer time or the time of the support staff - lost time translates directly to cost. Not only that, it also results in a lost opportunity to give more timely support if the support team gets swamped. 


Increase Sales

By now enough people have burned their fingers with buggy or unusable software. A good user manual is no longer seen as an added benefit. It's a must-have for many customers. I have always considered the user manual as an important factor when evaluating software for a purchase decision and I suspect many people will consider it to be an important factor before closing the deal.
Another way user manuals impact sales is through the satisfaction of existing customers. Satisfied customers are some of your best evangelists. They will talk about the product with other people which can generate sales with little or no effort from the sales team.


Create a Great Image for Your Product and Company

Scott Cooley considers documentation to be a maturity indicator. How true! It takes a mature company to understand the importance of great documentation and also allocate resources to actually create it.
It's also an indicator of how much your company values the customer's time. All organizations declare satisfaction as their #1 priority. Here's a simple way to actually demonstrate it.
Finally, a beautifully written user manual adds that extra X-factor to the image of the product. Producing great user documentation is an effective way to enhance the brand value of your company.


Limit Legal Liability Related to Misuse of the Product

You are liable if people hurt themselves while using your product and you haven't provided them with the means to avoid it. -- technicalwriting.eu
This one's probably more important for hardware products or software products that handle machinery or critical health-related equipment. If you do have a critical product it is your duty to write a manual that clearly outlines appropriate usage and safety instructions. But even if you aren't shipping critical software, it's still a good idea to describe the correct way to use your product.

Summing it up


We all know the benefits of great user documentation, but somehow deadline pressures make us complacent. However, if you consider the cost and opportunity benefit that accrues from:
  1. Enhanced user satisfaction
  2. Reduced support overhead
  3. Increased sales
  4. Improved branding
  5. Limited legal liabilities
- you will agree that it's a no-brainer to put in additional time and resources for creating awesome User Guides.

Labels:

Comments

Post a Comment

Popular posts from this blog

Commenting your code

Comments are an integral part of any program, even though they do not contribute to the logic. Appropriate comments add to the maintainability of a software. I have heard developers complain about not remembering the logic of some code they wrote a few months back. Can you imagine how difficult it can be to understand programs written by others, when we sometimes find it hard to understand our own code. It is a nightmare to maintain programs that are not appropriately commented. Java classes should contain comments at various levels. There are two types of comments; implementation comments and documentation comments. Implementation comments usually explain design desicisions, or a particularly intricate peice of code. If you find the need to make a lot of implementation comments, then it may signal overly complex code. Documentation comments usually describe the API of a program, they are meant for developers who are going to use your classes. All classes, methods and variables ...
Post a Comment
Read more

My HSQLDB schema inspection story

This is a simple story of my need to inspect the schema of an HSQLDB database for a participar FOREIGN KEY, and the interesting things I had to do to actually inspect it. I am using an HSQLDB 1.8 database in one of my web applications. The application has been developed using the Play framework , which by default uses JPA and Hibernate . A few days back, I wanted to inspect the schema which Hibernate had created for one of my model objects. I started the HSQLDB database on my local machine, and then started the database manager with the following command java -cp ./hsqldb-1.8.0.7.jar org.hsqldb.util.DatabaseManagerSwing When I tried the view the schema of my table, it showed me the columns and column types on that table, but it did not show me columns were FOREIGN KEYs. Image 1: Table schema as shown by HSQLDB's database manager I decided to search on StackOverflow and find out how I could view the full schema of the table in question. I got a few hints, and they all pointed to ...
Post a Comment
Read more

Inheritance vs. composition depending on how much is same and how much differs

I am reading the excellent Django book right now. In the 4th chapter on Django templates , there is an example of includes and inheritance in Django templates. Without going into details about Django templates, the include is very similar to composition where we can include the text of another template for evaluation. Inheritance in Django templates works in a way similar to object inheritance. Django templates can specify certain blocks which can be redefined in subtemplates. The subtemplates use the rest of the parent template as is. Now we have all learned that inheritance is used when we have a is-a relationship between classes, and composition is used when we have a contains-a relationship. This is absolutely right, but while reading about Django templates, I just realized another pattern in these relationships. This is really simple and perhaps many of you may have already have had this insight... We use inheritance when we want to allow reuse of the bulk of one object in other ...
3 comments
Read more