Read before asking

• QQ/WeChat and other communication tools provide a fast and convenient way of communication, but if you encounter problems, it is recommended to follow the following steps.
• Whether you can get a useful answer often depends on how you ask and follow up.

Problem Solving Steps:

1. Try to solve it yourself: Use your knowledge to try to solve the problem by yourself first. Don't be scared by the English output information, try to read it as much as possible. Most output information has a direction, you just need to find it and try to solve it yourself.
2. Search online: Search online to see if anyone has encountered a similar problem. If yes, refer to others' solutions first. If not, ask in the group.
3. Ask in the group: When asking in the group, describe the problem clearly first, then attach a screenshot to help everyone locate the problem quickly. The more information you prepare, the higher the efficiency of others solving the problem.

When asking, try to do the following as much as possible, which will greatly increase the chance of the problem being solved quickly:

Always think from the perspective of the person answering

Every time you ask, think from the perspective of the person who will answer:

• Assume that the person answering is an expert, and their time is precious.
• How can you make it easy for the person answering to understand your question at a glance, preferably without the need for the person answering to ask you what you have done or what your purpose is.
• If you can make the person answering willing to answer your question, such as having a deep technical discussion, or making the person answering feel highly respected, or even paying directly.
• Do not let the person answering think that you are lazy, haven't read the documentation, haven't read the code, haven't read the logs, haven't searched, haven't thought, haven't tried, and haven't made any effort before directly asking the question.

Clarify the problem, and understand exactly what happened and what you did, including:

• What effect or function do I want to achieve?
• How did I do it to achieve this effect, what is the detailed process?
• What errors occurred during the implementation, what is the phenomenon (for example, an error occurred, what error was reported, what is the complete error content? Avoid only looking at the last few lines, try to look further into the logs)
• Have I carefully read the error message? Does the error message provide hints about the cause of the error and the solution?
• Based on these error messages, can you think carefully and solve the problem?
• Search the documentation, FAQ, issue, and use a search engine to find solutions to the problem
• If you feel that the documentation is incomplete, you can point it out directly!! Don't worry, I am definitely not an expert and may have overlooked some aspects!!

Inefficient or ineffective questions

• Question: Excuse me, master, how to solve this problem?

Problems exist

• Quick screen capture Take a screenshot instead of a screen capture, learn to use the screenshot function provided by various tools. Unless there are special circumstances, take a clear one
• Incomplete information There are many reasons why CAN cannot find ID, such as wrong wiring, speed between host and slave, etc. Limit your problem to a specific scenario and give specific conditions, which helps focus on the problem.
• Not knowing how to take screenshots, this screenshot tutorial

Question template

Try to ask questions politely, don't add extra words, complaints, or phrases. Be careful with every word and punctuation mark. Think from the perspective of the person answering, and consider how to let the person answering quickly help you solve the problem. Too few words may not describe clearly, while too many words may make people lose patience.

If you really can't solve the problem yourself and need to ask someone else, you need to consider:

• Who to ask, where to ask, who is more likely to answer your question? And what is the real-time performance?

• What information and phenomena should I provide to the person so that they are willing to quickly help me solve the problem?

  • Provide my purpose (to help the person answering know what you are doing)
  • Provide the complete implementation process and the phenomena that occurred during the process (to help the person answering reproduce the problem by following your process)
  • Give the place where the error occurred, pointing out where the phenomenon or result differs from your expectations! (To let the person answering know where the expectation was not met)
  • Provide the error message, which needs to be complete, try to take more screenshots and more logs, don't be stingy with taking a small picture or giving only part of the log (because the person answering may have not done this for a long time and forgotten some details, and need screenshots and complete logs to quickly recall; also, detailed logs can quickly locate where the problem is)

• How to ask in a polite manner, even if I am a novice, others will be willing to answer

Title

No matter where you ask, give your question a 30 character title, clarify the central idea of the problem, including:

• The category of the problem, whether it is a question, a BUG submission, or an experience sharing. Let people quickly locate what you want to do on a screen full of text.
• A sentence to clarify the central idea of the problem, for example, encountering CAN cannot find ID, the mainboard cannot connect, etc.

So the title can be like this:

• 【Question】 SHT36V3 cannot find CANID, what has been confirmed

This kind of title must not appear:

• Ah ah ah ah why my board cannot find ID (I don't know, I don't know how you wired and operated)
• Why doesn't my host computer start (I don't know, I don't know what host computer)
• Why there is no device here (I don't know, I don't know what product)
• What is this error (didn't read the documentation, asked right away)
• Received the mainboard, how to connect the driver? (didn't read the documentation, asked right away)
• How to connect this wire (what's the problem?)
• Why can't I burn after entering DFU, why can't I enter DFU (you need to tell others how you operated and how you wired, otherwise others may think you are talking nonsense and not want to respond)

You can ask like this:

• 【Question】 My board couldn't start after I reversed the power supply, how to determine which part is damaged, and if possible, how to revive it
• 【BUG】 The explanation in this document is incomplete, I hope it can be added or modified

Reference template

• Please spend a little time organizing the problem and describing the following information clearly:
• Whether you can get a useful answer often depends on how you ask and follow up.

1. What problem For example: The new mainboard and toolboard can't find the device
2. What hardware equipment For example: Set-top box + D5 mainboard + SHT36V3
3. How to wire For example: Take a high-definition photo of the wiring and send it to the master
4. What problem phenomenon For example: The host computer input lsusb didn't find any devices, etc. Attach a screenshot of the complete information.

【Question】 I bought a D5 mainboard and SHT36, and when connecting to the set-top box host computer using lsusb, I couldn't find any devices