Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / writing / Can online help show “read wear?”

May 28, 2008 by annegentle

Can online help show “read wear?”

I’ve been re-reading Jakob Nielson’s Participation Inequality essay on useit.com, and the suggestion to some how show wear marks on content struck me this evening for some reason. I guess it’s because I’ve been working on Drupal recently, and discovered that Drupal documentation contains site recipies in the Drupal Handbook. What a nifty idea. Stick with me, these two concepts are related through a recipe and cookbook angle.

Part of Jakob’s treatise on inequal participation in online communities is that you can do little to overcome the typical contribution stats of 90-9-1, although one of the suggestions is to make participation so easy that you don’t even know you’re contributing. Case in point – Amazon’s “people who bought this book, bought these other books” recommendations. Sounds like the easiest contribution ever – data mining and analyzing, then giving the data back to the shopper in an understandable format.

Jakob says, “Will Hill coined the term read wear for this type of effect: the simple activity of reading (or using) something will “wear” it down and thus leave its marks — just like a cookbook will automatically fall open to the recipe you prepare the most.”

What are some similar examples of displaying read wear from the online help or user assistance world? The first example that comes to my mind is a wiki’s “most active pages” feature that shows the page with the most edits. However, the page with the most edits may be more controversial than truthful, so the most popular pages would be more useful than touting pages most active.

How else can you show read wear on a website? You could also show the most searched-for terms when the user searches. Concepts may be more easily connected when you understand what others were searching for.

Or, rather than showing search terms, show the most recently viewed knowledgebase articles or most popular articles. I know I’ve found that useful in the past when searching through BMC Software’s rich knowledge base.

Just like CNN and other news sites offer a listing of the most emailed stories per hour, you could show the most emailed online help topics if your system offers the ability to email topics.

The ability to rate an article is included in many online help systems, and exposing the ratings to the reader would help in determining how “well-worn” a help topic is.

Tag clouds can display read wear as well, as I just realized while looking at the WordPress FAQ starting page – tonight, the largest tag is “Images.”

I’ve distilled it down to popularity, time spent on the page, rating on a page, and number of edits from strongest to weakest indicators. What other factors matter in an online help system?

Related

Filed Under: writing Tagged With: online help, popular, popularity, read wear, reading, tag clouds, tagging, web analysis, wiki

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in