Embedded Help Standards

Embedded Help

Page Description

Element

Description

Examples

Additional Information / Standards

Element

Description

Examples

Additional Information / Standards

Description

Summarize what the user can expect to see on the page, including the key actions they can perform here.

Enter the project and process name and ensure that this combination is unique. Specify project type and provide additional details as required.

  • Limit the to less than 220 characters.

  • Use active voice.

  • Make it actionable.

  • Use complete sentences.

Tooltip

Element

Description

Example

Additional Information / Standards

Element

Description

Example

Additional Information / Standards

Message

A brief message to provide more information on a field in the application.

Set to true if the output of this project flows as input to another project

  • Limit the length to less than 80 characters.

  • Follow a consistent style across the application.

  • Do not use tooltips to provide essential information.
    Example: Do not Provide password requirements as a tooltip.

  • Do not provide redundant information as a tooltip.

  • Sentence case; no period at the end.

In-field Help

Element

Description

Example

Additional Information / Standards

Element

Description

Example

Additional Information / Standards

Message

A brief message that is displayed within a field to educate the user on the information they must enter in the field.

First name, last name

(Considering the field is: Name)

  • Use sentence case; no period at the end

  • Limit the length to less than 50 characters.

  • Follow a consistent style across the application.