Grunt Stuff

Dr. Leo Finkelstein, Jr.

EGR 335Technical Communication for Engineers

and Computer ScientistsCollege of Engineering and Computer Science

Overview of Topics

Formal Report RequirementsFormal Report Requirements

Deliverables and DatesDeliverables and Dates

Common Grammar and Style ErrorsCommon Grammar and Style Errors

Passive VoicePassive Voice

Report Requirements

10 Pages of 10 Pages of SubstanceSubstance containing: containing: Transmittal Letter* Title Page* Informative Abstract* Standard Introduction Discussion Summary/Conclusion Documentation*

*doesn’t count in page count

What is Substance?

““Material of an essential nature” Material of an essential nature” Solid, informative, and practical Has mass and occupies space

Substance includes:Substance includes: Non-fluff, unpadded discussions Useful, well-integrated visuals Proper, fully cited documentation

Transmittal Letter

Short, to the point, and SIGNEDShort, to the point, and SIGNED

March 13, 2008

Dear Dr. Finkelstein:

The attached document entitled, “Maglev Trains and Superconductors,” fulfills the formal report requirements of EGR 335 for the Winter Quarter 2008. If you have any questions, please e-mail me at student.3@wright.edu, or call (937) 775-1234.

Sincerely,

(signature)

Informative Abstract

How to write itHow to write it Inform reader of the report’s substance Do not refer to the report title or author Make it about 250 words in length

An intellectual view of piracy includes both its therapeutic effects on the pirate and the economic stimulus it provides the local economy. Pirates derive substantial catharsis from their criminal activity in a way that does not threaten society with violence. Economically, the availability of high quality software at a bargain price stimulates the local sale of computers and contributes to the sales tax base.

Standard Introduction

Here’s what to include:Here’s what to include: Purpose

What is this paper designed to do?

Problem (or Background) What is the subject of this paper?

• How does it fulfill the EGR 335 requirement?• Introduce topics and provide needed

background

Scope What is included, and what isn’t, and why?

Discussion

This is the heart of your reportThis is the heart of your report State of Art example:

What were the goals of your research? What was the methodology employed? What were the findings and results? What are your interpretations?

Documentation RequirementDocumentation Requirement Discussion must include source citations

Summary

Summarize your researchSummarize your research Make it similar to your abstract

Assuming you did the abstract correctly

Focus on substance Assumes you have substance

Provide any conclusionsProvide any conclusions Based on what’s in the discussion

Do not introduce new information here

Documentation Requirements

A complete list of references A complete list of references 1.Finkelstein, Leo Jr., “Sample Resume.” Internet:

www.cs.wright.edu/~lfinkel, May 20, 19992.Finkelstein, Leo Jr., “The QuadFINKEL Experience.”

Internet: rec.sports.skate.figure, April 20, 1999.3. Finkelstein, Leo Jr., “The Ethics of Using the

FinkelKICK in Competition.” Black Belt (July 2000), pp. 68-72, 140.

Source citations in the textSource citations in the textBecause of the kick’s great power, even its inventor says, “This technique should never be used.” (3:69) or (Finkelstein 2000, 69)

Example

Here’s what the student changed. Here’s what the student changed.

Is this a paraphrase of Finkelstein? Or is this a quote?Is this a paraphrase of Finkelstein? Or is this a quote?

My proposed state-of-the-art report will begin with a brief My proposed state-of-the-art report will begin with a brief review of review of workstation ergonomicsworkstation ergonomics, followed by a short history , followed by a short history of of workstation design for computing systemsworkstation design for computing systems. The report will . The report will then focus on the technical aspects of the then focus on the technical aspects of the Microsoft Microsoft Ergonomic KeyboardErgonomic Keyboard..

It’s a quote with the student’s words added and some of Finkelstein’s It’s a quote with the student’s words added and some of Finkelstein’s words removed.words removed.

““My proposed state-of-the-art report will begin with a brief My proposed state-of-the-art report will begin with a brief review of review of [workstation ergonomics],[workstation ergonomics], followed by a short history followed by a short history of of [workstation design for computing systems].[workstation design for computing systems]. The report will The report will then focus on the technical aspects of the then focus on the technical aspects of the [Microsoft [Microsoft Ergonomic Keyboard]Ergonomic Keyboard]..”” (Finkelstein 2005, 106) (Finkelstein 2005, 106)

Deliverable Dates

Formal Report DocumentFormal Report Document Due Thursday, March 13, 2008

Due at the beginning of class in class

Late turn-in penalties < = 24 hours - 1/2 letter grade > 24 hours - too horrific to fathom

Formal Report PresentationFormal Report Presentation As scheduled in class

No-show penalty - too horrific to fathom

Grammar and Style

Common ErrorsCommon Errors Comma splice (CS)

The computer was crashing, the operator was sleeping.

Verb agreement (VB) Everybody is invited to the demonstration.

Pronoun error (PN) Everybody must do his part. (agreement) This is how I look. (reference)

Fragment (FRAG) Running diagnostics on the CPU that’s a RISC

processor.

Grammar and Style

Common Errors (continued)Common Errors (continued) Spelling (SP)

It’s important to know the CPU and it’s capabilities.

Modification (MOD) Ignorance of social implications is a phenomena

among CS students that must be destroyed.

Semicolon (SEMI) Format a disk as follows; type format a: /s and hit

<RETURN>.

Fused sentence (FS) The workstation is poorly designed it really sucks.

Passive Voice

Active: subject – verb – objectActive: subject – verb – object Direct and efficient

“She hit him.” (3 words)

Passive: object – verb – subject*Passive: object – verb – subject* Indirect and inefficient

“He was hit by her” (5 words) Can omit the subject (accountability)

“He was hit.”

Key to spotting itKey to spotting it (form of the verb-to-be) + (past participle)

**not reallynot really

Other grammar problems

She smells She smells goodgood.. She smells She smells wellwell..

He is He is goodgood.. He is He is wellwell..

I am looking for I am looking for any teacher who will give any teacher who will give me a passing grade.me a passing grade.

Summary of Topics Covered

Formal Report RequirementsFormal Report Requirements

Deliverables and DatesDeliverables and Dates

Common Grammar and Style ErrorsCommon Grammar and Style Errors

Passive VoicePassive Voice

Grunt Stuff

Dr. Leo Finkelstein, Jr.

EGR 335Technical Communication for Engineers

and Computer ScientistsCollege of Engineering and Computer Science