FusionGPS: Design Patterns: Embedded Help Pattern Set

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 that a well-designed interface should be easy to use without large amounts of embedded help.


Patterns Used to Create Embedded Help

Static Instruction Text	Help on pages where the typical user may fail to perform a task unassisted
In-field Help Note	Help on an editable field
Terminology Definition	Help that defines the meaning of a UI component
Bubble Help	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

	Static Instruction Text	In-field Help Note	Terminology Definition	Bubble Help	User Assistance Popup
Valid UI components that use this type of help	Page header Subheader Sub-subheader	Standalone check box Multiselect check box group Single-select choice list Multiselect choice list Single-select list box Multiselect list box Text box Single-select option groups Items in true/false option groups Items in true/false check box groups Color picker Date/time picker Flexfield LOV Spin box Slider File upload Shuttle Rich Text Editor	Check box prompt Check box group prompt Single-select choice list Multiselect choice list Single-select list box Multiselect list box Text box Option group prompt Color picker Date/time picker Flexfield LOV Column headers Spin box Slider File upload Shuttle Rich Text Editor	Icon button Button Link Tab	Page header Subheader Sub-subheader Tab 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, including optional links to nonembedded help


Related Guidelines

Help Framework Usage Guideline	Describes ways that help appear in the Rich Client User Experience-based UI
Oracle Fusion Help UI Guideline	Guidance on which type of help to use in Oracle Fusion Applications

About Oracle | Legal Notices | Terms of Use | Your Privacy Rights