CHFEN 4903 WRITING THE REPORT Terry A. Ring Department of Chemical Engineering

advertisement

CHFEN 4903

WRITING THE REPORT

Terry A. Ring

Department of Chemical Engineering

November 1 & 3, 2004

1

Why is Writing Important to your

Career?

This is the only way you directly communicate with your boss’s boss.

– He decides your future.

– He decides your salary raise.

2

Reliance on Data

Engineering's rhetorical objectivity,

– Students are told and believe, objectivity rests on data. … Data are what convince, apparently objectively, but engineer's job is to

produce

in each situation the data that convince.

Writing Like an Engineer: A Rhetorical Education

Dorothy Winsor

3

What is rhetoric?

There are many definitions, but “the art of speaking and writing well” is among the most straightforward.

• This definition is attributed to Ἀριστοτέλης

(Aristotle, 4 th Century BC Greek Philosopher).

Aristotle ’ s Rhetorical Triangle

Speaker/ethos

Purpose/

Kairos

(or timeliness)

Subject/ logos

Audience/ pathos

Ethos—the authority and credibility of the author; how a writer presents him/herself to the audience.

Pathos—emotional appeals to the audience.

Logos—reliance on logic or reason to make an argument.

• Related to ethos because who or what the writer deems logical must also be considered logical by the audience.

OVERVIEW

FIRST DAY

How to prepare the report

Suggested Contents

Sample Formal Report

Writing Style

Plagiarism

SECOND DAY

Grammar

Style and Language

Grading the Report

7

SAMPLE FORMAL REPORT

http://www.che.utah.edu/~geoff/writing/i ndex.html

8

CHFEN 4903

CONTENTS ARE IMPORTANT

9

CHFEN 4903 Report Writing I

Contents of Formal Report (in order of appearance):

• Letter of Transmittal

• Title Page

• Table of contents, List of Figures, List of Tables

• Summary (Abstract) - must “ stand alone ” , do not refer to a table or a figure

Introduction - objective, literature, your approach

Theory - start with basic principles, write equations using an equation editor

Apparatus and Procedure apparatus and instrumentation diagrams are essential discuss accuracy of the instruments and measurements

10

CHFEN 4903 Report Writing I

Contents of Report (in order) - continued:

• Results - tell the reader what was observed without bias or interpretation present and discuss data

Discussion of Results

Tell the reader what you think the results mean

Error analysis - details in an appendix

Cite relationships, generalizations

Agreement with prior work?

• Are Values reasonable?

• Conclusions and Recommendations importance of the work- short and sweet summarize evidence for every conclusion give recommendations - be constructive 11

CHFEN 4903 Report Writing I

Contents of Report (in order) - continued:

• Table of Nomenclature

• References

• Appendices

Raw Data

Sample calculations

Calibrations

Major equipment items (List, Manufacturer, Model)

Uncertainty (Error) analysis, Error Propagation

Computer Disk(s)

12

CHFEN 4903 Report Writing I

Contents of Report (appendices):

• Sample Calculations

Clear enough so someone can check your calculations, at least for the sample

Must be written as English text, sentences

Indicate the run number for all data used in the calculations

Cite the source of all numbers used in the equations and the units used

13

CHFEN 4903 Report Writing I

How To Prepare the Report

Materials and Facilities:

• Word processor, spreadsheet, drawing and graphing programs

• Use spelling and grammar checker, but still proof read.

Spelling and grammar checkers are not fool-proof. Use dictionary if necessary

• Keep multiple electronic backup copies at every stage

• Printer - make sure toner cartridge is not on empty and leave plenty of time to print your report

14

CHFEN 4903 Report Writing I

How To Prepare the Report

Early Preparation:

• Theory (decide on notation, be consistent)

• Introduction (start a rough draft, decide what is important to tell)

• Equipment - decide on drawing/sketch, write down important information on major pieces of equipment, i.e. manufacturer, model number.

• Uncertainty (error) analysis, Error propagation

Can be hand written neatly but use complete sentences

• Sample calculations

Can be hand written neatly but use complete sentences

• Figures and Tables (decide on format)

Remember Figures: Caption at the bottom

Tables: Caption at the top

15

