Installing an AI Chatbot for DITA WebHelp Using Oxygen Feedback Cloud
This article explains how to add an AI chatbot to a DITA-based WebHelp Responsive output by using Oxygen Feedback Cloud and its AI Assistant integration.
If you publish documentation from DITA XML to WebHelp Responsive, you can enhance the user experience by embedding an AI chatbot directly in the output. With Oxygen Feedback Cloud, this chatbot is provided through the AI Assistant component, allowing readers to ask questions in natural language and receive contextual answers based on your published documentation.
This approach is useful when you want to make large DITA documentation sets easier to explore, especially for users who prefer conversational assistance instead of navigating the table of contents or manually refining search queries.
What the AI Assistant Provides
According to the Oxygen Feedback Cloud AI Search Features documentation, the AI functionality available for WebHelp includes:
- An AI Assistant chatbot that can be integrated into your WebHelp output.
- Real-time conversations that help users find more accurate answers and relevant information.
- An AI-enhanced Search Summary component that can display AI-generated answers before the standard search results.
In this article, the focus is on the chatbot integration scenario.
Architecture Overview
The integration combines three main parts:
- Your source content authored in DITA XML.
- A WebHelp Responsive output generated from that DITA content.
- An Oxygen Feedback Cloud deployment configured to provide the AI Assistant for the published output.
At a high level, you publish your DITA map to WebHelp, configure search indexing and Feedback integration, then enable the AI Assistant in the Feedback administration interface so that the chatbot becomes available in the published site.
Prerequisites
- A DITA project that publishes to WebHelp Responsive.
- Access to an Oxygen Feedback Cloud instance.
- A WebHelp output already integrated with Feedback.
- Administrative rights to configure Feedback search and AI-related settings.
If your output is not yet connected to Feedback, start with the general Feedback installation and integration steps from the Oxygen Feedback Cloud User Guide.
Installation Steps
-
Prepare and publish your DITA XML content to WebHelp Responsive.
Make sure the published output is stable and that the topics you want the chatbot to answer from are included in the generated site.
-
Integrate the WebHelp output with Oxygen Feedback Cloud.
This usually means configuring the Feedback deployment token and embedding the Feedback initialization script in the generated output or publishing template.
-
Enable search indexing for the published documentation.
The AI Assistant relies on the indexed documentation content to provide contextual answers, so your WebHelp site needs to be properly indexed in Feedback.
-
Open the Feedback administration interface and enable the AI Assistant feature for the site.
The exact options may vary depending on your Feedback configuration, but the goal is to activate the chatbot component for the documentation deployment you want to enhance.
-
Republish or refresh the WebHelp output if needed.
After the configuration is complete, open the published site and verify that the chatbot is visible and can answer questions about your DITA content.
DITA-Specific Recommendations
Because the chatbot answers questions based on your published content, the quality of your DITA topics matters. To improve the usefulness of the AI responses:
- Write clear topic titles and concise
<shortdesc>elements. - Use semantic DITA structures such as
<task>,<concept>, and<reference>appropriately. - Keep related information grouped in focused topics instead of very large, mixed-content pages.
- Use meaningful keywords and index terms to improve discoverability.
- Make sure your published output is complete and up to date before indexing it.
Well-structured DITA content generally leads to better search quality and more relevant AI-generated answers.
What Users Can Do with the Chatbot
Once installed, readers can use the chatbot to ask questions such as:
How do I configure profiling in this documentation set?
Where can I find the steps for publishing to WebHelp?
What is the difference between a task and a concept topic?
This can reduce the effort required to locate information in large documentation portals and can complement the standard search experience.
Limitations and Planning Considerations
Before enabling an AI chatbot in production, it is a good idea to evaluate:
- Whether all important content is indexed and publicly available to the assistant.
- Whether your documentation contains sensitive information that should not be exposed through AI-assisted answers.
- How often the documentation changes and how frequently the search index should be refreshed.
- Whether you also want to enable the AI-enhanced Search Summary component alongside the chatbot.
