design documentation in me 2110 jeffrey donnell mrdc 3104 894-8568 june, 2010

33
Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

Upload: jeffery-tate

Post on 28-Dec-2015

216 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

Design Documentationin

ME 2110

Jeffrey DonnellMRDC 3104894-8568

June, 2010

Page 2: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

2

Agenda

• What reports are for• Format and information in technical reports• Quick tips on presentations• Our expectations for drawings• How to integrate drawings and discussion

J. Donnell / ME 2110 2010

Page 3: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

3

What you will do in ME 2110

• Design and evaluate devices.

• Document these designs using drawings.– Drawings should be computer-prepared

– All design illustrations should represent your work

• Characterize and evaluate the designs in written reports.

J. Donnell / ME 2110 2010

Page 4: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

5

Technical Communication—IFigures

• Drawings display designs• Flowcharts display sequences of events• Tables display data• Graphs show comparisons• Matrices display decision criteria• Specification Sheets display evaluation criteria

J. Donnell / ME 2110 2010

Page 5: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

6

Technical Communication—IIDescribing Figures

• What is shown?

• What is important in the figure or table?

• What does this system do?

• What does this matrix help you to do?

J. Donnell / ME 2110 2010

Page 6: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

7

Reports present accomplishments

Accomplishments are tangible:

• A device (shown in a drawing)

• A plan for solving a problem

(shown in flowcharts and tables)

J. Donnell / ME 2110 2010

Page 7: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

8

Reports do not present administration

• Team meetings

• Brainstorming sessions

• Concepts that were discussed but not drawn

J. Donnell / ME 2110 2010

Page 8: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

9

Reports require teamwork

Team members must take charge of:

• Text• Drawing• Quality

– Coordinate figure numbers with citations– Proofread the document– Verify that page design is appropriate– Verify that the document is complete

J. Donnell / ME 2110 2010

Page 9: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

10

Typical Report Sections

• Abstract

• Introduction

• Overview– As appropriate

• Discussion– As appropriate

• Conclusions

J. Donnell / ME 2110 2010

Page 10: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

11

Abstract

• State Objective.

• State Result.(Use numbers when available)

• State Evaluation / Recommendation(such as lessons learned)

• List Report Contents.

Do not use figures in the Abstract

J. Donnell / ME 2110 2010

Page 11: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

12

Introduction

• State the assigned task.– Customer Needs– Overall Product Function

• Define the design challenges.

• State what is presented in the report.

J. Donnell / ME 2110 2010

Page 12: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

13

Overview(for water heater report)

Design Overview• Display and describe drawings of the selected

design

(for reports on large project)

Planning Presentation• Display and describe Planning ToolsConcept / Evaluation Presentation• Display and describe alternatives and

evaluation tools J. Donnell / ME 2110 2010

Page 13: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

14

Discussion

Justification: How was the design selected?• Present and describe alternatives and evaluation.• Present and describe planning tools.

OR

Analysis: Did the design perform as expected?• Report system performance.• Account for failures and for successes.

J. Donnell / ME 2110 2010

Page 14: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

15

Conclusions

• Restate the project task.

• Restate the result and evaluation.

J. Donnell / ME 2110 2010

Page 15: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

17

Displaying Illustrations

• Make your own drawingsIf an illustration is not original, you will be in trouble

• Label the drawings• Number the figures • Provide captions• Cite and describe figures:

“Figure 3 shows…..”

J. Donnell / ME 2110 2010

Page 16: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

18

How to display information in drawings

J. Donnell / ME 2110 2010

Page 17: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

19

Overview Drawings

Figure 1. Overview of Leatherman SuperTool

The Leatherman Tool Group

Drawing

Labels

Number with Caption

J. Donnell / ME 2110 2010

Page 18: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

20

Subsystem Drawings

The Leatherman Tool Group

Figure 2. Pliers Operation

BLADE END

LANYARD ATTACHMENT

Drawings

Labels

Number with CaptionJ. Donnell / ME 2110 2010

Page 19: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

21

Detail drawings isolate components

The Leatherman Tool Group

Figure 3. Hard Wire Cutter Location

Drawing

Label

Number with CaptionJ. Donnell / ME 2110 2010

Page 20: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

22

Formal Figure Description

See also section 9.1.3 of the book

J. Donnell / ME 2110 2010

