Difference between revisions of "FND-Technical questions"

From "A B C"
Jump to navigation Jump to search
m (Created page with "<div id="BIO"> <div class="b1"> Technical Questions </div> {{Vspace}} <div class="keywords"> <b>Keywords:</b>  HInts for asking technical questions on mailing l...")
 
m
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<div id="BIO">
+
<div id="ABC">
−
  <div class="b1">
+
<div style="padding:5px; border:1px solid #000000; background-color:#b3dbce; font-size:300%; font-weight:400; color: #000000; width:100%;">
 
Technical Questions
 
Technical Questions
−
  </div>
+
<div style="padding:5px; margin-top:20px; margin-bottom:10px; background-color:#b3dbce; font-size:30%; font-weight:200; color: #000000; ">
−
 
+
(HInts for asking technical questions on mailing lists and forums)
−
  {{Vspace}}
+
</div>
−
 
 
−
<div class="keywords">
 
−
<b>Keywords:</b>&nbsp;
 
−
HInts for asking technical questions on mailing lists and forums
 
 
</div>
 
</div>
  
−
{{Vspace}}
+
{{Smallvspace}}
−
 
 
−
 
 
−
__TOC__
 
−
 
 
−
{{Vspace}}
 
−
 
 
−
 
 
−
{{DEV}}
 
−
 
 
−
{{Vspace}}
 
  
  
 +
<div style="padding:5px; border:1px solid #000000; background-color:#b3dbce33; font-size:85%;">
 +
<div style="font-size:118%;">
 +
<b>Abstract:</b><br />
 +
<section begin=abstract />
 +
We all depend on others' insights and help to get computing done. But there are <b>good ways</b> to ask technical questions, that will lead to quick and useful answers, and other ways...
 +
<section end=abstract />
 
</div>
 
</div>
−
<div id="ABC-unit-framework">
+
<!-- ============================  -->
−
== Abstract ==
+
<hr>
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "abstract" -->
+
<table>
−
We all depend on others' insights and help to get computing done. But there are <b>good ways</b> to ask technical questions, that will lead to quick and useful answers, and other ways...
+
<tr>
−
 
+
<td style="padding:10px;">
−
{{Vspace}}
+
<b>Objectives:</b><br />
−
 
+
This unit will ...
−
 
+
* ... direct you to three documents that discuss strategies for asking technical questions;
−
== This unit ... ==
+
</td>
−
=== Prerequisites ===
+
<td style="padding:10px;">
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "prerequisites" -->
+
<b>Outcomes:</b><br />
−
<!-- included from "ABC-unit_components.wtxt", section: "notes-external_prerequisites" -->
+
After working through this unit you ...
−
You need the following preparation before beginning this unit. If you are not familiar with this material from courses you took previously, you need to prepare yourself from other information sources:
+
* ... are familar with effective strategies for asking technical questions;
−
<!-- included from "FND-prerequisites.wtxt", section: "writing" -->
+
* ... understand the importance of MWE's (Minimal Working Examples);
 +
* ... have begun to model these principles in your own work for this course and elsewhere.
 +
</td>
 +
</tr>
 +
</table>
 +
<!-- ============================ -->
 +
<hr>
 +
<b>Deliverables:</b><br />
 +
<section begin=deliverables />
 +
<ul>
 +
<li><b>Time management</b>: Before you begin, estimate how long it will take you to complete this unit. Then, record in your course journal: the number of hours you estimated, the number of hours you worked on the unit, and the amount of time that passed between start and completion of this unit.</li>
 +
<li><b>Journal</b>: Document your progress in your [[FND-Journal|Course Journal]]. Some tasks may ask you to include specific items in your journal. Don't overlook these.</li>
 +
<li><b>Insights</b>: If you find something particularly noteworthy about this unit, make a note in your [[ABC-Insights|'''insights!''' page]].</li>
 +
</ul>
 +
<section end=deliverables />
 +
<!-- ============================  -->
 +
<hr>
 +
<section begin=prerequisites />
 +
<b>Prerequisites:</b><br />
 +
You need the following preparation before beginning this unit. If you are not familiar with this material from courses you took previously, you need to prepare yourself from other information sources:<br />
 
