project report guidelines 2011

8/6/2019 Project Report Guidelines 2011

1/21

PROJECT REPORT

GUIDELINESMechatronics Program MIJ130S/MIJ230S

K.Wolff

2011


2/21

INTRODUCTORY NOTE

At the end of semesters 5 and 6, Mechatronics

students are required to present project reports

detailing their work.

It is very important to understand that as each

project is different, so is its report!

However, there are a few practices common to

ALL reports.

This guideline is not meant to be taken as the

only form, but it highlights what MUST be in any

project report.


3/21

GENERAL RULE

Why

What

WhoWhere

When

HowYou need to constantly ask yourself these questions atevery stage, because these are the kinds of questionsyour assessors may ask about your project. Keep anote of you Q&A processes in a project notebook!


4/21

THE PURPOSE OF YOUR REPORT

The purpose of your report is to prove that you meet

the requirements for an Engineering Technician.

A person achieving this qualification will be able to:

Competently apply an integration of theory, principles, proventechniques, practical experience and appropriate skills to the solution ofwell defined problems in the field of engineering while operating within therelevant standards and codes.

Demonstrate well-rounded general engineering knowledge, as well assystematic knowledge, of the main terms, procedures, principles and operationsof one of the disciplines of engineering.

Gather evidence from primary sources and journals using advanced retrievalskills, and organize, synthesize and present the information professionally in amode appropriate to the audience.

Apply the knowledge gained to new situations, both concrete andabstract, in the workplace/community.

Identify, analyze, conduct and manage a project.

Make independent decisions/judgments taking into account the relevanttechnical, economic, social and environmental factors.

Work independently, as a member of a team, and as a team leader.

Relate engineering activity to health, safety and environment, cultural, andeconomic sustainability.


5/21

THE REPORT FORMATTABLE OF CONTENTS

Page

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i

Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii

Illustrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Symbols and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Contents Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

1. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2. DEFINITION OF PROBLEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22.1Problem Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22.2 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2.3 Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2.4 Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

3. SOLUTION SPECIFICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

4. CONCEPT FORMATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

BODY OF REPORT DEPENDS ON NATURE OF PROJECT 4.1 Concept A. . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

4.2 Concept B . . . . . . . . . . . . . . . . .

5. CONCLUSION /RECOMMENDATIONS. . . . . . . . . . . . . . . . . . . 16

6. REFERENCES/BIBLIOGRAPHY. . . . . . . . . . . . . . . . . . . . . . . . . .19

APPENDIX A: Project Brief/Proposal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

APPENDIX B: Detailed Views / Rendered Scenes . . . . . . . . . . . . . . . . . . . . B-1

APPENDIX C: Extra Technical Specifications . . . . . . . . . . . . . . . . . . . . . . . C-1


6/21

WRITING THE REPORT: THE SUMMARY

Is written at the end, but placed at the beginning!!! It is NOT theintroduction!

(A busy manager who might not have time to read the full reportshould be able to get the gist of the whole report by reading thesummary.)

The summary: states the topic of the report

outlines your approach to the task if applicable

gives the most important findings of your research orinvestigation, or the key aspects of your design

states the main outcomes or conclusions.

The summary does NOT:

provide general background information

explain why you are doing the research, investigation ordesign

refer to later diagrams or references.


7/21

SUMMARY- EXAMPLE

This report presents a design for abridge to be constructed on theCalder Freeway crossingSlaty Creek in the Shire ofMacedon Ranges. Two designsfor the bridge were devised andthen compared by considering thecost, construction andmaintenance of each bridge.Design 1 is a super-T beambridge while Design 2 is asimple composite I girder

bridge. It is concluded thatDesign 1 is the better design.This design is cheaper, easier toconstruct, more durable andeasier to maintain.

Topic

Context

Approach

Key Aspects

Main

Outcome


8/21

WRITING THE REPORT:

THE INTRODUCTION

