how to write a 6.033 design report

How to Write a 6033 Design Report

Mya Poe1and Chris Lesniewski-Laas21MIT Program in Writing and Humanistic St

udies2LCS

March 2004

Why are you here today

1Proposal rarrreport

2Show you how a computer designer ldquothinks throughrdquo a design problem

3Explain what we look for when grading reports





bullProposal is not the report bullldquoArdquo on proposal may not = ldquoArdquo on report

Steps in the Writing Process

1Read comments on your proposal2Re-read the assignment3Make a priority list of design lsquofixesrsquo4ldquoFixrdquo your design5Write design description6Write introduction amp conclusion7Write front amp end matter8Double-check design specs9Clarify and refine report --peer review10Proofread

Read comments on your proposal

bullWhat information was missing or unclear

bullWhat was good

bullCan you build off existing design or do you need to ldquostart from the ground uprdquo

You wroteldquoThe master process cycles through all 1000 cameras in a round-robin fashion reading 2 seconds of data from each connectionrdquo


TA respondedWhat happens if network congestion prevents a camera from responding

Pipe Pipe

RPC

Controller

Queue

Pipe Pipe

RPC

Controller

Queue

What code implements this structure

Re-read the assignment

Proposal did not address all aspects of the assignment

bull1048698Whatrsquos missingbull1048698What about format Document specsbull1048698FAQ amp Proposal Feedback Guide

Identify priorities

1Make the system workbull1048698Is part of the system undefinedbull1048698Can you actually build it

2System should continue to work under normal faults in transcoderor AI

3Resilience to overloadΩPerformance

Fix your design

Identify problem darr

Fix design darr

Simplify design darr

Update schematic

Demo

Write the design description

1Uses Apache

2Operates in the MP [or MT] model

3Spawns a new thread to handle each request each thread pulls a response from a shared pool of images

Develop description from general to specific


bullUse section headings to show hierarchy of ideasbullChunk information into readable sections

bullUse figures tables and pseudo-code to illustrate concepts

Sections are organizing tool

Write introduction

bullState design purpose

bullList specific design considerations

bullState your approach to the problem

Each design problem has a consideration

Example

10 Design OverviewThe goal of this design is to provide Weaccomplish this goal by We achieve fault isolation by Our concurrency model

Write conclusion

Evaluate your design

bullSummarize design problems you solved

bullIdentify problems in your design amp

bullJustify why your design does not address these problems

50 ConclusionOur SurveillanceHome 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 matter

bullExecutive SummarybullTitle PageTitleYour nameIDRecitation instructor Section timeDate

Acknowledgements

bullAnyone who helped you with design1048698

ReferencesIEEE styleStep

AcknowledgementsThank you to Professor Kaashoekand Chris Lesniewski-Laasfor 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 pp680-683 1985

Double-check design specs

bullEnsures that you have not missed any design specs


Fix design darr


Update schematic

Refine clarify amp peer review

bullGive your report to a peer for review

bullRefine writingWriting tutors are available to help you

bullDP1 graded on writing amp content 6033 is CIM course

Proofreading Checklist

bullDid you chunk information into expected sections

Executive SummaryTitle Page10 Design Overview20 Design Description

30 ConclusionAcknowledgementsReferences

Organize by function Fault IsolationResource AllocationAlternatives





Organize by Modules


bullDid you number the pagesbullis your name on every pagebullAll figurestables labeled amp referenced in the textbullAll sources citedbullDid you avoid

bullDid you proofread a printed copy

bullnaked ldquothisrdquobullldquothe reason is because rdquo bullldquothe fact that rdquobullover-use of ldquoIrdquobullpassive voice

Report Format

bull11 or 12 point fontbullSingle-spacedbullNo more than 5000 words including executive summarybullSubmit 2 copiesbullNot stapledmdashpaper clipped

bullModel DP1 papers on 6033 website

bullReadings in your course packet

bullWriting Center httpwebmiteduwriting

bullMayfield Handbook of Technical and Scientific Writing

Writing Help

bullWriting Tutors availableTo make an appointment online httpwebmiteducourseotherpracticumwww6033

How do we grade DP1

Technical staff1Is the design described unambiguously2Does the design achieve design goals3Are your design decisions well justified

How do we grade DP1


Writing Staff1Is the report well-organized within and across sections2Is it professionally presented3Are text and figures integrated4Is the writing clear Edited prose

Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29














bullWhat was good





Pipe Pipe

RPC

Controller

Queue

Pipe Pipe

RPC

Controller

Queue





Identify priorities




Fix your design


Fix design darr


Update schematic

Demo


1Uses Apache








Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29




Pipe Pipe

RPC

Controller

Queue

Pipe Pipe

RPC

Controller

Queue





Identify priorities




Fix your design


Fix design darr


Update schematic

Demo


1Uses Apache








Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

Pipe Pipe

RPC

Controller

Queue





Identify priorities




Fix your design


Fix design darr


Update schematic

Demo


1Uses Apache








Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29




Identify priorities




Fix your design


Fix design darr


Update schematic

Demo


1Uses Apache








Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

Fix your design


Fix design darr


Update schematic

Demo


1Uses Apache








Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29


1Uses Apache








Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29





Write introduction





Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

Example


Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

Write conclusion








Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29




Acknowledgements







Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29





Fix design darr


Update schematic














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29














Organize by Modules





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29





Report Format






Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29





Writing Help


How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

How do we grade DP1


How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

How do we grade DP1



Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

how to write a 6.033 design report

Documents

design problems

home design

design description1

design description6

design specs9

existing design

problem fix design

problemeach design problem