Page 21: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

23

Description Statements

1) Citation

2) Objective

3) Listing of labeled features

4) Explanation of operation

5) Discussion (as needed)State potential challenges or actual results

Describing Figures

J. Donnell / ME 2110 2010

Page 22: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

24

A fully labeled drawing is shown

Pneumatic Actuators

T-Valve SolenoidValve

Air Reservoir

Launch Plate

Hinge

penn

Lever Arms

Base Plate

Figure 9.3 An Air CatapultJ. Donnell / ME 2110 2010

Page 23: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

25

The Figure is described

Figure 9.3 is a concept drawing of an air powered catapult. It is used to hurl tennis balls to the scoring zone of the design tournament field. The tennis balls are initially placed on a launch plate, which is connected to a hinge by two lever arms. Two pneumatic actuators are attached to these arms and are anchored to a base plate. Hoses connect these actuators to a T-Valve, which is connected to an air reservoir through a solenoid valve. The solenoid valve is connected to a controller box, which is not shown. To fire this catapult, the controller sends a signal to the solenoid valve. The valve opens to allow a burst of pressurized air to flow from the reservoir to the pneumatic actuators. The actuators extend, thereby forcing the lower arms and platform upward. This motion hurls the tennis ball towards the target.

12

3

4

J. Donnell / ME 2110 2010

Page 24: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

26

Labels coordinate with text discussion

J. Donnell / ME 2110 2010

Page 25: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

27

Figure 9.3 is a concept drawing of an air powered catapult. It is used to hurl tennis balls to the scoring zone of the design tournament field. The tennis balls are initially placed on a launch plate, which is connected to a hinge by two lever arms. Two pneumatic actuators are attached to these arms and are anchored to a base plate. Hoses connect these actuators to a T-Valve, which is connected to an air reservoir through a solenoid valve. The solenoid valve is connected to a controller box, which is not shown. To fire this catapult, the controller sends a signal to the solenoid valve. The valve opens to allow a burst of pressurized air to flow from the reservoir to the pneumatic actuators. The actuators extend, thereby forcing the lever arms and platform upward. This motion hurls the tennis ball towards the target.

Pneumatic Actuators

T-Valve SolenoidValve

Air Reservoir

Launch Plate

Hinge

penn

Lever Arms

Base Plate

Figure 9.3 An Air Catapult

J. Donnell / ME 2110 2010

Page 26: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

28

Information Resources

http://www.me.gatech.edu/undergraduate/microsoft_tools.shtml

(A collection of tips for using Microsoft Word and PowerPoint with Excel, AutoCAD, and Matlab)

J. Donnell / ME 2110 2010

Page 27: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

29

Description ofPlanning Tools

See also section 2.2 of the book

J. Donnell / ME 2110 2010

Page 28: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

Planning Tool Description

1) Cite the tool

2) State what the tool helps designers do

3) Call out significant entries(Cust Needs at left, Eng Char at top, Importance

on the side, Strong relationship between…..)

4) State how it impacts your work

30J. Donnell / ME 2110 2010

Page 29: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

HOQ from the book

Page 30: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

House of Quality for Personal Transporter

J. Donnell / ME 2110 2010 32

EngineeringRequirements

ecnatropmI 123 4

851 1 37 3153 1 1

10 3 3 15535 54 1 3

Reliability 931 3 15 1 5 58 33 1 555 55 3 16 3 3 15111 5 1311 1

Sidewalk Compatibility 8 5 11555 310133155535 5

Terrain Robustness 9111 3 335 53 1 1 313 3

Column 22 18 17 15 12 18 30 27 37 34164 143 143 105 103 165 240 205 308 281 =

0.09 0.08 0.08 0.06 0.06 0.09 0.13 0.11 0.17 0.15

0002$<

gk52

<

gk001-

gk04

egrahC/.sr

H2

.srH

4

.nim

5

reggoJ=

riahcleehW

<

elbats.ged51

mc01

AestethicsTransport Speed

Ease of Use

Ease of Storage

MobilityEase of Maintenance

Safe Operation

yticapaC

daoL

egasU

ygrenE

Low Purchase Cost

ytilibatSniarreT

ecnaraelC

dnuorGCustomer Needs

emiT

egrahceR

tnirptooFgnitarep

O

tsoC

noitcudorP

TargetValues