The introduction can be sub-divided into 1.1, 1.2 etcand includes:

the background to the topic of your report to set yourwork in its broad context (eg. Company & nature ofits business)

a clear statement of the purpose of the report, usuallyto present the results of your research, investigation,or design (evidence of YOUR WPL experience andtechnical application of knowledge)

a clear statement of the aims of the project. Anoverall description of the project (eg machinebuilding/ designing a control system) and a clearindication of the students responsibilities!

technical background necessary to understand thereport; e.g. theory or assumptions.

An outline of the structure of the report: what are youpresenting, in what order and with what evidence.


9/21

INTRODUCTION - EXAMPLE

1. INTRODUCTION

A dual carriageway bridge with two traffic lanes ineach direction is to be constructed on the Calder

Freeway crossing Slaty Creek in the Shire of

Macedon Ranges in Victoria.As a result of an

increase in local industry development in the

region, the current single lane wooden bridge can

no longer accommodate the increase in traffic. The

new bridge is to span 125 metres between man-made compacted fill embankments, and is

approximately 15 metres above the river surface,

with a grade of 0.056 m/m.

This report presents two possible concept designs for

the bridge. In evaluating these designs, the

following criteria are considered: constructionmethod, construction and maintenance costs,

possible disruption to traffic during construction,

the durability and the aesthetics of the bridge.

The two conceptual designs are presented in the form

of sketches of the elevations and cross-sections of

the structures.

Topic

Background

& Context

Report

purpose

Project Aim

Technical

Background

Report

Structure


10/21

PROBLEM DEFINITION

ALL Reports have a version of a Problem

Statement. This means there are always

requirements, constraints and criteria.

If you are designing something, then there are

requirements/constraints/criteria applicable to

the design.

If you are building a machine which you did NOT

design, then there are requirements, constraints,

criteria applicable to YOU as the assembler!

If you are doing a research project, then the

R/C/C apply to what you are researching.


11/21

DESCRIBING CONCEPTS & PROCESSES

Overallsystem

Sub-system A

Sub-system B

Sub-system C

Use a Macro to Micro

approach. Always

describe the overall

system first, then each

subsystem (separateheadings), then the

details of each.

If a picture/diagram/

chart helps, then use it!But you must explain it

in words too!


12/21

DESCRIBING CONCEPTS CONT.

Name it:

Identify all its characteristics (ADJECTIVES)

Identify its DIMENSIONS

What is it COMPOSED OF (made of)?

What does it CONSIST OF (all parts)?

What does it USE?

What does it DO/ What is its PURPOSE?

What is it CONNECTED/LINKED/ATTACHED to?

HOW is it CONNECTED/LINKED/ATTACHED?

How is it POWERED?

How is it CONTROLLED?

How does it WORK/FUNCTION/OPERATE?


13/21

CONCEPT DESCRIPTION EXAMPLE

4.1 Concept A

A~Dot is a mechatronic system, consisting of four main subsystems, theMagazine, the Reloading Arm, theAiming Subsystem and the ThrowingSubsystem. A~Dots purpose is to autonomously execute the aiming andthrowing of a dart as specified by a user and then automatically reload itself.All subsystems are bolted onto the base plate which is welded onto thesupporting structure.

4.1.4 Throwing Subsystem4.1.4.1 Pneumatic cylinder

The pneumatic cylinder acts as the actuator of the system and is the sourceof energy for throwing the dart. Its on one side attached to a hinge-point on theframe and its other side is attached to the throwing arm.

4.1.4.2 Throwing arm

The throwing arm acts as the speed converter. It is attached to a hinge-pointon theframe by means of bearings/bushings denoted as Bs and it is pushed bythe pneumatic cylinder, to which it is also attached by means of bearings. It islinked to the cart by means of a sliding pin, which slides linearly through agroove machined into the throwing arm.


14/21

USING GRAPHICS

Keep your diagrams

