Unformatted text preview:

How to Write a 6.033 Design ReportWhy are you here today?Why are you here today?Steps in the Writing ProcessRead comments on your proposalRe-read the assignmentIdentify prioritiesFix your design!Write the design descriptionWrite the design descriptionWrite introductionWrite conclusionWrite the front and end matterDouble-check design specsRefine, clarify, & peer reviewProofreading ChecklistProofreading ChecklistProofreading ChecklistReport FormatWriting HelpHow do we grade DP1?How do we grade DP1?How to Write a 6.033 Design ReportMya Poe1and Chris Lesniewski-Laas21MIT Program in Writing and Humanistic Studies2LCSMarch 2004Why are you here today?1. Proposal → report2. Show you how a computer designer “thinks through” a design problem.3. Explain what we look for when grading reports.Why are you here today?1. Proposal → report2. Show you how a computer designer “thinks through” a design problem.3. Explain what we look for when grading reports.z Proposal is not the report! z “A” on proposal may not = “A” on reportSteps in the Writing Process1. Read comments on your proposal2. Re-read the assignment3. Make a priority list of design ‘fixes’4. “Fix” your design5. Write design description6. Write introduction & conclusion7. Write front & end matter8. Double-check design specs9. Clarify and refine report -- peer review!10. ProofreadStep #1Read comments on your proposalz What information was missing or unclear?z What was good?z Can you build off existing design or do you need to “start from the ground up”?You wrote:“The master process cycles through all 1,000 cameras in a round-robin fashion, reading 2 seconds of data from each connection.”You wrote:“The master process cycles through all 1,000 cameras in a round-robin fashion, reading 2 seconds of data from each connection.”TA responded:What happens if network congestion prevents a camera from responding?QueuePipe PipeRPCControllerQueueWhat code implements this structure?Pipe PipeRPCControllerStep #2Re-read the assignmentProposal did not address all aspects of the assignment:z What’s missing?z What about format? Document specs?z FAQ & Proposal Feedback GuideStep #3Identify priorities1. Make the system work.| Is part of the system undefined?| Can you actually build it?2. System should continue to work under normal faults in transcoder or AI3. Resilience to overloadΩ PerformanceStep #4DemoFix your design!Identify problem ↓Fix design ↓Simplify design ↓Update schematicStep #5Write the design description1. Uses Apache.2. Operates in the MP [or MT] model. 3. Spawns a new thread to handle each request; each thread pulls a response from a shared pool of images.Develop description from general to specificStep #5Write the design descriptionz Use section headings to show hierarchy of ideasz Chunk information into readable sectionsz Use figures, tables, and pseudo-code to illustrate conceptsSections are organizing toolStep #6Write introductionz State design purposez List specific design considerationsz State your approach to the problemEach design problem has a considerationExample 1.0 Design OverviewThe goal of this design is to provide . . . We accomplish this goal by . . . . We achieve fault isolation by . . Our concurrency model . .Step #6Write conclusionEvaluate your design!z Summarize design problems you solved,z Identify problems in your design, &z Justify why your design does not address these problems5.0 ConclusionOur Surveillance@Home design uses processes to . . . This design does not cope well with long term overload because . . .[explain why you did not address this issue]Write the front and end matterz Executive Summaryz Title PageTitleYour nameID#Recitation instructor Section timeDatez Acknowledgements• Anyone who helped you with designz ReferencesIEEE styleStep #7AcknowledgementsThank you to Professor Kaashoek and Chris Lesniewski-Laas for their suggestions on achieving fault isolation. References[1] F. Cavalieri, T. Ruscio, R. Tinoco, S. Benedict, C. Davis, and P. K. Vogt, "Isolation of three new avian sarcoma viruses: ASV9, ASV17, and ASV 25," Virology, vol. 143, pp.680-683, 1985.Step #8Double-check design specsIdentify problem ↓Fix design ↓Simplify design ↓Update schematicz Ensures that you have not missed any design specsStep #9Refine, clarify, & peer reviewz Give your report to a peer for reviewz Refine writing:Writing tutors are available to help you.z DP1 graded on writing & content: 6.033 is CIM courseProofreading Checklist Did you chunk information into expected sections?Executive SummaryTitle Page1.0 Design Overview Organize by function:2.0 Design Description Fault IsolationResource AllocationAlternatives3.0 ConclusionAcknowledgementsReferencesStep #10Step #10Proofreading Checklist Did you chunk information into expected sections?Executive SummaryTitle Page1.0 Design Overview2.0 Design Description Organize by Modules3.0 ConclusionAcknowledgementsReferencesStep #10Proofreading ChecklistDid you number the pages?Is your name on every page?All figures/tables labeled & referenced in the text?All sources cited?Did you avoid:  naked “this” “the reason is because . . ”  “the fact that . . .” over-use of “I” passive voiceDid you proofread a printed copy?Report Formatz 11 or 12 point fontz Single-spacedz No more than 5,000 words, including executive summaryz Submit 2 copiesz Not stapled—paper clippedWriting Helpz Model DP1 papers on 6.033 websitez Readings in your course packetz Writing Center http://web.mit.edu/writingz Mayfield Handbook of Technical and Scientific Writingz Writing Tutors available:To make an appointment online http://web.mit.edu/course/other/practicum/www/6.033/How do we grade DP1?Technical staff:1. Is the design described unambiguously?2. Does the design achieve design goals?3. Are your design decisions well justified?How do we grade DP1?Writing Staff:1. Is the report well-organized within and across sections?2. Is it professionally presented?3. Are text and figures integrated?4. Is the writing clear? Edited prose?Technical staff:1. Is the design described unambiguously?2. Does the design achieve design goals?3. Are your design decisions well


View Full Document

MIT 6 033 - How to Write a 6.033 Design Report

Documents in this Course
TRIPLET

TRIPLET

12 pages

End Layer

End Layer

11 pages

Quiz 1

Quiz 1

4 pages

Threads

Threads

18 pages

Quiz I

Quiz I

15 pages

Atomicity

Atomicity

10 pages

QUIZ I

QUIZ I

7 pages

Load more
Download How to Write a 6.033 Design Report
Our administrator received your request to download this document. We will send you the file to your email shortly.
Loading Unlocking...
Login

Join to view How to Write a 6.033 Design Report and access 3M+ class-specific study document.

or
We will never post anything without your permission.
Don't have an account?
Sign Up

Join to view How to Write a 6.033 Design Report 2 2 and access 3M+ class-specific study document.

or

By creating an account you agree to our Privacy Policy and Terms Of Use

Already a member?