Actionable Words
#
Add vs. CreateUse add
when you are asking a user to add something that already exists (in the world) into Hub.
Do | Don't |
---|---|
Add product | Create product |
Add supplier | Create supplier |
Add manufacturer | Create manufacturer |
Use create
when you are asking a user to bring something into existence that never existed before (in the world).
Do | Don't |
---|---|
Create purchase order | Add purchase order |
Create invoice | Add invoice |
Create future price | Add future price |
#
Delete vs. RemoveUse 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. ManageUse 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.
Do | Don't |
---|---|
Edit | Edit 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/OffUse 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/Off
to turn on or off a top level option. An app or feature is turned ON or OFF at the company level.
Do | Don't |
---|---|
Enable | enable |
Disable | disable |
On | on |
Off | off |
enabled | |
disabled |
#
Export vs. DownloadUse export
when users need to convert data into a different format to access it on their device outside of Hub.
Do | Don't |
---|---|
Export CSV file | Export 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.
Do | Don't |
---|---|
Download PDF | Download CSV file |
Download product labels |
#
Import vs. UploadUse import
when users need to convert data into a different format before they can access it in Hub.
Do | Don't |
---|---|
Import CSV file | Import PDF |
Import Excel file | Import Image |
Use upload
when users need to copy data in the same format to access it in Hub.
Do | Don't |
---|---|
Upload Image | Upload CSV file |
Upload PDF |
#
Save vs. DoneUse 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 headersSave 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.
Do | Don't |
---|---|
Save product | Save |
Save supplier | Apply changes |
Save future price |
#
Saving in modalsWhen 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 saveDeferred 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
.
Do | Don't |
---|---|
| Save |
#
Sign in/Sign out vs. Login/LogoutUse Sign in
to authenticate a user based on their credentials. Use Sign out
to remove that user's authentication.
Do | Don't |
---|---|
Sign in | Signin |
Sign out | Signout |
Log in | |
Log out | |
Login | |
Logout |
#
StatusesWhen 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 statusesIn the case of badges, text should be in sentence case and without punctuation. For specific wording, see Allowed Terms.
Do | Don't |
---|---|
Enabled | enable. |