You can use a TourEmbed to place an interactive product tour inside your published documentation. This helps readers learn by following a guided experience directly from your public docs.
Overview
A TourEmbed connects a product tour to documentation that your audience can access through your public documentation site. Use it when written instructions alone are not enough—for example, when readers need to see a workflow, understand where controls appear, or follow a sequence of actions in your product.
You typically add or update tours while preparing documentation for publication. Start from your project’s documentation area, confirm that the content is intended for a public audience, and then review the published result before sharing it with readers.
Public documentation is separate from your internal editing workspace. The View Published Docs option lets you check the reader-facing version, while publishing and version-management options help you make sure the correct documentation release is available.
📷 Screenshot pending: TourEmbed configuration area for adding a product tour to a documentation page
Prerequisites
Before you begin, make sure you have the following:
- Access to the project that contains the documentation you want to publish.
- A product tour that is ready to be embedded.
- A documentation page or guide where the tour should appear.
- Permission to manage documentation publishing settings.
- A version that is ready to be marked Published.
- Access to the public documentation preview through View Published Docs.
- Any required branding decisions completed before you share the page publicly.
Step-by-Step Instructions
-
Open your project’s documentation workspace.
-
Select User Docs to work with customer-facing documentation.
-
Select 📋 User Manuals if you need to locate or organize the manual that will contain the tour.
-
Open the documentation page where you want readers to see the product tour.
-
Add a TourEmbed to the page content.
-
Select the product tour that matches the workflow described by the page.
-
Position the TourEmbed near the instructions or explanation that introduces the workflow.
-
Save your documentation changes.
-
Select Publishing to review the publishing options for the documentation.
-
Confirm that the documentation is configured for a Public audience.
-
Select Published when the documentation version is ready for readers.
-
Select View Published Docs to open the public version of your documentation.
-
Navigate to the page that contains the TourEmbed.
-
Open the embedded product tour as a reader would.
-
Complete or advance through the tour to confirm that it appears in the correct location and supports the page instructions.
-
Return to the documentation workspace if you need to adjust the page content or the selected tour.
-
Select Manage all versions → if you need to verify that the correct documentation version is the one available publicly.
📷 Screenshot pending: Public documentation page showing an embedded product tour in the reader-facing view
Tips and Best Practices
-
Embed one tour for one clear learning goal. For example, use a tour that teaches a specific task rather than trying to cover an entire product area in a single embed.
-
Place the TourEmbed after a short explanation of what readers will learn. Readers should understand why they should start the tour before they interact with it.
-
Keep the surrounding written instructions useful on their own. Some readers may prefer to read the steps first, while others may use the tour as a guided walkthrough.
-
Review the public version, not only the editing view. Select View Published Docs after publishing so you can verify the reader experience.
-
Use the same terminology in the documentation page and the tour. If the page tells readers to select a feature or menu item, the tour should guide them using the same name.
-
Check the documentation version before sharing a public link. If you maintain multiple versions, use Manage all versions → or 🕘 Go to Version Manager to confirm that the version containing your TourEmbed is the version readers can access.
-
Consider your documentation navigation. Readers may enter through User Guides, Publishing, or search rather than through the page you expect. Make the page title and introductory text clear enough for readers who arrive directly at the embedded tour.
-
Manage images and visual references separately from product tours. Select Manage Screenshots → when you need to update screenshots that support the same instructions.
Related Pages
- Publish Documentation
- Manage Documentation Versions
- Configure Public Documentation Branding
- Manage Screenshots
- View Published Documentation
- Create User Guides
Troubleshooting
The tour does not appear in public documentation
Confirm that you saved the documentation page after adding the TourEmbed. Then select View Published Docs and open the exact page that you updated. If the page is not publicly available, check that the documentation version is marked Published and configured as Public.
Readers see an older version of the page
Open Manage all versions → or 🕘 Go to Version Manager and verify which documentation version is currently published. Make sure the version containing the TourEmbed is the published version, then review the page again through View Published Docs.
The embedded tour does not match the written instructions
Return to the documentation page and review the selected TourEmbed. Choose a tour that follows the same workflow described in the page, then save your changes and test the public page again. Keep button names, feature names, and task order consistent between the written content and the tour.
Was this page helpful?