ENGLISH 1112 D: TECHNICAL REPORT WRITING

INTRODUCTORY LECTURE

GEFEN BAR-ON SANTOR (LECTURE, DGD 2)

DGD LEADERS
DGD 1: CORY SAMPSON
DGD 3: MOIRA DUNCAN
NOTE ABOUT THIS POWERPOINT
 I plan to put the lecture and DGD Powerpoints
on Virtual Campus (in lecture slides and DGD
slides folders) before each lecture and DGD for
students who wish to follow the slides on their
laptops during the lecture or DGD.

However (see next slide)

HOWEVER
 After the lecture/DGD I might modify the
Powerpoint and re-post it. Changes may include:
 Deleting slides that we did not have time to
review (postponed to the following week and
possibly modified then)
 Typo corrections
 The official Powerpoint is the one I post after the
lecture/DGD.
VIRTUAL CAMPUS: BASIC COURSE DOCUMENTS

 Syllabus

 Report Instructions (two reports)

 Attendance and participation grade

 Bibliography

 Classroom etiquette
COURSE’S OBJECTIVE (IDENTIFY 5 ERRORS/IMPERFECTIONS IN
THIS SLIDE)

Master and apply the rules and principals of

clear, concise, accurate, and ethical
professional writing.

Good writing is important for workplace succes.

FIRST IMPERFECTION: COURSE’S OBJECTIVE

 Not wrong grammatically (possessive: The

course’s objective is. . .)

 But the possessive sounds awkward as a

phrase (instead of part of a sentence).
BETTER TO USE COURSE AS AN ADJECTIVE

Course objective
SECOND ERROR

“rules and principals”

Should be principles

Homophones: sound similar, but have different

meanings
THIRD IMPERFECTION

Master and apply the rules and principles of clear,

concise, accurate, and ethical professional writing.

Serial comma (Oxford comma) before “and” at the

end of a list is not wrong (but not required).

Analogy: think of every word and punctuation as

costing money.
COMMA IS REQUIRED BEFORE “AND” IF “AND” IS A
COORDINATING CONJUNCTION

Luke Skywalker chose to study the force, and I

chose to study engineering.

Other coordinating conjunctions: but, so, yet

AVOID GENERIC WORDS
Good writing

Use vivid, descriptive, subject-specific language

Good writing
Good sandwich
Good idea
Good person
Good morning. . .
BETTER

Effective writing
FIFTH ERROR: SPELLING

Succes
CORRECT

Success
COURSE OBJECTIVE (EDITED)

Master and apply the rules and principles of

clear, concise, accurate and ethical
professional writing.

Effective writing is important for workplace

success.
IMAGINE

Your future job

What do you picture yourself doing

[punctuation?]writing or doing something else?
COLON

Your future job

What do you picture yourself doing: writing or

doing something else?
DASH

Your future job

What do you picture yourself doing—writing or

doing something else?

The dash creates a bolder emphasis than the

colon.
HOW DO YOU TYPE A DASH?

http://www.techtoolsforwriters.com/how-to-creat
e-an-em-dash/
PUNCTUATION QUESTION

What is the difference between the dash and the

hyphen?
HYPHEN
Shorter (- as opposed to —)

Used to “glue words together” when “two or

more elements in the sentence are linked”
(Straus 40).
HYPHEN TO INDICATE A RANGE

The presentation should be 5-10 minutes long.

No spaces before or after a hyphen (or a dash).

IN COMPOUND ADJECTIVES

Well-written report

Three-year-old boy
BUT NO HYPHENS IN

The report was well written.

The boy was three years old.

The words in blue are not adjectives that come

before nouns.
BACK TO THE QUESTION. . .

Your future job

How many of you think that at least 50% of your

time will be spent writing documents?

Use Google images for “engineers/scientists at

work.”
ENGINEERS AND SCIENTISTS WRITE

http://www.embeddedinsights.com/channels/201
0/08/04/how-much-of-an-engineer%E2%80%99
s-job-is-writing/
LANGUAGE: AN ESSENTIAL TOOL
 Many scientists and engineers spend much,
sometimes most, of their day writing.

 Good writing skills are often correlated with

promotion to management positions.

Why?
THINK ABOUT YOURSELF AS BOTH

(1) Your profession—engineer, scientist, health-

care professional etc.

And

