Team:UCSD Software/Documentation

From 2014.igem.org

(Difference between revisions)
Line 1: Line 1:
-
Provide detailed API documentation, preferably, automatically built from source code documentation (use tools like doxygen, yard, rdoc, naturaldocs, etc).
 
-
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.
 
-
Provide a comprehensive and well-designed User Guide. (Be creative! An instructional video may work as well.)
 
Line 551: Line 548:
             </ul>
             </ul>
           </div>
           </div>
-
          <div class = "col-md-9"><h2 class = "text-center">Description</h2>
+
</div>
-
 
+
</div>
<div id = "w1">
<div id = "w1">
<h3 class = "text-center"><b>Tutorial</b></h3>
<h3 class = "text-center"><b>Tutorial</b></h3>
-
Tutroial
+
Provide a comprehensive and well-designed User Guide. (Be creative! An instructional video may work as well.)
</div>
</div>
-
             
+
 
-
             
+
 
-
        </div>
+
<div id = "w2">
-
    </div>
+
 
 +
<h3 class = "text-center"><b>API Documentation</b></h3>
 +
Provide detailed API documentation, preferably, automatically built from source code documentation (use tools like doxygen, yard, rdoc, naturaldocs, etc).
 +
 
</div>
</div>
 +
 +
 +
<div id = "w3">
 +
 +
<h3 class = "text-center"><b>Testing</b></h3>
 +
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.
 +
 +
 +
</div>
 +
 +
<script>
<script>

Revision as of 18:49, 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"