Documenting Your DesignUNIVERSITY OF MINNESOTAME 4054WSpring 2010Prof. Bohlmann5TUNIVERSITY OF MINNESOTAFinal Report Sections ScheduleDue DateDeliverable*March 4Draft Problem Definition ChapterMarch 30Draft Design Description ChapterApril 6Draft Evaluation PlanApril 20Draft Design EvaluationApril 29Final Design Report* Includes supporting appendices, as appropriateUNIVERSITY OF MINNESOTAThe Final Report: The Basics • PURPOSE:Enduring record of your project • GOAL:To enable a follow-up group to completely understand and reconstruct your design • FORMAT:Professional(Excellent material, excellent writing) • GUARANTEED READERS:Your advisor and the course coordinatorUNIVERSITY OF MINNESOTATitle Page Example• Layout and font selection is not good:– Picture should not overlap title– Text in bottom half should:• not be italicized• be smaller• in a lighter color (e.g., white or yellow)• Picture is a confusing• Email addresses not neededUNIVERSITY OF MINNESOTATitle Page Example• Good layout• Font sizing is appropriate• Picture does a good job of helping reader understand the context of the report• Students should have “Team members:” header• Student ID numbers not neededUNIVERSITY OF MINNESOTATitle Page Example• Good layout• Font sizing and color are appropriate– B&W always works, although colors can make it visually appealing– A well done cover sets the tone, but doesn’t get the grade• The picture of the proposed solution is an excellent choiceUNIVERSITY OF MINNESOTAExecutive Summary• How you would describe the project to your CEO in 1-2 pages. Brevity and focus are critical.• What would you tell the Dean of IT? • Be sure to include the most important results in addition to the project description. Be quantitative. Include quantitative results! “The manufacturing cost (material, labor, and burden) of the concrete pump in production quantities of 1000 is $420.”UNIVERSITY OF MINNESOTAContributions Pages• Who did what? • List everything you did as an individual (considered in grading)• Hard copies should be signed by each team member (as shown) Sample Contributions PageUNIVERSITY OF MINNESOTAProblem Definition Chapter• Background • Mission Statement • Customer Needs – Identify key customers – VOC Method(s)– Customer Needs Chart – Explanation of Chart Entries • Product Design Specification – Specification Chart – Explanation of Chart Entries Product Design Specification (excerpt)#NeedImp.1Veneer press can handle large workpieces42Veneer press can melt hide glue5Customer Needs Chart (excerpt)Need #MetricImp.UnitMarginal ValueIdeal Value1Panel width4mm300-635150-7201Panel length4mm900-1900300-2000UNIVERSITY OF MINNESOTADesign Overview Chapter• "Walk the reader through" your finaldesign • Refer to lots of figures • Create context for following chapters Sample annotated figureUNIVERSITY OF MINNESOTAConcept Generation & Selection Chapter• Briefly review concept generation process • Show key example concepts • Present selection chart • Explain selection rankingsSample ConceptSelection Chart (Excerpt)CriteriaWt FactorClampDead weightSurface flatness2555Loading time1554…Total score100470465Rank12UNIVERSITY OF MINNESOTADesign Description Chapter• Present models • Show analyses (and their results) • Document experiments & experimental prototyping • Review testing of final product • Compare final specifications to design goals • Include: – Cost Analysis – Environmental Impact Assessment – Relevant regulations (UL, ANSI, etc.) Should be the longest chapterUNIVERSITY OF MINNESOTAConclusions & Recommendations Chapter• Summarize important results • Assess your final design (strengths & limitations) • Where should product go from here? • Reflect on design processUNIVERSITY OF MINNESOTAReferences• List articles, books, data sheets, URLs, etc. used in your project • Citing by author name suggested Durfee, W., “How to Design Good”, Journal of Good Engineering Design, Vol. 15, pp. 30-40, 1993.Reference exampleUNIVERSITY OF MINNESOTAAppendices• CAD drawings • Supporting detailed calculations • Raw experimental data • Concepts (from concept generation) • Bill of Materials • Catalog pages, data sheets (highlight important data) • Other important information that doesn't flow well in body of the reportAppendix ADetailed drawings of concrete pump piece partsAuger . . . . . . . . . . . A.1Body . . . . . . . . . . . . A.2Handle . . . . . . . . . . A.3•••Label and name every appendixUNIVERSITY OF MINNESOTAProject Flyer• Used to “advertise” your project• Include: – Project Name – Sponsor (if applicable) – Advisor – Team Member Names – 100-200 Word Description – Graphic • Please include course number and semester • Portrait orientation; B&W • Hand out at the Design Show!Sample FlyerUNIVERSITY OF MINNESOTAAdditional Project Flyer ExamplesUNIVERSITY OF MINNESOTATips on Preparing the Final Report• Develop a detailed, comprehensive outline now!• Appoint an editor to set styles, collect sections, etc. • Assign writing tasks– Be sure all team members contribute(Individual contributions must be cited on the "Contributions" page)• Create deadlines– Rough draft– Final copyUNIVERSITY OF MINNESOTATips on Preparing the Final Report• Plan to have other team members read your draft sections (find grammatical errors) • Don’t forget:– Cost analysis– Design for Environment– Regulatory analysisUNIVERSITY OF MINNESOTATips on Organization• Outline first! • Make your most important points first! • Define terms upon first usage (or in a glossary) • Begin each chapter with a "roadmap" which describes the content of each of the following sections (1 paragraph) • Begin each section with a "roadmap" of what's included in that section (1 paragraph)UNIVERSITY OF MINNESOTAStyle Suggestions• Use lots of short, simple sentences • Use lots of short, simple paragraphs • Avoid "It" & "There" as subjects• Use proper citation techniqueUNIVERSITY OF MINNESOTARecommended Additional Information• Re-read the web pages on the Final Report(Assignments link) • Elements of Style, Strunk & WhiteUNIVERSITY OF MINNESOTAFigures• Number each figure • Add a descriptive caption • Ensure plot axes are readable • Ensure graphics are clear Figure 9.13. Candidate worst-stressed points at junction of beam