Difference between revisions of "Team:Toronto/Parts"

Line 1: Line 1:
 
{{Toronto/head}}
 
{{Toronto/head}}
−
<html>
 
  
 
<h2> Part Documentation</h2>
 
<h2> Part Documentation</h2>
  
−
<p>Each team will make new parts during iGEM and will submit them to the Registry of Standard Biological Parts. The iGEM software provides an easy way to present the parts your team has created. The <code>&lt;groupparts&gt;</code> tag (see below) will generate a table with all of the parts that your team adds to your team sandbox.</p>
+
<p>Each team will make new parts during iGEM and will submit them to the Registry of Standard Biological Parts. The iGEM software provides an easy way to present the parts your team has created. The
−
<p>Remember that the goal of proper part documentation is to describe and define a part, so that it can be used without needing to refer to the primary literature. Registry users in future years should be able to read your documentation and be able to use the part successfully. Also, you should provide proper references to acknowledge previous authors and to provide for users who wish to know more.</p>
+
    <code>&lt;groupparts&gt;</code> tag (see below) will generate a table with all of the parts that your team adds to your team sandbox.</p>
 +
<p>Remember that the goal of proper part documentation is to describe and define a part, so that it can be used without needing to refer to the primary literature. Registry users in future years should be able to read your documentation and be able to use
 +
    the part successfully. Also, you should provide proper references to acknowledge previous authors and to provide for users who wish to know more.</p>
  
  
 
<div class="highlightBox">
 
<div class="highlightBox">
−
<h4>Note</h4>
+
    <h4>Note</h4>
−
<p>Note that parts must be documented on the <a href="http://parts.igem.org/Main_Page"> Registry</a>. This page serves to <i>showcase</i> the parts you have made. Future teams and other users and are much more likely to find parts by looking in the Registry than by looking at your team wiki.</p>
+
    <p>Note that parts must be documented on the <a href="http://parts.igem.org/Main_Page"> Registry</a>. This page serves to <i>showcase</i> the parts you have made. Future teams and other users and are much more likely to find parts by looking in the Registry
 +
        than by looking at your team wiki.</p>
 
</div>
 
</div>
  
Line 17: Line 19:
 
<h4>Adding parts to the registry</h4>
 
<h4>Adding parts to the registry</h4>
 
<p>You can add parts to the Registry at our <a href="http://parts.igem.org/Add_a_Part_to_the_Registry">Add a Part to the Registry</a> link.</p>
 