CHFEN 4903 Report Writing I

How To Prepare the Report

Writing the Report - suggested order of writing:

• Introduction section – do a rough draft

• Theory section – do a rough draft then do sample calculations

• Apparatus and Procedure

Discuss the apparatus diagram/sketches

Give a step by step procedure in detail unless very complicated, then put in the appendix

• Write Results and Discussion of Results

Discuss tables and figures, do not just show them

Give your interpretation of the data and results!!

16

CHFEN 4903 Report Writing I

How To Prepare the Report

Writing the Report - suggested order of writing (cont ’ d):

• Write the Conclusions and Recommendations

• Complete and write the sample calculations

• Prepare and write needed appended materials

Nomenclature

References

• Write the final Introduction and Theory Section direct toward project results and conclusions

• Write Summary/Abstract

• Write Letter of Transmittal

17

CHFEN 4903 Report Writing I

How To Prepare the Report

Before Starting the Final Draft:

• Assemble Figures and Tables in Complete form

• List Preliminary Conclusions and Supporting Evidence discuss with your group members

• Assemble list of items to be discussed in the report

• Prepare an outline of the complete report

18

CHFEN 4903 Report Writing I

How To Prepare the Report

T ables:

• Number in text using Arabic numerals sequential as referenced if in appendix, may use Table A-1, etc.

• Column and row headings must include name of quantity, error in quantity, symbol used, and units

• Organize with thought, don ’ t just copy spreadsheet

• Should “ stand alone ” , self explanatory

• Descriptive heading should be at the t op!!!

19

CHFEN 4903 Report Writing I

How To Prepare the Report

Figures:

• Number using Arabic numerals insert after first citation in text sequential as referenced

• Figure captions are required descriptive caption at the bottom of each figure captions are complete sentences, text-like

• Axis labels ( with units ) are required name, quantity, dimensions legends are usually helpful if plotting several things

20

CHFEN 4903 Report Writing I

How To Prepare the Report

Figures (continued):

• Correlation Curves and Error Bars typically do not draw outside data range keep simple, clear, not complicated

• Plots with theoretical lines use data symbols for experimental data use lines (solid, dashed, etc.) for theoretical line theoretical lines may be drawn to edge of plot

• Use log-log and semi-log plots when appropriate

• Flow sheet and piping diagrams, Equipment diagrams, control and computer system diagrams are all figures

21

How to Do Figures

6

4

2

0

-2

-4

-6

-8

Wet Air Cycle

Leach

Dry Air Cycle

-10

-12

0 20 40 60 80

Tim e (hours)

100 120 140 160

Figure 4.3.5-1 Temperature effects during the typical humidity cell weekly cycle showing evaporative effects during the dry air cycle with a temperature drop of 4 C. Note the rise in temperature after most of the water was evaporated. This experiment used 1 liter/min of total gas flow through the humidity cell, which consisted of marble (control cell) ground to the same grain size as the waste rock in this study. The relative temperature is the difference between the cell temperature and the ambient temperature.

22

How to Do Tables

Table 1. Chemical Analysis of Selenium-contaminated Wastewater used in the study.

Species/Property pH

Conductivity

Temperature

Alkalinity

Hardness

Total Dissolved

Solids

Total Suspended

Solids

Concentration or Value

7.25

2840 micro mho/cm

21 C

303 mg/L

557 mg/L as CaCO3

1670 mg/L

<detection

Detection

Limit

10 mg/L

5 mg/L

20 mg/L

3 mg/L

23

CHFEN 4903

WRITING STYLE

24

CHFEN 4903 Report Writing

Writing Style:

• Usually active voice but can use passive.

• Passive voice should not be overused

• active –

• “ The drafter improved upon the line quality ”

• passive –

• “

The line quality was improved upon by the drafter

• Avoid editorial “ we ”

Edit frequently - read, revise, read, revise, …

25

CHFEN 4903 Report Writing

Quotation of Material:

• Avoid plagiarism - learn to use quoted material

Refer to the Student Code on cheating www.admin.utah.edu/ppmanual/8/8-10.html

Short quotations - placed between quotation marks and the source cited

Long quotations - single spaced and indented on the left and right margins. Cite your source.

