How to write your question to maximize your chances to find a solution?

Lina DABASINSKAITE · ‎2023-07-18

DON'T put the ENTIRE question in the title
Keep your title short and concise, you add additional information in the Description section
Need to insert code? Use this button in the editor to post it.
Make sure you include a reference to the product concerned and the type of problem:
1. [Part Number] Always state the FULL Part Number of the product used.
2. [Environment] Describe the environment used as toolchain and hardware and state the version used.
3. [Schematics] If it is a custom board --> Share the schematics using “Attach file” option or inserting some image.
4. [Details] Describe the symptoms observed (examples: error messages, wrong behavior, screenshots of signals…).
5. [Expected behavior] If the question is related to performance then what is the target.
6. [How to reproduce] Detail the steps you have taken to get the behavior seen and clarify the set-up [Input, Output].
7. [Occurrence] Is the problem systematic? If not, state the frequency.
8. [Sanity checks] What are the checks that you have already performed (example: Have you reviewed the existing examples - GitHub, Cube...).

BarryWhit · ‎2024-07-06

When forum regulars look at your question, they're looking for a few things:

1. They want to quickly figure out what you're actually asking, so they can decide whether to try and help or move on.

2. They need to know what you're trying to achieve, not just what you tried to do that isn't working out.

3. Once they decide to help, they need as much relevant information as possible. If you include that information it to begin with, you save everyone the trouble of going back and forth asking for further information.