(2) A writer
THE FOLLOWING IS QUOTED FROM

Coders at Work: Reflections on the Craft of

Programming: Interviews with Some of the Top
Programmers of our Times

Douglas Crockford (invented parts of Java

script) on what he is looking for in an employee
WHY?
“I would focus on the communication aspect [of
education]. Learn to write. Learn to read. My advice
for everyone is pretty much the same, to read and
write. I generally don’t hire for specific skills . . . .
Are you a good java programmer, a good C
programmer, or whatever? I don’t care. I just want
to know that you know how to put an algorithm
together, you understand data structure, and you
know how to document it. If you can do that, you
should be able to figure out Java script.”
THE FOLLOWING IS QUOTED FROM

The Kaplan Guide to the Medical College

Admission Test (MCAT): Verbal Reasoning and
Writing (2009-2010 edition)
"Did you know that many medical schools
consider your MCAT verbal score the most
important of the section scores? That's because
the verbal section reflects what you will do as a
doctor—think critically" (17).
COST OF INEFFECTIVE WRITING

“If language is not correct, then what is

said is not what is meant; if what is said is
not what is meant, then what ought to be
done remains undone.”

Confucius (551-479 BCE)

EFFECTIVE WRITING: A SCIENTIFIC DUTY

"Great spirits have always found violent

opposition from mediocre minds. The latter
cannot understand it when a man does not
thoughtlessly submit to hereditary prejudices but
honestly and courageously uses his intelligence
and fulfills the duty to express the results of his
thoughts in clear form.”

Albert Einstein
NOTE THE HYPHENS

In December 2004 the New York Times reported

some conclusions of a survey of American
corporations: one-third of employees in the
nation’s blue-chip companies write poorly, and
businesses are spending as much as $3.1 billion
annually on remedial training (Houp et al.,
XVII).

Hyphens in fractions and compound adjectives.

MEANING OF METAPHOR?
“Poor communication skill
is the Achilles heel of
many engineers . . .
[P]oor communication
skills have probably
claimed more casualties
than corporate
downsizing.”

(Beer and McMurrey 1; CP 1)

ACHILLES HEEL

A weakness in someone who is otherwise

strong.

Many scientists and engineers are weaker in

writing than they are in their technical skills.
COMPARE TO ACHILLES’S DEATH

“Good ideas die in bad presentations.”

IMAGINE

That you are submitting a proposal to a

company to do remedial writing training for
engineers.
YOUR FIRST SENTENCES (4 ERRORS?)

Poorly-developed writing skills are the Achilles

hill of many engineers. Writing problems have
caused more job loses than corporate
downsizing.
FIRST ERROR: SPELLING

Heel, not hill

https://www.google.ca/search?tbm=isch&source=
hp&biw
=1368&bih=795&ei=3LyXW_2FMIjCjwSW64ioD
A&q=
hill&oq=hill&gs_l
=img.3..35i39k1j0l9.939.1467.0.1934.5.5.0.0.0.0.1
35.404.2j2.4.0....0...1ac.1.64.img..1.4.400.0...0.Gb
wZwwZGeCw
SECOND ERROR: SPELLING

Job loses

Loses=verb (She loses the tennis match every

time.)

Correct noun: job loss/job losses

THIRD ERROR

Poorly-developed writing skills are the Achilles

heel of many engineers. Writing problems have
caused more job loses than corporate downsizing.

Adverbs ending in ly are not hyphenated.

Should be poorly developed

FOURTH ERROR: SOURCE MUST BE ACKNOWLEDGED

Poorly-developed writing skills are the Achilles

heel of many engineers. Writing problems have
caused more job losses than corporate
downsizing (Beer and McMurrey 1).

List Beer and McMurrey in a citation and in the

bibliography.
PLAGIARISM

To avoid plagiarism, study the resources for

students on the academic integrity website:

http://web5.uottawa.ca/mcs-smc/academicintegrity/
home.php
WHAT IS THE DIFFERENCE BETWEEN

language and other scientific tools (such as

mathematics)?

an English course and a STEM course?

LANGUAGE IS
 A complex and vast tool.

 less subject to absolute principles and codes than

mathematics; depends on context and nuance.

 Acquired naturally (but often imperfectly) through

