"
Team:UCSD Software/Documentation
From 2014.igem.org
(Difference between revisions)
Jenhantao (Talk | contribs)
(Created page with "Provide detailed API documentation, preferably, automatically built from source code documentation (use tools like doxygen, yard, rdoc, naturaldocs, etc). Demonstrate that you fo...")
Newer edit →
(Created page with "Provide detailed API documentation, preferably, automatically built from source code documentation (use tools like doxygen, yard, rdoc, naturaldocs, etc). Demonstrate that you fo...")
Newer edit →
Revision as of 17:41, 17 October 2014
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.)