<p>You can add parts to the Registry at our <a href="http://parts.igem.org/Add_a_Part_to_the_Registry">Add a Part to the Registry</a> link.</p>
−
<p>We encourage teams to start completing documentation for their parts on the Registry as soon as you have it available. The sooner you put up your parts, the better you will remember all the details about your parts. Remember, you don't need to send us the DNA sample before you create an entry for a part on the Registry. (However, you <b>do</b> need to send us the DNA sample before the Jamboree. If you don't send us a DNA sample of a part, that part will not be eligible for awards and medal criteria.)</p>
+
<p>We encourage teams to start completing documentation for their parts on the Registry as soon as you have it available. The sooner you put up your parts, the better you will remember all the details about your parts. Remember, you don&#39;t need to send us
 +
    the DNA sample before you create an entry for a part on the Registry. (However, you <b>do</b> need to send us the DNA sample before the Jamboree. If you don&#39;t send us a DNA sample of a part, that part will not be eligible for awards and medal criteria.)</p>
  
  
Line 23: Line 26:
 
<p>The information needed to initially create a part on the Registry is:</p>
 
<p>The information needed to initially create a part on the Registry is:</p>
 
<ul>
 
<ul>
−
<li>Part Name</li>
+
    <li>Part Name</li>
−
<li>Part type</li>
+
    <li>Part type</li>
−
<li>Creator</li>
+
    <li>Creator</li>
−
<li>Sequence</li>
+
    <li>Sequence</li>
−
<li>Short Description (60 characters on what the DNA does)</li>
+
    <li>Short Description (60 characters on what the DNA does)</li>
−
<li>Long Description (Longer description of what the DNA does)</li>
+
    <li>Long Description (Longer description of what the DNA does)</li>
−
<li>Design considerations</li>
+
    <li>Design considerations</li>
 
</ul>
 
</ul>
  
 
<p>
 
<p>
−
We encourage you to put up <em>much more</em> information as you gather it over the summer. If you have images, plots, characterization data and other information, please also put it up on the part page. </p>
+
    We encourage you to put up
 +
    <em>much more</em> information as you gather it over the summer. If you have images, plots, characterization data and other information, please also put it up on the part page. </p>
  
  
Line 41: Line 45:
  
 
<h4>Inspiration</h4>
 
<h4>Inspiration</h4>
−
<p>We have a created a <a href="http://parts.igem.org/Well_Documented_Parts">collection of well documented parts</a> that can help you get started.</p>
+
<p>We have a created a <a href="http://parts.igem.org/Well_Documented_Parts">collection of well documented parts</a> that can help you get started.</p>
  
 
<p> You can also take a look at how other teams have documented their parts in their wiki:</p>
 
<p> You can also take a look at how other teams have documented their parts in their wiki:</p>
 
<ul>
 
<ul>
−
<li><a href="https://2014.igem.org/Team:MIT/Parts"> 2014 MIT </a></li>
+
    <li><a href="https://2014.igem.org/Team:MIT/Parts"> 2014 MIT </a></li>
−
<li><a href="https://2014.igem.org/Team:Heidelberg/Parts"> 2014 Heidelberg</a></li>
+
    <li><a href="https://2014.igem.org/Team:Heidelberg/Parts"> 2014 Heidelberg</a></li>
−
<li><a href="https://2014.igem.org/Team:Tokyo_Tech/Parts">2014 Tokyo Tech</a></li>
+
    <li><a href="https://2014.igem.org/Team:Tokyo_Tech/Parts">2014 Tokyo Tech</a></li>
 
</ul>
 
</ul>
  
Line 53: Line 57:
  
 
<h4>Part Table </h4>
 
<h4>Part Table </h4>
−
</html>
+
 
−
<groupparts>iGEM015 Example</groupparts>
+
<p></html></p>
 +
<p><groupparts>iGEM015 Example</groupparts></p>
 
<html>
 
<html>
  
  
−
 
+
{{Toronto/footer}}
−
</div>
+
−
</html>
+

Revision as of 15:26, 2 September 2015

Part Documentation

Each team will make new parts during iGEM and will submit them to the Registry of Standard Biological Parts. The iGEM software provides an easy way to present the parts your team has created. The <groupparts> tag (see below) will generate a table with all of the parts that your team adds to your team sandbox.

Remember that the goal of proper part documentation is to describe and define a part, so that it can be used without needing to refer to the primary literature. Registry users in future years should be able to read your documentation and be able to use the part successfully. Also, you should provide proper references to acknowledge previous authors and to provide for users who wish to know more.


Note

Note that parts must be documented on the <a href="http://parts.igem.org/Main_Page"> Registry</a>. This page serves to showcase the parts you have made. Future teams and other users and are much more likely to find parts by looking in the Registry than by looking at your team wiki.


Adding parts to the registry

You can add parts to the Registry at our <a href="http://parts.igem.org/Add_a_Part_to_the_Registry">Add a Part to the Registry</a> link.

We encourage teams to start completing documentation for their parts on the Registry as soon as you have it available. The sooner you put up your parts, the better you will remember all the details about your parts. Remember, you don't need to send us the DNA sample before you create an entry for a part on the Registry. (However, you do need to send us the DNA sample before the Jamboree. If you don't send us a DNA sample of a part, that part will not be eligible for awards and medal criteria.)


What information do I need to start putting my parts on the Registry?

The information needed to initially create a part on the Registry is:

  • Part Name
  • Part type
  • Creator
  • Sequence
  • Short Description (60 characters on what the DNA does)
  • Long Description (Longer description of what the DNA does)
  • Design considerations

We encourage you to put up much more information as you gather it over the summer. If you have images, plots, characterization data and other information, please also put it up on the part page.




Inspiration

We have a created a <a href="http://parts.igem.org/Well_Documented_Parts">collection of well documented parts</a> that can help you get started.

You can also take a look at how other teams have documented their parts in their wiki:


Part Table

</html>

<groupparts>iGEM015 Example</groupparts>

{{Toronto/footer}}