{"id":1308,"date":"2014-12-09T15:26:28","date_gmt":"2014-12-09T20:26:28","guid":{"rendered":"http:\/\/samueldube.com\/demo\/lios\/mythe-5-documentation-technique-ne-sert-a-rien\/"},"modified":"2017-07-25T15:06:24","modified_gmt":"2017-07-25T19:06:24","slug":"myth-5-technical-documentation-is-useless","status":"publish","type":"post","link":"https:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/","title":{"rendered":"Myth 5: Technical Documentation Is Useless"},"content":{"rendered":"<p>Just use the product. Push a few buttons. Shake, shake. Kick! Okay, it\u2019s still not working. Make a few phone calls. You\u2019ll figure it out! Right? Hmm\u2026 Actually, a user\u2019s manual might be handy right about now.<\/p>\n<p>&nbsp;<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-medium wp-image-1172\" src=\"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg\" alt=\"\" width=\"280\" height=\"280\" srcset=\"https:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg 280w, https:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-122x122.jpg 122w, https:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang.jpg 350w\" sizes=\"auto, (max-width: 280px) 100vw, 280px\" \/><\/p>\n<h1>Reality<\/h1>\n<p>Think of when you\u2019ve ever been in a pinch: a deadline is looming, your staff is twiddling their thumbs, that key piece of equipment just isn\u2019t working right. You\u2019ve tried, tested and just can\u2019t figure it out.<\/p>\n<p>Your clients may be going through this frustration right now\u2026 with your product! Take a hard, honest look: Does your documentation explain your product, its use and troubleshooting clearly and intuitively? Really, you shouldn\u2019t accept anything less. Your clients are your business\u2019 raison d\u2019\u00eatre. And providing them with quality documentation that helps them use your products according to best practices will make them satisfied customers happy to come back again and again.<\/p>\n<h3>At their fingertips<\/h3>\n<p>Quality documentation is a helping hand when things go wrong. If your technical documentation is well done, it will be the \u201cah-ha\u201d of relief when things were looking grim. Everybody likes being a hero\u2014why not be your client\u2019s?!<\/p>\n<h4>Hitting the spot<\/h4>\n<p>Technical documentation should help users in the way they need help. Well-structured information is easily findable and easily useable\u2014that means clients can find exactly what they\u2019re looking for. They will be grateful not to have to wade through the unnecessary stuff.<\/p>\n<h4>The one and only<\/h4>\n<p>You know your documentation is top quality when it becomes an in-house reference for your products and not just some paper you send to clients to look good. Does your documentation hold up with your experts? Do they consult it when something is unclear, needs improving or fixing? Technical documentation should be the reference for anyone using your product!<\/p>\n<h4>Technical documentation: A valuable sales tool<\/h4>\n<p>Quality documentation is also a loyal friend to your sales team. It reassures potential customers and gives them yet another reason to choose your product over the competition\u2019s. Is your product unique, top quality, expertly designed? Prove it with your technical documentation! And once convinced, clients will buy reassured that help will always be close at hand should there be bumps down the road. Well-crafted documentation shows your clients that you\u2019ve been there first and can help them find their way.<\/p>\n<h4>Squeezing out every last drop out<\/h4>\n<p>Quality documentation will allow your clients to get the most out of your product. Of course, your manuals describe how to get your product up and running without damaging it, but, done right, your documentation should also delve into the details of how to get the most out of your product. Maybe a secondary function or a better practice presented clearly and simply will allow your client to use your product even more efficiently. So next time you\u2019re tempted to skip documentation\u2026think again!<\/p>\n<p>To receive our latest publications, please subscribe to our mailing list.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Just use the product. Push a few buttons. Shake, shake. Kick! Okay, it\u2019s still not working. Make a few phone calls. You\u2019ll figure it out! Right? Hmm\u2026 Actually, a user\u2019s manual might be handy right about now. &nbsp; Reality Think of when you\u2019ve ever been in a pinch: a deadline is looming, your staff is [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[39],"tags":[],"class_list":["post-1308","post","type-post","status-publish","format-standard","hentry","category-technical-writing-and-documentation"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.3 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Myth 5: Technical Documentation Is Useless - Lios<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Myth 5: Technical Documentation Is Useless - Lios\" \/>\n<meta property=\"og:description\" content=\"Just use the product. Push a few buttons. Shake, shake. Kick! Okay, it\u2019s still not working. Make a few phone calls. You\u2019ll figure it out! Right? Hmm\u2026 Actually, a user\u2019s manual might be handy right about now. &nbsp; Reality Think of when you\u2019ve ever been in a pinch: a deadline is looming, your staff is [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/\" \/>\n<meta property=\"og:site_name\" content=\"Lios\" \/>\n<meta property=\"article:published_time\" content=\"2014-12-09T20:26:28+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2017-07-25T19:06:24+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg\" \/>\n<meta name=\"author\" content=\"Pascal\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Pascal\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#article\",\"isPartOf\":{\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/\"},\"author\":{\"name\":\"Pascal\",\"@id\":\"https:\\\/\\\/www.lios.ca\\\/#\\\/schema\\\/person\\\/185bd226f300ea376b71556a3861a2d2\"},\"headline\":\"Myth 5: Technical Documentation Is Useless\",\"datePublished\":\"2014-12-09T20:26:28+00:00\",\"dateModified\":\"2017-07-25T19:06:24+00:00\",\"mainEntityOfPage\":{\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/\"},\"wordCount\":505,\"image\":{\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/www.lios.ca\\\/wp-content\\\/uploads\\\/2017\\\/04\\\/hero_ang-280x280.jpg\",\"articleSection\":[\"Technical writing and documentation\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/\",\"url\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/\",\"name\":\"Myth 5: Technical Documentation Is Useless - Lios\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.lios.ca\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#primaryimage\"},\"image\":{\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/www.lios.ca\\\/wp-content\\\/uploads\\\/2017\\\/04\\\/hero_ang-280x280.jpg\",\"datePublished\":\"2014-12-09T20:26:28+00:00\",\"dateModified\":\"2017-07-25T19:06:24+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/www.lios.ca\\\/#\\\/schema\\\/person\\\/185bd226f300ea376b71556a3861a2d2\"},\"breadcrumb\":{\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#primaryimage\",\"url\":\"http:\\\/\\\/www.lios.ca\\\/wp-content\\\/uploads\\\/2017\\\/04\\\/hero_ang-280x280.jpg\",\"contentUrl\":\"http:\\\/\\\/www.lios.ca\\\/wp-content\\\/uploads\\\/2017\\\/04\\\/hero_ang-280x280.jpg\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/blogue\\\/myth-5-technical-documentation-is-useless\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"http:\\\/\\\/www.lios.ca\\\/en\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Myth 5: Technical Documentation Is Useless\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.lios.ca\\\/#website\",\"url\":\"https:\\\/\\\/www.lios.ca\\\/\",\"name\":\"Lios\",\"description\":\"L&#039;information \u00e0 l&#039;oeuvre\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.lios.ca\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.lios.ca\\\/#\\\/schema\\\/person\\\/185bd226f300ea376b71556a3861a2d2\",\"name\":\"Pascal\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/0b61a5ec5d50484aabc9949da35a378871871e11bf276aa4d242d1d5c3ad948a?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/0b61a5ec5d50484aabc9949da35a378871871e11bf276aa4d242d1d5c3ad948a?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/0b61a5ec5d50484aabc9949da35a378871871e11bf276aa4d242d1d5c3ad948a?s=96&d=mm&r=g\",\"caption\":\"Pascal\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Myth 5: Technical Documentation Is Useless - Lios","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/","og_locale":"en_US","og_type":"article","og_title":"Myth 5: Technical Documentation Is Useless - Lios","og_description":"Just use the product. Push a few buttons. Shake, shake. Kick! Okay, it\u2019s still not working. Make a few phone calls. You\u2019ll figure it out! Right? Hmm\u2026 Actually, a user\u2019s manual might be handy right about now. &nbsp; Reality Think of when you\u2019ve ever been in a pinch: a deadline is looming, your staff is [&hellip;]","og_url":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/","og_site_name":"Lios","article_published_time":"2014-12-09T20:26:28+00:00","article_modified_time":"2017-07-25T19:06:24+00:00","og_image":[{"url":"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg","type":"","width":"","height":""}],"author":"Pascal","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Pascal","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#article","isPartOf":{"@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/"},"author":{"name":"Pascal","@id":"https:\/\/www.lios.ca\/#\/schema\/person\/185bd226f300ea376b71556a3861a2d2"},"headline":"Myth 5: Technical Documentation Is Useless","datePublished":"2014-12-09T20:26:28+00:00","dateModified":"2017-07-25T19:06:24+00:00","mainEntityOfPage":{"@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/"},"wordCount":505,"image":{"@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#primaryimage"},"thumbnailUrl":"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg","articleSection":["Technical writing and documentation"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/","url":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/","name":"Myth 5: Technical Documentation Is Useless - Lios","isPartOf":{"@id":"https:\/\/www.lios.ca\/#website"},"primaryImageOfPage":{"@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#primaryimage"},"image":{"@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#primaryimage"},"thumbnailUrl":"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg","datePublished":"2014-12-09T20:26:28+00:00","dateModified":"2017-07-25T19:06:24+00:00","author":{"@id":"https:\/\/www.lios.ca\/#\/schema\/person\/185bd226f300ea376b71556a3861a2d2"},"breadcrumb":{"@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#primaryimage","url":"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg","contentUrl":"http:\/\/www.lios.ca\/wp-content\/uploads\/2017\/04\/hero_ang-280x280.jpg"},{"@type":"BreadcrumbList","@id":"http:\/\/www.lios.ca\/en\/blogue\/myth-5-technical-documentation-is-useless\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"http:\/\/www.lios.ca\/en\/"},{"@type":"ListItem","position":2,"name":"Myth 5: Technical Documentation Is Useless"}]},{"@type":"WebSite","@id":"https:\/\/www.lios.ca\/#website","url":"https:\/\/www.lios.ca\/","name":"Lios","description":"L&#039;information \u00e0 l&#039;oeuvre","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.lios.ca\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.lios.ca\/#\/schema\/person\/185bd226f300ea376b71556a3861a2d2","name":"Pascal","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/0b61a5ec5d50484aabc9949da35a378871871e11bf276aa4d242d1d5c3ad948a?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/0b61a5ec5d50484aabc9949da35a378871871e11bf276aa4d242d1d5c3ad948a?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/0b61a5ec5d50484aabc9949da35a378871871e11bf276aa4d242d1d5c3ad948a?s=96&d=mm&r=g","caption":"Pascal"}}]}},"_links":{"self":[{"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/posts\/1308","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/comments?post=1308"}],"version-history":[{"count":6,"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/posts\/1308\/revisions"}],"predecessor-version":[{"id":1692,"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/posts\/1308\/revisions\/1692"}],"wp:attachment":[{"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/media?parent=1308"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/categories?post=1308"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.lios.ca\/en\/wp-json\/wp\/v2\/tags?post=1308"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}