How to Ask Questions Effectively

This document was translated from Chinese by AI and has not yet been reviewed.

How to Ask Questions Effectively

Cherry Studio is a free and open-source project. As the project grows, the workload for the project team has also increased. To reduce communication costs and resolve your issues quickly and efficiently, we hope that you will follow the steps and methods below to handle problems before asking questions. This will allow the project team more time to focus on project maintenance and development. Thank you for your cooperation!

1. Check and Search the Documentation

Most basic questions can be solved by carefully reading the documentation.

• For questions about the software's features and usage, you can check the Feature Introduction documentation.

• Frequently asked questions are collected on the FAQ page. You can check there first for solutions.

• For more complex issues, you can try solving them directly by searching or asking in the search bar.

• Be sure to carefully read the content in the hint boxes within each document, as this can help you avoid many problems.

• Check or search the GitHub Issues page for similar problems and solutions.

2. Search Online, Ask an AI

For issues unrelated to the client's functionality (such as model errors, unexpected responses, or parameter settings), it is recommended to first search online for relevant solutions or describe the error message and problem to an AI to find a solution.

3. Ask in Official Communities or Create a GitHub Issue

If the first two steps did not provide an answer or solve your problem, you can describe your issue in detail and seek help in our official Telegram Channel, Discord Channel, or (Click to Join).

1. If it's a model error, please provide a complete screenshot of the interface and the console error message. You can censor sensitive information, but the model name, parameter settings, and error content must be visible in the screenshot. To learn how to view console error messages, click here.

2. If it's a software bug, please provide a specific error description and detailed steps to help developers debug and fix it. If it's an intermittent issue that cannot be reproduced, please describe the relevant scenarios, context, and configuration parameters when the problem occurred in as much detail as possible. In addition, you also need to include platform information (Windows, Mac, or Linux) and the software version number in your problem description.

Requesting Documentation or Providing Suggestions

You can contact @Wangmouuu on our Telegram channel or QQ (1355873789), or send an email to: [email protected].