For this class only - you may use copyrighted material without permission (copy charts/graphs) but you must indicate the source of this material

26

CHFEN 4903 Report Writing

Symbols and Abbreviations:

• Define all symbols when first used and/or in a table of nomenclature - see sample report

• Abbreviations are frequently overused. Define nonstandard abbreviations in text when first used.

Examples:

30 ’ = 30 feet

The new center is called CBI (Center for

Biopolymers at Interfaces).

27

CHFEN 4903 Report Writing I

Department Requirements:

• Final Report-1 paper copy to Instructor

• Electronic copy should be sent to

• Instructor

Final Report will be returned in less than 2 weeks;

A technical rewrite may be requested.

A cover is required

28

CHFEN 4903 Report Writing II

Style, Grammar, Punctuation

• Commonly Misused Words:

Affect, verb, to influence

Heat affects the surface.

Effect, verb, to bring about

A radical change was effected.

Effect, noun

The Coriolis effect will be studied

Comprise, verb, contains or includes

The text comprises all three modes of transfer.

Compose, verb, made up of, constituted of

The mixture is composed of sand and gravel

29

CHFEN 4903 Report Writing II

Style, Grammar, Punctuation

• Hyphenation (16,17,27):

When two or more words modify another word, and the words work as a unit, the hyphen must be used but do not hyphenate most prefixes added to common nouns.

bubble-cap tray liquid-gas interface a 20-percent increase a two- or three-year study precooled not pre-cooled nonpolar not non-polar

Exceptions: co-worker not coworker co-ion not coion

30

CHFEN 4903 Report Writing II

Style, Grammar, Punctuation

• Units of Measure:

Spell out the unit of measure when no quantity is given several milligrams not several mg

Do not use plurals for abbreviated units of measure

50 mg not 50 mgs

In ranges and series, retain only the first unit of measure

10-12 mg, between 25 and 50 ml

When a sentence starts with a specific quantity, spell it out as well as the unit of measure

Twenty-five milliliters of acetone was added.

Use the percent symbol with a number, without a space

25% 45-50%

31

Proof Read This

Aoccdrnig to a rscheearch at Cmabrigde

Uinervtisy, it deosn’t mttaer in waht oredr the ltteers in a wrod are, the olny iprmoetnt tihng is taht the frist and lsat ltteer be at the rghit pclae.

The rset can be a toatl mses and you can sitll raed it wouthit porbelm. Tihs is bcuseae the huamn mnid deos not raed ervey lteter by istlef, but the wrod as a wlohe.

Complacency = Oblivious to errors

CHFEN 4903

GRADING THE REPORT

33

CHFEN 4903 Report Writing II

Grading

A report is not acceptable and must be revised and turned in again if the instructor determines that the report does not meet the minimum standard for senior chemical engineering students

Category

A. Preliminary Oral Quiz, Teamwork

Score

10

25 B. Coherence – Does the report tell a technically coherent story? Are objectives stated and met?

C. Technical Accuracy

D. Professional Standards – English, Form,

Visuals, Citations, Lab operations, Safety, Use of equipment, Cleanup

TOTAL

45

20

100

34

Report Grading

Scoring Rubric for CHFEN 4903 – Categories and Learning Objectives

Category

A. Preliminary Oral

Presentation,

Teamwork (10)

B. Coherence

Does the report tell a technically coherent story? Are objectives stated and met?(25)

C. Technical

Accuracy (45)

Learning Objectives/Outcomes

(8) Demonstrate effective team skills-goal setting, consensus-building, listening, etc.

(9) Demonstrate effective leadership skills

– team discussions, calling team meetings, etc.

(11) Produce a professional-quality oral presentation (as a team), etc.

(7) Evaluate the quality of results by comparison with accepted correlations and theories and develop valid conclusions about deviations etc.

(10) Produce professional-quality written reports that present, analyzes, and interprets experimental results logically and which are well-organized and delivered

D. Professional

Standards

– includes quality of English

Language, Form,

Visuals, Citations

Lab Operations, safety, efficient use of equipment, cleanup (20)

(1)-(6) Apply concepts from previous courses, mathematics, compute description statistics and apply to analyze experimental data, develop specific experimental objectives to meet overall experimental goals, design and conduct experiments, analyze experimental data to obtain parameters and correlations

