Ask Your Docs
| Ask Your Docs is currently in the beta stage; the functionality is subject to change and will be continuously improved. |
Ask Your Docs is a bot that helps you understand whether your documentation is complete. Also, it shows whether your readers and other AI tools like AnswerGenius could easily find the needed information in it. So you can check your documentation before going live and improve it if needed.
When you send a request, Ask Your Docs analyzes projects and publications available to a given user (including private, restricted and public publications). If your documentation has an answer to your question or contains other information related to the query, Ask Your Docs shows its judgment of how well your documentation addresses the query, and also provides an answer just as other AI tools, like AnswerGenius, would provide. Additionally, Ask Your Docs displays links to topics that include relevant details below the answer.
| Ask Your Docs may provide inaccurate responses. Always review the response. |
If Ask Your Docs cannot find the answer, this indicates a gap in your documentation. You will see the following message: "My knowledge base does not contain an answer to your question".
Currenlty, Ask Your Docs provides answers only based on the content of your projects and publications. It doesn't analyze the project state based on existing review comments, ToDo items and topic statuses. To get information about the Project Readiness, refer to the corresponding Reports.
Enabling Ask Your Docs
To enable the Ask Your Docs feature on your portal, follow these steps:
- On the left sidebar, click on the Ask Your Docs icon.
- Accept the AI Terms.
- Click the Enable & Ask button.
Once the feature is enabled, you will see the input field at the bottom of the screen where you can type your queries.
|
Only portal administrators can enable the Ask Your Docs feature. |
If you need to disable the Ask Your Docs feature, contact ClickHelp support.
Ask Your Docs Specifics
Ask Your Docs provides answers in the language of the found sources. For example, if you have publications in English and ask your query in French, the reply is provided in English. The status is always in English.
| You can force Ask Your Docs to reply in the needed language by adding a phrase like "Reply in French" at the beginning of your query. |
Ask Your Docs considers the context of a conversation, i.e., previous queries and answers. To start a new conversation, click the Clear button.
To fine-tune Ask Your Docs answers, you can use the same approach as for fine-tuning Full-Text Search, i.e. add Index Keywords to your topics and use the Featured Snippets.
Limitations
The daily request limit depends on your current plan. The limit is portal-wide. You can see the number of available requests at the bottom of the screen.
