How to ask

1 When you ask questions in different places, you will find several phenomena:

• No response was received after asking the question.

• It took a long time for the question to be answered.

• The other party always complains that he is too bad.

2 Before asking questions, please make sure you have studied the manual.

Many problems will be solved in this process. Please avoid asking questions in QQ groups, forums, issues, or emails right from the start. Many problems that are explained at the beginning of the document may not receive timely responses from the community. To save everyone's time and to create a better community environment so that everyone can grow together better, please understand each other.

3 When asking questions, try to do the following, which will greatly increase the chances of quickly solving the problem:

To figure out what was going on, I did:

• What kind of effect and function do I want to achieve?

• In order to achieve this effect, what did I do and what was the specific process?

• During the implementation, what errors occurred and what phenomena occurred (for example, what was the error reported and what was the complete error content?)

• Have I read the error message carefully? Does it indicate the cause of the error and the solution?

• Based on these error messages, think carefully, can I solve the problem?

• Can I search for solutions to problems by searching documents, issues, and using search engines?

4 If you really can't solve the problem yourself and need help, you need to consider:

• Who should I ask, where should I ask, who is more likely to answer my question, and how timely will it be?

• What data and phenomena should I provide him so that he will be willing to help me solve the problem quickly?

  • Provide my purpose (to let the respondent know what you are doing)

  • Provide a complete implementation process and the phenomena that occurred during the process (so that the respondent can follow your process and reproduce the problem)

  • Give the wrong part, point out where the phenomenon or result is different from what you expected! (Let the respondent know where the expectation was not met)

  • Provide the error message that occurred. It needs to be complete, with as many screenshots and logs as possible. Don't be stingy and just take a small screenshot or give only part of the log (because the respondent may not have done this for a long time and has forgotten some details, and needs to rely on screenshots and complete logs to quickly recall; and according to the detailed log, you can quickly locate where the problem is)

• How can I ask questions with a more sincere attitude? Even if I am a novice, everyone is willing to answer.

5 Question Template

When asking questions, try to be elegant. There is no need to add extra modal particles or complaining words. Consider every word and punctuation mark. Think about the problem from the perspective of the person answering the question. Think about how to get the person answering the question to help you solve the problem quickly. Too few words will make the description unclear, and too many words will make people impatient.

6 Title

No matter where you ask the question (including QQ 群), give your question a title of about 30 words, clarifying the central idea of the question, including:

• Question category, whether it is a question, a bug report, or experience sharing, etc. Let everyone immediately locate what you want to do on a screen full of text.

• One sentence to clarify the main idea of the problem, such as Running the camera sample program, the error reset fail is reported, which may be a hardware problem

So the title after integration can be like this:

• 【mycobot asks】 When running the camera sample program, the error reset fail is reported. Could it be a hardware problem?

Try not to have titles like this :

• Aaaaaaaa why is my board broken again

• Why can't my code run

• Why is my screen black

• [mycobot asked] I received the development board, and the screen is red with a line of small text. Why is that

• I ran the xxx program and something went wrong

You can ask:

• 【mycobot asked】 My board cannot start after I connected the power supply in reverse. How can I determine where the board is burned? If possible, how can I revive it?

7 Content

First, from the perspective of the respondent, if asked:

• First of all, you need to know what the other party wants to do and what goals they want to achieve.

• In order to achieve this goal, he referred to the steps of

• What specific steps were actually taken, and at which step the problem occurred, so that I can follow his steps to try to reproduce the phenomenon. If the problem seems difficult to solve and there are no steps to reproduce it, it may take a lot of time to reproduce it, so put it aside and solve other problems first.

• What is the specific problem? If he only says that there is a problem, how can I know what is wrong with him? Maybe he is unwell? So this is very important. I need to ask him to explain the phenomenon when the problem occurs and point out the difference from the expectation. Otherwise, I have to guess and compare the difference from the expectation, which increases the time to solve the problem.

• There is a problem. I may need his log file so that I can analyze the source code according to the log. Otherwise, it may be difficult to solve the problem. I can put this problem aside and look at it later.

In summary, we can ask:

• Detail your goals, what you want to do, and what the phenomenon should be like

• Have I referred to any documentation, code, or tutorial?

• How to reproduce the error: How to do it, write each step in detail until the problem occurs

• Elaborate on the phenomenon when the error occurs and how it differs from the expected behavior. Prove that the problem actually occurred.

• Attach log files, screenshots, and even videos. The logs and screenshots must be complete, not just a small part. The answerer may find some problems that you have not noticed from your complete logs and screenshots. This is very important.

• In addition, pay attention to the format when pasting the code. Don't paste it in a messy way. Try to run it directly after copying it.

• Finally, I would like to express my gratitude to the community friends who answered my questions.