32.8 PROJECT REPORT

---

Purpose: A project report allows the developer or team to document all of the design decisions made during the course of the project. This report should also mention avenues not taken. Quite often the projects that we start will be handed off to others after a period of time. In many cases they will not have the opportunity to talk to us, or we may not have the time. These reports serve as a well known, central document that gathers all relevant information.

Writing Strategy:

1. Do the report exhibits (figures, tables, equations) first and then do the writing.

2. Define the goals for the project clearly in bullet point form.

3. Examine available options and also add these in bullet point form.

4. Start to examine engineering aspects of the options.

5. Make engineering decisions, and add bullet point form to the document.

6. As work continues on the project add notes and figures.

7. When the project is complete, convert the bullet point form to full text.

8. Proof read and edit.

The required project report elements are:

Title page

- title of project

- department/company (i.e., university) name

- course/name

- author list

- date of submission

Executive Summary/Overview

- the purpose is to let people know if they want to read the report

- write it last after all the details are done

- briefly describe the purpose of the work

- what were the results, be detailed

- given numbers

- keep it short

Nomenclature

- list all variables used in the report

- put in alphabetical order, with upper case first

- list Greek and other variables separately

Table of contents

- list all major sections, and minor sections to a reasonable level

- list page numbers

- right justify the numbers

Introduction

- if you must include this section, it should be brief

- the introduction is expected to outline details to be discussed in the report.

Body......

Appendices......