How to Ask for Help

I'm over-solicited by mails asking me for help. 

Most of the time, it is really difficult to understand the question as it is poorly worded. 

Here are some useful tips for a winning question!

Provide a Qualified Question

  • Provide information about your configuration, both hardware and software, including: model of board used and revision number, model of the MCU used. 
  • Provide the model of the additional shield or sensor or actuator or screen used, as well as links to the shield or sensor or actuator or screen data sheet.
  • Provide the name and version of the IDE used and the OS the IDE is running on
  • Extract minimal code relevant to the issue, as the first test to perform to qualify an issue is to replicate it. 
  • Provide all kinds of measures that may be useful, like logic analyser trace, oscilloscope screen-shots, ... The links saves time and provides the reader with direct access to the documentation.
Example:

  • LaunchPad MSP430G2 revision 1.5 --as there's a LaunchPad MSP430G2 revision 1.4 and a LaunchPad MSP430F5529
  • MSP430G2553 —as there're also the MSP430G2452 and the MSP430G2231 for the same LaunchPad MSP430G2
  • Anaren CC110L BoosterPack 
  • Energia 11 --or Energia 11 framework on Xcode or on CCS 6
  • Windows 8.1 64-bit --or the specific Linux distribution or Mac OS X 10.9.1

Consider the Power of Sharing

If you're a hobbyist
  • Use Google!
  • Search the forums! There are many great forums, and each platform has its dedicated forums. And the answer you're looking for may be already available, wanting for you!
  • So join a community, contribute and share your questions and answers.
If you're a student
  • As a student, your full-time job is to learn. 
  • Embedded computing is a wide and complex world. Each protocol —SPI, I²C, CAN, UART— is different and requires a learning curve. 
  • There's no alternative but learning the hard way.
  • Have you already asked your teachers and colleges for help?

Some Useful Forums

Click to open the forum.
profesional

Get the Right Tools

Software
Not all IDEs are equal. Some projects require more powerful tools.
  • For small projects, the a Processing-based Wiring-derived Arduino-like IDEs provide a fine and easy-to-use IDE —for Windows, Linux and Mac OS X.
  • For larger projects and rapid prototyping, use instead a plug-in based on the Processing-based Wiring-derived Arduino-like framework for a professional IDE, like Visual Micro for Visual Studio —for Windows— or embedXcode for Xcode —for Mac OS X.
  • For professional projects, use the official IDE from the MCU maker. For example, consider ATmel Studio --for Windows—, Code Composer Studio from Texas Instruments —for Windows and Linux—, MPLab X from Microchip —for Windows, Linux and Mac OS X.
Hardware
You also need minimal equipment, including 
  • a multimeter, 
  • a logic analyser —like the Saleae I'm using— 
  • and optionally an oscilloscope —like the Rigol I'm using.

Be Polite

Strange as it may sound:
  • Thank those who have helped you.
  • Give credit to those who have helped you.

Avoid Direct Mail

Here's an example of the typical messages I'm receiving on a daily basis.

​Some even post on Twitter expecting for help!
Hi!

I am trying to communicate a board with a sensor through the I²C protocol and it doesn't work.

Here's my code. Thank you for help.
Unfortunately most of the time, those message appear to be sent by engineers posing as false hobbyists or students, looking for free advice. 

I'm just a hobbyist and I consider this approach unfair and unethical. So be ready to receive the following standard answer.

Also of interest, read About Libraries.
Hi!

Before considering an answer to your question, please certify you are a hobbyist working on a private project not for sale.

On the contrary, please consider hourly fees, with a minimum of two hours.

Best regards,