*<b>Writing</b>: Basic essay and report writing skills. How to format your submitted materials, how to quote, cite and avoid plagiarism.
 
*<b>Writing</b>: Basic essay and report writing skills. How to format your submitted materials, how to quote, cite and avoid plagiarism.
 +
<section end=prerequisites />
 +
<!-- ============================  -->
 +
</div>
  
−
{{Vspace}}
+
{{Smallvspace}}
−
 
 
  
−
=== Objectives ===
 
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "objectives" -->
 
−
...
 
  
−
{{Vspace}}
 
  
 +
{{Smallvspace}}
  
−
=== Outcomes ===
 
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "outcomes" -->
 
−
...
 
  
−
{{Vspace}}
+
__TOC__
−
 
 
−
 
 
−
=== Deliverables ===
 
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "deliverables" -->
 
−
<!-- included from "ABC-unit_components.wtxt", section: "deliverables-time_management" -->
 
−
*<b>Time management</b>: Before you begin, estimate how long it will take you to complete this unit. Then, record in your course journal: the number of hours you estimated, the number of hours you worked on the unit, and the amount of time that passed between start and completion of this unit.
 
−
<!-- included from "ABC-unit_components.wtxt", section: "deliverables-journal" -->
 
−
*<b>Journal</b>: Document your progress in your [[FND-Journal|course journal]].
 
−
<!-- included from "ABC-unit_components.wtxt", section: "deliverables-insights" -->
 
−
*<b>Insights</b>: If you find something particularly noteworthy about this unit, make a note in your [[ABC-Insights|insights! page]].
 
  
 
{{Vspace}}
 
{{Vspace}}
Line 71: Line 68:
  
 
=== Evaluation ===
 
=== Evaluation ===
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "evaluation" -->
 
−
<!-- included from "ABC-unit_components.wtxt", section: "eval-none" -->
 
 
<b>Evaluation: NA</b><br />
 
<b>Evaluation: NA</b><br />
−
:This unit is not evaluated for course marks.
+
<div style="margin-left: 2rem;">This unit is not evaluated for course marks.</div>
−
 
 
−
{{Vspace}}
 
−
 
 
−
 
 
−
</div>
 
−
<div id="BIO">
 
 
== Contents ==
 
