For the complete documentation index, see llms.txt. This page is also available as Markdown.

How to Ask Questions Efficiently

An easy-to-answer question, not necessarily long, but it should let others know what you are doing, what actually happened, and how to see the same problem.

根据使用疑问、可复现问题和功能建议选择提问或反馈入口的流程图
First determine whether it is a question, a reproducible issue, or a feature request, then prepare the corresponding materials.

Choose the appropriate entry first

Your situation
Recommended entry

Not sure whether it's a configuration issue or a product issue

【Settings】→【About Us】→【Feedback】→【Submit with Agent】

Confirmed to be a reproducible bug

GitHub Bug Report

Want to add a new capability

GitHub Feature Request

Discuss usage or solutions

GitHub Discussion / Questions

Only need to look up operation steps

Current documentation and Cherry Assistant

Cherry Assistant can read the current installation package information, and with your consent collect the necessary diagnostics. It will first show a redacted preview, then submit feedback or generate a diagnostic package; you don't need to learn how to read logs first.

What the issue should include

1

1. State the goal in one sentence

For example: “I want the Agent to send the daily report to a Feishu group on weekday mornings.”

2

2. State the actual result and the expected result

Actual result: “The task ran successfully, but Feishu did not receive the message.” Expected result: “After the run completes, the specified group receives one daily report message.”

3

3. Provide the shortest reproduction steps

Start from the entry where the problem can be reproduced stably, and use 3–6 steps to clearly describe the click path, selected content, and where the error appears.

4

4. Add environment details

Specify the operating system, the version shown in 【Settings】→【About Us】, and the relevant service provider or channel type. Do not disclose API Keys or account credentials.

5

5. Add screenshots, screen recordings, or logs

Screenshots should include the error and the page where it occurred; logs should only cover the relevant time period and be redacted first. Issues with model output should include the input, model, and expected format.

Templates you can use directly

What to remove from screenshots and logs

Small habits that speed up troubleshooting

  • Reproduce only one problem at a time;

  • Use the minimal configuration that can trigger the problem;

  • Explain whether the problem occurs consistently;

  • Do not just write 'cannot use'; include the original error text;

  • Do not upload the entire log if it is unrelated to the problem;

  • If you find the same issue, add the environment and new clues instead of creating a duplicate.

Can I let Cherry Assistant submit it for me directly?

Yes. After entering Cherry Assistant through 【Feedback】, explain the issue and explicitly ask it to submit. It will request authorization for diagnostic data, show a redacted preview, and then handle it according to the method you choose. It will only go to a GitHub Issue if you explicitly ask for GitHub.

Last updated

Was this helpful?