Connect Oxygen Feedback to published DITA OT docs

[raducoravu]

This is not a bug report. The proposal is to add feedback forms at the end of each documentation page using the Oxygen Feedback cloud platform. Something like this:

Feedback forms would allow users to leave suggestions on each page of the documentation web site. One would need to perform these steps: https://www.oxygenxml.com/doc/versions/4.1/ug-feedback-cloud/topics/ofb-installing-feeback-all-platforms.html https://www.oxygenxml.com/demo/install_feedback_v2.html and they would obtain a script similar to this one: https://github.com/oxygenxml/blog/blob/master/publishing/webhelpBlogTemplate/html-fragments/feedback_footer.xml which needs to be added to the footer of each HTML page generated from the DITA OT docs.

On the Oxygen Feedback platform we could give a long subscription to the DITA OT web site so that there is no cost involved.

Once the form is active and usable we could consider as a next step to also add an AI Assistant widget (enabled also through the Feedback platform) which would allow people to ask questions and would answer from the content of the DITA OT docs. We already have something like this for the Oxygen user's guide:

I was reminded of this by @lief-erickson 's remarks about using LLM to answer userguide questions. Our Oxygen Feedback's AI-based chat (which we plan to officially release in Autumn) uses RAG retrieval augmentation based on project contents to answer questions.

[chrispy-snps]

This would be great.

[raducoravu]

More about this proposal:

The cookies added by the Oxygen Feedback platform are listed here: https://www.oxygenxml.com/about_cookies.html#:~:text=Oxygen%20Feedback%20Cookies in my opinion they fall in the category "Cookies that do not require consent" according to the EU rules: https://europa.eu/youreurope/business/dealing-with-customers/data-protection/online-privacy/index_en.htm but my colleagues from the Feedback team have not yet stated this for sure, so we are still investigating.

Benefits of integrating the Oxygen Feedback platform:

• Like/Dislike buttons on every article (for me this is not a that useful feature). The buttons can be hidden from the admin page.
• Possibility to add comments and reply to comments on threads, to approve/delete comments on every page. And for me this is an useful feature to receive feedback. We receive daily questions and feedback on our user's guide contents using this feature.
• The potential to index the entire content and perform the search in pages using the Oxygen Feedback platform.
• Possibility to analyze page views in the Oxygen Feedback admin pages. And these are page views, they do not track and de-duplicate individual users like Google analytics. But they are useful. As an example for the Oxygen XML Blog:

[chrispy-snps]

I have used Oxygen Feedback's comment feature a number of times, and I am quite fond of it. It is great for clarifying uncertainties right at the point where the content is conveyed. And more often than not, the discussions led to an improvement in the documentation.

[stefan-jung]

@raducoravu, does the implementation of the feedback function also imply to switch to oxygen webhelp or can the feedback function be connected to the website as-is.

[raducoravu]

@stefan-jung the Oxygen Feedback can be installed on any web site by adding a specific "div" element in each generated web page. The div would look like:

<div xmlns="http://www.w3.org/1999/xhtml" id="oxygen-feedback-frame-container">
    <script id="feedback-init" defer="defer" src="https://feedback.oxygenxml.com/app/init/init.js?deploymentToken=TOKEN_HERE"><!-- --></script>
</div>

[raducoravu]

I published here a clone of the DITA OT documentation project to Oxygen WebHelp with full AI support (AI chat bot, semantic search), I will not actively promote the link, but for those who want to chat with the AI about the DITA OT Docs: https://www.oxygenxml.com/dita-ot-docs/

[lief-erickson]

@raducoravu, very cool. Using the Search box, I asked a question of the docs in German and the AI replied in German, using the English-language source. There were also search results I could click. Nice. (The search results and linked pages were all in English, as one would expect.)

To use the AI Assistant/Chatbot, I must log in. Is that the intention? Is there a way to use the chatbot anonymously or without logging in?

[raducoravu]

@lief-erickson I do not see a setting to use the chatbot anonymously, I will ask my colleagues. But I think the main reason for this is that every time someone uses the chat bot tokens are consumed and they are paid by the organization which administers the Oxygen Feedback site (in this case us). I also enabled the semantic search and the chat bot on the DITA 1.3 WebHelp site: https://www.oxygenxml.com/dita/1.3/specs/introduction/dita-release-overview.html