Difference between revisions of "RSBP Draft Documentation Standards"
| Line 2: | Line 2: | ||
| − | ==''' | + | =='''RSBP Documentation Requirements for [[All Parts]]'''== |
===ESSENTIAL ITEMS=== | ===ESSENTIAL ITEMS=== | ||
| − | ==== | + | ====Main Page (What is it?)==== |
| − | 0. Designer | + | 0. Designer and affiliation. (research laboratory, iGEM team or company) |
1. Part number. (equivalent to an “Accession number”) | 1. Part number. (equivalent to an “Accession number”) | ||
| − | 2. Short name. ( | + | 2. Short name. ("nickname") |
| − | 3. Extended name. ( | + | 3. Extended name. (formal title) |
| − | 4. Origin (biological species | + | 4. Origin (biological species or synthetic/designed). |
5. A short abstract that tells (a) what the part does (function), (b) how it works (mechanism) and (c) why you made it (purpose). | 5. A short abstract that tells (a) what the part does (function), (b) how it works (mechanism) and (c) why you made it (purpose). | ||
| Line 26: | Line 26: | ||
====B. Design Page (How did you make it?)==== | ====B. Design Page (How did you make it?)==== | ||
| − | 7. Raison d’être for constructing the part. Links to related parts from the same project. [Details in addition to those under items (5) and (6).] | + | 7. Raison d’être for constructing the part. Links to related parts from the same project. [Details in addition to those given above under items (5) and (6).] |
| − | 8. DNA sequence | + | 8. DNA sequence (including ends if they are not proper BioBrick prefix and suffix)) |
9. Primers used (if part was created using PCR). | 9. Primers used (if part was created using PCR). | ||
| Line 71: | Line 71: | ||
2. Figures relating to the function and/or physical characteristics of the part. (Include forward and reverse efficiencies if known.) | 2. Figures relating to the function and/or physical characteristics of the part. (Include forward and reverse efficiencies if known.) | ||
| − | Experience Page | + | ====Experience Page==== |
3. Tables of measurements. | 3. Tables of measurements. | ||
Revision as of 19:21, 13 March 2008
This page summarizes the content needed for a well-documented basic part. Section I lists the information needed for all parts [in two categories: (1)essential items, and (2) possible enhancements]. Sections II-...
RSBP Documentation Requirements for All Parts
ESSENTIAL ITEMS
Main Page (What is it?)
0. Designer and affiliation. (research laboratory, iGEM team or company)
1. Part number. (equivalent to an “Accession number”)
2. Short name. ("nickname")
3. Extended name. (formal title)
4. Origin (biological species or synthetic/designed).
5. A short abstract that tells (a) what the part does (function), (b) how it works (mechanism) and (c) why you made it (purpose).
6. Dependencies: other parts, special materials, chassis, etc.
B. Design Page (How did you make it?)
7. Raison d’être for constructing the part. Links to related parts from the same project. [Details in addition to those given above under items (5) and (6).]
8. DNA sequence (including ends if they are not proper BioBrick prefix and suffix))
9. Primers used (if part was created using PCR).
10. Synthesis details (if part was created by DNA synthesis).
11. Special design features: (a) insertion/removal of BioBrick cloning sites, (b) codon optimization, (c) reverse orientation, (d) added tags…
13. Graphical sequence bar with all appropriate feature annotations.
14. One-to-three (possibly more for composite parts, devices and systems) references to literature on the part’s biological function and uses in synthetic biology. Frequently there is a key reference reporting on the first use or design of a modified version of the protein (see entries under “Reporters”). If no published references are available, cite other sources used (such as online, open-access textbooks, Open Wetware pages, etc.)
15. Difficulties/pitfalls encountered in the design process. Unworkable designs, necessary revisions etc. If everything worked exactly as planned, say so!
16. List all applicable patents and materials transfer agreements (MTAs). [Give link to disclaimer page on IP & iGEM issues.]
C. Experience Page (How well does it work?)
17. Summary of actual applications to date in originating laboratory.
18. Measurements or tests of part. Include efficiency.
19. Uploaded data, figures etc. can be put on the Registry wiki and linked here.
D. Hard Information Page (Reference data)
20. Sequence (FASTA format).
21. Exact source of the original sequence(s) used to construct the part. GenBank accession number (“VERSION”) and/or “GI” (aka “gi”) number if available. Otherwise any available published sequence or other source of information, including experimental sequence reads (which can be put on the Registry wiki and linked here).
22. More features (exact details of modified sequences).
POSSIBLE ENHANCEMENTS
(Liven it up, use visual materials!)
Main Page
1. Structure cartoon(s). PDB_IDs.
2. Figures relating to the function and/or physical characteristics of the part. (Include forward and reverse efficiencies if known.)
Experience Page
3. Tables of measurements.
4. Figures depicting functional output.
5. Links to additional databases.