CMPEN 352Lab Write-up Manual

Lab Report:

  1. The lab report is due at the beginning of the next lab period (i.e. one week after the end of the lab).
  2. No report will be accepted after the due date without a valid excuse. The format of your final report must conform to the following specifications.
  3. Lab reports need to be written in 3rd person..

Lab Report Format:

Cover Sheet

Below is the format for the cover sheet. Note, you must include the scoring rubric and basis for evaluation. Space out to fill the complete page.

Laboratory #5

Some Appropriate Title

Perpared by:Sue Student and Joe Student

Course:CMPEN 275

Section:008

Prepared:November 22, 2020

Instructor:Dr. X

Evaluation:

Percentage / Score
Purpose / 10
Procedure / 25
Results / 50
Conclusions / 15

In each section the evaluated based on:

  • Correctness – the results and methods are correct.
  • Grammar – the writing uses proper English.
  • Technical writing - the writing conform to accepted technical writing standards.
  • Logic – the exposition is presented in a logical coherent order.
  • Completeness – the exposition covers all the necessary points.
  • Concise – does not introduce unnecessary topics into discussion.
  • Thoroughness – the writing explores and explains the details of the assignment.

Purpose

In a brief statement, explain the objectives for performing the laboratory. In most cases it will be a statement of the input, output and behavior of the component. If the component is to be realized on hardware, then the method of supplying the input and displaying the output must be mentioned. The behavior of the component should describe how the inputs are transformed into the outputs.

Procedure

The procedure is your plan of attack to achieve the purpose of the lab. In terms of wording tense, it talks about what will be done. You should list the major steps needed to satisfy the requirements of the laboratory exercise. Things like “Write a truth table.”, “Solve the kmap.”, “Write the VHDL code describing the circuit.”, and “Run the testbench.” are the right resolution. Do not describe button pushes in the software. The first step will almost always be “Read and understand the problem statement.” Finally, you should briefly describe the strategy to achieve these objectives. For example, if you are running a testbench then describe how you will identify errors and how they will be approached.

Results

This is the main section of the report where you detail your results. This section should exactly follow the order in the procedure section, showing the results of your work for each item in the procedure. In terms of wording tense, it talks about what was done.

Figures, art work which contains a picture, are always followed by a caption which reads “Figure 5:” followed by a caption which described, in a single sentence, the piece of art. The first figure is numbered “1” with each subsequent figure given the next consecutive number. Note that the label “Figure 5” is bold, while the text in the caption is not.

Listings, snippets of code, are always followed by a caption which reads “Listing 2:” followed by a caption which described, in a single sentence, what the code does. The first listing is numbered “1” with each subsequent listing given the next consecutive number. Only include “code snippets”, fragments of the overall file, which you actually discuss in the body of your report. Finally, you should provide lines numbers in the left margin of the listing so that you can easily draw the reader’s attention to specific portions of the listing. Note that the label “Listing 5” is bold, while the text in the caption is not.

Tables, tabular listings of variables, are always followed by a caption which reads “Table 2:” followed by a caption which described, in a single sentence, what the table describes. The first table is numbered “1” with each subsequent table given the next consecutive number. Note that the label “Table 5” is bold, while the text in the caption is not.

Equations are always put in their own “paragraph”, centered on the page, followed by their equation number in parenthesis. The first equation is numbered “(1)” with each subsequent equation given the next consecutive number.

Every Figure, Table, Listing or Equation (hence forth referred to as “art work”) must be reference in the text of the results section before it’s displayed.

A good heuristic is that each step of the procedure should generate one piece of art work. If your procedure steps require several pieces of art, break the step into smaller pieces. Conversely, if a piece of art covers several steps of the procedure, then combine some of the procedure steps together.

The results section must be written in complete English sentences. You must explain, briefly and perhaps incompletely, how each piece of art work was generated. In most cases this will require references to previously displayed figures. For example, a SOPmin equation is derived from a truth table by solving the associated Kmap. If a piece of art work does not have an explanation of how it was generated, then it should not be included in the report.

The relevant tables and schematics which appear in your pre-lab must be copied, in a corrected form, into the results section – inclusion in the pre-lab does not constitute inclusion in the results section. You can take scans or pictures of schematics in your Prelab and include them as Figures in the body of the results section. Do not do this with truth tables. Art work must be included in-line in the body of the report; the appendix is not to be used for art work.

Conclusion

The conclusion should describe the state of the implementation described in the introduction. This may be a single sentence. The conclusion should also highlight:

  • Technical problems encountered
  • New software tools used
  • New design methodologies learned

If the lab does not work you need to offer possible reasons why.