6.111 PapersLeslie C. Perelman29 September 2006Massachusetts Institute of TechnologyIntroduction Why documentation is important What is a document The elements of a 6.111 lab report How to write the report Focus on the OverviewImportance of Documentation Clarifies and fixes ideas and procedures For designers For others Record of project For further modifications and adaptations For troubleshooting For avoiding needless repetition of workElements of 6.111 Report Title Informative Abstract Table of Contents List of Figures List of Tables Overview Description Conclusions AppendicesThe form also conveys function needed by readership• Scientific readers maximize potential of the form when they read. • Makes it is easy to locate data & compare experiments (methods, etc.) • Easy to write? No• Easy to read? Yes. Optimized for reading• Document design and use of figures conveys ethos of scientist. Introduction Description Design Discussion ConclusionAbstractStart hereThen, look at picturesThe grammar of scientific communication also follows its functionBecause science readers do not read chronologically and skim, the grammar of science is:• Prose that is not laden with jargon or vague expressions• Simple sentence structure S – V – O• Provides links between text and visuals e.g., “As shown in Figure 2 . ..”• Provides time reference (e.g., Methods – past tense)• Distances subjectivity of the researcher (e.g., passive voice)• Unambiguous prose It = ??, This = ?? See “The Science of Scientific Writing” By Gopen and SwanMany writers start off using the outlining approach to writingTitle PageAbstractTable of ContentsBody AcknowledgementsReferencesAppendices 1 Introduction2 Theoretical Analysis (maybe)3 Experimental Procedure4 Results*5 Discussion*6 Conclusion* Sometimes these sections are combinedStart hereEnd hereInefficient!Try the storyboarding approach insteadA “movie-making” approach to writingEach section of report is a “scene”Overview Description ConclusionAbstractTry the storyboarding approach insteadA “movie-making” approach to writingMovie design starts hereOverview Description ConclusionAbstractTry the storyboarding approach insteadA “movie-making” approach to writingLab report is built around Design figuresHow do you make a movie of your data?OverviewDesign DescriptionConclusionStep 1: Organize your designStart with figures:• Assemble hard copies of your figures in a “storyboard”• Figure out the major technical theme of the report• Assess how each figure contributes to the major theme• REVISE figures to focus on the major theme(develop figures that summarize that major theme)Use storyboard as the “backbone” of your report/presentation Tables Figures Overview Description Conclusion Appendices Lists of Tables & Figures Table of Contents Abstract TitleStep 3: Write in non-linear sequenceOverview Establishes the context and purpose of project Description of the whole before the parts Independent of abstractElements of the Overview Background and context Statement of problem Description of device’s purpose What does it do? Description of device’s uses How does a user use it? Brief description of subsystem organization Road map for readerSample Overview IAIn any business or multi-user environment where phone service charges are made on a per call basis, it is desirable tokeep a log of phone calls so individual calls may be charged to the actual callers. In addition, it is convenient to be able to dial frequently called numbers easily and to redial the last number that was dialed. The intent of this project is to demonstrate a system which performs these functions.Sample Overview IA ContextIn any business or multi-user environment where phone service charges are made on a per call basis, Problem and Main Purposeit is desirable to keep a log of phone calls so individual calls may be charged to the actual callers. Additional ObjectivesIn addition, it is convenient to be able to dial frequently called numbers easily and to redial the last number that was dialed. Summary Statement of Project The intent of this project is to demonstrate a system which performs these functions.Sample Overview IB – User PerspectiveThe user of this system sees an ordinary telephone with a few additional switches and indicator lights. The attached keypad produces the standard telephone tones. When the user picks up the receiver, she is prompted by a light to enter her two digit identification code to gain access to the phone system before being prompted to dial a phone number. The user may, if she wishes, turn on the “set” switch to set a short code. She is then prompted to enter a onedigit short code. After entering this digit, the user enters a normal phone number. When she is done, she turns off the “Set” switch. The user may dial normally, automatically redial the last regularly dialed number by entering a *, or may use the autodial function by entering # followed by the short code digit. The user may hang up at any time. If the user wishes to place another call without reidentifying herself, she may press the pre-redial switch.Sample Overview IC – Additional FunctionsAt any time when the phone is not in use, the phone call log may be produced. The “Bill” switch is depressed, causing a complete output of all previous calls. The record contains the user’s identification code, the date the call was made, and the actual number dialed. The day can be set to a number from 1 to 366, which specifies the day of the year. Two switches are available to change the date: one to simply increment the day by one, and the one which rapidly increments the counter while the switch is depressed.Sample Overview 1D – Summary of DesignThe project is divided into two main modules, called the “master” and the “slave”. The master monitors the actions of the slave and regulates the flow of information to and from the slave. The slave is responsible for all the interactions with the use, including auto-dial functions. A key element in the project is modularity. The master and the slave can be thought of as two semi-independent systems. For instance, the master has no way of knowing whether normal dialing or auto-dialing has produced a digit. A simple “ready-acknowledge” handshake
View Full Document
Unlocking...