Descriptions
Descriptions use a single sentence to clarify or explain complex information or tasks to the user. This pattern is frequently found in form fields and help-related components.
General
Include a description only when additional information is actually necessary.
| Do ✅ | Don't ❌ |
|---|---|
|
|
Keep it as short as possible while still being descriptive enough.
| Do ✅ | Don't ❌ |
|---|---|
| Volume of sessions in the intermediate stages of the purchase flow | This chart allows you to track the volume of sessions in the intermediate stages of the purchase flow and view opportunities for optimizing the conversion rate |
Use sentence case, but capitalize proper nouns.
| Do ✅ | Don't ❌ |
|---|---|
|
|
Avoid punctuation such as commas, and don't use periods or question marks.
| Do ✅ | Don't ❌ |
|---|---|
| Day in which the changes made will be published considering the time zone where the store is located | Considering the time zone where the store is located, the day in which the changes made will be published. |
Don't include redundant words.
| Do ✅ | Don't ❌ |
|---|---|
|
|
Don't use a marketing tone of voice or explain benefits.
| Do ✅ | Don't ❌ |
|---|---|
| Volume of sessions in the intermediate stages of the purchase flow | Track the volume of sessions in the intermediate stages of the purchase flow to optimize your conversion rate |
Specific
When explaining a label, write as if completing the sentence "This is the…". Start with a noun followed by additional information, such as conditions and definitions.
| Do ✅ | Don't ❌ |
|---|---|
|
|
When explaining how information given in a form field will be used, write as if completing the sentence "When you enter a value in this field, it…" and start with a verb in the simple present tense.
| Do ✅ | Don't ❌ |
|---|---|
|
|
When explaining both the label of a form field and how its value will be used, combine the two sentences described in the previous topics and adapt them if necessary.
| Do ✅ | Don't ❌ |
|---|---|
|
|