Escolar Documentos
Profissional Documentos
Cultura Documentos
Image from S. McCahan et al. Designing Engineers: An Introductory Text. Hobboken, NJ: Wiley, 2015.
Page 355
Table of Contents
Introduction ..................................................................................................................... 3
Learning objectives for the documents and presentations .............................................. 3
Detailed instructions for sections of the reports............................................................... 4
Basic components ....................................................................................................... 4
The Conceptual Design Specification (CDS) adds the following sections ................... 5
In ESP I, the following section is added: ...................................................................... 5
In ESP II, the following sections are added: ................................................................ 5
The Final Design Specification (FDS) does not include Alternative Designs but goes
into more detail on the Proposed Conceptual Design. ................................................. 5
Basic Components .......................................................................................................... 5
Cover Page (template posted) ........................................................................................ 6
Executive Summary ........................................................................................................ 6
1.0
1.1
1.2
1.3
Functions ........................................................................................................... 7
Objectives .......................................................................................................... 8
1.5
Constraints ......................................................................................................... 8
1.7
3.2
Introduction
This guide refers to the following cycle of graded assignments in ESP:
Team Documents (to be submitted to client):
Project Requirements (ESP I)
Project Requirements & Project Management Plan (ESP II)
Conceptual Design Specification (ESP I & II)
Final Design Specification (ESP II)
Individual assignment:
Lessons Learned & Strategy (ESP II)
Oral Presentations:
Seminar Presentation (ESP I)
Design Review Gateway in-tutorial presentation (ESP II)
Final presentation (ESP II - client is invited)
Basic components
Cover Page (posted template)
Executive Summary
1.0 Project Requirements
1.1. Problem Statement
1.2. Stakeholders
1.3. Functions
1.4. Objectives
1.5. Constraints
1.6. Service Environment
1.7. Client Ethics and Values (ESP II)
2.0 Project Management Plan
3.0 Conclusion/Recommendation
4.0 Reference List (IEEE format)
Appendices
Attribution Table: In addition to the required content for the CDS, a hard copy of the
attribution table must be completed and signed by ALL team members. This attribution
table must be submitted to the Teaching Assistant (TA) in the tutorial of the assignment
deadline. It does not have to be included in Google Docs.
Basic Components
The following basic components are required in most documents. However, these
requirements vary slightly from course to course, term to term. When in doubt check the
actual Assignment Instructions, posted on the course website. They will provide the
most authoritative and up-to-date requirements for sections of the document for which
you will be responsible.
Executive Summary
An Executive Summary is a short, detailed synopsis of your report. The final version
should not exceed one page. The purpose of the Executive Summary is to condense
the entire report such that a reader should finish it knowing the basic information about
the project. Only an interested reader needs to read more.
Important decisions about your project may be made based on the Executive Summary
alone. Therefore, it must be complete, clearly and precisely written, and cover the most
important points made in the most relevant sections of your report. Write the Executive
Summary after you have finished the rest of the report.
Executive Summaries are generally written in paragraph form, but may contain bullet
and/or numbered lists. The opening, however, should be in paragraph form. An
Executive Summary is an independent document attached to a report; therefore, it
should not have a page number or a header number or internal citations [numbers in
square brackets].
Note: It is not possible in Google Docs to remove a specific page from the automatic
page number tool. Therefore you will not be penalized for having a page number on
your Executive Summary. To submit the document to your client, you should export it to
Word or another word processing program and then correct all formatting. Remove
page number from the Executive Summary before the document goes to the client.
1.1
Problem Statement
The problem statement describes your clients need in engineering terms and includes
any relevant background information that you have discovered through research. This is
NOT merely a rewording or paraphrasing of the statement the client gives you; this is
the problem in the design engineers own words. It indicates the scope of the problem
and describes the gap in the world that your client is seeking to fulfill with the solution.
It is vital that you figure out the client need BEFORE you begin writing the problem
statement. This is actually the most important part of the assignment. Consider, as you
create the problem statement, the functional basis of the design. To be successful in
this assignment you must be solution independent, NOT solution driven (offering or
implying a solution before fully defining the problem). To be successful in this
assignment you must have references other than the client statement.
1.2
Identification of Stakeholders
Stakeholders are people or organizations that have a stake or interest that will be
affected by the design you are creating. A stakeholder interest is stakeholders
connection to the design: it is an aspect of their business, holdings or existence that will
be affected, positively or negatively, by the design. An interest implies that there may be
benefit or loss. (A stakeholder may be hostile to the whole idea of the design and want
to prevent it.) The interest should be stated independent of the design. Any claim
about the stakeholder interest should be supported by research.
A table is best for this section. It should show the Stakeholder, Interest and impact
which defines the connection between the stakeholder interest and an aspect of the
design (function, objective or constraint). You may create a kind of shorthand to save on
words e.g. C1 to refer to Constraint 1.
This section should include all stakeholders, and their respective interests. However,
although the client, user and design team are the most obvious stakeholders, as a
matter of convention they are NOT included in this list. Rather, the list should show all
other relevant individuals or organizations.
1.3
Functions
Functions are normally verbs i.e. the design will store energy. Other word forms such
as nouns or adjectives are not acceptable. Do not write the design will be for the
storage of energy. (Note, using the appropriate word form for functions reduces the
word count by almost 50%.)
7
1.4
Objectives
1.5
Constraints
A constraint will be identified by shall coupled with a definitive and testable limit.
Constraint statements identify mandatory requirements that the design must meet and
commit the designer to meeting the specification. If the constraint is not met, the system
may have to be re-designed at the expense of the designer to meet the tolerance.
1.6
Service Environment
The service environment describes the location where the design will operate. A
location is more than just a latitude and longitude on earth or a point in space. The
description of a location includes a description of all elements that might typically be
present in that location. For example the amount of rain, the typical temperature range,
the presence or absence of cell phone coverage, the types of animals and insects
native to the environment, the noise level range, and the people. If the technology you
are designing will be mobile, or will be installed in a number of different locations, then
you need to describe the range of conditions typical for these different locations. If it will
only operate outside, then you need to describe the outside conditions. And if it will only
operate inside, then you need to describe the indoor conditions.
Document the total environment that the design must operate in. Service environment
should not be written from the point of view of the device or design. That is, it is not how
the device will be designed to operate within an environment, but what the
environmental concerns are in the first place. In other words, NOT The design must be
water-proof but Temperatures can be expected to range from -32C to +40C.
Average rainfall is 709 mm and snow is 138 mm [1]. However, you may choose to
show the connection between the Service Environment and FOCs already defined in
your document as you did in the Stakeholders Section a kind of shorthand to save on
words e.g. C1 to refer to Constraint 1.
Physical environment
Considerations may include range of temperature, pressure range, wind velocity, rain
and salt spray, humidity, dirt and dust, corrosive environments, shock loading, vibration,
and noise level. When writing this sub-section:
9
As a general rule, you do not need to choose the most extreme extremes:
e.g. the record low temperature or high temperature. Engineers typically use
ranges that are based on statistical percentages. For example ASHRAE
tables (American Society of Heating, Refrigeration, and Air-conditioning
Engineers) and other environmental statistics will report the 99% low
temperature or 1% high temperature for an environment which means that
99% of the time the temperature is above this low and 1% of the time the
temperature is above this high.
You may also acknowledge other elements that may be active in the users
environment, including (but not limited to) appliances or machinery.
Living things
This subsection identifies organisms that may interact with the design or need to be
considered when developing the design. To think about when writing this sub-section:
Virtual environment
This subsection identifies any virtual systems that may exist within the physical
environment. These may include the presence of WiFi or a cellular network, the
operating system for the computer, or version of the software.
1.7
This section demonstrates that you understand your clients perspective. The client may
have specific ethical policies that will impact cost or implementation. Additionally, the
client may have values that will influence a design choice; these values may relate to
labour practices, aesthetics, cultural perception, or be environmental, social, or political.
Your client will be reading this section. Be professional and diplomatic.
10
3.0 Conclusion
Summarize the key points and bring the document to a close in a way that fully defines
what the reader may expect, at this point, from the project. The reader should therefore
have reaffirmed any action they are being asked to take as well as those you are taking.
This is not a word-for-word repetition of earlier material, but rather a way of bringing the
document together and consolidating its main message(s). It may include
recommendations and/or next steps.
11
Appendices
In the appendices, put material that does not fit in the flow of the document, either
because it is too extensive or because, though only a part of it is relevant, you have
included the whole to give an interested reader a complete, detailed understanding of
your subject. Examples are: manufacturers' data sheets, relevant research documents,
or details of alternate designs.
As far as figures are concerned, determining which should be in the body of the
document and which should be in the appendices will be a matter of judging the
relevance of the figure and the way that it fits into (or disrupts) the flow of the document.
It is vital to include the most relevant drawings, plans or sketches in the body of your
document; additional ones can be included in the appendices.
Any information included in the appendices must be mentioned in the body of the report.
Moreover, all material in the appendices, including published material such as
manufacturers specifications, must have a short explanation written by your team
showing the relevance of this material. Material should be divided appropriately into
individual appendices, each of which should be clearly labeled and titled: eg, Appendix
F: Drawings of Alternate Designs.
Sources for all material included in appendices must be documented in the
Reference List. You do this by putting a number in a square bracket [#] next to the
discussion of the appendix in the body of the report. Then you add to the reference list,
as you would any reference material, the full bibliographic information in correct form, as
explained in the Course Package.
2.1 2.5
There should be five alternatives and all must be feasible. You may not have one
clearly superior design and four clearly inferior designs. Give a unique name for each
design to aid your reader in recalling each design for example, Design 1 Ramp
Meters, Design 2 - Viaduct. Give a short description of each alternative design and then
review its performance in relation to project key requirements functions, objectives
and constraints. A table listing the same requirements (e.g. the same top objectives) for
each alternative helps the reader to compare the alternatives. Use parallel structure
throughout the five alternative design subsections to make it easier for your reader to
understand the comparison.
In each section, provide visual descriptions for all designs (such as sketches, drawings,
schematics, flow charts). Add measurements where appropriate. Make sure all figures
and tables are labelled according to the style requirements of the course.
If you have too many figures to include in the body of the report, you may add extra
figures in the appendices. Refer your reader to these appendices clearly in the body of
the report, identifying each appendix by alphabetical designation and title e.g.
Appendix A: Design Option 1 Details of the Power Supply.
3.0
Identify the alternative design your team is recommending, and provide a rationale
explaining how and why it will solve the clients problem. Whereas the alternative
section showed how each alternative meets the technical requirements (functions,
objectives and constraints) this introduction justifies your design approach and shows
how meeting the functions, objectives and constraints (FOC) will result in the outcome
the client has asked for. In this brief, persuasive discussion, you will explain how the
solution will have the desired result and you will support that explanation with evidence.
3.2
Metrics (ESP I)
To persuade your client to proceed with the recommended design, you must
demonstrate that there are actual tests to show that your recommended design will
meet the design objectives. Given the restrictions of the document, the Metrics section
should focus only on the most critical objectives in your project and should rely on
appropriate conventional testing methods that have been documented by credible
sources, such as ISO or CSA or other standards organizations. You are not expected to
perform these tests.
For more information, please see Designing Engineers: An Introductory Text
Investigating Ideas: Using Metrics, pp. 177-179 (Chapter 7, section 7.1 in WileyPLUS).
3.2
Determine the scope for the Final Design Specification, the next document you will work
on. What will you deliver to your client? A design, a flowchart, a paper prototype? What
seems feasible at this point? What is your plan for creating a detailed design? What
aspects of the design are you proposing to detail, and to what degree? Give your client
a good idea of what to expect at the end of the term.
14
15
Disclaimer
All Final Design Reports must have clearly noted on the Cover Page, the following
disclaimer:
This Final Design Specification (the "Report") has been prepared by first year
engineering students at the University of Toronto (the "Students") and does
not present a Professional Engineering design. A Professional Engineer has
not reviewed the Report for technical accuracy or adequacy. The
recommendations of the Report, and any other oral or written
communications from the Students, may not be implemented in any way
unless reviewed and approved by a licensed Professional Engineer where
such review and approval is required by professional or legal standards, it
being understood that it is the responsibility of the recipient of the Report to
assess whether such a requirement exists.
16
Safety and environmental regulations and standards that apply to your project
Building codes that apply to your project
Any patented technologies or processes that are relevant to this project. It is
not likely that you will be infringing on patents, but you should make the client
aware of the licensing fees for patented or copyrighted material (e.g.,
software packages) if applicable.
For more information on regulations, standards and IP, please see Designing
Engineers: An Introductory Text Constraints, pages 56-60 (Chapter 2, section 2.4 in
WileyPLUS) and Design for X: Intellectual Property. pp. 436-459 (Chapter 18 in
WileyPLUS).
2.2 Testing
Indicate how your proposed design would be tested to ensure that it meets important
design objectives. ESP teams are rarely called upon to perform the actual tests, so
identify and describe three standard tests that would be conducted. These tests should
be feasible and include measurable criteria where appropriate. Good sources for
credible tests are standards organizations such as ISO or CSA. Note: Section 2.1 has
already identified safety and environmental regulations, so do not repeat that
information in this section.
For more information, please see Designing Engineers: An Introductory Text
Investigating Ideas: Using Metrics, pp. 177-179 (Chapter 7, section 7.1 in WileyPLUS).
There may be other questions to consider, depending on your project. If your client has
approved the recommended design from the CDS, you can build on the Preliminary
Implementation Requirements section from that document, this discussion is expected
to be more detailed and thoroughly researched than the one in the CDS.
For more information on Implementation Requirements, please see Designing
Engineers: An Introductory Text Post Conceptual Design, pages 194-217 (Chapter 8
in WileyPLUS).
17
2.7 Economics
This section has a different focus than Implementation Requirements. That section
focused on the costs for materials and installation. This section looks at the design from
a broader perspective. While you should summarize capital expenditures and
installation costs, this is where you identify operating costs including energy, materials,
18
19
All explanations must be in the body of the document the Lessons Learned and
Strategies section(s) and not in the Appendix of Examples or other Appendices. The
word limit for this document is intentionally kept tight; marks will be deducted for any
attempt to add words either in the appendices or by including wordy additions as jpgs or
any other format that subverts word count processes. Further, labels must NOT be
longer than 200 characters, including spaces.
Evidence is anything that backs up your explanation:
A reference list is only required if you used research in exploring some of the ideas you
discuss in the document. In such a case, all requirements in relation to the use of other
peoples ideas and words will apply to this document.
Oral Presentations
Various forms of oral presentation are performed in Engineering Strategies and Practice
I & II, from informal small group talks, to client interviews to formal presentations.
Person to person interactions are key to developing trust. Interviews and conversations
can do this. Presentations take person-to-person to a higher level person to group or
group to group. They are more structured than conversations but in engineering should
have a sense of spontaneity and ease. That is, the speaker should seem to be simply
talking to the audience, but in a heightened way that is structured and gives the
audience a sense of efficiency. Such a presentation contains no irrelevant details. It
comes to an end appropriately and in good time. (Based on Dieter, Engineering Design:
A Materials and Processing Approach p.768)
Outline form
An outline enables you to give a presentation that seems spontaneous but in reality
reflects a high degree of control on your part. A template is provided with the following
required fields:
o
o
o
o
o
o
o
Opening Strategy
Main Statement
Keyword Summary of Sub-statements
Sub-statements with individual explanations and evidence
Conclusion
Take-Away Statement
Question and answer period
21
22
For more information on design, please see Designing Engineers: An Introductory Text
Communication: Effective Slides, pages 354-359; (Chapter 13, section 13.8 in
WileyPLUS). Also, visit Michael Alleys website Scientific Presentations The
Assertion-Evidence Approach http://writing.engr.psu.edu/slides.html - this site has great
information, examples and templates.
23