imitation and subconscious learning. Naturally
acquired habits are hard and slow to modify.
LIKE MATHEMATICS AND OTHER ENGINEERING/SCIENTIFIC
TOOLS, LANGUAGE REQUIRES

 precision and attention to detail.

 active practice and deliberate effort (reading

journal)

 work in order to use effectively.

CAR ANALOGY

http://www.autoblog.com/2012/12/27/man-drives-r
olls-royce-for-78-years-then-makes-museum-donati
on-t/
MANY PEOPLE DO NOT MAXIMIZE THEIR WRITING POTENTIAL
BECAUSE OF

 Lack of time to immerse themselves in reading

and writing.

 The temptations of electronic entertainment.

Is literacy the Achilles heel of our culture?

KEEP A READING JOURNAL FOR TEXTS YOU READ FOR DGD’S

 New words

 Words that you recognize but do not use

 Effective sentence structures

 Thought-provoking ideas
CHALLENGE

Teach a computer to edit

Keep a list of “high-risk” materials to input

Will a computer ever be able to edit as

effectively as a human expert?
WHAT IS THE HIGH-RISK EXPRESSION?

There are many engineers who do not know how

to punctuate.
WORDINESS

There are many engineers who do not know how

to punctuate.

Improved: Many engineers do not know how to

punctuate.
CLASSROOM ETIQUETTE IN THE ELECTRONIC AGE

Refrain from chatting, electronic entertainment

or any other distracting behaviours during
lectures and discussion groups.
https://www.forbes.com/sites/maxinejoselow/201
5/06/25/digital-distraction-how-phones-are-takin
g-over-the-classroom/#140f13c76f7c

Please sign the attendance sheet (starting next

week) only if you are committed to refraining
from distracting behaviours.
CHALLENGES OF LARGE CLASS

https://www.youtube.com/watch?v=0OatZHB71UI
LET’S TALK A BIT ABOUT THE NAME OF THE COURSE. . .

 What is technical writing?

 How does it differ from other kinds of writing?

EXAMPLES OF TECHNICAL WRITING
 Texts, emails, workplace social media
 Propose projects to clients
 Progress reports
 Analytical reports
 Describe products
 Write instructions
 Request funding
 Apply for promotion/job
TECHNICAL WRITING

 Solves practical needs

 reader centered

 Appeals to understanding (not imagination)

 Strives for efficiency, clarity

 Follows code of ethics

(Lannon and Klepp, chapter 1)

FOLLOWING DEFINITION QUOTED FROM

From Keith Hull’s “Notes from the Besieged, or

Why English Teachers Should Teach Technical
Writing.” College English 41.8 (April 1980):
876-883.
Prose constructed to convey ideas and facts with maximum clarity and
authority. Technical writing

 Is carefully tailored to match task and audience

 Has a clear purpose
 Is systematically, logically, and purposefully organized
 Explains clearly and as fully as necessary
 Usually deals with verifiable facts
 Usually supports generalizations with facts
 Logically matches facts and generalities
 Is economical in content, organization and style
 Is mechanically correct
 Possesses the dignity of truth in restraint (882-3)
TECHNICAL WRITING

Is everywhere

Look for technical description opportunities in

your daily lives.
WHEN SHOPPING FOR A WATERPROOF BAG

“This bag is waterproof, but is not single word.”

[cannot be dropped into a body of water]

WHEN SHOPPING FOR A WATERPROOF BAG

“This bag is waterproof, but is not submersible.”

[cannot be dropped into water]

CLASS STRUCTURE

Monday, 17:30-18:50: Lecture

Wednesday, 17:30-18:50: Discussion groups

(DGD’s)—practice and elaborate lecture
material.

Tests will take place at the DGD’s (see syllabus

for dates)
WHEN EMAILING THE PROFESSOR
 Indicate your course section and DGD
number.

 Anakin Skywalker (ENG 1112 D, DGD 2)

REQUIRED WEEKLY HANDOUTS: PRINT FROM VIRTUAL CAMPUS

 No later than 5 pm on the Tuesday before each

discussion group, I will post a handout on virtual
campus in a folder called “bring to DGD.”
[Syllabus said Thursday by mistake; corrected
now].

 Bring handout to the discussion group.

 No handout on some weeks (indicated on syllabus).

FIRST DGD
 Diagnostic test

 Does NOT count toward final grade

 NO preparation needed
