Tutorials

1. Prepare

• Ensure you have the correct permissions to use TBW. You will be assigned to specific products. 
• Plan your tutorial content and assets.
  
• Create your assets: 
  • Starter file
  • Hero image
  • Thumbnail image
  • Intro video (optional)
  • Section and step assets
    
  • Completion asset (optional)

Review Asset guidelines on the required formats and dimensions of your various assets.

2. Create, edit, or delete

Edit a previously created tutorial

• Open the More menu (three dots) on the right side of the specific tutorial and choose what action you want to take.
  
  • Click Review and edit
  • Your template tutorial opens in edit mode. 
  • Continue editing your tutorial until it is ready for submission.

Delete a previously created tutorial

• Open the More menu (three dots) on the right side of a tutorial and choose what action you want to take.
  
• Click Delete
  • Note: There is no confirmation button, once you click delete the tutorial is immediately deleted.

CREATE A NEW TUTORIAL

• Select the app
• Click Create new

• Enter the tutorial title
  • Since you selected the product before creating a new tutorial, the app and format are now locked.
    
  • The title you enter becomes the user-facing title (a.k.a. DOC ID) and the document identifier (a.k.a. AEM ID).
    • Note: New titles cannot be an exact match to an existing AEM ID. If it is a duplicate title, an error message will appear.
  • Review Writing guidelines on tutorial titles if needed.

• Click Start authoring

3. Starter file section

The starter file is the original asset users see when they start a tutorial. Uploading the starter file is required to preview your tutorial in-app. View Asset guidelines for more details.

When your Starter file contains text

• If your starter file contains text click "Yes."
• This lets the Learn Global Operations team know that the asset needs to be translated into other languages. 

Image credits

• Click the check box to include your name for author credit.
• List the names of everyone who worked on the Starter file and its assets, including Adobe Stock contributors. Be sure to separate names with commas.

Remove starter file

• Delete the asset by clicking the trash icon. 
• Upload a new starter asset to continue creating your tutorial.

Save section changes

• Be sure to save your changes by clicking the Save section changes button.
• The Save section changes button is only enabled once all required fields have been filled. 

4. Intro section

Click on the intro section to open it. The title will pre-fill from the start screen information.

Tutorial title and description

• Edit your tutorial title (optional)
  • If you want to change the title you entered earlier, do so here. Making changes to your title will alter the DOC ID
• Enter the tutorial description
  • Briefly explain the topics covered and what the user will learn.
  • Let your unique voice come through here. 
• Check out tips on how to write a tutorial title and description in the Writing guidelines.

Upload intro assets

• Upload your intro assets by dragging or dropping the image into the correct field. You can select a file from your computer as well.
  
• Add your hero and thumbnail images.
• You can add a tutorial intro video by pasting an MPC link in the video field.
• Once you have uploaded your assets click the Save section changes button which is now available. 

Follow the Asset guidelines or you'll receive an error message. 

5. Sections, steps & notes

Aim for no more than four sections, though you can add up to ten. Each section should have no more than five steps, with three being preferable. Add no more than two notes per section step.

For an overview check out Sections and steps.

Section 1

• Enter a section title
  • The section title starts with an action verb. It summarizes what users will accomplish by following the steps in this section. 
  • See Writing guidelines for more information.
• Enter a section description
  • Enter additional information to convey what the user will learn in this section. 
  • See Writing guidelines for more details.

UPLOAD SECTION 1 ASSET

• Upload your asset by dragging or dropping the image into the correct field. You can select a file from your computer as well.
• You can add a video by pasting an MPC link in the video field.
• You cannot have both images and video as section assets.
• Once you have uploaded your assets click the Save section changes button which is now available. 

Follow the Asset guidelines or you'll receive an error message.

Add sections

• Hover between sections to enable the + Section button to add another section
• You cannot add a section between the Intro and Section 1. 

UPLOAD SECTION ASSETS

• Upload your asset by dragging or dropping the image into the correct field. You can select a file from your computer as well.
• You can add a video by pasting an MPC link in the video field.
• You cannot have both an image and video as a section asset.
• Once you have uploaded your assets click the Save section changes button which is now available. 

