dita-ot / dita-ot/docs

Connect Oxygen Feedback to published DITA OT docs

Open
#565 8 comments 0 reactions 0 assignees View on GitHub
Dominant language
XSLT
Stars
64
Forks
102
Avg merge
14h 50m
Merged PRs (30d)
1

Description

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:

Screenshot 2024-07-12 at 09 02 06

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:

Screenshot 2024-07-12 at 09 07 23

Screenshot 2024-07-12 at 09 08 53

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.