How to Ask Questions Effectively

Cherry Studio is a free open-source project. As the project grows, the workload for the project team has also gradually increased. To reduce communication costs and be able to resolve your issues quickly and efficiently, we hope everyone handles problems as much as possible according to the following steps and methods before asking questions, so the project team can devote more time to maintenance and development. Thank you for your cooperation!

1. Documentation review and search

Most basic issues can be solved by carefully consulting the documentation

• Questions about the software's features and usage can be found at Feature introduction in the documentation;

• High-frequency questions are collected in FAQ pages — you can first check the FAQ page to see if there is a solution;

• More complex issues can be resolved directly by searching or asking in the search box;

• Be sure to carefully read the tip boxes in each document, they can help you avoid many problems;

• On GitHub, Issues page — check or search there to see if there are similar problems and solutions.

2. Web search and asking AI

For issues related to model usage that are unrelated to client functionality (such as model errors, responses not meeting expectations, parameter settings, etc.), it is recommended to first search online for related solutions, or provide the error messages and problem descriptions to an AI to look for solutions.

3. Ask in official communities or open an issue on GitHub

If the steps in sections 1 and 2 above do not find an answer or cannot resolve your problem, you can go to the official tg channel,Discord channel,QQ group (One-click join the group) and describe the problem in detail and seek help.

1. If it is a model error, please provide a complete screenshot of the interface and the console error information. Sensitive information can be redacted, but please make sure the model name, parameter settings, and error messages are included in the screenshot. How to view console error information Click here.

2. If it is a software bug, please providea specific error descriptionanddetailedreproductionstepsto make it easier for developers to debug and fix. If it is an intermittent issue that cannot be reproduced, please describe the related scenario, background, and configuration parameters in as much detail as possible. In addition, you also need to includeplatform information(Windows, Mac or Linux),software version numberand other information in the problem description.

Request documentation or provide documentation suggestions

You can contact the tg channel @Wangmouuu or QQ (1355873789), or you can also send an email to:[email protected].