Use context help to briefly explain how a functionality works if it is not clear from the UI or the application behavior. A full description of the functionality should be provided in product web help.
Context help can be shown as an inline help text, in a help tooltip, and in an empty state.
Inline help textUse an inline help text in settings dialogs that are not constrained by space and are not frequently used. Since settings are rarely changed, users may forget their purpose, so displaying the information immediately makes sense.
Use a tooltip:
If the space is not enough for showing the inline help text.
In frequently used dialogs, tool windows, or popups. The more often a person uses an interface, the more likely they are to remember what each option does.
For icons or other controls that do not have a label.
Fill in empty states of tool windows, tables, trees, and other containers with:
a reason why the data is missing
an action that can fix it
a link to a corresponding article in the web help.
Below you will find rules for tooltips and inline texts.
When not to use Do not explain UIDo not use context help to explain how the user interface works. If you need to explain that, consider redesigning the UI.
Do not explain common actionsDo not explain common actions and entities. Show a regular tooltip with an action name and shortcut in this case.
Do not clutter UI with context helpDo not explain each option. Too many help icons or too much inline text make a dialog cluttered and harder to navigate visually. If all options need to be explained, consider rewriting the labels to make them clearer.
How to useSee Inline help text, Tooltip, and Empty State.
05 February 2025
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4