Loading in 2 Seconds...
Loading in 2 Seconds...
The CI-M Side of 6.111 Lab 2: Writing the Design Report. Donald N.S. Unger, PhD Writing Across the Curriculum Spring 2008. DigiAlarm’08 Sands Hotel, Las Vegas 29-30 January 2008. I’m on the MIT website. Really. Does the “envelope” really matter?. “I gave you the information.
Writing the Design Report
Donald N.S. Unger, PhD
Writing Across the Curriculum
Sands Hotel, Las Vegas
29-30 January 2008
“I gave you the information.
What’s the problem?”
Easy to understand
Logically laid out
In a familiar form
1. Attention to detail
2. Quick follow-through
4. Genuine interest
. . . . The characteristics of someone with whom you would want to work.
If I send you off to find my contact information, I’m telling you that you are on your own.
If I give you my card, I am showing you that I will make sure that you don’t have to hunt for information, and that, by extension, you can both rely on my technical expertise and rely on me personally as well.
How you communicate demonstrates your professionalism along multiple axes.
Hard skills matter. You have to present the right information and present it clearly.
Soft skills matter too. You have to communicate in ways that convey an awareness of professional standards of behavior.
Is your design report so good that it would get you the job?
Letter of Transmittal
Title and AbstractTable of ContentsList of FiguresOverview Focus on thisDescriptionConclusionReferencesAppendices
“Wrapping”: Letter of Transmittal, Title and Abstract, Table of Contents, List of Figures, References, Appendices
“Core”: Overview, Description, Conclusion
If the overview is clear, complete, concise, and well organized, it provides a map, both for the reader and for you as a writer.
1. Describe the overall goals of the design
2. Provide a concise specification of the functionality
3. Present the specification in a manner that allows the client to quickly and easily assess whether or not it does everything she would like it to do
Graphics should be: labeled, self-contained, explained in the text
If it’s not yours (even if that’s “obvious”) or it’s not common knowledge, give credit—using IEEE citation format
Page Set-Up: one column, single spaced, justified left, ragged right, 1” margins,12 point font (of a professional sort, f. ex. Times Roman or Helvetica)
Your report should run 4000-6000 words, not including appendices
As long as you convey all the information you need to convey (ask your TA), and do so clearly and in good prose (ask your writing instructor), you do better to aim for concision