simple. Include only

those details that will

be relevant to your

discussion.

Label the elements of

your diagram clearly.

Identify each diagram

with a figure number

and a caption at the foot

of the diagram.

Tables are indentified atthe top.Table 1. Engine size comparison

Fig. 2 Concept A mounted Back View

1. Roof of silo

2. Silo partition of container

3. Top door of silo partition4. Lorry cabin

5. Hinges of top door of silo

6. Bottom door of silo

7. Skip partition of container

8. Back right door of skip partition

9. Back left door of skip partition

10. Bottom door of skip partition A B C D
http://www.mhhe.com/mayfieldpub/tsw/grf-accu.htmhttp://www.mhhe.com/mayfieldpub/tsw/grf-numb.htmhttp://www.mhhe.com/mayfieldpub/tsw/grf-numb.htmhttp://www.mhhe.com/mayfieldpub/tsw/grf-accu.htm


15/21

USING GRAPHICS CONT.

If you are working withsoftware, then use printscreen to save imagesthat will help explainwhat you are talking

about.

The reader should NOThave to turn to theAppendices tounderstand what you

are saying in the text.Use overview charts/diagrams/ pictures toillustrate your text.

Label all visuals clearlyand refer to them in thetext. Eg.

As shown in Figure 3, theretracting arm (A) isattached to a steel base(B)...

The following flowchart illustrates thestages in the building ofthe machine...


16/21

DISCUSSION

You may choose to have a discussion section in

which you highlight particular problem-solving

moments/ challenges and describe how you solved

them. This is where you can demonstrate your

awareness of problem-solving strategies.

You can concentrate on technical as well as

professional challenges during the project.


17/21

WRITING THE REPORT:

THE CONCLUSION

The Conclusion:

Reminds the reader what the aim of the

project is and the purpose of the report

gives a brief summary of the keyfindings/features in your report

highlights the major outcomes of your

investigation and their significance.

(May also include recommendations)


18/21

CONCLUSION: EXAMPLE

Two designsforthe bridge to be constructedon the Calder Freeway across Slaty Creekhave beenpresented and discussed in thisreport.Design 1 is a super-T beam bridgeand Design 2 is a simple composite I girderbridge. Both designs incorporate round

piers on piled foundations, which are used

because the soil conditions are unknownand possibly unstable. Design 2 has someadvantages because it is made of steel andthus has longer spans and fewer piers.

However,Design 1 is clearly the betterdesign. This design requires minimal

formwork in the construction of itsconcrete deck, it is relatively easy to erect

and it maintains stability duringtransportation and construction. Inaddition, it is cheaper to build and moredurable.

Project Aim

ReportPurpose

Key features

MainOutcomes


19/21

Referencing is very important. You cannot use someoneelses words/pictures/ideas without acknowledging them. If

you do, it is called PLAGIARISM.

Although there are many different referencing styles, theprinciple is always the same:

WHOWHENWHATWHERE

Who wrote it?

When was it published?

What is it called?

Where did you read it (internet)?/ Where was it published?

You may choose ANY referencing format, BUT it must beconsistent. Harvard referencing guidelines are in WRITTENASSIGNMENT GUIDELINES, but if you have MS Word 2007or later, you may use Manage Sources

REFERENCING


20/21

USING MS WORD 2007MANAGE SOURCESAs you do your research, open a blank word document.

Note the following:

Name of the site

Name of the author (can be a company)

Date it was written (scroll down the webpage to the end)

The day/month/year you accessed the site

Copy & paste in the URL When you have this information, select from your tool

bar:

ReferencesStyle (APA)Manage sources Click new -Select type of source - Click show all fields Enter each

new source separatelyYou only need to fill in the detailslisted above. When you click in each box, you will see anexample below as to HOW to write the information.

When you write the report, you will be able to select yoursources and automatically generate a Bibliography.


21/21

project report guidelines 2011

Documents