How to Ask Questions Efficiently

Cherry Studio is a free and open-source project. As the project grows, the workload of the project team is also increasing day by day. In order to reduce communication costs and be able to solve your problems quickly and efficiently, we hope everyone will try to handle the problems encountered according to the following steps and methods before asking questions, so that the project team can spend more time on maintenance and development. Thank you for your cooperation!

1. Documentation Review and Search

Most basic problems can basically be solved by carefully reading the documentation

• For software functions and usage issues, you can go to the Feature Introduction documentation;

• Frequently asked questions will be included in the FAQ page. You can first check the FAQ page to see whether there is a solution;

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

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

• On GitHub's Issue page to view or search for similar issues and solutions.

2. Search online and ask AI

For issues unrelated to client functions, such as model usage issues (e.g., model errors, answers not meeting expectations, parameter settings, etc.), it is recommended to first search online for relevant solutions, or describe the error content and problem to AI to find a solution.

3. Ask in the official community or open an issue on GitHub

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

1. If it is a model error, please provide a full screenshot of the interface and the console error information. Sensitive information can be obscured, but the model name, parameter settings, and error content must be retained in the screenshot. How to view console error information click here.

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

Request documentation or provide documentation suggestions

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