(7) Evaluate the quality of results by comparison with accepted correlations and theories and develop valid conclusions about deviations etc.

(3) Apply methods of statistical inference

(10) Produce professional-quality written reports that present, analyzes, and interprets experimental results logically and which are well-organized and delivered

(11) Produce a professional-quality oral presentation, etc.

(12) Apply concepts of professional ethics to design and conducting experiments and analyzing and interpreting experimental data

(13) Demonstrate knowledge of laboratory equipment and instrumentation and their capabilities and limitations

Proficiency and Scoring

4 Levels

– Exemplary

– Proficient

– Apprentice

– Novice

Category Exemplary Proficient Apprentice Novice Score

A. Preliminary Oral

Presentation,

Teamwork

B. Coherence

Does the report tell a technically coherent story? Are objectives stated and met?

C. Technical Accuracy

D. Professional Standards includes quality of

English Language,

Form, Visuals,

Citations

Lab

Operations, safety, efficient use of equipment, cleanup

Student worked well in group, helped set group goals, participated in all team discussions, played a leadership role, prepared well for and presented an excellent oral presentation

Objectives were well stated and all objectives were met.

Report told a technically coherent story and was well written. Analyses, interpretations and conclusions clear and logical.

Experiments were designed and conducted with virtually no errors; concepts

(theory) from previous courses applied correctly; uncertainty analysis excellent; excellent comparison with accepted correlations/results

Written report is virtually errorfree, well-organized, easy to read, contains highquality graphics, several good references, followed required format; excellent attention to safety and cleanup; knowledgeable of equipment; used equipment efficiently

Student worked well in group, helped set some group goals, participated in most team discussions, prepared well for and presented a good oral presentation

Objectives were fairly well stated and most were met. Report told a technically coherent story and was fairly well written. Analyses, interpretations and conclusions were mostly clear and logical.

Experiments were designed and conducted with only a few errors; concepts (theory) from previous courses applied correctly with few errors; uncertainty analysis good; good comparison with accepted correlations/results

Written report has only a few errors, relatively wellorganized, easy to read, contains good graphics, a few good references, mostly followed required format; good attention to safety and cleanup; fairly knowledgeable of equipment; mostly used equipment efficiently

Student worked fairly well in group, helped set only a few group goals, participated in a few team discussions, fairly prepared for oral quiz and presented a fair oral presentation

Objectives were fairly well stated and some objectives were met. Report did not tell a technically coherent story but was fairly well written.

Analyses, interpretations and conclusions were fairly clear and logical.

Experiments were designed and conducted with several errors; concepts (theory) from previous courses not applied correctly; uncertainty analysis fair; comparison with accepted correlations/results not quite done correctly

Written report has several errors, not very well-organized nor easy to read, fair graphics, references not good, usually followed required format; fair attention to safety and cleanup; not very knowledgeable of equipment; used equipment efficiently

Student did not work well in group, did not help set group goals, did not participate in team discussions, was not prepared for oral quiz and presented a poor presentation

Objectives were not stated well and objectives were not met. Report did not tell a technically coherent story and was poorly written. Analyses, interpretations and conclusions were neither clear nor logical.

Experiments were not designed and conducted correctly; concepts (theory) from previous courses not understood; uncertainty analysis poor; no comparison with accepted correlations/results

Written report is not acceptable, not wellorganized nor easy to read, contains poor graphics, no references, did not followed required format; poor attention to safety and cleanup; not knowledgeable of equipment; used equipment efficiently

________

_

10 points max

________

__

25 points max

________

_

45 points max

________

_

20 points max

_____

CONCLUSIONS

Writing is a learned skill

Preparing your report takes organization and time management

Tables, figures, references have to be done a certain way

Proofread your reports – grammar, punctuation, style

Follow requirements

Turn in the report on time

38

Rhetorical

Grammar:

Commas

39

Rhetorical Grammar: Commas

(con’t)

Where do the commas go?

– I used to be a good writer but then I took an arrow to the knee.

,

Coordinating conjunction arrow to the knee.

;

,

Conjunctive adverb

40

Download