Documenting Your Design

Transcription

1 Documenting Your Design

2 What 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 done

3 Notebooks and Final Report Focus today on notebooks and final report

4 Design 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 tips

5 Design Notebooks Do s - Dates - Names & Titles - Contact Information - Reason for contact - Conversation details Don ts - Quote excessively - Ex: Gary thinks

6 General Framework of the Final Design Report Volume I Volume II (Appendices) Volume II Supporting Information Problem Definition Supporting Docs Design Description Supporting Docs Evaluation Supporting Docs

7 General Features Format/headings Past tense 1 Margins 1.15 Spacing Page numbers and Section Numbering ASME References Overall length: 30 pages

8 General 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)

9 Executive Summary Guidelines 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

10 Executive Summary Guidelines 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

11 Problem Definition Chapter Content List of Figures or Tables 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

12 Problem Definition Supporting Docs Content Annotated Bibliography Summary and References Patent Search Objectives, Search Criteria, and Findings User Need Research Surveys, Interviews, Focus Groups Concept Alternatives Concept Selections List of Figures, and Tables Patent Figures Survey Results Concept Sketches Concept Selection Chart

13 Design Description Content List of Figures or Tables Summary of the Design Detailed Description Functional Description Additional Uses Overview Drawing Functional Block Diagram

14 Design Description Supporting Docs Content Manufacturing Plan Manufacturing Overview Part Drawings Bill of Materials Manufacturing Procedure Implementation Plan Implementation Overview Process Drawings Component List Implementation Procedure List of Figures or Tables Complete Drawings Block Drawings Gantt Charts Work Breakdown Structure

15 Evaluation Content 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 List of Figures or Tables Design Criteria Table Picture of Prototype fulfilling specific design criteria Relevant plots, graphics to support findings

16 Evaluation Supporting Docs Content Evaluation Reports Test Procedure Test Data Cost Analysis Environmental Impact Statement Regulatory and Safety Considerations List of Figures or Tables 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

17 Tables Guidelines Do s: Title above with description Headings for each column Don't: ID numbers Description Wordiness

18 Tables Guidelines 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 Bold column headings would add more clarity

19 Schematics as Figures Guidelines Include titles Include keys Highlight details of design Include necessary dimensions Clear distinction between different parts

20 Figures Guidelines 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

21 Photographs as Figures Guidelines Brief caption describes the figure Sequentially numbered. Refers to section of report (Fig th figure in Section 3) Needs size reference Parts labeled by callout

22 Photographs as Figures Guidelines Small as possible still showing content Numbers still legible Include scale/reference size Max size ½ page Contrasting colors

23 Graphs 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

24 Graphs Guidelines 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.

25 Equations Guidelines Define all variables and include units (as necessary) Number equations Reference the equation number

26 References [1] [1] References should follow ASME guidelines Bibliography entries should all be in same font and format Footnotes should not be used for references to original sources for cited material Arrange references in numerical order according to order of appearance in text

27 Annotated Bibliography: Patent Search Report Find similar devices History of solutions, prior art Are other patents threatening your ability to obtain a patent? What s your PROBLEM!?!

28 Annotated Bibliography: Patent Search CRITERIA! Findings Objectives, Search Criteria, and Findings Objectives: Why do the search Search Criteria: Google Patents, Findings: Pat. No. and Description

29 Patent Search Discuss smaller risk patents of interest Add first page of patents to Appendix Don t add if it wasn t discussed

30 General Framework of the Final Design Report Volume I Draft DUE DATES: Problem Definition & Supporting Docs: Oct. 20 Design Description and Supporting Docs: Nov. 8 Evaluation: Nov. 29 Final Report Due: Dec 12 (Design show Dec 13)

31

32 Annotated Bibliography Must contain two section: summary and references Summary - one paragraph with current state of the field and another paragraph on how the research affects the final outcome References - the citation should be in ASME or IEEE style - every reference should need two paragraphs (summary of the article and the relevancy of the article)

33 Elements that could be in a Final Design Report Product design spec Patent search Description of problem to be solved Background Table with top 5 design specs Sketch of your final design Photo of your prototype Strengths and weaknesses Interview with your advisor Index cards with various concepts Detailed part drawings Photos of the current lab kit Description of a competitors kit Printout of a patent Concept selection matrix Manufacturing plan Cost Analysis Detailed part drawings Bill of materials Test procedure Test Data Regulatory requirements Environmental Impact