Average rating is 71% positive
71.43
14 votes
This pattern was helpful This pattern is useless

Inline Help Box

Problem summary

The user needs an assistive introduction aside the interaction he is about to perform

Example

Example image showing 'Inline Help Box'

Usage

  • Use when an interaction with your website is not necessarily intuitive and self-explanatory in itself.
  • Use inline tips to document your interface
  • Use when you want to motivate the user to start using the system.
  • Use when you want to aid the user in getting started with your web application.
  • Use when you want to guide the user to get a good start with your web application.
  • Use to gently introduce functionality to the new and untrained user.
  • Use the ‘hide’ functionality to avoid frustration of the experienced and trained user.

Solution

Document your interface in-line with descriptive help blocks. If you have functionality in your software that requires interaction from your users, this functionality can be easily explained in a help box just above or below the functionality that requires the user’s interaction.

As the help box itself is not part of the main functionality, it is a good idea to add a style to it that visually separates the help box from that functionality. An easy way to do this is by applying another background and font color to the help box.

Additionally, to avoid the user’s discontent with the help box, a great feature of the in-line help box is to have a “hide this box” functionality. Once the user has clicked this link, the help box will never be shown to the user again.

However, you might want to provide an option for the user to re-enable all help boxes, to allow the user to get that first-hand help that he or she started out getting.

Rationale

By providing your user with assistive instruction aside the interaction, it is easier for the user to relate the instruction with how it applies to your web application’s functionalities than a disconnected FAQ or help section.

By allowing the user to easily close/hide each help box, the user is not bothered with unnessecary information once it has been understood.

More examples images of the Inline Help Box pattern

The help box can also be used as a notification box that describes system updates. From <a href="http://basecamphq.com/">Basecamp</a>.
The help box can also be used as a notification box that describes system updates. From Basecamp.

This pattern was last updated on February 07, 2008

2 comments

Post a comment

Required
Required
Will not be published
simple_captcha.jpg
Required
Type the code from the image