Design Documentation in ME 2110 Jeffrey Donnell MRDC August 21, 2008

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

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.

4 Reports in ME 2110 During studio sessions At the end of each project Homework

5 Technical Communication—I Figures Drawings display designs Flowcharts display sequences of events Tables display data Graphs show comparisons Matrices display decision criteria Specification Sheets display evaluation criteria

6 Technical Communication—II Describing 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?

7 Reports present accomplishments Accomplishments are tangible: A device (shown in a drawing) A plan for solving a problem (shown in flowcharts and tables)

8 Reports do not present administration Team meetings Brainstorming sessions Concepts that were discussed but not drawn

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

10 Typical Report Sections Abstract Introduction Overview –As appropriate Discussion –As appropriate Conclusions

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

12 Introduction State the assigned task. Describe the design challenges. State what is presented in the report.

13 Overview Design Overview Display and describe design drawings (Especially in Platform and Dissection) Planning Presentation Display and describe Planning Tools (Especially on Major Project) Concept / Evaluation Presentation Display and describe alternatives and evaluation tools (Especially on Mini Project and Major Project)

14 Discussion Justification: How was the design selected? Present and describe alternatives and evaluation. Present and describe other planning or validation information. Analysis: Did the design perform as expected? Report system performance. What changes would improve performance? Other Discussion: Respond to questions in Studio Assignment sheets.

15 Conclusions Restate the project task. Restate the result and evaluation.

16 Presentations in ME 2110 State your name and your teammates’ names State the project objective and the challenge (as available) Describe your design (or other accomplishments) –Display design drawings (or other charts) Evaluate your results –What Worked –What Failed –What you would do Differently Summarize points and ask for questions

17 Displaying Illustrations Make your own drawings If 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…..”

18 How to display information in drawings

19 Overview Drawings Figure 1. Overview of Leatherman SuperTool Courtesy Leatherman Tool Group Drawing Labels Number with Caption

20 Subsystem Drawings Courtesy Leatherman Tool Group Figure 2. Pliers Operation BLADE END LANYARD ATTACHMENT Drawings Labels Number with Caption

21 Detail drawings isolate components Courtesy Leatherman Tool Group Figure 3. Hard Wire Cutter Location Drawing Label Number with Caption

22 Formal Figure Description

23 Describing Figures 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

24 A fully labeled drawing is shown Figure 1. Single-pass color printing system. U.S. Patent # 2,757,610

25 Description of Figure 1

26 Labels coordinate with text discussion

27

28 Information Resources rosoft_tools.shtml (A collection of tips for using Microsoft Word and PowerPoint with Excel, AutoCAD, and Matlab)