As usual, I bring this article to you courtesy of JACQUIE SAMUELS, as I think it adds relevance to what I am setting out to achieve with my documentation framework. You may view the original article here.
Guess what: That’s not how customers see it.
Anything but the simplest product is useless unless it comes with documentation. If you deliver a product without documentation, it’s the equivalent of dumping a jumble of IKEA pieces in their laps without assembly instructions. Congratulations, you’ve made your customer very, very unhappy. After all, they’ve just paid you hard-earned money for your product and you’ve rendered it immediately useless and possibly dangerous.
To your customers, a product without documentation is a product that isn’t complete.
If you think no one reads the documentation, you’re sadly mistaken. The truth is that everyone turns to the documentation as soon as they need help. If they can’t find the answer (quickly and easily) in the documentation, they will a) be annoyed and b) call Support—a far more costly action for you.
In many ways, out of date documentation is far, far worse than no documentation at all. There is implicit trust when a user reads documentation—that it is as correct as humanly possible.
The only way you can possibly deliver out of date documentation is to say loudly and very visibly that it is, in fact, not up to date. Then you might as well beg for mercy because, these days, that is simply not acceptable. What bits are out of date? If unknown pieces are wrong, how can they trust anything in the documentation at all? Don’t forget that errors in documentation are often seen by users as mistakes in the product itself—they expect the product to work as documented and if it doesn’t then the product must be broken. If you’ve cut corners in documentation, where they go for help, how can they trust your product? How can they trust your company at all? It snowballs very quickly into a complete breach of trust.
In these days of Web 2.0, people don’t sit idly by being furious with you. They take to Twitter, Facebook, and every other social media outlet they can find and they share their anger with the world.
So please, on behalf of all consumers of your product, put that extra time and money into writing and updating the documentation. Build it into the cost of the product because, after all, your product isn’t complete without it.
About the Author
Jacquie Samuels is a technical communication consultant providing companies with DITA, CMS, and information architecture solutions and training. She endeavors to help everyone create documentation that is stronger, faster, and smarter. You can connect with Jacquie through Writing Assistance, Inc. at www.writingassist.com or