Tips for writeups (CSE 260, Winter 2008)

Changelog

Date Description
3-Feb-08 Original posting

General guidelines

Your report should thoroughly discuss any goals, methods, speculation, hypotheses, and reflection. Provide a running commentary of your observations, noting any trends, or interesting, unusual, or anomalous behavior. State the facts, even if they are obvious. Offer explanations for the observations as best you can.

Be sure to include tabular data along with your plots. Large tables of data (more than about 1/2 page) or your raw data should appear as files in the electronic turnin (see below). Put related information together in the same plot or table. Number the figures and tables. Remember that many readers will see a Black and White version of the paper you write, especially the referees! Are the effects you want to present in color still visible in monochrome? If not, think about how to redesign the figures so they will be.

If you wrote code, present a clear evaluation of its design, including bottlenecks of the implementation. Describe any special coding or tuned parameters. Use code fragments (pseudocode is helpful) as illustrations. Provide all source code in the electronic turnin, including Makefiles and the scripts you used to submit your jobs, as well as all provided code (it should be possible to build an executable using make or gmake) Document any changes you made to any provided code.

Your report should cite any written works or software as appropriate in the text of the report. Citations should include any software you used that was written by someone else, or that was written by you for purposes other than this class.

Electronic vs. hard copy

Put code fragments in the hard copy version of your report, full listings in the electronic version. For tabular data: small tables (about 1/2 page or less) in the main test of the report, larger tables either in an appendix at the end or in the electronic turnin. Raw data should appear in the electronic version.

Units of measurements

When discussing computation rates, or communication rates, the following conventions may be helpful.

  • The symbol `B' designates bytes, `b' bits.
  • Capitalized units (e.g. K,M,G,T) represent powers of two, whereas units in lower case (resp. k, m, g, t) represents powers of ten. For example, 8K represents 8 × 210, 8k represents 8 × 103
  • It follows that, n gBps represents n × 109 bytes per second, n Gbps represents n × 230 bits per second. (Discussion due to Alden King).


    Copyright © 2008  Scott B. Baden. Last modified: 02/3/08 11:08 AM