Context Help

Use 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.

	Explain complex behavior that a short action or a setting name cannot convey clearly.
	Provide input format requirements and examples.
	Suggest alternative ways.
	Warn about possible issues.
	Explain limitations.
	Provide quick navigation to related settings.
	Explain IDE-specific entities.

See Inline help text, Tooltip, and Empty State.