| Embedded Help Pattern Set | Version 2.0.0.0 | ||
| Description | |
Embedded help provides Oracle Fusion Applications users with in-context assistance in the local area of the user interface (UI). Embedded help enables users to complete their tasks and reduces errors. Remember, a well-designed interface should be easy to use without large amounts of embedded help. |
| Patterns to Create Embedded Help | |
Help on pages where the typical user may fail to perform a task unassisted. |
|
| In-field Help Note | Help on an editable field. |
Help that defines the meaning of a UI component. |
|
Help that appears on UI components that a user selects to perform certain actions. |
|
| User Assistance Popup | Either brief contextual help or links to nonembedded help, or both, for a page or region. |
| Pattern Set Decision Table | |
| Valid UI components to use this type of help | - Page header - Subheader - Sub-subheader |
- Standalone check box |
- Check box prompt |
- Butcon |
- Page header - Subheader - Sub-subheader - Tab - Tasks listed in the Setup Table Checklist or Setup Hgrid Checklist, - Dashboard region |
| Does the user need help understanding the effects of entering a value or leaving the component blank? | N |
Y |
N |
N |
N |
| Does the user need a detailed description of what the UI component means or does? | N |
N |
Y |
Y |
N |
| Does the user need help understanding what to do on a page or within a header region? | Y |
N |
N |
N |
Y |
| Does the user require in-depth assistance or need to explore more information? | N |
N |
N |
N |
Y |
| How long is the help text including spaces? | Less than or equal to two lines (of local area width) or 400 characters |
Less than or equal to 160 characters |
Less than or equal to 80 characters |
Less than or equal to 80 characters |
Less than or equal to 400 characters, optional links to nonembedded help |
| Related Guidelines | |
Describes ways that help can be displayed in the Rich Client User Experience-based UI. |
|
Guidance on the creation of embedded help content for Oracle Fusion Applications. |
|
Guidance on which type of help to use in Oracle Fusion Applications. |