> For the complete documentation index, see [llms.txt](https://docs.cherryai.com.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cherryai.com.cn/docs/en-us/question-contact/ask.md).

# How to Ask Questions Efficiently

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

<figure><img src="/files/1f45275b203c7f5ea09c49487ede4dadd4ee6214" alt="根据使用疑问、可复现问题和功能建议选择提问或反馈入口的流程图"><figcaption><p>First determine whether it is a question, a reproducible issue, or a feature suggestion, then prepare the corresponding materials.</p></figcaption></figure>

### Choose the right entry first

| Your situation                                                  | Recommended entry                                                         |
| --------------------------------------------------------------- | ------------------------------------------------------------------------- |
| Not sure whether it is a configuration issue or a product issue | Sidebar \[Help] → \[Issue Feedback] → \[Ask the Issue Feedback Assistant] |
| Confirmed as 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 check the 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 do not need to learn how to read logs first.

### What the issue should include

{% stepper %}
{% step %}

#### 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.”
{% endstep %}

{% step %}

#### 2. Write 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 a daily report.”
{% endstep %}

{% step %}

#### 3. Provide the shortest steps to reproduce

Start from the entry where the problem can be reproduced reliably, and use 3–6 steps to clearly describe the click path, selected items, and where the error appears.
{% endstep %}

{% step %}

#### 4. Add the environment

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.
{% endstep %}

{% step %}

#### 5. Add screenshots, screen recordings, or logs

Screenshots should include the error and the page where it occurred; logs should only include the relevant time range and be redacted first. For model output issues, include the input, model, and expected format.
{% endstep %}
{% endstepper %}

### Template you can use directly

```
Title: Agent scheduled task ran successfully, but the Feishu channel did not receive the result

Goal: Send the operations daily report to the specified Feishu group at 09:00 on weekdays.
Actual result: The run history shows success, but Feishu has no message.
Expected result: The group receives a daily report message.

Reproduction steps:
1. Open [Settings] → [Scheduled Tasks].
2. Select the daily report task and click [Run].
3. Wait for the task to complete.
4. Check the Feishu group; there is no new message.

Environment: macOS / the version shown in Cherry Studio [About Us] / Feishu channel.
Already tried: re-enabling the channel; sending a test message to the bot in Feishu.
Attachments: screenshots of the channel status with credentials masked, corresponding run records.
```

### What to remove from screenshots and logs

{% hint style="danger" %}
Before submitting, remove API keys, Authorization, cookies, bot tokens, App Secret, email addresses, full local file paths, chat content, and business data. Once a secret is exposed, revoke it immediately with the service provider or platform.
{% endhint %}

### Small habits that make troubleshooting faster

* Reproduce only one issue at a time;
* Use the minimum configuration that can trigger the issue;
* State whether the issue occurs consistently;
* Do not just write “doesn’t work”; include the exact error message;
* Do not upload a whole log unrelated to the issue;
* If you find the same issue, add the environment and new clues instead of creating a duplicate.

<details>

<summary>Can I just let Cherry Assistant submit it for me?</summary>

Yes. After entering Cherry Assistant via \[Feedback], explain the problem and clearly ask it to submit it. It will ask for permission to collect diagnostic data, show a redacted preview, and then handle it according to the method you choose. It will only use a GitHub Issue if you explicitly request GitHub.

</details>

<details>

<summary>Can I just let Cherry Assistant submit it for me?</summary>

Yes. After entering Cherry Assistant via \[Feedback], explain the problem and clearly ask it to submit it. It will ask for permission to collect diagnostic data, show a redacted preview, and then handle it according to the method you choose. It will only use a GitHub Issue if you explicitly request GitHub.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cherryai.com.cn/docs/en-us/question-contact/ask.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.