== Contents ==
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "contents" -->
 
 
{{Task|1=
 
{{Task|1=
 
Study the following three documents:
 
Study the following three documents:
−
* [https://www.r-project.org/posting-guide.html ''the R Help Mailing list posting guide'']
+
<ul>
−
* [http://stackoverflow.com/help/mcve ''How to create a Minimal, Complete, and Verifiable example''] – '''R''' advice via stack'''overflow'''.
+
<li>[https://www.r-project.org/posting-guide.html ''the R Help Mailing list posting guide'']</li>
−
* [http://www.catb.org/~esr/faqs/smart-questions.html ''How to Ask Questions the Smart Way''] <small>for the technical minded, excellent advice!</small>
+
<li>[http://stackoverflow.com/help/mcve ''How to create a Minimal, Complete, and Verifiable example''] – '''R''' advice via stack'''overflow'''.</li>
−
 
+
<li>[http://www.catb.org/~esr/faqs/smart-questions.html ''How to Ask Questions the Smart Way''] <small>for the technical minded, excellent advice!</small></li>
 +
</ul>
 
}}
 
}}
  
Line 96: Line 85:
 
{{Vspace}}
 
{{Vspace}}
  
−
 
−
== Further reading, links and resources ==
 
−
<!-- {{#pmid: 19957275}} -->
 
−
<!-- {{WWW|WWW_GMOD}} -->
 
−
<!-- <div class="reference-box">[http://www.ncbi.nlm.nih.gov]</div> -->
 
−
 
−
{{Vspace}}
 
−
 
−
 
−
== Notes ==
 
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "notes" -->
 
−
<!-- included from "ABC-unit_components.wtxt", section: "notes" -->
 
−
<references />
 
−
 
−
{{Vspace}}
 
−
 
−
 
−
</div>
 
−
<div id="ABC-unit-framework">
 
−
== Self-evaluation ==
 
−
<!-- included from "../components/FND-Technical_questions.components.wtxt", section: "self-evaluation" -->
 
−
<!--
 
−
=== Question 1===
 
−
 
−
Question ...
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
 
−
Answer ...
 
−
<div class="mw-collapsible-content">
 
−
Answer ...
 
−
 
−
</div>
 
−
  </div>
 
−
 
−
  {{Vspace}}
 
−
 
−
-->
 
−
 
−
{{Vspace}}
 
−
 
−
 
−
 
−
{{Vspace}}
 
−
 
−
 
−
<!-- included from "ABC-unit_components.wtxt", section: "ABC-unit_ask" -->
 
−
 
−
----
 
−
 
−
{{Vspace}}
 
−
 
−
<b>If in doubt, ask!</b> If anything about this learning unit is not clear to you, do not proceed blindly but ask for clarification. Post your question on the course mailing list: others are likely to have similar problems. Or send an email to your instructor.
 
−
 
−
----
 
−
 
−
{{Vspace}}
 
  
 
<div class="about">
 
<div class="about">
Line 161: Line 94:
 
:2017-08-05
 
:2017-08-05
 
<b>Modified:</b><br />
 
<b>Modified:</b><br />
−
:2017-08-17
+
:2020-09-17
 
<b>Version:</b><br />
 
<b>Version:</b><br />
−
:0.2
+
:1.1
 
<b>Version history:</b><br />
 
<b>Version history:</b><br />
−
*0.2 Under development
+
*1.1 Maintenance
−
*0.1 First stub
+
*1.0 Completed to first live version
 +
*0.1 Material collected from previous assignments
 
</div>
 
</div>
−
[[Category:ABC-units]]
 
−
<!-- included from "ABC-unit_components.wtxt", section: "ABC-unit_footer" -->
 
  
 
{{CC-BY}}
 
{{CC-BY}}
  
 +
[[Category:ABC-units]]
 +
{{UNIT}}
 +
{{LIVE}}
 
</div>
 
</div>
 
<!-- [END] -->
 
<!-- [END] -->

Latest revision as of 09:28, 25 September 2020

Technical Questions

(HInts for asking technical questions on mailing lists and forums)


 


Abstract:

We all depend on others' insights and help to get computing done. But there are good ways to ask technical questions, that will lead to quick and useful answers, and other ways...

Objectives:
This unit will ...

  • ... direct you to three documents that discuss strategies for asking technical questions;

Outcomes:
After working through this unit you ...

  • ... are familar with effective strategies for asking technical questions;
  • ... understand the importance of MWE's (Minimal Working Examples);
  • ... have begun to model these principles in your own work for this course and elsewhere.

Deliverables:

  • Time management: Before you begin, estimate how long it will take you to complete this unit. Then, record in your course journal: the number of hours you estimated, the number of hours you worked on the unit, and the amount of time that passed between start and completion of this unit.
  • Journal: Document your progress in your Course Journal. Some tasks may ask you to include specific items in your journal. Don't overlook these.
  • Insights: If you find something particularly noteworthy about this unit, make a note in your insights! page.

Prerequisites:
You need the following preparation before beginning this unit. If you are not familiar with this material from courses you took previously, you need to prepare yourself from other information sources:

  • Writing: Basic essay and report writing skills. How to format your submitted materials, how to quote, cite and avoid plagiarism.


 



 



 


Evaluation

Evaluation: NA

This unit is not evaluated for course marks.

Contents

Task:
Study the following three documents:

If you follow this advice, you can't go wrong.


 


About ...
 
Author:

Boris Steipe <boris.steipe@utoronto.ca>

Created:

2017-08-05

Modified:

2020-09-17

Version:

1.1

Version history:

  • 1.1 Maintenance
  • 1.0 Completed to first live version
  • 0.1 Material collected from previous assignments

CreativeCommonsBy.png This copyrighted material is licensed under a Creative Commons Attribution 4.0 International License. Follow the link to learn more.

Retrieved from "http://steipe.biochemistry.utoronto.ca/abc/index.php?title=FND-Technical_questions&oldid=11732"