{"id":471,"date":"2009-04-23T10:31:57","date_gmt":"2009-04-23T10:31:57","guid":{"rendered":"http:\/\/www.cherryleaf.com\/blog\/?p=471"},"modified":"2009-04-23T10:31:57","modified_gmt":"2009-04-23T10:31:57","slug":"what-should-you-include-in-your-user-documentation","status":"publish","type":"post","link":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/","title":{"rendered":"What should you include in your user documentation?"},"content":{"rendered":"

Technical authors are faced with limited time and resources, so they often are faced with the dilemma as to what to include and what to leave out of their user documentation. You may ask, if 80% read only 20% of the content, is there any value in documenting the rest?<\/p>\n

Technical Authors are often great advocates of\u00a0doing away with what\u00a0doesn’t add value in documentation. However, in an article “How normal is normal?<\/a>“, John Casti explains why extreme events like a killer hurricane\u00a0occur far more often than we think.<\/p>\n

So does this mean\u00a0that your rare and unusual topics in documents do need to described, after all?<\/p>\n

Casti\u00a0discovered there was greater likelihood to extreme values than we\u2019d expect from\u00a0bell-shaped, normal distributions:<\/p>\n

“Just as with the meltdown of the global financial system, the normal distribution dramatically underestimates the likelihood of unlikely events. Such events follow a different type of probability curve informally termed a \u201cfat-tailed\u201d distribution.”<\/em><\/p>\n

Indeed, he states Pareto’s (80-20) principle\u00a0is closely related to fat-tailed distributions:<\/p>\n

“In a normal bookshop, there might be around 100,000 titles on the shelves of which 80 per cent don\u2019t sell a single copy during the course of a month. Here the 80-20 Rule prevails. Now consider amazon.com, which has nearly four million titles available, or perhaps an online music site like iTunes, and ask how many of the titles they have available sell at least one copy in a month\u2019s time. The answer is not 20 per cent or 50 per cent or even 80 per cent. It\u2019s a staggering 98 per cent! Nearly every single title gets some action nearly every single month.”<\/em><\/p>\n

There are also implications regarding information architecture and site navigation in Casti’s article:<\/p>\n

“What\u2019s needed, (Chris Anderson) he says, is for there to be a functioning way to drive demand for those niche products out near the end of tail. First you need a \u2018head\u2019, consisting of a relatively small number of hits. Then comes a tail of many niche volumes, the kind only the author, his mother and a small band of fanatics and connoisseurs could ever love. So there must be not only a huge inventory of products, but also a way to direct prospective customers from the head to the tail by means of suggestions, background profiles from past purchases and all the other things a place like amazon.com does to match readers with the books they really want.”<\/em><\/p>\n

So does this mean that users navigate to the “niche” topics via the popular “head”\u00a0topics? Do\u00a0you need a “head topic” to bring the users in, with a filtering\u00a0and suggested topics mechanism to direct them to niche topics, to service any customer\u2019s wishes?<\/p>\n

I’m not aware of any user assistance-related usability studies that have looked into this.\u00a0Perhaps\u00a0there is, as Casti claims, “a lot more going on out on the \u2018fringe\u2019 than we ever imagined”. As more content is published online, and more Web analytics-derived statistics becomes available to Publications Managers, then perhaps we’ll find out.<\/p>\n","protected":false},"excerpt":{"rendered":"

Technical authors are faced with limited time and resources, so they often are faced with the dilemma as to what to include and what to leave out of their user documentation. You may ask, if 80% read only 20% of the content, is there any value in documenting the rest? Technical Authors are often great… Read more »<\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[162,157,194,236,176,230,229,191,154],"tags":[276,294,258,262,295,264],"class_list":["post-471","post","type-post","status-publish","format-standard","hentry","category-documentation","category-survey","category-technical-communication","category-technical-documentation","category-technical-writing","category-usability","category-user-assistance","category-user-manuals","category-writing","tag-documentation","tag-research","tag-technical-author","tag-technical-communication","tag-usability","tag-user-assistance"],"acf":[],"yoast_head":"\nWhat should you include in your user documentation? - Cherryleaf<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"What should you include in your user documentation? - Cherryleaf\" \/>\n<meta property=\"og:description\" content=\"Technical authors are faced with limited time and resources, so they often are faced with the dilemma as to what to include and what to leave out of their user documentation. You may ask, if 80% read only 20% of the content, is there any value in documenting the rest? Technical Authors are often great... Read more »\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\" \/>\n<meta property=\"og:site_name\" content=\"Cherryleaf\" \/>\n<meta property=\"article:published_time\" content=\"2009-04-23T10:31:57+00:00\" \/>\n<meta name=\"author\" content=\"ellis\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@cherryleafltd\" \/>\n<meta name=\"twitter:site\" content=\"@cherryleafltd\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"ellis\" \/>\n\t<meta name=\"twitter:label2\" content=\"Estimated 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\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\"},\"author\":{\"name\":\"ellis\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318\"},\"headline\":\"What should you include in your user documentation?\",\"datePublished\":\"2009-04-23T10:31:57+00:00\",\"dateModified\":\"2009-04-23T10:31:57+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\"},\"wordCount\":519,\"commentCount\":3,\"publisher\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#organization\"},\"keywords\":[\"documentation\",\"research\",\"Technical Author\",\"Technical Communication\",\"usability\",\"user assistance\"],\"articleSection\":[\"documentation\",\"survey\",\"Technical Communication\",\"Technical Documentation\",\"Technical Writing\",\"usability\",\"user assistance\",\"user manuals\",\"writing\"],\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\",\"url\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\",\"name\":\"What should you include in your user documentation? - Cherryleaf\",\"isPartOf\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#website\"},\"datePublished\":\"2009-04-23T10:31:57+00:00\",\"dateModified\":\"2009-04-23T10:31:57+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.cherryleaf.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"What should you include in your user documentation?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.cherryleaf.com\/#website\",\"url\":\"https:\/\/www.cherryleaf.com\/\",\"name\":\"Cherryleaf\",\"description\":\"Clear instructions your users will love. Tel: +44 (0)207 100 4513\",\"publisher\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.cherryleaf.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.cherryleaf.com\/#organization\",\"name\":\"Cherryleaf\",\"url\":\"https:\/\/www.cherryleaf.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png\",\"contentUrl\":\"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png\",\"width\":435,\"height\":121,\"caption\":\"Cherryleaf\"},\"image\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/x.com\/cherryleafltd\",\"https:\/\/www.youtube.com\/channel\/UCQQmJCmDrCqEAmBhinq0CIQ\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318\",\"name\":\"ellis\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg\",\"caption\":\"ellis\"},\"sameAs\":[\"https:\/\/www.cherryleaf.com\"],\"url\":\"https:\/\/www.cherryleaf.com\/author\/ellis\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"What should you include in your user documentation? - Cherryleaf","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":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/","og_locale":"en_GB","og_type":"article","og_title":"What should you include in your user documentation? - Cherryleaf","og_description":"Technical authors are faced with limited time and resources, so they often are faced with the dilemma as to what to include and what to leave out of their user documentation. You may ask, if 80% read only 20% of the content, is there any value in documenting the rest? Technical Authors are often great... Read more »","og_url":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/","og_site_name":"Cherryleaf","article_published_time":"2009-04-23T10:31:57+00:00","author":"ellis","twitter_card":"summary_large_image","twitter_creator":"@cherryleafltd","twitter_site":"@cherryleafltd","twitter_misc":{"Written by":"ellis","Estimated reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#article","isPartOf":{"@id":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/"},"author":{"name":"ellis","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318"},"headline":"What should you include in your user documentation?","datePublished":"2009-04-23T10:31:57+00:00","dateModified":"2009-04-23T10:31:57+00:00","mainEntityOfPage":{"@id":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/"},"wordCount":519,"commentCount":3,"publisher":{"@id":"https:\/\/www.cherryleaf.com\/#organization"},"keywords":["documentation","research","Technical Author","Technical Communication","usability","user assistance"],"articleSection":["documentation","survey","Technical Communication","Technical Documentation","Technical Writing","usability","user assistance","user manuals","writing"],"inLanguage":"en-GB","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/","url":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/","name":"What should you include in your user documentation? - Cherryleaf","isPartOf":{"@id":"https:\/\/www.cherryleaf.com\/#website"},"datePublished":"2009-04-23T10:31:57+00:00","dateModified":"2009-04-23T10:31:57+00:00","breadcrumb":{"@id":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.cherryleaf.com\/2009\/04\/what-should-you-include-in-your-user-documentation\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.cherryleaf.com\/"},{"@type":"ListItem","position":2,"name":"What should you include in your user documentation?"}]},{"@type":"WebSite","@id":"https:\/\/www.cherryleaf.com\/#website","url":"https:\/\/www.cherryleaf.com\/","name":"Cherryleaf","description":"Clear instructions your users will love. Tel: +44 (0)207 100 4513","publisher":{"@id":"https:\/\/www.cherryleaf.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.cherryleaf.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"},{"@type":"Organization","@id":"https:\/\/www.cherryleaf.com\/#organization","name":"Cherryleaf","url":"https:\/\/www.cherryleaf.com\/","logo":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png","contentUrl":"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png","width":435,"height":121,"caption":"Cherryleaf"},"image":{"@id":"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/cherryleafltd","https:\/\/www.youtube.com\/channel\/UCQQmJCmDrCqEAmBhinq0CIQ"]},{"@type":"Person","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318","name":"ellis","image":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg","caption":"ellis"},"sameAs":["https:\/\/www.cherryleaf.com"],"url":"https:\/\/www.cherryleaf.com\/author\/ellis\/"}]}},"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[],"_links":{"self":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/posts\/471"}],"collection":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/comments?post=471"}],"version-history":[{"count":0,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/posts\/471\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/media?parent=471"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/categories?post=471"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/tags?post=471"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}