Report  Guidelines

Due Dates

Report Contents

• Title Page - must to include:
  
  • Project Title
  • Names and/or Student IDs
  • Date the report was submitted
• Abstract - a concise summary of the contents of the lab report. The abstract should appear by itself on the first page after the title page.
• Introduction - a brief description, in your own words, of the lab problem.
• Design Section - describes, in words, the design of your solution. It is recommended that you make reference to appendix items, such as schematic diagrams and VHDL files. This section should be very detailed and descriptive.
  
• Waveforms - should be included in the Appendix of your report. However, there should be a brief description of the waveforms in the body of your report. Your waveforms should be clearly annotated, and testing sequences should be pointed out.
  
• Testing - consists of two parts. You must describe, in the body of your report, the strategy behind your testing sequences (ie. Why are you using this test, and why is this a good test?). Describe your inputs and expected outputs. The second part of testing is the results. Are the results of your simulation, as displayed on the waveforms, what you expected? All of this should be explained in the body of the report, with references made to the annotated waveforms in the Appendix.
  
• Conclusion - summarizes the results of your work. Does your design solve the lab problem?
  
• Appendix - includes waveforms (with annotation), diagrams, schematics, VHDL files and other such items. A list of items expected in the Appendix will be included in each lab handout. All appendix items should be clearly labelled, and, in the case of diagrams, neatly drawn. If a diagram is handdrawn, it must be drawn using a straight edge, preferably on graph paper or engg paper.
  

Report Format and Presentation

• Lab reports must be typed. Handwritten reports will not be accepted. Handwritten additions to the appendix materials are acceptable, provided the writing is clear and legible.
• Use page numbering, a table of contents is useless without page numbers.
• The style of the lab reports should be formal. Terms such as "I" or "we" should not be used.
• Spend time developing the flow of your report. Its readability will have a strong influence on how well it is received (translation: easier to read, easier to mark, higher mark).
• Check your spelling and grammar. The spell checker exists for a purpose, use it.
• All appendix items should be clearly labelled, and, in the case of diagrams, neatly drawn. If a diagram is handdrawn, it must be drawn using a straight edge, preferably on graph paper or engg paper.
• The names and ID numbers of your group members must be included in each VHDL file (ie typed into the file header) included with your report.
• Waveform annotations should be useful and should include a title for the diagram, explanations of special conditions, etc. Don't go overboard and make the waveforms hard to understand due to the barrage of comments on the printout.

Marking and Major Deductions

• A report without required VHDL files will be deducted 25% of the report mark.
• Late reports are deducted 10% of the report mark per day, up to a maxium of 3 days (30%). Reports more than 3 days late will not be accepted.
  
• Failing to include your names and ID#'s in all of your VHDL files will result in a deduction of10% of the report mark.
• No annotations on your waveforms will result in a mark only for handing in paper ('1' for each waveform).