READ FOR DGD 2, SEPTEMBER 13 (AND KEEP A READING
JOURNAL)

 Wushow Chou’s “Communications Smart,”

pages 137-145

 Frederick Brooks’ “Great Designs Come from

Great Designers, Not from Great Design
Processes” and “Where Do Great Designers
Come From?,” pages 280-293
REQUIRED COURSE PACK (ENG 1112 C, D AND H)

docUcentre, University Centre 0024 (85 Université)

Bin A52

Bring to DGDs.

Read the assigned pages from the course pack before the
DGD.
IN COURSE CITATIONS

CP=course pack
BRIGHTSPACE VIRTUAL CAMPUS

Powerpoint presentations from the lectures and

DGD’s will be posted on virtual campus after
each meeting.

Regular attendance is crucial for your success

(and is graded).
DISCUSSION STARTERS STARTING AT LECTURE 3 (SEPTEMBER
20)

 See attendance and participation handout on

Virtual Campus (basic course documents).

 Starters assigned by September 17.

May (but not required to) email preferences by

September 13.
GRADING SCHEME
Attendance and participation 10%

Test 1: September 25 15%

Test 2: October 23 15%

Report 1: October 30 15%

Test 3: November 20 15%

Final report: December 11 30%

TESTS
 Test your knowledge of the principles and texts discussed in class. For
example:

 Recognize and correct a grammatical/stylistic problem.

 Answer questions about class discussion.

 Answer questions about course pack texts (not only what discussed in class).

 Define meaning of words—see following slides.

 Self-graded component (5%)—see following slides.

SAMPLE QUESTIONS FOR TESTS
 Given in DGD one week before the test.

But

 Everything we do in class can be thought of as

a “sample question.”
STUDY THESE WORDS FROM THE COURSE PACK FOR THE
TESTS:

 Test 1: SAT words, 347-349 (5% of test)

 Test 2: SAT words, 350-352 (5% of test)

 Test 3: SAT words, 353-356 (5% of test)

A USEFUL TOOL FOR STUDYING VOCABULARY

http://youglish.com/
SELF-GRADED SECTION OF TEST 1 (5% OF TEST)

 These instructions for the self-graded section

will also appear in the DGD handout posted
one week before the test.

 In the test, you will be asked to provide your

grade for the self-graded section, to be
calculated as follows:
3 POINTS

For having fifteen observations in your reading

journal about any combination of the course
pack texts in the following slide (1 point per 5
observations).

You do not have to show your reading journal

observations, just to report that you have them.
COURSE PACK TEXTS FOR READING JOURNAL

 “Meeting your ethical obligations,” pages 43-57

 Wushow Chou’s “Communications Smart,” pages
137-145
 Frederick Brooks’ “Great Designs Come from
Great Designers, Not from Great Design
Processes,” and “Where Do Great Designers
Come From?,” pages 280-293
 Kimberly Young’s "Clinical Assessment of
Internet-Addicted Clients," 211-226
EXAMPLE OF READING JOURNAL OBSERVATIONS

 Write down a word that the author uses which

impressed you as effective and useful (record
the sentence from the text in your journal).

 Comment on an idea in the text.

1 POINT

For carefully having read all the materials in the

“basic course documents” folder on Virtual
Campus (except for the bibliography) at least
once.

This will ensure that you understand the

structure and expectations of the course.
1 POINT
 For having chosen the topic of your report and
done at least two hours of work outside of class
toward the report.
REPORT 1 AND FINAL REPORT: YOUR RESEARCH PROJECT

 Instructions on virtual campus (basic course

documents).

 Start as soon as possible.

START NOW BECAUSE EDITING IS
 A multi-stage process.

 Important to go through as many edits as

possible.
NEWTON ON HOW HE DISCOVERED TRUTH

“I keep the subject constantly before me and

wait till the first dawnings open slowly, by
little and little, into a full and clear light.”
CAN USE INTERNET FOR PRELIMINARY RESEARCH AND TO
LOOK FOR INTERESTING ISSUES

https://www.cbc.ca/news/thenational/canadian-start
up-uses-ai-to-reduce-job-interview-bias-1.4810864

But in the report must discuss sources based on

library research.
LIBRARY SUBJECT GUIDES

http://www.biblio.uottawa.ca/html/Page?node=h
elp-guides&lang=en

Librarian talk on September 30 and first part of

October 7