Team:SJTU-Software/Requirement/Notebook

Introduction

This is our time table;

2. Silver

In addition to the Bronze Medal requirements, the following 4 goals must be achieved:

1. Demonstrate the relevance of your development for Synthetic Biology based on standard Parts.
The assessment model in “Easy BBK” are based on the information of standard Parts collected from Registry. In the model, we have taken into consideration 13 attributes of the biobricks and have modified the weight of those attributes to rank the standard Parts in a reliable manner.
Additionally, the components in the “design” part of “Easy BBK” are based on the legend available on Registry. Although a little modification have been made on each component, they are easier to be identified by users.

2. Provide a comprehensive and well-designed User Guide. (Be creative! An instructional video may work as well.)
User Guide is available on this link:

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


4. 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.

3.Gold

In addition to the Bronze and Silver Medal requirements, two additional goals must be achieved:

1. Provide a convincing validation, testing the performance of the development -- experimentally (can be outsourced) or by other teams and users. Note, even if the algorithm or tool turns out not to work that well, the Gold requirement is fulfilled if the test is good and the analysis convincing. Validation may include: preferably experiments, informatics analysis (complexity, run time) of an algorithm, or user studies.

And the second goal can be any one of the following:

1. Make your software interact / interface with the Registry.

2. Re-use and further develop previous iGEM software projects (or parts thereof) or use and/or improvement of existing synthetic biology tools or frameworks.

3. Develop a well documented library or API for other developers (rather than “only” a stand-alone app for end users.)

4. iGEM projects involve important questions beyond the bench, for example relating to (but not limited to) ethics, sustainability, social justice, safety, security, or intellectual property rights. Describe an approach that your team used to address at least one of these questions. Evaluate your approach, including whether it allowed you to answer your question(s), how it influenced the team’s scientific project, and how it might be adapted for others to use (within and beyond iGEM). We encourage thoughtful and creative approaches, and those that draw on past Policy & Practice (formerly Human Practices) activities.