Design Documentation in ME 2110

FALL, 2020
Chapter 1
J. Donnell / ME 2110 2
Technical Communication-I
• Figures display what you have done
• Words explain what the figures are • Words explain what the figures mean
Technical Communication--II
• Reports tell stories to clients, about their projects
• Clients are not like your teammates! – They don’t track your daily actions – They do want your result to meet their goals – They expect you to demonstrate that your
recommendations are valid J. Donnell / ME 2110 4
Technical Communication--III
• The Client does not work for you!
• The Client will not try to figure out something that you did not say.
Clients don’t know what your displays mean. So….
• Label things that are significant
• Define what you have created
• State explicitly how your work advances your work / their goals
Client expectations
– The client’s needs
– How you have made design decisions
Client problems
– They don’t know things that you think are obvious
– They notice the wrong things
Complete explanations can intercept these problems!
9
Information displays are goal- oriented.
Explain how each display helps you meet the client’s goals
J. Donnell / ME 2110
Goals and Displays--I
• Planning tools help you think through the design problem
• They also encode a strategy for your project / sections of the project
• That strategy relates you to the client and to the goal
Goals and Displays--II
• Each display tells a story
• Each display makes a point – About the project plan – About the design – About the client
An Old Competition
20 ft St
ar t L
13
Next: How to use planning tools to tell the story of this
competition
Direction of Improvement O ↓ O ↑ O ↑ ↑ ↑ ↑
Hits rats 10 O O Hangs Flags 10 O O Gathers insects 10 O O Defends points 8 Looks appealing 9 Safe for crowd 10 O Does not harm competition 5 O Does not harm arena 8 O Fast 8 Strong parts 6 Able to be used many times 7 Maximize Forces 2 Easily Transported 3 Orginizational Difficulty
Absolute Importance 272 212 72 108 90 168 61 128 210 0.21 0.16 0.05 0.08 0.07 0.13 0.05 0.10 0.16
1 3 8 6 7 4 9 5 2
H itt
in g
Ac cu
ra cy
Im po
rta nc
You Develop Engineering Characteristics
You Reconcile with Client
Hits rats 10OO
Hangs Flags 10OO
Defends points 8
Looks appealing 9
Fast 8
Maximize Forces 2
Easily Transported 3
> 75%
Targets
Relative Importance
12x24x18< 30 poundsEvery part that canAll parts2 armsless than 2at least 1Use all avaliable
An Old Competition
20 ft St
ar t L
15
Next: How to use planning tools to tell the story of this
competition
You Identify the actions the system must take
The Morphological Chart
Friction String Break Anchor Rubber Stopper Weighted Skid
Equal Size Wheels Larger Front Wheels
Rolling Sliding Projectile Launch
You Have Identified Functions
Evaluating Design Alternatives
Concept 1 2 3 4
Criteria 3 4 3 4 2 3 3 2 2 3 3 2
High-Speed Motion 3 2 3 2 2 3 2 2
Precise Positioning 3 4 4 2 2 3 3 3
Mobility 3 2 3 3 Easy Setup 3 2 3 3 High Stability 2 4 3 3 Reliability 3 3 3 3 Low-Cost Operation 3 2 2 3
3 4 3 2 Total 34 39 38 34
0.65 0.75 0.73 0.65 4= Very Good, 3= Good, 2= Satisfactory, 1=Just Tolerable, 0=Unacceptable
Relative Total
1) You compare alternatives
2) You Develop Criteria
Criteria
Chapter 3
Using Displays
“Displays should stand on their own”
Prepare displays so clients can easily see:
1. Your Goal and Your Result
2. Inputs / Value Added – What you were provided / What you created or decided.
3. Significance of the display – Your plans, their cost, their expectations
4. Unknowns
5. Actions
Direction of Improvement O ↓ O ↑ O ↑ ↑ ↑ ↑
Hits rats 10 O O Hangs Flags 10 O O Gathers insects 10 O O Defends points 8 Looks appealing 9 Safe for crowd 10 O Does not harm competition 5 O Does not harm arena 8 O Fast 8 Strong parts 6 Able to be used many times 7 Maximize Forces 2 Easily Transported 3 Orginizational Difficulty
Absolute Importance 272 212 72 108 90 168 61 128 210 0.21 0.16 0.05 0.08 0.07 0.13 0.05 0.10 0.16
1 3 8 6 7 4 9 5 2
H itt
in g
Ac cu
ra cy
Im po
rta nc
House of Quality Shows
Hits rats 10OO
Hangs Flags 10OO
Defends points 8
Looks appealing 9
Fast 8
Maximize Forces 2
Easily Transported 3
> 75%
Targets
Relative Importance
12x24x18< 30 poundsEvery part that canAll parts2 armsless than 2at least 1Use all avaliable
Highlights can identify Inputs, Actions, Significance
22
Concept 1 2 3 4
Criteria 3 4 3 4 2 3 3 2 2 3 3 2
3 4 3 2 Total 34 39 38 34
Relative Total
23
– The Client’s Takeaway 3) Call out the critical features
– For large displays, limit to 3 or 4 items! 4) Explain Operation (designs) or Significance
(planning displays) 5) Comment: How does this further the Goal?
How to describe your displays
PneumaticActuators
Text Description of the Figure
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.
1 2
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.
PneumaticActuators
How to Think About Reports
• Define the Project Goal and Background • Define the deliverables that you will present
– Planning / strategy – Design Alternatives / Evaluation / Selected
design • Assess performance (after competition) • Predict performance (before fabrication)
Explain why the client should have confidence in the design
30
• Abstract
• Design Overview (Sometimes you present Results instead of a design)
• Discussion (How well does your design meet the goal?)
• Conclusions J. Donnell / ME 2110
More About Written Reports
• An Example report is in Appendix A
Chapter 5
Displaying Drawings and Charts
• Displays should be large. (Drawings can fill a slide)
• Drawings should have labels • Tables / Matrices can be highlighted to call
attention to significant entries • Some tools may need to be reformatted for
display • Minimize text (other than labels)
33
Design of Newspaper Structure Concept
Structural Objectives • Enclose two tallest team members • Support weight to prove stability • Make minimal use of materials • Demonstrate aesthetic quality
Design Specifications • Trapezoidal newspaper frame with
taped joints and cross-sectional tape weight hanger
• 2 Base Connector Rods (2 members/rod) • 4 Vertical Posts (4 members/post) • 4 Top Frame Braces (2 members/brace)
• Required number of sheets = 28 • Projected width/height = 44”/82”
Structural Objectives • Enclose two tallest team members • Support weight to prove stability • Make minimal use of materials • Demonstrate aesthetic quality
Design Specifications • Trapezoidal newspaper frame with
taped joints and cross-sectional tape weight hanger
• 2 Base Connector Rods (2 members/rod) • 4 Vertical Posts (4 members/post) • 4 Top Frame Braces (2 members/brace)
• Required number of sheets = 28 • Projected width/height = 44”/82”
35
J. Donnell / Georgia Tech Mechanical Engineering
Extension sub-assembly (retractable)
37
Concept 1 2 3 4
Criteria 3 4 3 4 2 3 3 2 2 3 3 2
3 4 3 2 Total 34 39 38 34
Relative Total
Documentation and References
Fall, 2020
2
From a previous project: Did the student team members take these photographs?
Authorship and Ownership Documents and images are • Created by people • Owned by companies
You must acknowledge both creator and owner
3J. Donnell / ME 2110
The New York Times *
* The New York Times. (1-21-2019). “This Time It Took Overtime but the Patriots Are Back in the Super Bowl Yet Again” [online]. Available https://www.nytimes.com/2019/01/20/sports/football/nfl-playoffs-live-new-england-patriots-vs-kansas-city-chiefs-afc-championship.html
Plagiarism:
Submission of material that is wholly or substantially identical to that created or published by another person or persons, without adequate credit notations indicating the authorship.
You must give credit, with documentation, when you use others’:
• Words • Drawings / diagrams • Photographs • Calculations
• Explaining your designs with photos from the Web.
• Copying an explanation from the Web and using it in your work.
• Obtaining a material property from the Web and using it in your work.
Acknowledging Sources
1. Cite the source in your text 2. Create a reference entry, showing:
Author name(s) Title of the document Place and type of publication Publisher name Date of publication Page number(s)
Appropriate use of Source--I
You looked up the density of Aluminum for your ME 3057 lab report, then wrote this:
“The density of aluminum T6101, ρ is 0.00277 g/mm3 [1]. If sin(θ) is sufficiently small…..”
Reference [1] J. M. Gere, Mechanics of Materials, 5th ed., Pacific Grove California: Brooks/Cole, 2001, p. 989.
0)sin('' =+× θθ mgLI
Appropriate use of Source--II
“Figure 1 displays the major veins of a normal human leg….
Figure 1. The veins of a normal leg [1]
The Image you obtained
Your Caption
https://www.ieee.org/content/dam/ieee- org/ieee/web/org/conferences/style_references_ manual.pdf Reference entries are discussed beginning on Page 6. Electronic sources are discussed beginning on Page 10.
Example IEEE Reference List 1) a journal article, 2) an image, 3) a
newspaper article References
[1] A. Khalid, J. Huey, W. Singhose, J. Lawrence, D. Frakes, “Human Operator Performance Testing Using an Input-Shaped Bridge Crane,” ASME Journal of Dynamic Systems, Measurement and Control (electronic version), vol. 128 (4), pp. 835-842, 2006.
[2] The University of Iowa Department of Radiology, “The VNUS® Closure®
Procedure for Varicose Veins,” (Electronic Database), (Cited 6-7-06), http://www.radiology.uiowa.edu/pi/vnus/about/
[3] M. Maske, “Broncos beat Patriots to advance to Super Bowl 50,” The Washington Post. (1-24-2016). [online]. Available https://www.washingtonpost.com/sports/broncos-beat- patriots-to-advance-to-super-bowl-50/2016/01/24/cbd1bdfc-c2da-11e5-8965- 0607e0e265ce_story.html
[3] Rob Carr, “The Falcons’ Julio Jones ran past the Packers’ Damarious Randall on a 73-yard touchdown catch in the third quarter. Jones caught nine passes for 180 yards and two touchdowns,” in B. Pennington, “Falcons Thrash Packers to Reach Second Super Bowl,” The New York Times. (1-23- 2017). [online]. Available https://www.nytimes.com/2017/01/22/sports/football/atlanta-falcons-super-bowl-green-bay- packers.html?hp&action=click&pgtype=Homepage&clickSource=story- heading&module=second-column-region&region=top-news&WT.nav=top-news&_r=0
Google search: “bridge crane georgia tech”
http://www.google.com/search?q=bridge+crane+georgia+tech&o e=utf-8&rls=org.mozilla:en-US:official&client=firefox- a&um=1&ie=UTF- 8&hl=en&tbm=isch&source=og&sa=N&tab=wi&ei=oNoFT6LDDt TLtgfFpLisAw&biw=1680&bih=935&sei=pNoFT_uHJ4LBtgeVw4 C4Aw
Example Plagiarism Cases
Singhose, 1996 Palaez, 2005
0 5 10 15 20 25 30
Unshaped, ζ=0 Unshaped, ζ=0.05 Unshaped, ζ=0.1 Shaped, ζ=0 Shaped, ζ=0.05 Shaped, ζ=0.1
R ad
Unshaped ZVD Shaped
Technical Summaries FALL 2020
Chapter 1Technical Communication:You and the Client
Technical Communication-I
Technical Communication--II
Technical Communication--III
Client expectations
Client problems
Information displays are goal-oriented. Explain how each display helps you meet the client’s goals
Chapter 2How Design Displays Work
Goals and Displays--I
Goals and Displays--II
An Old Competition
Slide Number 14
An Old Competition
Function Tree Diagram
The Morphological Chart
Evaluating Design Alternatives
Slide Number 21
How to describe your displays
How to describe that drawing?
Text Description of the Figure
Labels coordinate with text discussion
Slide Number 27
Chapter 4Reports
More About Written Reports
Displaying Drawings and Charts
What Is This? What Does It Do?
Slide Number 36
Documentation Fall 2020
Documentation and References
Slide Number 2
Authorship and Ownership
In practical terms:
The IEEE Editorial Style Manual
Example IEEE Reference List1) a journal article, 2) an image, 3) a newspaper article
Nested Citations
Example Plagiarism Cases
Slide Number 16
Slide Number 17
Slide Number 18
Slide Number 19
Slide Number 20
Slide Number 21
Slide Number 22