emiT

gniniarT

ytefaSkla

wediS

thgieW

enihcaM

Low Operation Cost

1857 mportance*Relationship)RelativeValue {/Total }

PoorWeather Oeration

Page 31: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

Description of HOQ(first of four paragraphs)

J. Donnell / ME 2110 2010 33

(2) In order to thoroughly define the problems that a personal human transporter must address, (1) the House of Quality shown in Figure 1 was developed. (3) The column on the left lists the customer needs, which are ranked on an importance scale of 1 to 10. The top row displays the engineering requirements that have been identified at this point in the project. The most important customer needs are “Safe Operation,” “Ease of Use,” “Reliability,” and “Terrain Robustness,” which are ranked 10 and 9 in importance.

Page 32: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

House of Quality for Personal Transporter

J. Donnell / ME 2110 2010 34

EngineeringRequirements

ecnatropmI 123 4

851 1 37 3153 1 1

10 3 3 15535 54 1 3

Reliability 931 3 15 1 5 58 33 1 555 55 3 16 3 3 15111 5 1311 1

Sidewalk Compatibility 8 5 11555 310133155535 5

Terrain Robustness 9111 3 335 53 1 1 313 3

Column 22 18 17 15 12 18 30 27 37 34164 143 143 105 103 165 240 205 308 281 =

0.09 0.08 0.08 0.06 0.06 0.09 0.13 0.11 0.17 0.15

0002$<

gk52

<

gk001-

gk04

egrahC/.sr

H2

.srH

4

.nim

5

reggoJ=

riahcleehW

<

elbats.ged51

mc01

AestethicsTransport Speed

Ease of Use

Ease of Storage

MobilityEase of Maintenance

Safe Operation

yticapaC

daoL

egasU

ygrenE

Low Purchase Cost

ytilibatSniarreT

ecnaraelC

dnuorGCustomer Needs

emiT

egrahceR

tnirptooFgnitarep

O

tsoC

noitcudorP

TargetValuese

miTgniniarT

ytefaSkla

wediS

thgieW

enihcaM

Low Operation Cost

1857 mportance*Relationship)RelativeValue {/Total }

PoorWeather Oeration

(2) In order to thoroughly define the problems that a personal human transporter must address, (1) the House of Quality shown in Figure 1 was developed. (3) The column on the left lists the customer needs, which are ranked on an importance scale of 1 to 10. The top row displays the engineering requirements that have been identified at this point in the project. The most important customer needs are “Safe Operation,” “Ease of Use,” “Reliability,” and “Terrain Robustness,” which are ranked 10 and 9 in importance.

Page 33: Design Documentation in ME 2110 Jeffrey Donnell MRDC 3104 894-8568 June, 2010

House of Quality for Personal Transporter

J. Donnell / ME 2110 2010 35

EngineeringRequirements

ecnatropmI 123 4

851 1 37 3153 1 1

10 3 3 15535 54 1 3

Reliability 931 3 15 1 5 58 33 1 555 55 3 16 3 3 15111 5 1311 1

Sidewalk Compatibility 8 5 11555 310133155535 5

Terrain Robustness 9111 3 335 53 1 1 313 3

Column 22 18 17 15 12 18 30 27 37 34164 143 143 105 103 165 240 205 308 281 =

0.09 0.08 0.08 0.06 0.06 0.09 0.13 0.11 0.17 0.15

0002$<

gk52

<

gk001-

gk04

egrahC/.sr

H2

.srH

4

.nim

5

reggoJ=

riahcleehW

<

elbats.ged51

mc01

AestethicsTransport Speed

Ease of Use

Ease of Storage

MobilityEase of Maintenance

Safe Operation

yticapaC

daoL

egasU

ygrenE

Low Purchase Cost

ytilibatSniarreT

ecnaraelC

dnuorGCustomer Needs

emiT

egrahceR

tnirptooFgnitarep

O

tsoC

noitcudorP

TargetValuese

miTgniniarT

ytefaSkla

wediS

thgieW

enihcaM

Low Operation Cost

1857 mportance*Relationship)RelativeValue {/Total }

PoorWeather Oeration

Based on this analysis of the problem, the design presented here addresses community acceptance in the requirement of “Sidewalk Compatibility,” and it addresses safety in the requirements of “Terrain Stability” and “Ground Clearance.”