Guide: Get Started with Inline Manual

Learn how to create great engaging and supportive user experiences.

What can you build with Inline Manual?

Use our authoring tool to create content to get users out of dead ends by helping them where they need it. Light up your inbound chat, support messages, and campaigns with engaging tours. You can do this all completely without the help of your IT or development teams.

You’ll be able to use our segmentation, automation, and analytics tools to target their new users and bring them on a journey to reach important onboarding goals. However, onboarding never ends, because you can also use the same tools to re-target users who may have missed key features. Make sure your customers are getting the most out of your software.

Your Inline Manual Toolbox

This guide will take you through creating some essential components you can use to build user onboarding experiences, feature tours, and contextual in-app help.

The first thing you need to understand is how Inline Manual works. We’ll look at these examples to see what you have in your toolbox.

A brief note about customization: The first thing you’re probably wondering is, ‘How much control will I have?’ Our customers tell us they are surprised with the level of control and customization they can reach. Everything from the look and feel to the timing and interactive responses can be changed to suit your needs. Most options are a click away, but you can use code. With custom CSS and Player Callbacks, your developers can integrate your applications seamlessly. With our Segmentation and Automation tools, you can also control who can see messages, for now, let’s focus on how to build these first.

We’re always happy to help you figure out how to tune Inline Manual to work best for you. With that in mind, we’re going to show you the essentials in this guide, and later we’ll look at customization.

The Widget

Use the Widget to offer in-context help to users, so they don’t have to leave your application to see advice.

widget illustrated

By default the Widget is enabled on your site. And as you add new content such as a walkthrough or tooltips, these will be listed in the widget. Articles will also be listed, and they load right in the widget.

You’ll notice the widget appears in the lower right-hand corner, it’s blue and it says “Inline Manual.” You can customize every last bit of the Widget to suit your needs. - Change the appearance Dock it on the lower left-hand corner, and make it pink. - Change the title to make it say Tutorials. - Re-order the list of topics and you can even hide topics, if you’re launching them another way. Such as through an email campaign, or using an Autolauncher for targeted users. - You can also hide the Widget entirely.

Articles

Use Articles to add in-context help or knowledge base articles.

article illustrated

Articles get listed in the widget by default and load right there in the widget.

Like any content you make with Inline Manual, you can use the WYSIWYG editor, add media and edit the HTML directly.

The best thing you can do is help your users find the most relevant content. Define Context paths so your chosen articles only appear in a particular section and make sure they pop to the top of your list.

Walkthroughs

Use Walkthroughs to guide users through tasks and tutorials.

article illustrated

By default, when you add a new Walkthrough it will be listed in your Widget. When a user clicks on it, it can redirect them to start on a particular page, or launch the tour right from wherever they are.

It’s most likely that Walkthroughs are what you’ll be creating with Inline Manual.

  • Want to create a welcome message?
    • That’s a one-step walkthrough.
  • Want to announce a new feature?
    • That’s welcome message linking to a step-by-step tour.
  • Want to create a tutorial your support team can hand to clients in chat?
    • That’s a walkthrough, hidden from the widget, and the support team uses a direct URL to launch the tutorial.

Tooltips

Use Tooltips to shed light on known trouble spots in your application.

tooltips illustrated

  • You can place Tooltips anywhere on your site. You can have these helpful question mark launchers always available or only in sections of your site.
  • You can also group Tooltip advice together, and have the launchers only appear when the Tooltip is Active.
  • Don’t like question marks? Customize your launchers. You can swap that out for any text you like, and use custom CSS to change how your launchers look.

Redirects

Use a Redirects to add any link to your Widget.

You may want to list a link in your Widget to a specific page without needing a walkthrough.

For example, you might like to provide a link to Report a bug or open a Support ticket on another site.

What's next?

  • Install the Authoring Tool and the Player.