Worthwhile Documentation

Detailed support docs are not enough. If they were, our queues would be emptier. A good doc builds a customer’s confidence and helps them find clear, approachable answers. They won’t find that, though, if we don’t make documentation seem worthwhile.

Any customer who contacts support is motivated to solve their problem, but that doesn’t mean a simple link will be enough to draw their attention. A support doc still has to sound compelling. And yet too often our replies tack on a link to documentation as an afterthought.

To make a doc sound worthwhile, focus on the words right before a link. I know I’ve sent many a reply like, “You can read more about this here…” with a link. That sounds superficial and ignores important context and direction. My job is to give the customer a look at what’s inside the doc and how it can help them—but a minimal reply like that does neither.

It helps to think about what the doc contains that I couldn’t just copy and paste into an email response. Here’s an example that makes it sound more worthwhile:

There’s a lot more you can do with this feature and our support doc covers all the details. That link takes you through everything and includes screenshots to help you find each step and get it set up exactly how you want.

That reply is longer, but it puts more energy behind the link. The customer gets a thorough nudge and greater confidence this is information they need to know. They can see documentation as more than just a dry manual and have a hint that it will help them be more effective. Manuals are off-putting while a good support doc helps someone learn and build confidence.

It’s extra special if you can include tidbits into some docs. If a feature’s key to the product, document a couple (brief) case studies or next-level steps. With those included you can add something like,

And check out the bottom of the page for tips from some of our largest customers about how they use this feature. There’s good advice in there that can help you avoid common mistakes.

This takes a support doc from simple help material to something more like educational marketing. It shows a customer not just how to configure a feature but how to thrive. That may save you another email from the customer later on once they’ve mastered the basics.

There’s, of course, much more that can be done with documentation. To overhaul a set of support docs can be a mountain of work that takes weeks or months while improving our own replies is work we can start today. There’s no development time required nor any software to integrate. It’s something each team member can tinker with and learn. Customers are willing to spend more time with docs once they know it’ll be worth their while.