--- title: "What should you include in your user documentation?" id: "471" type: "post" slug: "what-should-you-include-in-your-user-documentation" published_at: "2009-04-23T10:31:57+00:00" modified_at: "2009-04-23T10:31:57+00:00" url: "https://www.cherryleaf.com/2009/04/what-should-you-include-in-your-user-documentation/" markdown_url: "https://www.cherryleaf.com/2009/04/what-should-you-include-in-your-user-documentation.md" excerpt: "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..." taxonomy_category: - "documentation" - "survey" - "Technical Communication" - "Technical Documentation" - "Technical Writing" - "usability" - "user assistance" - "user manuals" - "writing" taxonomy_post_tag: - "documentation" - "research" - "Technical Author" - "Technical Communication" - "usability" - "user assistance" --- 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 advocates of doing away with what doesn’t add value in documentation. However, in an article “[How normal is normal?](http://kn.theiet.org/magazine/issues/0907/how-normal-0907.cfm) “, John Casti explains why extreme events like a killer hurricane occur far more often than we think. So does this mean that your rare and unusual topics in documents do need to described, after all? Casti discovered there was greater likelihood to extreme values than we’d expect from bell-shaped, normal distributions: *“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 “fat-tailed” distribution.”* Indeed, he states Pareto’s (80-20) principle is closely related to fat-tailed distributions: *“In a normal bookshop, there might be around 100,000 titles on the shelves of which 80 per cent don’t 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’s time. The answer is not 20 per cent or 50 per cent or even 80 per cent. It’s a staggering 98 per cent! Nearly every single title gets some action nearly every single month.”* There are also implications regarding information architecture and site navigation in Casti’s article: *“What’s 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 ‘head’, 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.”* So does this mean that users navigate to the “niche” topics via the popular “head” topics? Do you need a “head topic” to bring the users in, with a filtering and suggested topics mechanism to direct them to niche topics, to service any customer’s wishes? I’m not aware of any user assistance-related usability studies that have looked into this. Perhaps there is, as Casti claims, “a lot more going on out on the ‘fringe’ 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. ### Share this: - [Share on Facebook (Opens in new window) Facebook](https://www.cherryleaf.com/2009/04/what-should-you-include-in-your-user-documentation/?share=facebook) - [Share on LinkedIn (Opens in new window) LinkedIn](https://www.cherryleaf.com/2009/04/what-should-you-include-in-your-user-documentation/?share=linkedin) - [Share on WhatsApp (Opens in new window) WhatsApp](https://www.cherryleaf.com/2009/04/what-should-you-include-in-your-user-documentation/?share=jetpack-whatsapp) - [Share on Bluesky (Opens in new window) Bluesky](https://www.cherryleaf.com/2009/04/what-should-you-include-in-your-user-documentation/?share=bluesky) - ### *Related* ### 3 Comments Interesting questions here. Questions about the 80-20 rule aside, when you begin to look at numbers, it’s important not to forget the qualitative side of its use-cases: while a topic might only get 1% of views, the context in which these views happen may have relatively high importance- perhaps the topic troubleshoots a workaround for a rare but catastrophic bug, or perhaps it’s something that people only turn to if they need emergency or out of hours help… The ‘head’ pages sound very like the ‘landing pages’ Matthew Ellison has talked about, no? The idea of which is to present links to useful (ideally “most visited”) information as soon as the user enters the online help at a particular point. Something we’re trying to figure out for our system at the moment. > Casti discovered there was greater likelihood to extreme values than we’d expect from bell-shaped, normal distributions: BTW, he did not discover this; but it is known for a very long time. It means that the normal distribution is not an ideal, not even a realistic model. Anyhow, it is used merely for it’s simplicity to deal with it “scientifically”. You can not expect realistic forecasts, this way. ### Leave a Reply[Cancel reply](/2009/04/what-should-you-include-in-your-user-documentation/#respond) This site uses Akismet to reduce spam. [Learn how your comment data is processed.](https://akismet.com/privacy/) #### Previous post [Documentation and when things go wrong](https://www.cherryleaf.com/2009/04/documentation-and-when-things-go-wrong/) #### Next post [Trends in technical documentation – Is technical writing broken?](https://www.cherryleaf.com/2009/04/trends-in-technical-documentation-is-technical-writing-broken/) #### Browse posts by month Browse posts by month Select Month August 2026 (5) July 2026 (7) June 2026 (14) May 2026 (8) April 2026 (6) March 2026 (14) February 2026 (9) January 2026 (9) December 2025 (7) November 2025 (9) October 2025 (10) September 2025 (7) August 2025 (6) July 2025 (1) June 2025 (3) May 2025 (2) April 2025 (5) March 2025 (3) February 2025 (3) January 2025 (2) November 2024 (8) October 2024 (3) September 2024 (2) August 2024 (3) July 2024 (4) June 2024 (1) May 2024 (2) April 2024 (4) March 2024 (1) February 2024 (2) January 2024 (1) December 2023 (2) November 2023 (9) October 2023 (8) September 2023 (5) August 2023 (3) July 2023 (1) June 2023 (1) May 2023 (2) April 2023 (3) March 2023 (2) January 2023 (2) December 2022 (4) November 2022 (1) October 2022 (1) September 2022 (1) August 2022 (1) July 2022 (1) June 2022 (1) May 2022 (2) April 2022 (1) March 2022 (1) February 2022 (1) January 2022 (2) December 2021 (1) November 2021 (2) October 2021 (1) August 2021 (1) July 2021 (2) June 2021 (3) May 2021 (5) April 2021 (3) March 2021 (3) February 2021 (1) January 2021 (2) December 2020 (4) November 2020 (4) August 2020 (3) February 2020 (3) January 2020 (1) November 2019 (3) October 2019 (1) September 2019 (1) August 2019 (3) July 2019 (2) June 2019 (3) May 2019 (4) April 2019 (1) November 2018 (2) October 2018 (1) July 2018 (2) June 2018 (4) May 2018 (2) April 2018 (3) March 2018 (4) February 2018 (2) January 2018 (3) December 2017 (2) October 2017 (3) September 2017 (1) August 2017 (3) July 2017 (2) June 2017 (7) May 2017 (4) April 2017 (5) March 2017 (1) February 2017 (7) January 2017 (1) December 2016 (3) November 2016 (4) October 2016 (1) September 2016 (5) July 2016 (1) June 2016 (3) May 2016 (1) April 2016 (2) February 2016 (2) January 2016 (5) December 2015 (1) November 2015 (4) October 2015 (2) August 2015 (1) July 2015 (1) June 2015 (2) May 2015 (3) February 2015 (2) January 2015 (6) December 2014 (1) October 2014 (1) September 2014 (4) June 2014 (4) May 2014 (1) April 2014 (2) March 2014 (3) February 2014 (4) January 2014 (4) November 2013 (2) October 2013 (5) September 2013 (3) July 2013 (3) June 2013 (11) May 2013 (4) April 2013 (6) March 2013 (7) February 2013 (4) January 2013 (4) December 2012 (9) November 2012 (23) October 2012 (14) September 2012 (8) August 2012 (4) July 2012 (12) June 2012 (12) May 2012 (10) April 2012 (8) March 2012 (12) February 2012 (3) January 2012 (6) December 2011 (2) October 2011 (3) August 2011 (1) June 2011 (5) May 2011 (2) April 2011 (1) January 2011 (1) December 2010 (1) November 2010 (3) October 2010 (4) September 2010 (8) August 2010 (5) May 2010 (2) April 2010 (3) March 2010 (3) February 2010 (2) January 2010 (3) December 2009 (2) November 2009 (6) September 2009 (1) July 2009 (6) June 2009 (7) April 2009 (8) March 2009 (3) February 2009 (3) January 2009 (3) December 2008 (1) November 2008 (3) October 2008 (3) September 2008 (4) August 2008 (1) July 2008 (3) June 2008 (5) May 2008 (2) April 2008 (2) March 2008 (3) February 2008 (2) January 2008 (1) November 2007 (3) October 2007 (2) September 2007 (1) July 2007 (3) November 2006 (1) October 2006 (2) September 2006 (3) August 2006 (1) April 2006 (1) March 2006 (3) #### Browse posts by category