An Article That Changed My Approach to Help
August 7th, 2008 | Posted in Technical Writing, usability |
After a topic title in your help, what do you write? Do you jump straight into the numbered steps, or do you explain why a user would likely perform the topic?
Although I practice the latter (adding explanatory text before the steps), I recently read an article by Mike Hughes that convinced me readers rarely read text that appears before a numbered list.
Here’s the gist of Mike’s article. He’s really talking about on-screen text, but I’m extrapolating the principle to apply it to my online help.
When using an application, users are motivated to take action, and their focus is easily drawn to action objects such as menus, buttons, and text fields.
Once an action object or other visual element on a page has drawn a user’s focus downstream in the focus flow, it is difficult to redirect it back upstream. In other words, if something initially draws a user’s attention to the middle of a page, it is far more likely that the user will continue across and down as opposed to going back up the page. This is especially true if there are additional action objects downstream.
See “Instructional Text in the User Interface: Some Counterintuitive Implications of User Behaviors” for the full article.
Two weeks after reading the article, it still rattles around in my mind. I think just like a button on a page, users are drawn to a numbered list. Although I still add some “why” or “when” before my numbered lists, if the information is critical, I insert it somewhere in the list.
Here’s an example.
The information about why you’d want to make a spinach shake precedes the numbered steps. But the critical information about using frozen peaches is embedded in the list because readers would most likely skip over it in the introduction.
Thanks for a great article Mike. By the way, Mike’s blog is here.
And if you want to read more about Shrek shakes, see Jane’s post: “Shrek Shakes and Twinkies.” We went through a 3 week period at our house where we drank nothing but Shrek shakes. Then one day my oldest daughter said she was sick of them, and we all agreed and haven’t drunk them since.
———-
Note: I posted Mike’s article on Writer River, as well as a ton of other excellent articles. Have you discovered Writer River yet? You can subscribe to the feed or to a daily email update. Then each morning, when you open your feedreader or email, you can start the day off with information that will help you do your job better.
Related Posts
- How Much Should You Document? Everything? Strategies for an Agile Environment
- Vista and Office 2007: Presentation by David McNamee from Microsoft
- Podcasting article in STC Intercom magazine
- New Look and New Approach to Blog/Podcast
- Blog Usability Checklist
Tags: online help, shrek shakes, usability
Twitter
iTunes

August 7th, 2008 at 3:01 am
Hello! Thanks for this interesting entry. However, I’d like to disagree about the “no introduction necessary”, and since yesterday (when in a German group someone posted an according explanation) I can argue that *G*
When it comes to learning types, there are the “why”, “what”, “how” and “what if” types of people. And “why” people don’t even get started with the task if they don’t know the reason for it - I am such a person myself. So e.g. in a presentation or manual, all of these learning groups need to be addressed, and the “why” people at first, because otherwise they won’t proceed. It may be kept short, but there needs to be something IMO.
I think your spinach example is very good, I handle such warnings etc. accordingly at the steps when it’s important.
August 7th, 2008 at 5:31 am
I accompany a task sequence with a 1-2 sentences long introduction. If the content requires a longer introduction, I write it on a topic of it own.
avis last blog post..היסטוריית הדפדפן שלי אומרת שאני 48% בחורה
August 7th, 2008 at 8:01 am
Step 2 should be “Throw in about a dozen frozen peach slices.” Then, add the note to explain why. I don’t want to be halfway through the process when I discover that key information.
August 7th, 2008 at 10:00 am
I agree with BG’s post. Explanatory text is useful when it gives context that is essential to the task at hand. Unfortunately, most of the time it’s also an invitation for “filler” if you are bound by a style guide that dictates that you *must* have explanatory text before each task list for the sake of consistency. Is consistency more important than efficient instruction? I don’t think so.
August 7th, 2008 at 10:09 am
I’m not saying no introductory text is necessary, only that readers tend to glaze over that text and move straight to the numbered list. So if you have info that you really want the reader to see, embed it in the list.
August 7th, 2008 at 10:19 am
Explanatory text prior to a procedure is going the way of the user manual paradigm for exactly the reason you mentioned. People don’t read - they get what they need, when they need it.
August 7th, 2008 at 10:39 am
Even though we may be initially drawn to the numbered steps following a topic title, we can return to the explanatory text whenever we want to understand why we might want to perform this task.
In this case, I would get stuck at Step 1: “Add two handfuls of leafy spinach in a blender,” and wonder why on earth we might want to make such a disgusting thing. We could return to the trusted explanation zone between the topic title and the first step: “Getting your kids to eat spinach can be difficut, but if you hide the leafy greens in a shake…” and feel a little more comfortable about step 1 and excited to move on to step 2.
I also agree with Debra’s post–the peaches should be referred to as frozen peach slices.
August 7th, 2008 at 11:06 pm
I’m glad I just read this. All day, I’ve been seeing posts in regards to making content more efficient for the reader’s experience, so this just further proved to me that I need to get on top of changing around my content! Thanks!
Erikas last blog post..Miami Web Design
August 13th, 2008 at 12:58 pm
I think I loved that. I never really have a very big into paragraph. I try to make it short and sweet. Then I go onto the numbered list.
August 18th, 2008 at 6:24 am
I loved that too.It is nice article.
& this is very nice website too.
I just Bookmarked it.
Thanks
Passions last blog post..Speed Up Startup & Loading Time In Firefox
September 14th, 2008 at 3:36 am
[...] aktuell gerne darauf verwiesen, dass Leute angeblich keine Hintergrundinformationen nutzen, sondern direkt die Anleitung einsetzen. Am liebsten würde man diese “unnötigen Einleitungen” ganz wegfallen lassen - ich als [...]