Actionable Words

Add vs. Create#

Use add when you are asking a user to add something that already exists (in the world) into Hub.

DoDon't
Add productCreate product
Add supplierCreate supplier
Add manufacturerCreate manufacturer

Use create when you are asking a user to bring something into existence that never existed before (in the world).

DoDon't
Create purchase orderAdd purchase order
Create invoiceAdd invoice
Create future priceAdd future price

Delete vs. Remove#

Use delete when you are asking a user to remove something from the system permanently. Use remove when you are asking a user to remove something from the UI but it still exists in the system.

Edit vs. Manage#

Use edit when you can change the input of a field (letters, numbers, properties). There’s no need for a noun unless it’s unclear what’s being edited. See forms for edit state documentation.

DoDon't
EditEdit Customer

Use manage at a higher level to convey that multiple actions can be done, or sections and settings can be updated. Pair this verb with a noun if it’s in a button or if it’s unclear what is being managed.

Enable/Disable vs. On/Off#

Use Enable/Disable to turn on or off a second level option within an application or feature. Eg. Enable or Disable a location or feature within an app. Use On/Offto turn on or off a top level option. An app or feature is turned ON or OFF at the company level.

DoDon't
Enableenable
Disabledisable
Onon
Offoff
enabled
disabled

Export vs. Download#

Use export when users need to convert data into a different format to access it on their device outside of Hub.

DoDon't
Export CSV fileExport PDF
Export Excel file

Use download when users need to copy data in the same format to access it on their device outside of Hub.

DoDon't
Download PDFDownload CSV file
Download product labels

Import vs. Upload#

Use import when users need to convert data into a different format before they can access it in Hub.

DoDon't
Import CSV fileImport PDF
Import Excel fileImport Image

Use upload when users need to copy data in the same format to access it in Hub.

DoDon't
Upload ImageUpload CSV file
Upload PDF

Save vs. Done#

Use Save when changes made by the user are immediately saved to the database Use Done when changes made by the user are not immediately saved to the database.

Saving in page headers#

Save buttons in page headers allow users to save changes made anywhere on the page. Since the save applies to the entire page, the button should provide context to the user of the scope of the save. This can be done by using the Save + {noun} structure in the button. Where the {noun} is the entity represented by the entire page.

DoDon't
Save productSave
Save supplierApply changes
Save future price

Saving in modals#

When user selections in modals can immediately save to the database, simple use Save and not the Save + {noun} structure. This is because modals provide context into the action the user is taking close to the button.

Deferred save#

Deferred save scenarios usually occur in Hub when a user makes a selection inside a Hub modal - the selection is added as unsaved changes to the page. The modal selection is not immediately saved to the database, it will be saved once the user saves the entire page. In deferred save scenarios, use Done and not Save.

DoDon't
Deferred save
Deferred save
Deferred save
Save

Sign in/Sign out vs. Login/Logout#

Use Sign in to authenticate a user based on their credentials. Use Sign out to remove that user's authentication.

DoDon't
Sign inSignin
Sign outSignout
Log in
Log out
Login
Logout

Statuses#

When the status of an element needs to be indicated keep the language simple and direct. Use no more than two words to indicate the status.

Badge statuses#

In the case of badges, text should be in sentence case and without punctuation. For specific wording, see Allowed Terms.

DoDon't
Enabledenable.
Last updated on by Diana Thomson