PROJECT REPORT GUIDELINES

Mechatronics Program MIJ130S/MIJ230S

K.Wolff
2011

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.

GENERAL RULE

Why
What Who Where When How
You need to constantly ask yourself these questions at every stage, because these are the kinds of questions your assessors may ask about your project. Keep a note of you Q&A processes in a project notebook!

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, proven techniques, practical experience and appropriate skills to the solution of well defined problems in the field of engineering while operating within the relevant standards and codes. Demonstrate well-rounded general engineering knowledge, as well as systematic knowledge, of the main terms, procedures, principles and operations of one of the disciplines of engineering. Gather evidence from primary sources and journals using advanced retrieval skills, and organize, synthesize and present the information professionally in a mode appropriate to the audience. Apply the knowledge gained to new situations, both concrete and abstract, in the workplace/community. Identify, analyze, conduct and manage a project. Make independent decisions/judgments taking into account the relevant technical, 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, and economic sustainability.

THE REPORT FORMAT

TABLE 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 2.1Problem Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 2.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

WRITING THE REPORT: THE SUMMARY

Is written at the end, but placed at the beginning!!! It is NOT the introduction! (A busy manager who might not have time to read the full report should be able to get the gist of the whole report by reading the summary.)

The summary: states the topic of the report outlines your approach to the task if applicable gives the most important findings of your research or investigation, 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 or design refer to later diagrams or references.

SUMMARY - EXAMPLE
This report presents a design for a bridge to be constructed on the Calder Freeway crossing Slaty Creek in the Shire of Macedon Ranges. Two designs for the bridge were devised and then compared by considering the cost, construction and maintenance of each bridge. Design 1 is a super-T beam bridge while Design 2 is a simple composite I girder bridge. It is concluded that Design 1 is the better design. This design is cheaper, easier to construct, more durable and easier to maintain.

Topic Context Approach Key

Aspects

Main

Outcome

WRITING THE REPORT: THE INTRODUCTION

The introduction can be sub-divided into 1.1, 1.2 etc and includes: the background to the topic of your report to set your work in its broad context (eg. Company & nature of its business) a clear statement of the purpose of the report, usually to present the results of your research, investigation, or design (evidence of YOUR WPL experience and technical application of knowledge) a clear statement of the aims of the project. An overall description of the project (eg machine building/ designing a control system) and a clear indication of the students responsibilities! technical background necessary to understand the report; e.g. theory or assumptions. An outline of the structure of the report: what are you presenting, in what order and with what evidence.

INTRODUCTION - EXAMPLE
1. INTRODUCTION

Topic Background & Context Report purpose Project Aim

A dual carriageway bridge with two traffic lanes in each 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 manmade 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: construction method, 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.

Technical Background
Report Structure

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.

DESCRIBING CONCEPTS & PROCESSES

Use a Macro to Micro approach. Always describe the overall system first, then each subsystem (separate headings), then the details of each. If a picture/diagram/ chart helps, then use it! But you must explain it in words too!

Overall system
Subsystem A

Subsystem B

Subsystem C

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?

CONCEPT DESCRIPTION EXAMPLE

4.1 Concept A A~Dot is a mechatronic system, consisting of four main subsystems, the Magazine, the Reloading Arm, the Aiming Subsystem and the Throwing Subsystem. A~Dots purpose is to autonomously execute the aiming and throwing 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 the supporting structure. 4.1.4 Throwing Subsystem 4.1.4.1 Pneumatic cylinder The pneumatic cylinder acts as the actuator of the system and is the source of energy for throwing the dart. Its on one side attached to a hinge-point on the frame 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-point on the frame by means of bearings/bushings denoted as Bs and it is pushed by the pneumatic cylinder, to which it is also attached by means of bearings. It is linked to the cart by means of a sliding pin, which slides linearly through a groove machined into the throwing arm.

USING GRAPHICS

Fig. 2 Concept A mounted Back View 1. Roof of silo 2. Silo partition of container 3. Top door of silo partition 4. 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

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 at the top.

Table 1. Engine size comparison

USING GRAPHICS CONT.

If you are working with software, then use print screen to save images that will help explain what you are talking about. The reader should NOT have to turn to the Appendices to understand what you are saying in the text. Use overview charts/ diagrams/ pictures to illustrate your text.

Label all visuals clearly and refer to them in the text. Eg. As shown in Figure 3, the retracting arm (A) is attached to a steel base (B)... The following flow chart illustrates the stages in the building of the machine...

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.

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 key findings/features in your report highlights the major outcomes of your investigation and their significance. (May also include recommendations)

CONCLUSION: EXAMPLE
Two designs for the bridge to be constructed on the Calder Freeway across Slaty Creek have been presented and discussed in this report. Design 1 is a super-T beam bridge and Design 2 is a simple composite I girder bridge. Both designs incorporate round piers on piled foundations, which are used because the soil conditions are unknown and possibly unstable. Design 2 has some advantages because it is made of steel and thus has longer spans and fewer piers. However, Design 1 is clearly the better design. This design requires minimal formwork in the construction of its concrete deck, it is relatively easy to erect and it maintains stability during transportation and construction. In addition, it is cheaper to build and more durable.

Project Aim

Report Purpose
Key features Main Outcomes

REFERENCING
Referencing is very important. You cannot use someone elses words/pictures/ideas without acknowledging them. If you do, it is called PLAGIARISM.

Although there are many different referencing styles, the principle is always the same: WHO WHEN WHAT WHERE 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 be consistent. Harvard referencing guidelines are in WRITTEN ASSIGNMENT GUIDELINES, but if you have MS Word 2007 or later, you may use Manage Sources

USING MS WORD 2007 MANAGE SOURCES

As 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:
References Style (APA) Manage sources Click new Select type of source - Click show all fields Enter each new source separately You only need to fill in the details listed above. When you click in each box, you will see an example below as to HOW to write the information. When you write the report, you will be able to select your sources and automatically generate a Bibliography.

APPENDICES

Appendices are for support information. They are divided into section types, eg. B = detailed design. That means B1 is maybe overall design; B2 is isometric view of X; B3 is isometric view of Y etc. Make sure you include any detailed drawings you have done, and that they have your name in the title block. You may include other peoples drawings if they help the reader to understand the project, but these must be indicated as not being your drawings. There is no limit as to what you can include, but do not include pages and pages of quotations!! Refer to the qualification guidelines to see what you need to demonstrate many of these will be suitable for the Appendices.