[Ai] Create a tutorial

This section is a walkthrough of how to author your tutorial in the Tutorial Builder in Illustrator.

1. Plan for limitations

Tutorial Builder is still in development and there are some Illustrator features that are not currently supported in the builder. It is best to choose assets and workflows that don’t require these features. 

3. Set up the tutorial

To set up your tutorial, enter a title and and upload the Starter file.

Enter the tutorial title

• Enter a title in the Title your tutorial field which describes what you’ll cover. Use search terms that will help end users find your tutorial. Go to Writing Guidelines for more details on creating a title. 
•  The title you enter becomes both the user-facing title and the document identifier that’s important for searches. 
  • You can’t return to this screen or change the document identifier after entering your title. 
  • You can change the user-facing title in the next screen.

• Click Create to go to the next screen.

4. Create Sections, Steps, and Notes

Create sections, steps, and notes to build out the tutorial. The maximum number of Sections in a tutorial is 10. Try to keep the maximum number of Steps in a Section to 3 (three) and the maximum number of Notes to 2 (two).

Currently, there are only two Step types, Menu Bar and Tool Bar where Authors use a record button to create coach marks in the Tutorial Builder. For Canvas and Panel coach marks, Authors will need to use the drop down menus and add text. 

There is a Play icon, which allows authors to preview their Steps. The Play icon appears with each Step type, but may not be actionable. If the Play icon is not actionable it is dimmed.

Create a Section

• Click the blue +Add button
• Toggle Asset on (so that it turns blue) if you are adding a static image or animation to illustrate the section. 
  • Static images must be a JPG or JPEG file under 600KB. 
  • Animations must be MP4 files under 4MB.
  • Dimensions for both must be 560 by 280 pixels. 
• Enter a section Title on the following screen
  • Describe what this section covers. 
  • The best section titles start with an action verb summarizing what a user can accomplish. 
• Enter a section Description 
  • Explain what the user will learn. 
    
  • This is optional and used to offer context. See Guidelines for writing descriptions.
• Click Done this completes the section information
• Click Save
• You can edit by clicking the Edit button
• Select the  three-dot menu . . .  buttons to Delete or Move Up and Down

Create a Step 

• Click the blue +Add button
• Pick a Placement from the drop down menu
• Canvas
  • No recording option available with Canvas
  • Add information to the Text box describing what the user should do
  • Click Done this completes the section information
  • Click Save
  • You can edit by clicking the Edit button
  • You also click the three-dot menu . . .  buttons to Delete or Move Up and Down

• Menu Bar
  • You can record most Menu Bar options as Steps. 
  •  Click the Record button and use the cursor to demonstrate to the end user what they should do to complete the step
    • Click Stop Recording when finished with the step
    • To change what was recorded, remove it and click Record again
  • The step you completed will be automatically added to the Text box describing what the end user should do
  • Click Done  to complete the step information
  • Click the play icon to preview the step and see what the end user will see
  • Click Save
  • You can edit by clicking the Edit button
  • You can click the three-dot menu . . .  button to Delete or Move Up and Down

• Panel
  • Choose Properties from the drop down Panel name menu.  
  • Add information to the Text box describing what the user should do
  • Click Done this completes the section information
  • Click Save
  • You can edit by clicking the Edit button
  • You also click the three-dot menu . . .  buttons to Delete or Move the Step Up and Down

• Tool Bar
  • Click the Record button and use the cursor to demonstrate to the user what they should do to complete the step
    • Click Stop Recording when finished with the step
    • To change what was recorded, remove it and click Record again
  • The step you completed will be automatically added to the Text box describing what the user should do
  • Click Done  to complete the step information
  • Click the Play icon to preview the step and see what the user will see
  • Click Save
  • You can edit by clicking the Edit button
  • You can click the three-dot menu . . .  button to Delete or Move Up and Down

Create a Note

• Click the blue +Add button
• Add information to the Text box that explains why a Step is useful
• Click Done this completes the section information
• Click Save
• You can edit by clicking the Edit button
• You can click the three-dot menu . . .  buttons to Delete or Move Up and Down

5. Previewing as You Go

Preview Steps

• You can preview individual Steps you have created as you build your tutorial. 
• Look for the Play icon after you have created a Step and clicked Done. 
• Review the Step by clicking the Play icon
• If the Step was correctly created, click Save at the top right hand corner of the tutorial. 

Preview what you’ve created so far

• Click the Save button at the top of the Tutorial Builder
• Click the Preview button
• Click Start Tutorial to start the tutorial from its beginning
• Follow the instructions to walk through the tutorial from the user’s point of view. 
• Note: If you want to make changes to your tutorial, you will need to exit Preview mode. To exit the tutorial preview, click End.

• Upload your Thumbnail image
  • This square image appears next to your tutorial title in search results. It should show the final output, or “after” state, of your tutorial. 
  • Must be a PNG, JPG, or JPEG file, 740 by 740 pixels, and under 200KB. 
• Upload your Hero image 
  • This banner image appears when users click your tutorial to learn more about it before they begin. It should show either the “before” and “after” states, or just the “after” state of your tutorial. 
  • Must be PNG, JPG, or JPEG file, 1200 x 600 pixels, and under 600KB.
• Click Save

7. Final preview

When you’re finished creating a tutorial, make sure you preview how it will look for users from start to finish. 

• Click the Save button at the top of the TB
• Click the Preview button
• Click Start Tutorial to start the tutorial from its beginning
• Follow the instructions to walk through the tutorial from the user’s point of view. 
• If you want to make changes to your tutorial, you will need to exit Preview mode. To exit the tutorial preview, click End. 

8. Complete and submit your tutorial

• Click Save at the top of the Tutorial Builder. Feel free to click Preview again to give your tutorial a final once over.
• If you want to make any changes to your tutorial, click Create at the top of the screen to return to sections and steps in the Tutorial Builder.
• Click the Submit button at the bottom of the Finish screen when you’re sure the tutorial is complete. 
  • This moves it out of the In progress queue in your Dashboard, so you won’t be able to access it again until you receive a review notification.

9. Tutorial review

Step 1: Notification

• After you submit your tutorial, a curator will review it, and you’ll receive an email notification from the system that your tutorial is approved or that further action is required.
  • Don’t feel bad if you get an Action Required notification from the system. It just means that some changes are needed. 

Step 2: Editing

• If you get an Action Required notification, go to your Topics for [author] Paper document. 
  • The requested changes will be listed in the Review Feedback section
  • Contact your Community Manager if you have questions or comments about changes.
• Make the requested changes in the Tutorial Builder.
  • In the Tutorial Builder Dashboard click the three-dot menu . . . on the tutorial and choose Edit
  • Make the requested changes.
  • Click Submit

Step 3: Completion

• After you make changes, you’ll receive another notification from the system approving or rejecting the tutorial.
  • If the tutorial is rejected at this stage, please repeat review Step 2: Editing.
  • Once your tutorial is approved, your work is complete. Thank you!

Cool Tips and Tricks

Easily add a Step or Note: 

• Once you have created your first Section and Step you can add additional steps and notes by hovering between a Section/Step or Step/Note and clicking the Plus icon. 
• Choose which element you want to add.