Consider the following criteria to decide when to use help boxes or other feedback options:
Well written alert messages should be:
Messages should use the plainest possible language that can clearly convey the message. Avoid obscure codes, abbreviations, or technical jargon. Ideally, a beginner-level user of the feature should be able to understand the alert message.
Only include the information the user needs to understand and resolve the immediate problem.
Alert messages should not be written in a negative voice that blames users for incorrect usage but in a positive or neutral voice. Avoid phrases like "illegal command".
Do include any phrasing that specifically relates to that error so users can look up that exact problem on a search engine using precise wording
Do not use vague wording such as "syntax error"
Do not begin the error or warning message with “Error” or “Warning” as the color styling and associated icon makes this wording redundant
A help box contains the following elements:
1. Message icon
2. Message text
Help boxes appear below the affected area (for example a property in the Inspector window) and shift the content below it.
Default state of a help box.
Use canGrabFocus method if the help box can be focused.
UI Toolkit
Unity - Scripting API:
HelpBox
IMGUI
Unity - Scripting API:
EditorGUI.HelpBox
