PART I Define, Conceive, Prove, Document
Chapter 8 Documentation
8.7 Preliminary Design Report
The PDR is a formal engineering document that encapsulates the entire accomplish- ments of the design team during the first phase of the design project, typically at the end of the first semester of the project The PDR documents the design team’s work, covering the design team’s entire work, leading to the creation of proof concept design and a prototype
The PDR is a complex document with many aspects that must be included, so a set of guidelines is necessary to prepare the document for each project The typical length of a PDR is 50–150 pages The following section covers a list of suggested guidelines for creating the PDR
8.7.1 guidelinesfoR pReliminaRy design RepoRt
General Format – PDF format is an excellent form for PDRs in a single file It can be shared easily through file-sharing or e-mailed It is also a standard format that maintains file consistency across various operating systems and printing systems Most sponsors appreciate receiving the PDR in this format A 1-in margin (on all sides) on each page is recommended Include a page number on every page Outline the report in the manner prescribed below
Title Page – Project title, team number, team name, team logo, team members (and role of each member), sponsor, name of a faculty advisor(s), academic year,
138 Engineering Capstone Design submission date, and a report identification number (if assigned) No page number should be inserted on this page
Abstract – The abstract is a concise and brief description of the project It should include project objectives, what was accomplished, and how in the design process Typically, the abstract should not exceed 500 words and should be limited to one page Page # “ii”
Table of Contents – Contains a list of major and minor headings within the report along with page numbers Page # “iii”
List of Acronyms – Include a list of all acronyms used in the report Page # “iii”
List of Tables – Include a list of all tables in the report, including the page number of each table Each table must be numbered Page # “iii”
List of Figures – Include a list of all figures in the report and the page number of each figure Each figure must be numbered Page # “iii”
Introduction – Include project description and problem definition, the stated design requirements and expectations, a brief chronology of previous work per- formed in this area, the purpose, scope, and objectives of the design work Page # “1”
Literature Searches – Provide a complete list of literature researched by each team member and referenced in the PDR Explain what was used or learned from each article or publication Explain how each publication or report pertains to the team’s design solution
Patent Searches – Provide a complete list of patents researched and used as a reference in the design project Patents listed should be relevant to the design project Explain how each pertains to the design solution
Project Planning – Describe the project planning and management Include a Gantt chart showing the timeline, tasks, milestones, and resources showing team member task assignments Specify tasks completed as a percentage, milestones, and managerial tools implemented to achieve design goals
Design Specifications – Describe how customer requirements and engineering criteria were transcribed into engineering design specifications Describe how target values were set for the engineering design specifications The target values for design specifications should be numerical parameters with units In addition to any write- up, set the design specification in a tabular format
Conceptual Design – Describe the process the team followed to generate design solution concepts Include a list (including sketches) of all concepts generated by each team member Analyze each concept and evaluate its applicability as a solution to the design problem Finally, perform a Pugh analysis on all concepts and include the decision matrix to explain how it was created Show the iterations on the Pugh analysis to select three or four top design choices
Competitive Analysis – Document the market analysis conducted to identify and assess the competition (or alternatives to the team’s top design) and establish a strategy to gain market/customer advantage Present a QFD analysis of the design solution as a tool to identify important aspects of the project Include a trade-off and competitive analysis in the detailed discussion of the QFD analysis
Project Specific Details and Analysis – This section includes any details, data collection activity, or engineering analysis specific to the team’s project For exam- ple, product design teams should include market analysis, demand forecasting, cost
139 Documentation
versus price information, and surveys of potential users Process design teams should include a flowchart or floor plans of the current process and time studies of the cur- rent operations National design competition teams should document evidence of work done to fulfill the requirements of the competition that goes beyond typical capstone course requirements
Product or Process Design Details – Describe how the chosen concept was developed into the prototype design Include drawings, including composing parts Drawings may be placed in the Appendices if too numerous but should be referenced in this section Organize the appendix material so it is clear what is included Include dimensions, tolerances, annotations, linkages, and relationships
Engineering Analysis – Describe mathematical models such as process models, thermal, fluids, structural, vibrational, static, dynamic, materials, and finite element analysis, as appropriate Is the product design sound, safe, and following the current state of knowledge (state of the art), regulatory requirements, standards, and codes?
Proof of Concept – Discuss the proof of concept, prototype, or how the design was proven that the design functions as envisioned Compare the prototype’s features, func- tions, and performance against all of the design specifications the team created
Financial Analysis – Describe the analysis of design solution costs for imple- mentation as a usable product Include person-hours (and dollar equivalent) spent on the project by team members, faculty advisors, consultants, etc Include an analysis of costs for mass production of design, market demand, forecast of technology, and future revisions Analyze return on investment as appropriate Discuss cost savings and manufacturing or process efficiencies as a result of the project
Conclusions – Describe how the design satisfies the design specifications Further Work – Describe what is yet to be accomplished as a continuation or follow-up on the project Describe the project plan for continuation and further devel- opment Describe the project conclusion goals
References – List all publications, papers, and reports, in a reference list
Appendices – Include important information that is too bulky to fit within the main report, such as computer programs and detailed assembly drawings All items in the appendices must be referenced in the main text
Format the report following a professional engineering organization publications guideline such as the example suggestions listed below (source: ASME publication standards with modifications):
Footnotes
• Numbered consecutively using superscript numbers
• Positioned flush left at the bottom of the column/page in which the first reference appears
• Footnote text should be 10 pt
• Spacing: allow one extra line between the text and the footnote Equations
• Insert equations apart from the body of the text and center Use two or three-line spaces to separate equations from the text
140 Engineering Capstone Design
• Number equations consecutively, using Arabic numerals enclosed in paren- theses and position flush right along the final baseline of the equation Graphics
• Graphics include photographs, graphs, and line drawings
• Number consecutively and include a caption
• Include a centered caption using 11 pt boldface serif typeface, uppercase, below the graphic
• Annotations within the graphic should be no smaller than 9 pt
• Use enough space to separate graphic from the text and other elements
• Position the graphic as close as possible to where it is referenced within the body of the report
• Size the graphics as follows:
• 75 in across the top of the page
• 9 × 75 in (length × width) to fit the entire page (portrait or landscape)
• Gantt and QFD charts should be formatted as large as possible (tabloid is best 11 × 17 in)
Tables
• Number consecutively and add a descriptive caption
• Include 11-pt boldface caption centered above the table
• Position the table as close as possible to where it is referenced within the body of the report
• Use enough space to separate the table from text and other elements
• Size the tables as large as needed to display all information clearly
• 75 in to fit across the top of the page
• 9 × 75 in (length × width) to fit the entire page
• Rotate the table sideways (landscape) if needed for a better format List of References
References to sources for cited material should be listed together at the end of the report under a heading called References; footnotes should not be used for this purpose References should be arranged in numerical order according to their order of appearance within the text
1 Reference to journal articles and papers in serial publications should include:
• last name of each author followed by their initials
• year of publication
• full title of the cited article in quotes, title capitalization
• full name of the publication in which it appears
• volume number (if any) in boldface (do not include the abbreviation, “Vol”)
• issue number (if any) in parentheses (do not include the abbreviation,
“No”)
• inclusive page numbers of the cited article (include “pp”)
141 Documentation
2 Reference to textbooks and monographs should include:
• last name of each author followed by their initials
• year of publication
• full title of the publication in italics
• publisher
• city of publication
• inclusive page numbers of the work being cited (include “pp”)
• chapter number (if any) at the end of the citation following the abbrevia- tion, “Chap”
3 Reference to individual conference papers, papers in compiled conference pro- ceedings, or any other collection of works by numerous authors should include:
• last name of each author followed by their initials
• year of publication
• full title of the cited paper in quotes, title capitalization
• individual paper number (if any)
• full title of the publication in italics
• initials followed by last name of editors (if any), followed by the abbre- viation, “eds”
• publisher
• city of publication
• volume number (if any) in boldface if a single number, include “Vol” if part of a larger identifier (eg, “PVP-Vol 254”)
• inclusive page numbers of the work being cited (include “pp”) 4 Reference to theses and technical reports should include:
• last name of each author followed by their initials
• year of publication
• full title in quotes, title capitalization
• report number (if any)
• publisher or institution name, city Sample References
1 Ning, X, and Lovell, M R, 2002, “On the Sliding Friction Characteristics of Unidirectional Continuous FRP Composites,” ASME J Tribol, 124(1), pp 5–13
2 Barnes, M, 2001, “Stresses in Solenoids,” J Appl Phys, 48(5), pp 2000–2008 3 Jones, J, 2000, Contact Mechanics, Cambridge University Press, Cambridge,
UK, Chap 6
4 Lee, Y, Korpela, S A, and Horne, R N, 1982, “Structure of Multi-Cellular Natural Convection in a Tall Vertical Annulus,” Proc 7th International Heat Transfer Conference, U Grigul et al, eds, Hemisphere, Washington, DC, 2, pp 221–226
5 Hashish, M, 2000, “600 MPa Waterjet Technology Development,” High- Pressure Technology, PVP-Vol 406, pp 135–140
6 Watson, D W, 1997, “Thermodynamic Analysis,” ASME Paper No 97-GT-288
142 Engineering Capstone Design 7 Tung, C Y, 1982, “Evaporative Heat Transfer in the Contact Line of a
Mixture,” PhD thesis, Rensselaer Polytechnic Institute, Troy, NY
8 Kwon, O K, and Pletcher, R H, 1981, “Prediction of the Incompressible Flow Over A Rearward-Facing Step,” Technical Report No HTL-26, CFD- 4, Iowa State Univ, Ames, IA
9 Smith, R, 2002, “Conformal Lubricated Contact of Cylindrical Surfaces Involved in a Non-Steady Motion,” PhD thesis, http://wwwcasphysunm edu/rsmith/homepagehtml