Beacon + Docs
In this article
Control Access to Docs with Beacon
- Healthcare Portals: If you manage a healthcare platform, you might have a dedicated knowledge base with FAQs, appointment guides, or post-care instructions that only active patients should access. Using a hidden Docs site within Beacon ensures that only logged-in patients can view this sensitive information.
- Online Learning Platforms: Running an online course? Keep your support materials exclusive to enrolled students by linking Beacon to a private Docs site. This way, students can easily access lecture notes, troubleshooting guides, and FAQs—without exposing them to the public.
- University Student Portals: Universities can restrict access to course materials, financial aid application details, and administrative forms so that only enrolled students can see them. This setup ensures that academic and financial support content is available only to those who need it, streamlining the student experience.
Customize Content Suggestions with Beacon
E-Commerce Product Support
An online retailer can suggest helpful Docs content based on what a shopper is viewing, reducing friction in the buying process.
Example: A customer browsing a 4K Ultra HD Smart TV page might see links to:
- Setup guides to help with installation
- Troubleshooting tips for common connectivity issues
- Warranty details for easy access to coverage information
A SaaS company can provide targeted help articles based on the feature a user is working with, improving user adoption and reducing support requests.
Example: A user in the Analytics Dashboard might get suggested articles on:
- Customizing reports to fit their specific needs
- Interpreting data to make informed business decisions
- Setting up alerts to stay on top of key metrics
An online learning platform can serve up course-specific support content, helping students stay engaged and on track.
Example: A student viewing a module related to Advanced Calculus might find:
- Complex integrals explained step by step
- Sample problems with solutions to practice key concepts
- Study strategies to prepare effectively for exams
By customizing content suggestions in Beacon, you can surface the most relevant Docs articles exactly when and where users need them—improving their experience and reducing support requests.
Smarter Self-Service with AI Answers
Got a question? AI Answers has you covered—no searching, no waiting. Instead of reaching out to support, customers get instant answers to things like password resets, billing updates, or login issues. That means less back-and-forth and more time for your team to tackle the trickier stuff.
New to something? No problem! AI Answers displays the right Docs articles at the right time—think setup guides, feature walkthroughs, and account navigation tips—so customers can get up and running without the guesswork (or support emails!).
Support that never sleeps! AI Answers makes sure customers get instant help, anytime, anywhere. Whether it’s pricing details, subscription plans, or troubleshooting steps, customers can find what they need—even when your team is off the clock. Fewer emails, and a lot more efficiency.
Use Beacon’s API to Make Docs Even More Helpful
search
, suggest
, and article
methods, you can customize the assistance provided to users based on their specific interactions and needs.
‘Search’
The search
method enables you to programmatically perform a search within your Docs knowledge base and display the results directly within Beacon. This is particularly useful for providing immediate answers related to user actions.
Suppose a user encounters an error code "E404" within your application. You can automatically trigger a search for this error code, presenting relevant articles to assist the user without requiring manual input.
‘Suggest’
The suggest
method allows you to display a curated list of articles within the Beacon, tailored to the user's current context or behavior. This proactive support can significantly enhance user satisfaction by anticipating their needs.
Imagine a user is navigating the billing section of your platform. You can use the suggest
method to present articles related to billing inquiries.
The article
method enables you to open a specific Docs article within the Beacon, providing users with direct access to detailed information without navigating away from the current page.
If a user is on a page discussing a particular feature, you can offer a "Learn More" link that opens a related article directly within the Beacon. You can even display specific Docs content in various formats:
Inline: Ideal for tooltips or brief explanations.
Sidebar: Perfect for in-depth tutorials alongside primary content
Modal: Suitable for important information requiring full attention.
Other Resources
If you would like to get started setting up a Docs site or adding a Beacon to your website, here’s a few other resources to help you get started.