Contents

Preamble

• Operating system: any
• Strategy: A check-list for best help-seeking behaviour
• Date: July 9, 2022
• Source: This tip is heavly based on Matt Studdert's (2018) article on "How to ask good questions as a developer,” posted on https://www.freecodecamp.org/news/how-to-ask-good-questions-as-a-developer-9f71ff809b63/ (last accessed on September 13, 2022).

Never forget

Whenever you are seeking for help, remember these three things:

1. Screenshots are less helpful than text because we can't copy and paste from images easily. Also, we can't run images as scripts (yet). Whenever possible, include textual information, and never hesitate to add attachments. The information should fully describe the input and error. A description of your objectives and expected outputs is always helpful. You want the person tryin to help you to have as little trouble as possible in replicating your error.
2. Give a complete description of your hardware, operating system, and other relevant software. It is always best to have excess information than missing information. This will make it easier and faster for you to find the help you seek. Also, it is rude not to show that you put an effort to write a good question while expecting someone else to put time and energy to give you a decent answer.
3. A good question should always be longer, and more verbose, and more informative than the expected answer when it comes to bioinformatics. If the person trying to help you has to ask too many questions to give you an answer, you are doing something wrong.

Before asking for help

When it comes to coding, there are some steps you must take to increase the chances of getting a good answer.

Check your code editor for typos and syntax errors

Syntax highlighting is a powerful ally when spotting simple typos. In the early days, the majority of your errors will be typos and syntax errors. These should be a quick fix with the help of your trusty code editor.

Check for written errors