Contents
Overview
After creating a Guide, the Settings page becomes the central hub for managing all aspects of your guides. Here, you can easily handle tasks such as naming, publishing, cloning, deleting, and previewing to ensure they are correctly configured. Additionally, you can navigate to manage the guide in-app, set activation rules for timely delivery, segment users for targeted communication, schedule guide deployment for maximum impact, and localize content to meet diverse user preferences. This comprehensive suite of tools empowers you to optimize guide management and drive effective adoption strategies.
Basics
Rename Guide: Easily update the guide's name by hovering over its current name. Below the guide name, you'll find details about the user who created it and the user who last updated it.
Clone Guide: Save time by cloning existing guides. Click the [...] icon and select "Clone Guide." You'll be redirected to a new guide in draft mode, where you can customize the name and content as needed.
Delete Guide: Deleting a guide isn't immediate. Clicking the delete button allows for reconsideration in case of accidental clicks. To finalize deletion, confirm by clicking "Delete guide" on the modal that appears.
Preview Guide: Check the user experience by previewing your guide. Select "Preview," input your page URL, and click "Launch Preview" to see a live preview from your users' perspective.
Guide Status: Set the guide as Public, Disabled, or Draft. If a guide is Public, it is visible and accessible to your end users. If the guide is Disabled, it isn't visible to the end user. There is no functional difference between Draft and Disabled; these categories are useful for Guide organization.
Activation
Overview
In the Activation section, you can control how and when your guide is triggered. This flexibility allows you to align guide presentation with user behavior. You can choose between automatic activation, where guides are shown to users based on predefined criteria, or manual activation, where users need to manually trigger the guides.
Note: A video tutorial is available below for a step-by-step walkthrough of these settings.
Accessing Activation Settings
You can select or amend activation settings in the visual design studio. Here are the steps to do it:
Visual Design Studio Method:
1. Hover over the guide preview.
2. Click "Manage in-app."
3. Enter the URL of the page where your guide should appear.
4. Launch the visual design studio.
5. Select "Activation" from the bar to open the activation settings box.
Activation Widget Method:
1. Go to the guide settings page.
2. Click "Edit" on the activation widget.
3. In the Edit Guide Activation Pop-Up, enter the URL where the guide should appear.
4. Click "Launch visual design studio."
Activation Options
There are three main options for activating your guides: automatic, badge, and target element. Each option serves a different purpose depending on your specific use case.
Automatic Activation:
Guides appear automatically when users land on a specific page. For example, when users first visit the Betterworks platform or click into a module, an automatic guide can provide a brief introduction and highlight key features.
- To enable, simply click the on toggle.
Badge Activation:
A Badge is a small, non-intrusive icon indicating the presence of a guide. Badges are useful for providing guidance without overwhelming the user experience, such as offering more information about a specific part of the platform or introducing new features.
- To enable and customize Badge Activation click on 'Badge' to enable Badge Activation. Target the element on your web page that you want the badge to be associated with.
- Customize the badge's appearance in the 'Badge Settings' section, including shape, color, size, and behavior.
Target Element Activation:
Associates a guide with a specific element on your page, such as a button.
Ideal for providing context-sensitive help or guiding users through complex processes.
- To enable Target Element Activation click on 'Target Element' to enable, select the specific element on your web page that you want to associate the guide with. You can customize the guide's behavior in the target element behavior settings, such as opening automatically when users click or hover over the targeted element.
Segments
Overview
The Segmentation section allows you to target specific user segments with your guides, ensuring personalized and relevant content delivery to different user groups. By using segmentation, you can enhance the user experience by tailoring guides to the needs of distinct user demographics.
Accessing Segmentation Settings
In the "Segmentation" section on the Guides Settings page, you can see how many users are eligible to view the guide based on the selected segmentation option. It’s important to note that the eligible user count may not always match the total user base, as it depends on guide location and user access.
Segment Rules
Segment rules utilize Product Usage data or Visitor metadata to dictate which users are targeted. This includes any metadata passed from the Partner (e.g. username, email, isX, role, etc.) or any of the following rules provided by Betterworks Guides:
Product Usage (Page, Feature, or Guide usage and/or Poll Responses)
Example rules:
- "Page ‘Dashboard’ Seen at least 10 times"
- "Feature 'Search Bar' Clicked within last 30 days"
- "Guide 'New User Tour' Seen"
- "Poll ‘Opt-in Guide’ response equal to Yes"
Visitor Level Metadata
- Visitor ID
- First Visit
- Last Visit
- Most Recent Browser Name
- Most Recent Operating System
- is_manager (can create a segment for only managers or only non-managers)
- is_admin (can create a segment for only admins or non-admins)
- Custom_01 through 05 (can create a segment for your custom Betterworks fields)
Note: When using a rule of a text type attribute, the entered text is case-sensitive.
Utilize the "Visitors List" at the bottom of the Analytics page to see what metadata fields are available for segmentation by managing your columns.
Predefined Segments
There are 5 predefined segments as well as the ability to create custom segments.
- Everyone
- Time Since First Visit: < 30 Days
- Time Since First Visit: 31 - 60 Days
- Time Since First Visit: 61 - 90 Days
- Time Since First Visit: > 30 Days
Creating a Custom Segment
1. Navigate to Segments and on the left-hand side menu, click on "Segments." Here, you can view and edit all existing segments.
2. To Create a New Segment click the "Create Segment" button. The most common use case is to limit a guide's visibility to Betterworks admin groups:
- "Is admin": Targets Betterworks Admins.
- "Is group admin": Targets Betterworks HR Admins.
- "Is super Admin": Targets Betterworks Super Admins.
3. Selecting any of these will create a custom segment containing users with the specified admin roles.
4. Give your segment a clear name and click “Create Segment.” Your new segment will appear in the list of existing segments.
Adding a Segment to Your Guide:
1. Navigate to the guide list and click on your guide and select "Edit" in the segment section.
2. Choose the custom segment you created and click “Save.”
By using segmentation, you can ensure that your guides are only shown to the most relevant users, enhancing their effectiveness and user engagement.
Troubleshooting Segments
To control who sees a guide, it’s important to understand how "AND" and "OR" work when creating segments.
Using "OR"
-
Visitor ID does not contain Apples OR Visitor ID does not contain Oranges
- This will show the guide to users who do not have both "Apples" and "Oranges" in their Visitor ID.
- It means that if a user’s ID has either "Apples" or "Oranges" (but not both), they will still see the guide.
Using "AND"
-
Visitor ID does not contain Apples AND Visitor ID does not contain Oranges
- This will show the guide only to users who do not have "Apples" and do not have "Oranges" in their Visitor ID.
- Users with either "Apples" or "Oranges" in their ID will be excluded from seeing the guide.
In summary, use "OR" if you want to include users who meet at least one condition, and use "AND" if you want to include only those who meet both conditions.
The following video guide explains Segments & Scheduling guides:
Scheduling
Overview
The Scheduling section in Betterworks Guides allows you to control when and how often your guides are displayed to users. This ensures that your guides are delivered at the most opportune times, maximizing their effectiveness and enhancing the overall user experience.
Delivery Frequency
The Delivery Frequency setting lets you determine how often your guides are shown to users. This is crucial for managing the user experience, as it prevents users from being overwhelmed by repetitive guides. You can choose from several options:
- One Time Only: The guide is shown only one time per user. It will appear once and remain visible until the user interacts with it, such as by dismissing or completing it.
- Custom Interval: Allows for more granular control, such as showing the guide a specific number of times or on specific days.
Start Date / Time
The Start Date / Time setting specifies when the guide should begin appearing to users. This allows you to plan ahead and schedule guides to coincide with product launches, feature releases, or other important events. By setting a precise start date and time, you can ensure that your guides are timely and relevant.
Expiration Date / Time
The Expiration Date / Time setting defines when the guide should stop being displayed to users. This is useful for time-sensitive content, such as promotional messages, seasonal features, or limited-time offers. Setting an expiration date ensures that outdated or irrelevant guides do not clutter the user experience.
By carefully configuring these scheduling settings, you can ensure that your guides are shown to the right users, at the right times, and with the appropriate frequency. This level of control helps to create a seamless and effective user experience, increasing the likelihood that your users will engage with and benefit from your guides.
Localization
Overview
Localization in Betterworks Guides allows you to tailor your guides and messages to users in different languages and regions. This ensures that users receive content in their preferred language, improving their overall experience.
Key Features
- Multi-language Support: Create guides in multiple languages to reach a diverse user base. Betterworks Guides automatically displays the appropriate version based on the user's language settings.
- User Segmentation: Target specific user segments based on their language preferences or geographic location. This helps deliver more relevant content to each user group.
-
Translation Management: Easily manage translations within Betterworks Guides or integrate with external translation services to ensure accurate and consistent messaging.
For more information and detailed instructions on how to add languages to your Guides, please check out our article: Betterworks Guides: Localization