Chapter 6. About quick start tutorials
If you are creating quick start tutorials for the OpenShift Dedicated web console, follow these guidelines to maintain a consistent user experience across all quick starts.
6.1. Understanding quick starts
A quick start is a guided tutorial with user tasks. In the web console, you can access quick starts under the Help menu. They are especially useful for getting oriented with an application, Operator, or other product offering.
A quick start primarily consists of tasks and steps. Each task has multiple steps, and each quick start has multiple tasks. For example:
Task 1
- Step 1
- Step 2
- Step 3
Task 2
- Step 1
- Step 2
- Step 3
Task 3
- Step 1
- Step 2
- Step 3
6.2. Quick start user workflow
When you interact with an existing quick start tutorial, this is the expected workflow experience:
- In the Administrator or Developer perspective, click the Help icon and select Quick Starts.
- Click a quick start card.
- In the panel that appears, click Start.
- Complete the on-screen instructions, then click Next.
In the Check your work module that appears, answer the question to confirm that you successfully completed the task.
- If you select Yes, click Next to continue to the next task.
- If you select No, repeat the task instructions and check your work again.
- Repeat steps 1 through 6 above to complete the remaining tasks in the quick start.
- After completing the final task, click Close to close the quick start.
6.3. Quick start components
A quick start consists of the following sections:
- Card: The catalog tile that provides the basic information of the quick start, including title, description, time commitment, and completion status
- Introduction: A brief overview of the goal and tasks of the quick start
- Task headings: Hyper-linked titles for each task in the quick start
- Check your work module: A module for a user to confirm that they completed a task successfully before advancing to the next task in the quick start
- Hints: An animation to help users identify specific areas of the product
Buttons
- Next and back buttons: Buttons for navigating the steps and modules within each task of a quick start
- Final screen buttons: Buttons for closing the quick start, going back to previous tasks within the quick start, and viewing all quick starts
The main content area of a quick start includes the following sections:
- Card copy
- Introduction
- Task steps
- Modals and in-app messaging
- Check your work module
