Team:UCSD Software/Documentation

From 2014.igem.org

(Difference between revisions)
Line 1: Line 1:
-
 
{{Team:UCSD Software/CSS}}
{{Team:UCSD Software/CSS}}
Line 302: Line 301:
}
}
-
#w4 {
 
-
display: none;
 
-
}
 
-
#w5 {
 
-
display: none;
 
-
}
 
-
 
-
#w6 {
 
-
display: none;
 
-
}
 
-
 
-
#w7 {
 
-
display: none;
 
-
}
 
-
 
-
#w8 {
 
-
display: none;
 
-
}
 
-
 
-
#w9 {
 
-
display: none;
 
-
}
 
-
 
-
#w10 {
 
-
display: none;
 
-
}
 
-
 
-
#w11{
 
-
display: none;
 
-
}
 
-
 
-
#w12 {
 
-
display: none;
 
-
}
 
-
 
-
#w13 {
 
-
display: none;
 
-
}
 
-
 
-
#w14 {
 
-
display: none;
 
-
}
 
-
 
-
#w15 {
 
-
display: none;
 
-
}
 
/******************************DEFAULT WIKI SETTINGS CSS: CHANGING IT TO REFLECT OUR OWN PAGE********************
/******************************DEFAULT WIKI SETTINGS CSS: CHANGING IT TO REFLECT OUR OWN PAGE********************
Line 548: Line 501:
             </ul>
             </ul>
           </div>
           </div>
-
</div>
 
-
</div>
 
<div id = "w1">
<div id = "w1">
Line 574: Line 525:
</div>
</div>
-
 
+
</div>
 +
</div>
<script>
<script>

Revision as of 18:51, 17 October 2014


Topics

Tutorial

Provide a comprehensive and well-designed User Guide. (Be creative! An instructional video may work as well.)

API Documentation

Provide detailed API documentation, preferably, automatically built from source code documentation (use tools like doxygen, yard, rdoc, naturaldocs, etc).

Testing

Demonstrate that you followed best practises in software development so that other developers can modify, use and reuse your code. Provide more than one realistic test case. Examples of best practices are automated unit testing and documentation of test coverage, bug tracking facilities, documentation of releases and changes between releases.

Retrieved from "http://2014.igem.org/Team:UCSD_Software/Documentation"