Use Tutorial Builder to create interactive, task-oriented demos, with tips prompting users to perform specific actions on your live intranet.
What is Tutorial Builder?
Tutorial Builder is a hands-on guided tour of specific intranet functionality. Rather than just showing users something, you're making them an active participant in their learning.
The goal is to provide a framework that reduces the amount of written or video documentation provided to users when deploying new intranet functionality, by guiding them through the process directly within the site.
Take part in a Tutorial to see it in action before building one. In the Admin section on the Tutorials tab, scroll down to Existing Tutorials, and click a magnifying glass to experience a tutorial as a user would.
Build a Tutorial
Define your purpose and map out the required intranet tutorial steps before you begin to build. This will be very helpful when you're recording your Tutorial.
You'll also need to decide on a descriptive name for your Tutorial, and whether you want to record your Tutorial as a different user. Recording as a different user may be helpful if you want participants to see content as a regular user, rather than the options available to you as a site Admin. If you want to impersonate a user, select their name from the drop down menu.
Recording a Tutorial
The process for recording your Tutorial is:
- On the Tutorials tab under Tutorial Builder, type a Name for your Tutorial, impersonate a user if desired, and click Build.
- You're immediately taken to your intranet home page and a Help box appears. Close the Help box. Note the small box which shows at the top of your screen. This box will remain in place during your Tutorial build, and has elements as follows:
- Record/Stop Recording (1) - Controls whether you're currently recording tips or navigation. Each page must have at least one tool tip so this will default to recording when you land on a page. When you're finished with this page, click Stop Recording to navigate to the next page.
- Tips (2) - A counter showing how many tips you've placed on the current page.
- Page (3) - A counter showing the number of pages in your current recording session.
- Buttons (4) - Get help with Tutorial Builder, save the current Tutorial, or cancel the recording session.
- Navigate to the page where you want to begin your Tutorial.
- Click Begin Recording in the small box at the top of the screen.
- Click on an element on the page where you want the Tutorial to begin. A tip box appears for you to type the text users will see. Type concise but informative information to guide users (maximum of 500 characters per tip). You can move, delete the tip or save it.
- If you want more tips on the same page, click Record More Tips in the top bar. Once you have more than one tip on a page, you can navigate back and forth using the arrow keys in the tip box.
- Keep in mind that your actions aren't being recorded in real time, so take as much time as you want to build the Tutorial.
- If you're done with the tips for this page, click Stop Recording Tips in the top bar, which will allow you to navigate to the next step in your Tutorial.
- Click on the same link that you described in the last tip.
- As soon as you land on the next page, you'll by default be recording again. Click an element on the page to add a tip.
- Repeat the above process until you've completed all of your Tutorial steps.
- Click the blue Save icon in the top bar to end your tutorial. Note that you can edit your Tutorial later to add more content or alter the existing content.
Best Practices for Tutorial Tips
Tips will work best when you use these guidelines:
- Features of the site such as form fields, buttons, menu items, links, widgets, and other distinct interface elements are good candidates for targeting with a tip.
- Avoid associating a tip with dynamic content, as it may not be there for your user when they view the tutorial (e.g. a specific wall comment, title of specific advertised item in widget feed). Instead, try placing the tip on the area or widget itself.
- When you want your users to either perform an action on the page or navigate somewhere, be clear about what you’re asking of them. Use language like Click on X link.
- If adding a link to another page in the intranet, first set up the initial tip, stop recording, click the link to navigate, then add a note on the next page (otherwise the tutorial editor doesn't recognize that the desired action is to have users click to another page).
- Note that Tutorials with tips that can’t be placed correctly will have the tutorial tip errors icon shown next to their name on the Tutorials tab. Use the edit mode to go in and correct the positioning of these tips.
All Tutorials are listed on the tab in the section Existing Tutorials.
The icons listed beside the Tutorial name allow you to perform functions such as participating in the Tutorial as a user, generating a direct link to the Tutorial, or identifying issues with the Tutorial.
Edit a Tutorial
If you want to change an existing Tutorial name, click on the name, type the new name, and click the blue Save icon.
To edit the content of an existing Tutorial, click the edit pencil beside the Tutorial name. A Help box will appear, advising that your Tutorial is being edited. Click the red X on the box to clear it from your screen and start the editing process.
Just as when you were building your Tutorial, as you continue editing a small box will remain at the top of your screen which allows you to record more tips, show Help, Save, etc.
Each step of your Tutorial will appear as a small window. In this window you can:
- edit the instructional text that appears with each step (1)
- advance to the next tip or go to the previous tip (2)
- adjust the placement of the tip as it appears in the Tutorial (3) - click the move icon, then the element where you want to locate the tip
- delete the tip (4)
- Save the changes made to the tip (note that you also need to save the Tutorial at the top of your screen before closing or your changes will be lost)