Good day, colleagues,
I want to create an assistant for my platform to help users by answering system-related questions. For example, users will be able to ask whether a particular functionality exists in the system, where to find it, and how to configure it. The AI assistant should provide clear and precise answers.
To achieve this, I started writing system documentation specifically for the assistant. I have already gone through several revisions to find a more convenient format for describing the system. However, I am still unsure if this is the best format. Therefore, I am seeking support here, as someone might have already implemented such an assistant and knows the best way to structure the documentation.
I am attaching a screenshot with the glossary (to give an idea of how I structure the document) and a screenshot of a formatted part of the documentation. P.S. I’m preparing the documentation in Notion and then exporting it in Markdown format.
Overall, I am almost satisfied with the model’s responses, and to my surprise, the 4o-mini model has performed better for these purposes than the 4o. 4o-mini responds directly and to the point, while 4o sometimes starts fabricating information.
Could you please advise me on how to improve the document’s structure? Am I on the right track by simply describing all interface elements and their interactions?
Thank you.