Writing as a Materials Writing as a Materials EngineerEngineer

How to get lab discoveries and How to get lab discoveries and results into a written results into a written

documentdocument

Dr. Hillary HartDr. Hillary Harthttp://http://www.ce.utexas.edu/prof/hartwww.ce.utexas.edu/prof/hart//

Office Hours: Office Hours: ECJ ECJ 8.2148.214

M WM W 11:00-11:00-12:0012:00

Th.Th. 10:00-11:0010:00-11:001:00-2:001:00-2:00

471-4635471-4635hart@mail.utexas.edu

Writing Teaching AssistantsWriting Teaching Assistantshttp://www.ce.utexas.edu/prof/hart/333t/people.cfmhttp://www.ce.utexas.edu/prof/hart/333t/people.cfm

ECJ 3.256

232-9215

Allison Osborne T. 2:00-3:15W. 11:00-12:45

Jason Fialkoff T. 2:00-3:30Th. 10:45-12:15

Read Requirements inRead Requirements in Technical Writing GuideTechnical Writing Guide

► General InformationGeneral Information applies to all applies to all writingwriting assignments for 314K. assignments for 314K.

► Two types of assignments:Two types of assignments: Writing AssignmentsWriting Assignments Calculation AssignmentsCalculation Assignments

► Figures and TablesFigures and Tables applies to applies to allall assignments.assignments.

Three Layers of InformationThree Layers of Information

• Plot and present the data.Plot and present the data.• Compare data to expected Compare data to expected

values.values.• Interpret and explain the data, Interpret and explain the data,

especially any differences. especially any differences. Even if no differences, Even if no differences, interpret the interpret the significancesignificance of the data for of the data for bothboth your audiences.your audiences.

Three tasks for you the writer:

Although the stress-strain curves plotted in Fig. 1 indicate that the rubber experienced a slight amount of permanent elongation, the specimen returned to its original length after approximately 5 minutes. Therefore, the observed response may be classified as being elastic. These trends in the measured data were expected based on published information (Young et al., 1998).

Figure 1: Measured Stress-Strain Curves for Rubber Specimen

0

100

200

300

400

0.00 0.05 0.10 0.15 0.20 0.25 0.30Strain

Str

ess,

psi

Engineering Stress and StrainTrue Stress and StrainEngineering Stress and StrainTrue Stress and Strain

Figure 1: Measured Stress-Strain Curves for Rubber Specimen

Use writing to solve Use writing to solve problems for others.problems for others.

Most important questions

for you to ask:

Who is reading your reports?Who is reading your reports?

►These assignments ask you to These assignments ask you to interpret the significance of your interpret the significance of your data for 2 data for 2 differentdifferent audiences. audiences.

►Letter or memo is for a busy Letter or memo is for a busy managerial decision-making managerial decision-making person.person. Characteristics?Characteristics?

►Report is for a technical advisor. Report is for a technical advisor. Characteristics?Characteristics?

Writing AssignmentsWriting Assignments

Every writing assignment Every writing assignment includesincludes

two two parts:parts: A scenario-based memo or letterA scenario-based memo or letter A short lab report of results and A short lab report of results and

conclusions attached to the letter conclusions attached to the letter or memoor memo

Memos and LettersMemos and Letters

► LetterLetterss are for external audiences are for external audiences Contain salutations and sign-offsContain salutations and sign-offs Include addresses of sender Include addresses of sender andand

receiverreceiver

► MemosMemos are for internal audiences or are for internal audiences or for recipients who are working for recipients who are working together on the same project.together on the same project. To:To: From:From: Date:Date: Subject:Subject:

Sample Lab Report: Sample Lab Report: Bungee CordBungee Cord

► Engineering supervisors usually have Engineering supervisors usually have technical backgrounds, but they are VERY technical backgrounds, but they are VERY BUSY.BUSY.

► Supervisors often have to pass along Supervisors often have to pass along summary documents to the client. The memo summary documents to the client. The memo is a summary.is a summary.

► Clients want their concerns addressed Clients want their concerns addressed quickly.quickly.

Why add on a memo for the Why add on a memo for the supervisor?supervisor?

For memos and letters: For memos and letters: Give critical information Give critical information up front.up front.“I have conducted a series of materials tests on our standard 0.5-in. diameter bungee cord manufactured by Titan Rubber Supply and have concluded that this material is suitable for the proposed attraction at Six Flags in San Antonio, TX.” (sample memo)

“Using lumber with a moisture content above the fiber saturation point would be catastrophic for the structural integrity of this building.”

More suggestions for memos More suggestions for memos and letters:and letters:► You may use personal pronouns (“I” You may use personal pronouns (“I”

and “we”) in memos and letters, but and “we”) in memos and letters, but not in technical reports.not in technical reports.

► Figure or table may be very helpful to Figure or table may be very helpful to reader!reader!

► Never make the memo or letter more Never make the memo or letter more than 2 pp. (including figures and than 2 pp. (including figures and tables).tables). This is not a suggestion!This is not a suggestion!

Sample Sample Lab ReportLab Report

►Audience is a technical person.Audience is a technical person.►No more than 5 pages in lengthNo more than 5 pages in length►Attach appendices with raw data.Attach appendices with raw data.►Both sets of TAs will evaluate the Both sets of TAs will evaluate the

report.report.

Organization of a Lab ReportOrganization of a Lab Report

► Introduction -- Introduction -- shortshort►Procedures -- Procedures -- shortshort►Results and DiscussionResults and Discussion

Consider including sub-headingsConsider including sub-headings

►Conclusions -- Conclusions -- shortshort►AppendicesAppendices

