Difference between revisions of "Netiquette"
m (→Links) |
|||
(15 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | <div | + | <div id="BIO"> |
+ | <div class="b1"> | ||
Netiquette - Network Etiquette | Netiquette - Network Etiquette | ||
</div> | </div> | ||
− | |||
− | |||
'''Netiquette''' is a ''portmanteau'' of "network etiquette". It is a collection of social conventions for communication on the Internet such as e-mail, mailing lists, forums ... Here is a subset of relevance for our mailing list. | '''Netiquette''' is a ''portmanteau'' of "network etiquette". It is a collection of social conventions for communication on the Internet such as e-mail, mailing lists, forums ... Here is a subset of relevance for our mailing list. | ||
+ | __TOC__ | ||
+ | |||
+ | |||
+ | ====Be kind==== | ||
+ | |||
+ | This is the single most important rule. We are all working together. Let's all make this a pleasant and exciting experience. | ||
+ | |||
+ | {{Vspace}} | ||
====Pay attention who you reply to==== | ====Pay attention who you reply to==== | ||
Line 14: | Line 21: | ||
If you use "reply", your message will go the entire list. Pause a moment, and consider whether this is what you want. Perhaps your message is of interest to only a single recipient? Or your message may be personal, or confidential ... | If you use "reply", your message will go the entire list. Pause a moment, and consider whether this is what you want. Perhaps your message is of interest to only a single recipient? Or your message may be personal, or confidential ... | ||
+ | {{Vspace}} | ||
====Use informative subject lines==== | ====Use informative subject lines==== | ||
Line 26: | Line 34: | ||
Try to be specific for example, this subject line is poor: | Try to be specific for example, this subject line is poor: | ||
− | + | Chimera doesn't work! | |
+ | |||
Much better would be | Much better would be | ||
− | Can't load molecule in | + | Can't load molecule in Chimera after editing coordinates |
− | |||
Line 37: | Line 45: | ||
New subject (was: old subject) | New subject (was: old subject) | ||
+ | |||
+ | {{Vspace}} | ||
====Don't hijack threads==== | ====Don't hijack threads==== | ||
Line 54: | Line 64: | ||
As a corollary: if your post '''is''' related to the thread, by all means '''do''' use the reply function of your mail client and '''don't''' change the subject line, even if you think the original subject line was not well written or contained a (non-critical) typo etc. | As a corollary: if your post '''is''' related to the thread, by all means '''do''' use the reply function of your mail client and '''don't''' change the subject line, even if you think the original subject line was not well written or contained a (non-critical) typo etc. | ||
+ | {{Vspace}} | ||
+ | |||
+ | ====Follow the discussion==== | ||
+ | From time to time I see questions asked that have already been answered previously. This shows me that you did not follow the discussion. What do you think I think of that? | ||
+ | |||
+ | Exactly. | ||
+ | |||
+ | |||
+ | {{Vspace}} | ||
====Describe problems clearly==== | ====Describe problems clearly==== | ||
− | + | Sometimes your problems will be due to a faulty assumption, sometimes due to incompatible software, sometimes due to bugs, or errors in assigned tasks ... The more clearly you describe what you did and what happened, the more likely it is someone will be able to help. Simply stating "this or that didn't work" will get you nowhere. Ask yourself: | |
* Did I specify the circumstances under which the problem arose? | * Did I specify the circumstances under which the problem arose? | ||
Line 64: | Line 83: | ||
* Have I given enough information so that someone else would be able to reproduce the problem? | * Have I given enough information so that someone else would be able to reproduce the problem? | ||
+ | {{Vspace}} | ||
+ | |||
+ | ====Avoid screenshots==== | ||
+ | |||
+ | Almost always when I see a screenshot of errors that arise during assignments, the issue would have been better described by copy/pasting code and text. Screenshots, as images, are a dead-ends for further analysis. | ||
+ | |||
+ | * If you paste a screenshot with a sequence ID, others will need to type it out, awkwardly, on a different page to reproduce your problem. | ||
+ | * If you paste a screenshot with a piece of code, others will have to type the code, awkwardly, into their code editor to reproduce your problem and experiment for a solution. | ||
+ | * If you paste a screenshot of an error message, it is that much more work to Google for the message and figure out what could have caused it. | ||
+ | |||
+ | In all those cases, you prevent others from helping you quickly and effectively and you are wrong to expect others to type down the contents of your images because you didn't copy/paste the essential material. That's not smart. Also you are wasting other's bandwidth on their computers or mobile devices. That's rude. | ||
+ | |||
+ | The only case where screenshots are encouraged is where an image is involved - but even then, for example when discussing R plots, the code that has generated the plot would be more helpful. <code>dput()</code> is your friend. And learn to create '''MWE'''s (Minimal Working Examples). | ||
+ | {{Vspace}} | ||
− | ==== | + | ====Show us that you've ''done your homework''==== |
The [http://www.catb.org/~esr/faqs/smart-questions.html "How to Ask Questions the Smart Way"] document gives the following excellent advice: | The [http://www.catb.org/~esr/faqs/smart-questions.html "How to Ask Questions the Smart Way"] document gives the following excellent advice: | ||
Line 76: | Line 109: | ||
<small>I can't put it any better.</small> | <small>I can't put it any better.</small> | ||
− | + | {{Vspace}} | |
====Use mixed case and write full words==== | ====Use mixed case and write full words==== | ||
Line 83: | Line 116: | ||
It also looks lik u cant B rly botherd 2 rite if u rite ur txt with textN shorth&. | It also looks lik u cant B rly botherd 2 rite if u rite ur txt with textN shorth&. | ||
+ | |||
+ | {{Vspace}} | ||
====Don't Troll==== | ====Don't Troll==== | ||
− | Just don't [http:// | + | Just don't {{WP|Internet_troll|do it}}, oK? |
+ | |||
+ | {{Vspace}} | ||
+ | |||
+ | Also remember: trolling, stalking, impersonating etc. may fall under sanctionable offences of the [http://www.governingcouncil.utoronto.ca/Assets/Governing+Council+Digital+Assets/Policies/PDF/ppjul012002.pdf University's Student Code of Conduct]. | ||
+ | {{Vspace}} | ||
====No need to address me on the list==== | ====No need to address me on the list==== | ||
Line 93: | Line 133: | ||
Sending a message to the list reaches all list members. That's the point of the list: we are sharing discussions with everyone. There is no need to address anyone in particular (not even your professor), unless you are responding publicly to a specific statement by that person. Even generic salutations - like <tt>Howdy</tt> or <tt>Dear all,</tt> are nowadays usually omitted for the sake of brevity. | Sending a message to the list reaches all list members. That's the point of the list: we are sharing discussions with everyone. There is no need to address anyone in particular (not even your professor), unless you are responding publicly to a specific statement by that person. Even generic salutations - like <tt>Howdy</tt> or <tt>Dear all,</tt> are nowadays usually omitted for the sake of brevity. | ||
− | + | {{Vspace}} | |
+ | |||
+ | ---- | ||
+ | |||
+ | {{Vspace}} | ||
+ | |||
+ | <div class="alert">If I feel that someone does not respect these principles, I may place their contributions under moderation. | ||
+ | |||
+ | <small>... and that's not good, because participation on the mailing list documents your engagement which reflects on your participation mark.</small> | ||
+ | </div> | ||
+ | |||
+ | {{Vspace}} | ||
+ | |||
+ | {{Vspace}} | ||
====Links==== | ====Links==== | ||
+ | {{#pmid: 21980280}} | ||
+ | * {{WP|Netiquette}} | ||
+ | * [http://www.albion.com/netiquette/corerules.html Virginia Shea's Core Rules of Netiquette] | ||
+ | * [http://stackoverflow.com/help/mcve ''How to create a Minimal, Complete, and Verifiable example''] – '''R''' advice via stack'''overflow'''. | ||
+ | * [http://www.catb.org/~esr/faqs/smart-questions.html ''How to Ask Questions the Smart Way''] <small>for the technical minded, excellent advice!</small> | ||
+ | |||
+ | {{Vspace}} | ||
+ | |||
+ | ====Useful Forums==== | ||
+ | |||
+ | <div class="reference-box">'''[https://groups.google.com/forum/#!forum/bch441_2016 bch441_2016]''': Our course mailing list for this term</div> | ||
+ | <div class="reference-box">'''[http://biostar.stackexchange.com BioStar]''': General bioinformatics, computational-, and systems biology questions <small>(timesink warning!)</small></div> | ||
+ | <div class="reference-box">'''[https://www.reddit.com/r/bioinformatics/ Reddit]''': the bioinformatics "subreddit" <small>(timesink warning!)</small></div> | ||
+ | <div class="reference-box">'''[https://stat.ethz.ch/mailman/listinfo/r-help R-help]''': The R programming language</div> | ||
+ | <div class="reference-box">'''[http://stackoverflow.com/questions/tagged/r Stack Overflow]''': R-related questions</div> | ||
+ | <div class="reference-box">'''[https://www.bioconductor.org/help/support/ BioConductor Support]''': for all questions about the BioConductor Project</div> | ||
+ | <div class="reference-box">'''[http://stats.stackexchange.com/ Cross Validated]''': statistics related questions on ''Stack-exchange''</div> | ||
+ | |||
+ | |||
− | + | </div> | |
− | |||
− |
Latest revision as of 23:54, 30 December 2016
Netiquette - Network Etiquette
Netiquette is a portmanteau of "network etiquette". It is a collection of social conventions for communication on the Internet such as e-mail, mailing lists, forums ... Here is a subset of relevance for our mailing list.
Contents
- 1 Be kind
- 2 Pay attention who you reply to
- 3 Use informative subject lines
- 4 Don't hijack threads
- 5 Follow the discussion
- 6 Describe problems clearly
- 7 Avoid screenshots
- 8 Show us that you've done your homework
- 9 Use mixed case and write full words
- 10 Don't Troll
- 11 No need to address me on the list
- 12 Links
- 13 Useful Forums
Be kind
This is the single most important rule. We are all working together. Let's all make this a pleasant and exciting experience.
Pay attention who you reply to
If you use "reply", your message will go the entire list. Pause a moment, and consider whether this is what you want. Perhaps your message is of interest to only a single recipient? Or your message may be personal, or confidential ...
Use informative subject lines
Spend a moment thinking what your post is about, then condense the message into a few words. This goes a long way towards
- allowing the recipients to estimate how interested they are in the contents of your message;
- retrieving a thread in your archived messages;
- browsing the archives for information;
- keeping the ensuing discussion on topic.
Try to be specific for example, this subject line is poor:
Chimera doesn't work!
Much better would be
Can't load molecule in Chimera after editing coordinates
If you must change the subject line, quote the old line as in:
New subject (was: old subject)
Don't hijack threads
If you have a new question, never simply write it into the reply to an older thread. If you don't give your post it's own thread:
- your new question will end up in an unrelated discussion;
- it will be much harder to search;
- the original poster's question gets diluted and may never get appropriately discussed;
- you demonstrate that you didn't actually care enough to type up a subject line.
Taking a thread away on a tangent is called hijacking a thread and is considered rude.
Use reply if you contribute to a thread, write a new mail or post if you have something new to add. Some mailing list software builds thread based on subject line and some software builds thread based on message ID. Only changing the subject line may not be sufficient to start a new thread. Since you usually don't know which does what, use the rule above to be sure.
As a corollary: if your post is related to the thread, by all means do use the reply function of your mail client and don't change the subject line, even if you think the original subject line was not well written or contained a (non-critical) typo etc.
Follow the discussion
From time to time I see questions asked that have already been answered previously. This shows me that you did not follow the discussion. What do you think I think of that?
Exactly.
Describe problems clearly
Sometimes your problems will be due to a faulty assumption, sometimes due to incompatible software, sometimes due to bugs, or errors in assigned tasks ... The more clearly you describe what you did and what happened, the more likely it is someone will be able to help. Simply stating "this or that didn't work" will get you nowhere. Ask yourself:
- Did I specify the circumstances under which the problem arose?
- Did I specify exactly what happened and what I believe the problem is?
- Have I given enough information so that someone else would be able to reproduce the problem?
Avoid screenshots
Almost always when I see a screenshot of errors that arise during assignments, the issue would have been better described by copy/pasting code and text. Screenshots, as images, are a dead-ends for further analysis.
- If you paste a screenshot with a sequence ID, others will need to type it out, awkwardly, on a different page to reproduce your problem.
- If you paste a screenshot with a piece of code, others will have to type the code, awkwardly, into their code editor to reproduce your problem and experiment for a solution.
- If you paste a screenshot of an error message, it is that much more work to Google for the message and figure out what could have caused it.
In all those cases, you prevent others from helping you quickly and effectively and you are wrong to expect others to type down the contents of your images because you didn't copy/paste the essential material. That's not smart. Also you are wasting other's bandwidth on their computers or mobile devices. That's rude.
The only case where screenshots are encouraged is where an image is involved - but even then, for example when discussing R plots, the code that has generated the plot would be more helpful. dput()
is your friend. And learn to create MWEs (Minimal Working Examples).
Show us that you've done your homework
The "How to Ask Questions the Smart Way" document gives the following excellent advice:
- "Hasty-sounding questions get hasty answers, or none at all. The more you do to demonstrate having put thought and effort into solving your problem before seeking help, the more likely you are to actually get help. [...]
- Never assume you are entitled to an answer. [...] You will earn an answer, if you earn it, by asking a substantial, interesting, and thought-provoking question - one that implicitly contributes to the experience of the community rather than merely passively demanding knowledge from others."
I can't put it any better.
Use mixed case and write full words
Using UPPERCASE ONLY IS THE TYPOGRAPHIC EQUIVALENT OF SHOUTING; this is appropriate only under exceptional circumstances. some people use lowercase only. are they too lazy to find the caps key?
It also looks lik u cant B rly botherd 2 rite if u rite ur txt with textN shorth&.
Don't Troll
Just don't do it, oK?
Also remember: trolling, stalking, impersonating etc. may fall under sanctionable offences of the University's Student Code of Conduct.
No need to address me on the list
Sending a message to the list reaches all list members. That's the point of the list: we are sharing discussions with everyone. There is no need to address anyone in particular (not even your professor), unless you are responding publicly to a specific statement by that person. Even generic salutations - like Howdy or Dear all, are nowadays usually omitted for the sake of brevity.
... and that's not good, because participation on the mailing list documents your engagement which reflects on your participation mark.
Links
Dall'Olio et al. (2011) Ten simple rules for getting help from online scientific communities. PLoS Comput Biol 7:e1002202. (pmid: 21980280) |
- Netiquette
- Virginia Shea's Core Rules of Netiquette
- How to create a Minimal, Complete, and Verifiable example – R advice via stackoverflow.
- How to Ask Questions the Smart Way for the technical minded, excellent advice!
Useful Forums