Gallery of Onscreen Help

A collection of screen captures from online documentation, to permit technical writers and documentation designers to review a variety of visual styles.

Gallery of Onscreen Help. Resources>Documentation>Help>Online

Nine Trends in Online User Assistance

Whilst applications are becoming more complex, many people believe that online user assistance hasn't changed much since WinHelp was introduced with Windows 3. This is a misconception. There have been many developments in this field aimed at increasing end-user productivity and satisfaction.

Pratt, Ellis. Cherryleaf (2003). Articles>Documentation>Online>Help

Ode to Balloon Help

Just as a romantic poet might choose to pen an ode to a single rose as opposed to the entire garden, perhaps we should look to the simplest elements of usability for inspiration. Perhaps it’s time to recognize the contribution of a single humble helper. Yes, it’s time for an ode to Balloon Help. You may smile, but it can be argued that Balloon Help is not only one of the most ubiquitous implementations of modern technological performance support but it is also one of the most underappreciated.

Cavanagh, Thomas B. Usability Professionals Association (2004). Articles>Documentation>Online>Help

Eight Tips for Writing Informative Overview Topics

Overview topics play an important role in creating a positive user assistance experience. Unlike procedures, which deliver critical information on how to solve a problem quickly, overview topics fill in the conceptual details and background "story." Here are some tips for writing thorough and informative overviews.

HelpScribe (2008). Articles>Documentation>Online>Help

Alternatives to Software Documentation

Software documentation such as Help systems and user guides may be the best method of helping your customers to use your software effectively. However, one or more of these alternatives may be a better solution.

Unwalla, Mike. TechScribe (2007). Articles>Documentation>Online>Help

Could You Repeat That in English?

Frequently, error messages are totally uninformative -- or, worse, just plain wrong. Here, we look at how meaningful error messages can make it easier for users to correct problems without having to rely on technical support, and how poorly chosen messages can turn users into ex-users.

Seebach, Peter. IBM (2002). Articles>User Interface>Online>Help

Where to Start With HTML Help

Knowing HTML alone is not enough to create HTML Help. What deliverables does the client need? CHMs (HTML Help)? Web-based Help (HTML files + other things that create the Toc, Index, Search tabs etc.)? Java Help? Oracle Help? Be aware of the limitations of some formats.

CyberText Consulting (2008). Articles>Documentation>Online>Help

A Question of Trust

Last month, Forrester Research released results from a survey on how much consumers trust different sources for information. They didn't include online Help or knowledge bases in the survey, so we don't know how well or badly they would have come out in the survey.

Cherryleaf (2009). Articles>Documentation>Online>Help

Should Your Help Be Moved to a Server?

As broadband Internet access becomes increasingly available, software providers are minimizing the local installation of help topics and instead moving some or all help to Web servers. While this approach may alienate users who have no Internet connection or lack broadband access, there are many advantages. Web servers offer features and options that aren't available with locally installed help.

HelpScribe (2009). Articles>Documentation>Online>Help

Think Simple: A Fresh Approach to User Assistance  

Online help. User assistance. That thing that pops up when you press F1. No matter what you call it, user assistance is an important element in the experience of a user. It can mean the difference between a frustrated user and a productive one. But is today's user assistance all it can be? Are we giving users purposeful information at the right time, in the most effective format, and ultimately in the way that they need it? Unfortunately, no.

Davis, Aaron and Scott Nesbitt. DMN Communications (2009). Presentations>Documentation>Online>Help

How Embedded User Assistance Impacts Documentation

Embedded user assistance is only part of a complete documentation plan. It does not replace the need for other types of content. For example, embedded user assistance is not a good delivery mechanism for comprehensive concepts and detailed discussions of a topic with strategy and best practice guidelines. However, with a strong design, embedded user assistance can support the immediate needs of the user and provide a valuable, contextual link that steers the user into the other parts of the documentation as needed.

Mueller, Paul. Answers for All (2009). Articles>Documentation>Online>Help

Discovering Relationship Tables

Lately I’ve been creating context-sensitive help for an online application. As part of my strategy, I’ve been trying to follow Theresa Putkey’s advice in “Usability in Context-Sensitive Help.” In her article, Theresa recommends providing more than just the steps for a specific task in the context-sensitive help window. Instead, she says to show more contextual links, including answers to why, when, and who questions, because too frequently the user who searches for help may have needs outside the specific task you describe.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Online>Help

Install Windows' Old-School "Help" in Windows 7 

If you've installed older software in Windows 7, you might notice that .hlp-formatted Help files aren't recognized or supported. Microsoft offers a free download to read and manage those WinHelp files.

Purdy, Kevin. LifeHacker (2009). Articles>Documentation>Online>Help