UI consistency guidance

Table of Contents

Note: This section applies only to BriteCore documentation, not other collateral; it addresses variations between classic BriteCore and BriteSuite screens and elements.

Tabs

Because of layout differences between classic BriteCore and BriteSuite, instead of directing a user to select a tab, direct them to select the element name itself.

Instead of……write:
Select the Processing tab.Select Processing.

 

Never refer to screens as tabs.

Instead of……write:
On the Legacy Search tab, select Create a New Policy.On the Legacy Search screen, select Create a New Policy.

Internal tabs

For screens in BriteCore that use internal tabs (those not in the main navigation, but rather in the middle of a screen), refer to its instances in the main navigation instead, or identify and refer to the element by name without tab.

Example of internal tabs

Example of internal tabs reflected in the [Policies] menu

Instead of……write:
Scroll to and select the Information tab, and then, under Contacts, select Add Another Named Insured.Select Information in the Policies menu. Under Contacts, select Add Another Named Insured.

OR

Select Information. Under Contacts, select Add Another Named Insured.

Note: Use your best judgment for which approach will be clearest to the end user given the context of the documentation you’re writing.

Screen names

Don’t use the [Module] – [Screen] naming convention used in classic BriteCore. Screens aren’t titled this way in BriteSuite.

Classic BriteCore: Policies – Legacy Search

BriteSuite: Legacy Search

Therefore (examples):

Instead of……write:
On the Policies – Legacy Search screen, select Create a New Policy.

(This is titled this way only in classic BriteCore.)

On the Legacy Search screen, select Create a New Policy.

(This works with what the user will see in both classic BriteCore and BriteSuite.)

On the Settings – Business Locations screen, in the System Wide dropdown list, select System Tags.

(Only classic BriteCore titles the screen as Settings – Business Locations. While both sites have dropdown lists, they are located in different places in each, and in full-demo, the System Wide dropdown list in the Settings menu is already expanded by default upon accessing the Business Locations screen, thus displaying the System Tags link without user interaction required.)

In the Settings menu, under System Wide, select System Tags.

(This works with what the user will see in both classic BriteCore and BriteSuite. Accessing the System Tags screen isn’t contingent on first being on the Business Locations screen. The System Wide submenu is already open when you access Settings, which is why this rewrite doesn’t indicate to first select it. Selecting System Wide in this instance would effectively hide the System Tags option.)

On the Settings screen, select the Modules dropdown list, and then select Lines.In the Settings menu, under Modules, select Lines.

OR

In the Settings menu, in the Modules submenu, select Lines.

Menus

BriteCore menu

Refer to the main menu only as the BriteCore menu.

Instead of……write:
In the top menu, select Lines. (The menu isn’t always on top.)

In the main menu, select Lines.

In the side navigation, select Lines. (The menu isn’t always on the side.)

In the sidebar, select Lines. (The menu isn’t always a sidebar).

In the navigation, select Lines. (This isn’t clear. There are multiple navigation levels.)

In the BriteCore menu, select Lines.

OR

Select Lines.

 

Note: Exceptions such as BriteApps’ Navigation Menu, where the menu name is titled on the screen, are still acceptable.

Secondary (module-level) menus

Refer to module menus by name when applicable. This isn’t required, but can add clarity. Use your best judgment.

Note: Don’t refer to module menus (Contacts, Lines, Policies, Claims, Reports, Settings, etc.) as submenus.

Acceptable examples:

  • Select Lines. In the Lines menu, select Notes.
  • Select Lines, then select Notes.

Tertiary menus (submenus)

Some modules, such as Policies, have a tertiary menu (Payments).

While not required, you can refer to this menu level as a submenu.

Acceptable examples:

  • Select Policies from the BriteCore menu. Select Payments. In the Payments submenu, select Daily Cash Receipt.
  • Select Policies, then select Payments. Select Daily Cash Receipt.

Table of Contents