16

Click here to load reader

Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Embed Size (px)

Citation preview

Page 1: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Writing Effective One-Pagers

Mary E. CaulfieldTechnical Instructor,

Writing Across the CurriculumFebruary 11, 2005

Page 2: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

In a one-page paper, every wordshould count.

• Main issues from Therac papers– Thesis/focus– Conclusions– Sentences– Word choices

• Strategies for revision• Getting help

Page 3: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Most problems stemmed from anunclear thesis and sentences that

were difficult to follow.• Thesis

– A thesis makes an assertion.– Without a strong thesis, structuring the paper is

difficult.– A good thesis leads the reader to a strong conclusion.

• Sentences– Effective sentences reflect a logical progression of

ideas.– Carefully-considered word choices are essential to good

arguments.

Page 4: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

A good thesis is the foundation ofan effective one-pager.

“This paper aims to discuss the manyproblems in hardware design andsoftware testing that led to the tragicTherac-25 accidents.”

Page 5: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

A good thesis is the foundation ofan effective one-pager.

“Without effective software design andexhaustive testing, fatalities can occurand small, but important, details can bemissed.”

Page 6: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

A good thesis is the foundation ofan effective one-pager.

“Because the AECL did not have aconsistent methodology for testingerrors and evaluating users’ complaints,programmers did not understand thesignificance of software problems asthey emerged.”

Page 7: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

How would you make thisstatement more effective?

“The design and implementation of theill-fated Therac-25 suffered from manyproblems as regards its software andhardware.”

Page 8: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Crafting a good thesis statementis worth the extra time.

• Without a good thesis, writers have adifficult time selecting evidence andexamples from the article.

• When the paper lacks a central argument,making transitions between ideas isdifficult.

Page 9: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

If I know what I’m arguing, I canselect evidence

• “a consistent method for testing errors”Which errors should have been tested?

Why?What method should have been used?How would the method have helped?

Page 10: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

We can use a similar method tofix our vague sample.

• What problems were specific to the designof the Therac 25?

• What problems were specific to thehardware? To the software?

• What was the result or implication of theseproblems?

Page 11: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Just as the thesis establishes afoundation, the paper’s sentencesserve to explain and clarify ideas.

• Sentence structure matters.• Reduce word count through careful

editing.• Know what you are saying.

Page 12: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Sentence structure matters.“The removal of hardware checks allowed for

software errors in other parts of the systemlike the input interface to compromise thesafety of the system as a whole. Basedupon information available in the article, itappears that had the traditional safetydevices had been installed, all of theaccidents would have been prevented.”

Page 13: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Reduce word count through carefulediting.

• Right now, take your paper’s longestparagraph and reduce it by 25%.

• Can you reduce it by 50%?• How about 75%?

Page 14: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

Know what you are saying.• “Oversight” has two meanings:

– Error resulting from lack of attention– Responsibility

• Which meaning was crucial to yourunderstanding of this paper?

Page 15: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

A good one-pager has a structurethat is easy to follow.

• The introduction frames the argument.• Each paragraph makes a focused claim with

supporting evidence.– In a short paper, your own words are more

effective than quotes from the article.– Readers need transitions between ideas.

• The conclusion should resolve the problemraised in your thesis statement.

Page 16: Writing Effective One-Pagersweb.mit.edu/6.033/2005/ · Writing Effective One-Pagers Mary E. Caulfield ... •Strategies for revision ... software testing that led to the tragic

We understand that this workisn’t easy.

• Make use of the Writing Programinformation on the 6.033 web site.

• Get help from the Writing Center.