{"id":399,"date":"2018-02-28T09:42:40","date_gmt":"2018-02-28T14:42:40","guid":{"rendered":"https:\/\/lios.dev.creationsunivers.net\/nobodys-reading-your-technical-documentation-so-make-it-better\/"},"modified":"2018-02-28T09:42:40","modified_gmt":"2018-02-28T14:42:40","slug":"nobodys-reading-your-technical-documentation-so-make-it-better","status":"publish","type":"post","link":"https:\/\/lios.dev.creationsunivers.net\/en\/nobodys-reading-your-technical-documentation-so-make-it-better\/","title":{"rendered":"Nobody\u2019s reading your technical documentation? So make it better!"},"content":{"rendered":"

\"Personne<\/p>\n

If you\u2019re one to believe technical documentation goes unread, you may well end up wondering what the point of investing time and money in technical documentation is. But what if that\u2019s actually not the right question?<\/p>\n

Technical documentation isn\u2019t literature<\/h4>\n

As Mark Baker points out in\u00a0Users\u2019 Advocate: Nobody Reads Documentation<\/a>, \u201cPeople read novels. They don\u2019t read documentation.\u201d And this observation doesn\u2019t just go for technical documentation. Be it store catalogues, recipe books and even the telephone directories of days past, many texts are never read from start to finish. So what\u2019s our point here? While these documents aren\u2019t read, they are<\/em> consulted frequently, and that\u2019s exactly why we have to keep producing them to the very best of our ability.<\/p>\n

Not convinced? You think to yourself \u201cbut I never refer to technical documentation\u201d? Right, but isn\u2019t your car owner\u2019s manual on hand if some strange light starts blinking?<\/p>\n

Consulting technical documentation is all about trust<\/h4>\n

You may still feel like technical documentation is pointless. That\u2019s totally normal if your customer service department is flooded with questions about your products, especially if their answers are right there in your documentation.<\/p>\n

As we noted in our article Having a Hard Time Retaining Customers? Think Technical Documentation<\/a>, 81% of consumers prefer to find their own solution before calling customer service. So let\u2019s put it this way: If your customers don\u2019t turn to your technical documentation right off, something is definitely wrong.<\/p>\n

What if the problem is trust, actually? If customers\u2019 first instinct is to call your customer service department, maybe it\u2019s because they lack the confidence your documentation will provide them with the answer faster than by calling!<\/p>\n

Sheila Fahey at Cherryleaf, quoted by Tom Johnson in his article\u00a0If No One Reads the Manual, That’s Okay<\/a>, offers this summary: \u201cWhen things go wrong and it matters to the user, they will seek assistance. They will look for the easiest way to get to the information they need to do the task. If this is the manual, then they will use it.\u201d<\/p>\n

So the long and the short of it? Make sure your documentation is the easiest and fastest way for your customers to get the information they need.<\/p>\n

Hints for better technical documentation<\/h4>\n
    \n
  • Documentation should be accessible<\/strong>: Does your product come with an installation and user\u2019s guide? Great! But make sure that these documents are also available online. If your customers have to track down a paper copy for a product they bought 10 years ago, they\u2019re going to call your customer service department, for sure. And when putting your documentation online, make sure your customers can find it easily on the web.<\/li>\n
  • Information should be easy to find<\/strong>: Make the structure of your documentation consistent so your customers can instinctively<\/strong> find what they\u2019re looking for. If your technical documentation is available online, be sure to include a high-performance search tool, since that\u2019s probably how people will begin their search when visiting your site. Make things easier for them by ensuring that your documentation terminology matches the search terms they\u2019re most likely to use. This is also the perfect time to make use of the data collected by your site\u2019s analytical tools to determine which search terms crop up most often.<\/li>\n
  • Information should be divided into subjects<\/strong>: Since few people are going to read your documentation from beginning to end, make sure that when they find what they\u2019re looking for, they don\u2019t have to search too much longer for their answers. Information on a given topic should be grouped, even if you have to include links to other relevant subjects.<\/li>\n
  • Information should be easy to understand<\/strong>: If customers find what they\u2019re looking for but can\u2019t understand it, they won\u2019t be any better off. This means that your documentation should be written in a user-friendly style. Use diagrams, images, videos, tables, procedures and other straightforward ways of presenting information so customers can find what they need quickly and determine what they have to do instantly.<\/li>\n
  • Documentation should be a work in progress<\/strong>: Making sure your technical documentation is well structured, with information that is easy to find, understand and use is a great start\u2014but it\u2019s only the beginning! Treat your documentation like a work in progress, rather than as a one-up project. Once your initial documentation is complete, you\u2019ll have to update and improve it regularly to better meet your customers\u2019 needs. What\u2019s the best way forward? Put tools in place to analyze how customers use your documentation, what they look for, which webpages they visit, and so on. Use data from your customer service department, since the questions your reps typically handle will provide useful clues to what\u2019s lacking in your documentation.<\/li>\n<\/ul>\n

    Just like in all areas of operations, you have to size up your technical documentation\u2019s issues before improvements can be made. What\u2019s more, you\u2019ll quickly realize how much happier your documentation users are when you better understand their needs. And who knows? You might even find out about how they use your products and identify a few new features you could develop!<\/p>\n","protected":false},"excerpt":{"rendered":"

    If you\u2019re one to believe technical documentation goes unread, you may well end up wondering what the point of investing time and money in technical documentation is. But what if that\u2019s actually not the right question? Technical documentation isn\u2019t literature As Mark Baker points out in\u00a0Users\u2019 Advocate: Nobody Reads Documentation, \u201cPeople read novels. They don\u2019t […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[32,28,23],"tags":[],"class_list":["post-399","post","type-post","status-publish","format-standard","hentry","category-content-management","category-information-architecture","category-technical-writing-and-documentation"],"acf":[],"_links":{"self":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/posts\/399","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/comments?post=399"}],"version-history":[{"count":0,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/posts\/399\/revisions"}],"wp:attachment":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/media?parent=399"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/categories?post=399"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/tags?post=399"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}