9/29/20091Writing the Lab 3 Design ReportWriting Across the CurriculumBen Miller, Ph.D.Writing Across the CurriculumFall 2009Common Reasons Why Project Proposals are RejectedErnest Allen, Chief of the Division of Research Grants, NIH.n = 605n = 605Approach ( 73%)1. The proposed tests, or methods, or scientific procedures are unsuited to the stated objective. (34.7)2. The description of the approach is too nebulous, diffuse, and lacking in clarity to permit adequate evaluation. (28.8)3. The overall design of the study has not been carefully thought out. (14.7)Writing Across the CurriculumScience, Vol. 132, pp. 1532‐34, Nov. 1960.Writing the Design ReportIf you were reading a design report about a sequential FSM Car Anti‐Theft System, what would you need to see? If you were reading a design report with the intent of funding that project, what else would you need to see?What does a complete project proposal do?1. Describe: Conveys all necessary information to understand the common and uncommon features of a designWriting Across the Curriculumuncommon features of a design2. Persuade: Present the measurable outcomes of the project, explain the concrete objects that result from this project and how they are guaranteed to work.3. Inspire: organized documents reflect organized work processes and instill confidence in logic, professionalism, and abilities of designers.Design Report Components and FrameworkLetter of TransmittalDesign Report Title and AbstractDesign Report Title and AbstractTable of ContentsList of FiguresOverviewDescriptionFront MatterOrientCoreEliWriting Across the CurriculumConclusionReferencesAppendicesEnd MatterExtensionExplain9/29/20092Letter of T ransmittalBriefSpecificAccurateFormalDigital Lab Designs, Inc.George P. BurdellSenior [email protected] Engineering Division450 Memorial Dr.Cambridge, MA 02139October 31, 2009FormalMs. Jane Porsche222 Technology SquareCambridge, MA 02139Dear Ms. Porsche:I submit herewith a proposal for the automobile anti‐theft system that meets your specifications.Please feel free to contact me at the phone number or e‐mail address b ihih b lWriting Across the Curriculumabove with any questions or concerns you have about our proposal.Your consideration of our proposal is greatly appreciated.Sincerely,George P. BurdellEnclosure: ProposalStrengths of a Good Design DocumentResponds directly to the required specificationsHolistic overview of projectHolistic overview of projectOverview of necessary componentsOverview of required logicExplanation of design decisionsSufficient definitions to allow a reader to continueWriting Across the CurriculumSufficient definitions to allow a reader to continueSufficient description to allow a reader to imagineDemonstrates concern for dealing with problems –testing and debuggingStrengths of a Good Design DocumentDegrees of Sufficient DefinitionsParentheticalThe system timings are based on four parameters (in seconds) the delayThe system timings are based on four parameters (in seconds): the delay between exiting the car and the arming of the alarm (T_ARM_DELAY), the length of the countdown before the alarm sounds after opening the driver's door (T_DRIVER_DELAY) or passenger door (T_PASSENGER_DELAY), and the length of time the siren sounds (T_ALARM_ON).SentenceFuel Pump Logic. This simple FSM controls the power to the fuel pump.Writing Across the CurriculumParagraphThe time parameters module is made up of four 4 bit memory values which can be reprogrammed by the user. These four values can also be selected as outputs to other modules which use them as parameters for that various timings between states.An Example of a Poor Testin g and Debugging DescriptionTest i n g and debuggingTest i ng and debugging was not too difficult for this labTest i ng and debugging was not too difficult for this lab. First of all, the signals of the included florescent display in the labkit are driven using a hexadecimal display driver such that numbers passed in as inputs to the driver will determine the numbers display on the 16‐character florescent display. Using the code supplied in the Appendix, the least significant digit shows the current state of the FSM (see the Anti‐Theft FSM module Description for number to state correspondence). The second to the last digit shows the time left in the Timer module. The third right‐Writing Across the Curriculumto the last digit shows the time left in the Timer module. The third rightmost digit is driven by the time_param_selector inputs while the next two digits are the time values to be reprogrammed into the Time Parameter module. The next two digits are driven by the Siren generator to display the current siren frequency.9/29/20093Relevant DatesReport due October 15Commented report returned by October 29Comments are representative of typical difficultiesComments are representative of typical difficultiesComments facilitate revision, not editingPeer workshop on November 5During class time, required attendanceBring two hardcopies of your reportPrior, consider an appointment with the writing centerRevised report due November 13Writing Across the CurriculumFormatCite everything not yours. Use IEEE citation format.Page should be single‐column left aligned 1”margin reasonable fontPage should be single‐column, left aligned, 1 margin, reasonable fontFigures must be included in a four‐part process.Sentence define the figure: “Figure 1 shows the various inputs and outputs…”Include the figureCaption the figure descriptivelyExplain the relevant elements of the figure…and if necessary, cite the figure’s sourceWriting Across the CurriculumReport length is 4000 ‐6000 words. This range describes about how much detail is required to fully explain your proposal. Avoid padding, and avoid running long. Odds are, if a report does either, it’s because of too shallow or too vague a description.ResourcesWriting and Communication Centerhttp://humanistic.mit.edu/wccMayfield Handbook on Technical Communicationhttps://web.mit.edu/21.guide/www/home.htmT ransmittal Lettershttps://web.mit.edu/course/21/21.guide/www/l‐trans.htmBen [email protected] Across the CurriculumDon
View Full Document
Unlocking...