Introduction
After clicking a quick start card, a side panel slides in that introduces the quick start and lists the tasks within it.
-
Make your introduction content clear, concise, informative, and friendly.
-
State the outcome of the quick start. A user should understand the purpose of the quick start before they begin.
-
Give action to the user, not the quick start.
-
Correct example:
In this quick start, you will deploy a sample application to {product-title}. -
Incorrect example:
This quick start shows you how to deploy a sample application to {product-title}.
-
-
The introduction should be a maximum of four to five sentences, depending on the complexity of the feature. A long introduction can overwhelm the user.
-
List the quick start tasks after the introduction content, and start each task with a verb. Do not specify the number of tasks because the copy would need to be updated every time a task is added or removed.
-
Correct example:
Tasks to complete: Create a serverless application; Connect an event source; Force a new revision
-
Incorrect example:
You will complete these 3 tasks: Creating a serverless application; Connecting an event source; Forcing a new revision
-