Documenting Your DesignWhat are Some Methods for Documenting Your Work?  Short Reports (memos)  Drawings  Design Notebooks  Shared Documents  Presentations  Google site  Final Report If you don’t “write” it down no one will know what you’ve doneNotebooks and Final Report  Focus today on notebooks and final reportDesign Notebooks Sample page Do’s •Add a page number and date •Be clear-add notes for calculations and sketches •Be neat and add contact info in case its lost Don’ts •Forget to label the picture-Use descriptions •Explain why you chose that sketch •Take Lecture notes in design notebook •Erase ADD up to 6 do’s and don’ts, be sure to point out features of the sample page that support your tipsDesign Notebooks Do’s Don’ts - Dates - Names & Titles - Contact Information - Reason for contact - Conversation details - Quote excessively - Ex: “Gary thinks…”General Framework of the Final Design Report Volume I Volume II (Appendices) Volume II Supporting Information Design Description Supporting Docs Problem Definition Supporting Docs Evaluation Supporting DocsGeneral Features  Format/headings  Past tense  1” Margins  1.15 Spacing  Page numbers and Section Numbering  ASME References  Overall length: 30 pagesGeneral Features Comment on  Format/headings: numbered sections and subsections  Tense: present tense  Margins, Spacing, Numbering: Different font size for header and sub-header (color not a requirement since report may be photocopied)Executive Summary  Synopsis of entire report  Includes  Problem definition  Design description  Design evaluation  70% writing, 30% graphic (relevant to problem)  1 page  Figure has too much white space, font difficult to read GuidelinesExecutive Summary  Brief explanation of problem, lists the results and has a conclusion  Gives specific results to make an informed decision within a reasonable length  Includes figures  Format (i.e. no paragraph indentation) makes the text difficult to read GuidelinesProblem Definition Chapter  Problem Scope  Technical Review  Background Info  Previous Work in Field  Design Requirements  Table of User Needs  Table of Design Requirements  Figures as necessary to describe prior work/background Content List of Figures or TablesProblem Definition Supporting Docs  Annotated Bibliography  Summary and References  Patent Search  Objectives, Search Criteria, and Findings  User Need Research  Surveys, Interviews, Focus Groups  Concept Alternatives  Concept Selections  Patent Figures  Survey Results  Concept Sketches  Concept Selection Chart Content List of Figures, and TablesDesign Description  Summary of the Design  Detailed Description  Functional Description  Additional Uses  Overview Drawing  Functional Block Diagram Content List of Figures or TablesDesign Description Supporting Docs  Manufacturing Plan  Manufacturing Overview  Part Drawings  Bill of Materials  Manufacturing Procedure  Implementation Plan  Implementation Overview  Process Drawings  Component List  Implementation Procedure  Complete Drawings  Block Drawings  Gantt Charts  Work Breakdown Structure Content List of Figures or TablesEvaluation  Restate the 3-5 Design Requirements  Discuss Prototypes that fulfill design criteria  Evaluation Method  By hand, computer simulation, survey, etc.  Verification Reports  I M R D report format  Design Criteria Table  Picture of Prototype fulfilling specific design criteria  Relevant plots, graphics to support findings Content List of Figures or TablesEvaluation Supporting Docs  Evaluation Reports  Test Procedure  Test Data  Cost Analysis  Environmental Impact Statement  Regulatory and Safety Considerations  Test Method Setup/Apparatus  Graphs or tables with test results or statistical analysis  Summary table of cost breakdown and competitor comparison  Matrix to evaluate environmental tradeoffs of alternate designs  Table of major safety concerns Content List of Figures or TablesTables  Do’s:  Title above with description  Headings for each column  ID numbers  Description  Don't:  Wordiness GuidelinesTables  No more than 25% of volume 1 should be tables  Labels and units on columns, rows, and data  Titles on all tables  Table captions above tables  Adequate space in cells for data and headings  Table proximity to references or relevant data Guidelines Bold column headings would add more claritySchematics as Figures  Include titles  Include keys  Highlight details of design  Include necessary dimensions  Clear distinction between different parts GuidelinesFigures  Caption below all figures  Use callouts to highlight important features  Use detail/section views when needed  Refer to figure within text  Make sure figures are clear and easy to understand  Reference in appendices GuidelinesPhotographs as Figures  Brief caption describes the figure  Sequentially numbered. Refers to section of report (Fig 3-7  7th figure in Section 3)  Needs size reference  Parts labeled by callout GuidelinesPhotographs as Figures  Small as possible still showing content  Numbers still legible  Include scale/reference size  Max size ½ page  Contrasting colors Guidelines Use word “figure” instead of “graph” in caption  Caption below the graph should be concise  Proper representation on scales (use proper significant digits)  No need for figure title  Keep unit format for axis titles consistent  Add trend line if necessary  Legible size and font Guidelines GraphsGraphs  Labels (x-axis, y-axis, title), corresponding units, legend  Explain terms (used in the diagram) in the caption  Use a small sketch to explain the physical situation being graphed, if necessary  Use discrete points and error bars if data are collected experimentally. Use a continuous line for theoretically calculated data. GuidelinesEquations  Define all variables and include units (as necessary)  Number equations  Reference the equation number GuidelinesReferences  References should follow ASME guidelines  Bibliography entries should all be in same font and format  Footnotes