Overview
This document aims to capture the language conventions we are using in the product. It is a continous work in progress. Please reach out in the #design-system channel if you additions to include to this list.
Terms
General
Default to sentence-casing in the UI to help readability, with the exception of the following cases:
- Iterable resources
- User fields
- Event fields
- Metrics
- Webhook names
Actions
WIP: When to use create vs new vs add
|
Term |
Do's and Don'ts |
|
New - the action of initiating the creation flow process. |
|
|
Create - the action of finalizing the creation flow process. |
|
|
Add - the action of adding something to Iterable that already exists. (Data Feeds, Org member, Third-Party Integration, etc.) |
|
|
Configure - the action of modifying Settings or Third-Party Integrations. |
|
|
Edit - the action of modifying Iterable resources (Campaigns, Workflows, Templates, etc.) |
|
|
Export - the action of taking a file of data out of Iterable. |
🚫 Download |
|
Import - the action of putting a file of data into Iterable. |
🚫 Upload |
|
Archive - the action of a removing an Iterable resource from the index view, but does not permanently delete. (Applies to Workflows and Campaigns.) |
|
|
Delete - the action of removing an Iterable resource from the index view, while permanently deleting. (Applies to Templates, Experiments, Reports, Lists, and User Profiles.) |
|
|
Filter - |
|
|
Search - |
✅ Search all campaigns 🚫 Filter by ID or name |
|
Select - the action of making a selection between multiple things. |
🚫 Choose, Pick |
|
View - the action of looking at something that is not currently visible. |
✅ View all templates 🚫 See all templates |
Metadata
|
Term |
Do's and Don'ts |
|
Created - the action of having created a resource.
Created date defaults to relative date format, as it's secondary to Modified date. |
✅ Created by, Creator |
|
Modified - the action of having contributed to a resource.
Modified date should default to absolute date format, unless it is within "today"/"yesterday", so that it can be sorted on as the primary date/time metadata. |
✅ Modified by, Modifier, Last modified by 🚫 Updated, Updated by |
|
DD/MM/YYYY - the absolute date format |
✅ 09/22/2020 🚫 A month ago |
|
Tomorrow - tbd |
|
|
Today - if a resource has been modified/created within the last 24 hours. This will the be the primary display for the day part of the date, followed by the time, with the absolute date format visible on hover. |
✅ Today, 2:41 PM |
|
Yesterday - if a resource has been modified/created between 24 and 48 hours ago. This will the be the primary display for the day part of the date, followed by the time, with the absolute date format visible on hover. |
✅ Yesterday, 2:41 PM |
People
|
Term |
Do's and Don'ts |
|
Members - our customers and users of Iterable (e.g. Members of a project/organization) |
🚫 Users |
|
Contacts - our customers’ customers. |
🚫 Users |
|
^ Will be really expensive to update our API and SDKs, plus marketing needs to sign off on this one. |
|
|
Audience - contacts which will receive a Campaign send. |
|
Things
|
Term |
Do's and Don'ts |
|
Resources - parts of the Iterable app (Campaigns, Workflows, Templates, Snippets, etc.) |
|
|
Templates - the reusable copy/design/layout of a message that's been intentionally saved as a Template. |
🚫 Base templates, Campaign templates, Workflow templates |
|
Content - the copy/design/layout of a message, that has not been made into a template. |
✅ Campaign content, Workflow content, Message content 🚫 Base templates, Campaign templates, Workflow templates |
Campaign Types
|
Term |
Do's and Don'ts |
|
|
|
Campaign States
|
Term |
Do's and Don'ts |
|
Draft |
|
|
Scheduled |
|
|
Ready |
|
|
Running |
|
|
Completed |
🚫 Finished |
|
Recurring |
|
Workflow States
|
Term |
Do's and Don'ts |
|
Enabled |
🚫 On |
|
Disabled |
🚫 Off |
Misc (needs to be categorized)
|
Term |
Do's and Don'ts |
|
Delivery |
|