The field help popup allows User Assistance Developers to provide application specific information to administrators and end-users to better instruct them with details and context for a specific page element in a specific UI area. The field help icon appears directly adjacent to the page element it accompanies and launches a small popup window without a heading that contains the help text defined by the UAD and translated by the LANG team as needed.

The pattern of Field Help is a combination of a help icon placed to the right of the page element, and a popup window with extremely lightweight properties. There is no text formatting, header, or close button. Selecting another part of the UI closes the popup.

The following usage guidelines apply to field help:

• If you want to provide static help text for specific input fields, column headers, page headers and sub-headers, buttons, tabs, links, switches, checkboxes, radio buttons, and other page elements.
• When it’s necessary to understand a crucial idea or to perform an important task. This may be the meaning of the component, or the details on its usage.
• Use sparingly, and with purpose to meet the target user’s needs.
• On page elements you would not expect the target user to understand through regular training, according to their profile.
• To explain values in lists as needed.
• If a UI change can remove the need for field help.
• As a workaround for poor design or usability.
• If it looks overused and clutters the page.
• If an action or item is obvious or should be part of the user’s knowledge domain.
• To replace ALT text.
• If the explanation needed is complex or specific to a certain type of customer or vertical.
• Field help should be short, clear, and precise.
• No more than 160 characters of full sentences with periods.
• Uses active voice and imperative mood.
• If the field help needs to refer to the user, it does so directly as “you”.
• Does not begin with an article (a, an, the).
• Doesn’t reference the target component itself by name, or other UI components.
• Doesn’t include character (bold, italic) of paragraph formatting (no bullets or lists or steps), or symbols.
• Does not duplicate instruction text already on the page.
• Keep it short, clear, and precise.
• Use no more than 160 characters of full sentences with periods.
• Use the active voice and imperative mood.
• If the field help needs to refer to the user, address the user as "you".
• Don't begin with an article (a, an, the).
• Don't reference the target component itself by name, or other UI components.
• Don't include character (bold, italic) or paragraph formatting (no bullets or lists or steps), or symbols.
• Don't duplicate instruction text already on the page.
• You can assign a time type filter rule to define conditions which, if met, lead to an exclusion of the time type from the time type dropdown list when recording an absence, attendance, or on-call.