----------------
Report templates
----------------

The following documents are available as templates for the project report.
These are intended both to make the report writing easier and to ensure a proper format. 

   eee499-written-report-template-head.doc - Title, Abstract, Acknowledgements, TOC, LOF, LOT, LOS.
   eee499-written-report-template-body.doc - Sections, References, Appendices

Additionally the following Excel file is available for you to create your project plan
(Gantt chart) which should appear in the appendix.

   eee499-written-report-template-plan.xls

Please study the following notes regarding these template files. Ask your supervisor
if you are not sure what to do. Your supervisor may wish to do deviate in some parts
from the format given below, that's ok as long as the result is a well written report.

Note that MS Word is not the only document presentaiton system. If you have plenty of
time(!), and want to use a professional system then Google "Latex"; but beware that it
can take significant time to learn the basics!


1. eee499-written-report-template-head.doc
---------------------------------------------
You will need to leave most of this to last, until the main body of the report is completed.

The title page is not numbered, the remaining pages are numbered in roman numerals starting with "i".
Simply replace the project title, student names, and date. If you are working on a group
project then write the names of all the students.

The abstract and key words pages are in both English and Turkish. Here you include your supervisor's
name and make sure you write the number of pages correctly (the last page number in the body of the report). 

In the Acknowledgements you give thanks and credit to anyone who signficantly helped you through your
project, usually starting with your supervisor and including those who provided you with practical and/or
financial support.

The pages that following are self-explantory. Please make sure you get all the
page/figure/table/citation references complete and correct. It can be quite a
lengthy task to build these associations. If you know MS Word well enough then you
should be able to get the program to build much of this automatically(?).
In a group project you may assign parts of the process to each member to distribute the task.


2. eee499-written-report-template-body.doc
------------------------------------------
This is the main part of the project report. Each section is numbered 1, 2, 3 ... with
subsections numbered 1.1, 1.2, 1.3 ... and 2.1, 2.2, 2.3, and so on. Try not to use
sub-sub-sections. The first section is the "Introduction"  where the subject of the project
is introduced together with some notes about how many students are involved and the division
of tasks. You can also give the results of a literature search in this section or put these
results in a second section if they are extensive.

Remember that the aim of the report is to communicate to others in a clear and concise way
the ideas, procedures and results of your project. The quality of this communication is far
more important than quantity. Please do not include irrelevant or trivial information.

Notes.

- Figures should be clear so please use high quality images. A figure should have a concise
  caption that explains briefly what is being shown. If a figure exists then make sure you
  reference it in the body of the text. If you reference a figure in the body of the text
  then make sure the figure exists!

- Tables, same comment as for Figures.

- Program listings:
  Use "Courier New" for programm listings, format and comment in such a way that the reader
  can easily follow the stucture. For complex programs include a flow diagram.

- Remember to spell-check your document.

- Type neatly; only one space between words, one space after a period, spaces between paragraghs.

- Finally; A report that is not of acceptable standard, according to the supervisor,
  may be rejected by the supervisor without review by the GPC or assessors.
  PLEASE SEEK AND TAKE NOTE OF ADVICE FROM YOUR SUPERVISOR.

For more information see: http://eee499.gantep.edu.tr/written-report.php

Dr Andrew Beddall
04/02/2013