IntroductionIntroduction

►What was What was objectiveobjective of experiment? of experiment?►GiveGive brief brief statement of methodology: statement of methodology:

How were data collected, measured, and How were data collected, measured, and analyzed?analyzed?

No longer than 150 words.No longer than 150 words.

ProcedureProcedure►Also brief (150 words), but includes Also brief (150 words), but includes

more detail on how data were more detail on how data were collected: collected: tests and equipment used.tests and equipment used.

► You may reference the lab manual.You may reference the lab manual.

Results and Results and DiscussionDiscussion

►Present results in figures and Present results in figures and tables.tables. Use titles and labels – see later Use titles and labels – see later

slides.slides.

►Tell the story of what happened, Tell the story of what happened, weaving in figures and tables. weaving in figures and tables.

Organize results to illustrate Organize results to illustrate main findings.main findings.

►Consider using headings from lab Consider using headings from lab assignment:assignment: Modulus of ElasticityModulus of Elasticity Poisson’s Ratio Poisson’s Ratio etc.etc.

Present results in both narrative and Present results in both narrative and graphical form. Highlight graphical form. Highlight significancesignificance of data shown in tables and figures.of data shown in tables and figures.

“The test results are tabulated below. In both tests, the dry lumber sustained significantly larger loads before failure.”

Sample Sample descriptiondescription

Maximum Maximum loadload

(lbs.)(lbs.)

DisplacemenDisplacementt

(in.)(in.)

Strength Strength ratioratio

(dry/wet)(dry/wet)

Test 1Test 1DryDry

WetWet

25572557

149814981.141.14

1.601.601.7071.707

Test 2Test 2 DryDry

WetWet19051905

9919911.081.08

1.501.501.9221.922

After presenting data,After presenting data, analyze and interpret the results.

► “Although the stress-strain curves plotted in Figure 1 indicate that the rubber experienced a slight amount of permanent elongation, the specimen returned to its original length after 5 minutes. Therefore, the observed response may be classified as being elastic.”

►Not just here are the numbers, but here’s what the numbers mean.

ConclusionsConclusions►Compare the results with theory: did Compare the results with theory: did

the expected happen?the expected happen? ““These trends in the measured data were These trends in the measured data were

expected based on published information expected based on published information (Young et al., 1998).(Young et al., 1998).” ”

““The experiments were remarkably The experiments were remarkably repeatablerepeatable .” .”

““Additional tests are required to determine Additional tests are required to determine whether these variations are whether these variations are representative of the rubber tested …”representative of the rubber tested …”

Suggested sequence of writingSuggested sequence of writing

1.1. Do calculations, appendices and Do calculations, appendices and graphs.graphs.

2.2. Write Results and Discussion section.Write Results and Discussion section.

3.3. Write rest of report.Write rest of report.

4.4. Write memo or letterWrite memo or letter

In this order, each part of In this order, each part of the assignment addresses the assignment addresses a wider circle of readers.a wider circle of readers.

First writing assignment:First writing assignment:

►You will do a You will do a draftdraft of the of the letterletter-plus-lab -plus-lab report.report.

►Draft will be graded. You’ll get Draft will be graded. You’ll get comments from TAs; then you can comments from TAs; then you can rewriterewrite the draft. the draft.

►Final grade is a combination of the Final grade is a combination of the draft’s and the revised version’s draft’s and the revised version’s grades.grades.

Integrating Graphics with Integrating Graphics with TextText

Position each graphic as near as possible to the words it supports.

Comment on every graphic at least oncein the text. Discuss significance!

Guidelines for Guidelines for LabelingLabeling

Label each graphic clearly with a figure or table number and a title.

Place the figure number and title beneath a figurePlace the table number and title above a table.

Create a title (or a title and a caption) that draws attention to significant aspects of the graphic.

             

CE 331 Beam Tests

0.0

5.0

10.0

15.0

20.0

25.0

30.0

-0.50 0.50 1.50 2.50 3.50

Deflection at Mid-Span, in.

Ap

plie

d L

oad

, kip

Series1

Series2

Series3

Series4

Beware the default parameters in Excel!

CE 331 Beam Tests

0.0

5.0

10.0

15.0

20.0

25.0

30.0

0.0 0.5 1.0 1.5 2.0 2.5 3.0 3.5

Deflection at Mid-Span, in.

Ap

pli

ed

Lo

ad

, k

ip

Beam 1 Beam 2 Beam 3 Beam 4

Figure 2. Deflection of Concrete Beams at Various Applied Loads

AppendicesAppendices►Give each appendix a letter and a titleGive each appendix a letter and a title►Number pages separately from reportNumber pages separately from report

e.g., A-1e.g., A-1

► Include detailed information:Include detailed information: Data sheets, sample calculations, Data sheets, sample calculations,

mathematical derivations . . . anything not mathematical derivations . . . anything not essential for a reader’s understanding of essential for a reader’s understanding of the report.the report.

►CiteCite each appendix in body of report each appendix in body of report

Document sources of information in Document sources of information in References References and avoid plagiarizing.and avoid plagiarizing.

► CE 333T web site CE 333T web site has information on how has information on how to avoid plagiarizing: to avoid plagiarizing: no more than 5 words in a row copied from no more than 5 words in a row copied from

another source without quotation marksanother source without quotation marks

► Don’t plagiarize unintentionally – consider Don’t plagiarize unintentionally – consider these writing strategies:these writing strategies: Quotation, paraphrase, summaryQuotation, paraphrase, summary

► If in doubt about whether to cite source, If in doubt about whether to cite source, cite it!cite it! Improper citation is way better than no citation. Improper citation is way better than no citation.