How To Write A Design Report
How To Write A Design Report
How To Write A Design Report
Table of Contents
I. Before you Begin ...........................................................................................1
II. Design Report Organization...........................................................................2
III. Format and Style ............................................................................................4
IV. Design Report Outline....................................................................................5
Volume I....................................................................................................7
1. Title Page ........................................................................................7
2. Executive Summary........................................................................7
3. Problem Definition .........................................................................8
4. Design Description .........................................................................8
5. Evaluation .......................................................................................9
6. References.....................................................................................10
Volume II.................................................................................................11
1. Problem Definition Support Documents ......................................11
2. Design Description Support Documents ......................................13
3. Evaluation Support Documents ....................................................14
Audience: anyone who has to implement your design, understand your design, or reference it to
solve their own unique problem. Typically, this is the project client. While the client may be
familiar with the project, the report is still written as thought the client is new to the project.
Committed to your friend’s well-being, you take the appropriate action. You find a box-spring
on craigslist for free. You suggest the use of caffeine-free tea after 6 pm and recommend that he
play Bach softly as he falls asleep to drown out the sound of late-night buses. Your friend thanks
you for the best night’s sleep he’s had in a while.
Word spreads and it isn’t long before someone comes to you and says, “A friend of mine is
having trouble sleeping at night.”
What do you tell them? Do you say, “Easy, get a box spring and play Bach!?” If you did that,
they would be confused. This is how you would answer.
“My friend Tim was having problems sleeping at night. He had three problems. He had an
unsupportive mattress, he was drinking WAY too much coffee, and there are noisy buses passing
outside his window every night. I got him a new mattress, got him hooked on caffeine-free tea,
and had him play music to block out the background noise.”
If you stopped there, you would most certainly be asked one more question, “did it work?”
Therefore, you would continue.
“After we made those changes, Tim slept great for almost three weeks. He told me everything
was back to normal, and what’s better, he’s become a huge classical music fan. The only
drawback was getting the mattress for free off of craigslist. Next time I’d pay a little money for
one that was less dirty.”
This problem is not an engineering design problem, but the way in which it is documented is
identical. The documentation has three main parts: problem definition, design description, and
evaluation. All three are required to communicate your solution.
B Design Description
In this part you describe your solution to the problem. You describe what your solution is and
how it works.
C Evaluation
In this part you describe how you have verified that your solution works. You do this by
evaluating it against the design requirements you outlined in the problem definition. It is not
enough to simply provide a solution to a problem; you have to know it works. Evaluation could
be through experimental testing of a prototype, through analysis or by computer simulation
Lastly, this part describes the main strengths and weaknesses of the design and describes
recommendations for future work.
D Design Requirements
The design requirements are a central element to the design report and must be concrete,
measurable criteria which can be tested. They should be based on a user need. For example,
“supports 80 lbs” and “has an emissivity greater than 0.8” are concrete testable requirements.
“Looks nice, ” “comfortable, ” and “low cost are user needs and not design requirements. Refine
them to measurable criteria, like “aesthetically rated above average on a 5 point Likert scale” or
“can be held for 5 minutes without fatiguing the average user’s hand,” Or “parts cost less than
$20 in lots of 100.”
One last thing to consider when setting design requirements is that they must be tested by you. If
you do not (or can not) test them, even approximately, then they do not belong in the report. For
example, do not use the design requirement, “can withstand a half-mile drop test,” unless you are
going to either make an analytical model or empirically test out of a C-130.
The absence of a methods section in a design report will be disconcerting when writing your
report. You might have spent up to half the semester considering different concepts before
choosing one, but ultimately you won’t write about that process. The audience only cares what
you came up with. If you find you are writing more than a paragraph about your concept
selection process, you’re writing too much.
B Tense
Use past tense to describe what you did or found out. For example, “We built and tested a
prototype.” Use present tense to describe things that were known before your project. For
example, “Squirrels are warm-blooded.”
C Self Supporting
Your report should provide enough information to be understood. It shouldn’t reference outside
sources for information that is essential to understanding.
D Technical Writing
The basis for technical writing is to communicate information as clearly and effectively as
possible. You should not use language that is excessive or complex. This is typically done by
writing at an 8th grade level. This does not mean you have dumb down your engineering. Define
terminology that might be confusing and avoid wordiness. Don’t be dramatic; drama is used in
creative writing to elicit an emotional response. Technical writing is centered on the use of
logic.
H Report Length
The executive summary should be a page, with approximately 30% of that space occupied by a
figure. Volume I of the report should be between 20 and 25 pages, with no more than about 25%
of that space occupied with figures and tables. There is no limit to Volume II. The purpose of
the length requirement is to keep your writing focused and concise.
Volume I
This 20 – 25 page document describes the project clearly and concisely. It contains the problem
definition, design description, and evaluation
Volume II
This large second volume documents the design in excruciating detail. It contains elements of
Problem Definition, Design Description, and Evaluation. Volume II contains all of the
supporting information for your project.
In addition Volume 1 has a title page, an executive summary and a list of references.
1 Title Page
The title page has the project title, team members, advisor name, client name, the date, and one
graphic that best shows the design solution.
2 Executive Summary
The executive summary distills your entire report onto a single page that is about 70% text and
30% graphic. The executive summary contains a succinct synopsis of the problem definition, the
design description and the evaluation. .
This section provides the background and significance of the project, and a state-of-the-art
technical review
The review has two parts. The first part is a more detailed background to the field. For example,
if you are developing a medical device, the background would be a tutorial on the medical
condition being treated by the device.
The second part of the review describes all of the prior art relevant to the problem, which means
all of the existing technology and methods relevant to the problem. This can include commercial
products, academic journal articles and theses, and patents.
The technical review will have many citations to the source of the information with citations
listed in the Reference section. Citations and references should follow IEEE or ASME style.
4 Design Description
This section describes your solution to the problem. It describes both what the solution is and
how it works.
5 Evaluation
In this section, you verify the solution you have provided. You do this by looping back to the
design requirements you established in the first section.
If you developed a prototype to satisfy a design requirement, this is the section to discuss it. The
prototype will be the method section for an experimental report to test one or more design
requirements.
The four major parts of a lab report are introduction, methods, results, and discussion. In the
introduction, state what you are testing and the theory behind it. In methods, describe how you
tested these requirements. In the results section, show the results of the testing. In the discussion
section, interpret the results and make a conclusion on the testing of the design requirement.
The abstract for these small lab reports should include parts from each of the four I M R D
sections.
5.3 Discussion
6 References
This section contains a list of the references cited in the report. . Use IEEE ASME format for
these citations. Use RefWorks to manage your citations.
These supporting documents won’t flow along the same way as the main report. The reader will
come to this section when they seek additional information not found in volume I. This becomes
a reference and only these mini-reports need to flow, not volume II as a whole.
The summary section is first and summarizes the material that was researched. There is usually
one paragraph spent describing the current state of the field. Then the remainder of the page is
spent discussing how the research affects your design project.
The references section is simply a big list of the references you researched, separated by a
paragraph or two of discussion. The citation style is ASME or IEEE. Include a very brief
summary of the article. This is mostly so you can find the article later from fragments you
remember. Then your second paragraph discusses the implications this article has for your
report. If it does not apply to your design, just state that.
The patent search should have three main parts: objectives, search criteria, and findings.
The objectives section should show why you are doing the patent search. Give a brief overview
of your design and what parts of it might be patentable.
The search criteria are the ways which you found the patents. Show the databases you searched,
like Google or USPTO. Give class and sub-class numbers which you searched in. State the
keywords you searched as well.
The findings section should describe one or two main patents which relate to your project.
Explain why your sponsor would want to know about these and how they relate to the design.
Assess the level of threat these patents pose to your design’s patentability.
After the major findings, you can discuss some smaller risk patents that might have features of
interest to your sponsor.
Attach the front page of any relevant patents as an appendix to this report. Do not attach patents
in the appendix if you never discussed them.
List user needs for your project here. Rank them by priority and provide their sources.
Provide a categorical approach to presenting different concepts here. Do not simply paste in fifty
concept sketches and let it be sufficient. Group your concepts into a few main categories and
provide an example or two from each category. Briefly describe how each concept would work.
At the end of this section, discuss the validity in your chosen concept. Persuade the audience
that you chose correctly and justifiably.
For each report, have an introduction, method, results, and discussion section. If the same
apparatus or method is used to evaluate different criteria, there is no need to re-describe your
previous explanation.
In the method, describe the way that you tested the design criteria. The apparatus for this testing
might be a prototype, computer simulation, physical experiment, or hand analysis. Include the
procedure for your testing as well.
In the results, describe the results of the testing you performed. This should show the analysis
equations and a graph or other graphic result.
Contrast these costs with the sales potential. State the market your design would serve. If a one-
off, state the cost savings of your design versus others. The idea is to give the sponsor company
an impression of the value added to them by your design.
An environmental impact statement has four main parts: purpose and need, impact to
environment, alternatives to design, and discussion.
In the purpose and need, briefly describe the value added by your design. What good does your
design provide for society?
In the impact to environment section, describe how your design is going to change the
environment by its existence. Think of the impact during the whole phase of product life:
production, use, and end-life. Does it pollute? Is it user-serviceable? Is it disposable?
In the alternatives to design section, give alternatives to your design that might be more
environmentally friendly. Might you consider an end-of-life reclamation program? What about
using biodegradable lubricants?
In the Discussion section, weigh the alternatives with the additional cost. Show how you have
considered the environment in your design. You might decide it would be better to compromise
and propose future work to your design. This is an extension of your strengths and weaknesses
analysis from Volume I.