EEE1004: Project Work Instructions

 

Submission Requirements and Deadlines

You are expected to hand in your project documentation to the Reception of the School of Electrical, Electronic and Computer Engineering (Merz Court, 1st Floor) not later than 14.00 Monday, 3 December 2007 (Project "Equivalent Resistance Calculations")

This deadline is strict unless you are specifically notified of a change through your lecturer or practical supervisor, in person or via email. Late submissions will not be accepted (except in exceptional medical or personal circumstances which should be notified through your tutor to your lecturer or practical supervisor before the above deadline).


Project Documentation

The production of documentation is an extremely important part of the programming process.

For your projects you should provide documentation in six sections: (Document should be word processed, with a separate chapter and chapter title for each section.)

  1. Header sheet: containing information about you: Name, Coursecode, Course, Student Number, Date, then start a new page for:
  2. Specification Refinement: brief description of any refinements, assumptions (e.g. about input data) or modifications you have made as a programmer, to the original specification of the problem
  3. Design: the design of your program expressed using the design notation introduced in the lectures (hand-drawn diagrams are acceptable)
  4. Testing: show how you tested the program (see further comments about saving the contents of the bash window in a file) and discuss why you know that it works correctly
  5. Further thoughts: Provide further thoughts on how your program might be improved
  6. Program Listing: This MUST be in a fixed size font (10 pt Courier New) and PROPERLY FORMATTED (as the examples in the notes and according to the style rules), and in a separate section at the end of the document. The program listing looks better if it is oriented and printed in a landscape mode
    Bash text can be copied to your Word Document by selecting the text in the bash window (white selection rectangle appears) and then with text still selected, paste into MS-Word (make sure it is formatted in Courier font as well).

A template for the header sheet is available on the WWW.

This documentation must be word processed, for example, using Microsoft Word. You should aim to have all of the sections above in a single document.

You should use the Format/Font menu items in Microsoft Word to change the font of any cut-and-pasted sections to use 10 point COURIER NEW font. Other text in your documentation should use a font such as "times". If you do not use a font such as courier for the C++ code pasted into a Word document, the document will not correctly show the indentation and layout that your program contains.

Print a copy of your project document. Ensure that all of the sheets of your document remain together. This can be achieved by one of the following (paper clips or folding the corners together are not acceptable):

  1. Stapling all of the sheets together
  2. Placing all of the sheets in a clear A4 plastic file "pocket" (that acts as a bag)
-----------------------

NOTE ABOUT PLAGIARISM

Plagiarism is an attempt to pass someone else's work as your own. This is a serious offence and may result in disciplinary measures being taken against anyone who is found to be plagiarising.
In particular, copying someone else's program code, algorithm design solutions, documentation etc. is seen as examples of plagiarism and will be treated as such with all appropriate consequences, from having a zero mark given for the relevant piece of submitted work to a case raised to the university disciplinary committee. More details on plagiarism can be found here

A. Yakovlev

09/11/2007