Follow the Asset guidelines or you'll receive an error message.

Delete or replace section assets

You can delete or replace section assets. 

• Delete: Open the More menu (three dots) on the right side of the field and choose what action you want to take.
  
• Replace: Open the More menu (three dots) on the right side of the field and choose what action you want to take.

Add section steps and notes

For each section, provide users with steps to follow throughout the tutorial. Each step should describe user actions and the corresponding tools or features used.

To search for a tool, menu, or panel item, type the '@' symbol. Once selected, the UI name will be formatted differently.

If you can't find the feature you want, type its name without the '@' symbol.

Click Add step or note and pick Step.

• Describe what the user should do for this particular step using "@" to point to specific tools and features. 
• When you add a tool or feature to a section step, it will show in the preview panel on the right hand side.

Click Add step or note and pick Note.

• Notes are used for additional context or quick explanations about a step.

Upload section step assets

• Drag or drop the image into the asset field. You can select a file from your computer as well.
• You can add a video by pasting an MPC link in the video field.
• You cannot have both image and video assets for a section step.

Coachmarks

When you add a tool or feature using the "@" feature in your section step, this shows up as a coachmark in the tutorial itself. 

Save section changes

• Be sure to save your changes by clicking the Save section changes button.
• The Save section changes button is only enabled once all required fields have been filled. 

6. Finish tutorial

TUTORIAL COMPLETION MESSAGE

Enter your completion message, which appears when users finish the tutorial. Create a message that encourages further creativity and summarizes what the user accomplished.

Upload your completion asset if you are using one.

• Drag or drop the image into the asset field. You can select a file from your computer as well.
• You can add a video by pasting an MPC link in the video field.
• You cannot have both image and video assets as a completion asset. 

Choose tutorial tags

• Add tutorial tags to each category to enhance the search experience for users, aiding them in finding the most relevant tutorial.
•  Use the “@“ symbol to search and select the tags for each category. 
• You can always click the "x" next to the tag to delete it.
• To understand what tagging is and how to choose which category tags to add to your tutorials go to Tagging guidelines.

7. Preview your tutorial

Preview in TBW

You have a preview panel as you create the intro, sections and steps, and the completion message. This panel mimics users' experience and is a visual preview for you as you build your tutorial.

Preview in-app

Even though you have a preview panel as you create sections and steps, be sure to Preview in app and go through the entire tutorial before submitting.

• Make sure you have clicked Save section changes for each section
• Click the Preview in app button
• Confirm you want to preview your tutorial in-app
• You will not be able to preview the introduction section in-app. 
• The tutorial opens up in-app for you to preview what you created.
• Ensure you click through everything to understand the user's experience.

8. Submit your tutorial

After completing your tutorial and previewing it in-app, it's time to submit. 

• Click the Send to Curator button at the bottom of the screen.
• A pop-up window will appear asking if you intend to send it to a Curator for review. 
• You will not be able to make further edits until you receive feedback from the Curator. 
• If you intend to submit, click Send to Curator

Success

• A confirmation dialog will appear to confirm that your tutorial has been successfully sent to the Curator.
• From this screen, you can cancel to stay on the page or Return to home (your dashboard).

Incomplete fields

• If you have incomplete fields, a dialog box will appear listing the fields that require information before you can submit the tutorial.
• Click OK and edit the tutorial to include all of the required information.

9. Tutorial curation and QE

Notification

• After you submit your tutorial, a curator will review it. 
• You’ll receive an email notification that your tutorial is approved or that further action is required.

Editing

• If you get an Action Required notification, review your Needs Author edits area on your TBW dashboard.
• Make the requested changes
  • Locate the tutorial that needs edits.
  • Open the More menu (three dots) and choose Review and edit
  • Make the requested changes.
  • Click Submit.

Finished

• After you make changes, you’ll receive another notification that your tutorial is approved or needs further action.
  • If the tutorial needs further edits at this stage, please continue editing.
  • Once your tutorial is approved, your work is complete. Thank you!