Technical Writing basics Technical Definitions Ethical considerations 92411

Tech Writing/Definitions/Ethics o What is technical writing Technical Definitions o Ref: Finkelstein – Chapters

Technical Writing o What is technical writing? n n o Writing (communication) is an essential skill for all professionals Technical writing is the writing of those involved in the technical fields, i. e. , science and engineering. In science and engineering n n n Write technical reports Write technical proposals Various forms of technical communication 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 3

What is technical writing o For some things it is easier to say what it is not. n What type of writing is this? n Creative writing – It describes a storm, is descriptive, but also often evokes emotion. Often creative writing is seen as imaginative and “fun”. n 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 5

Technical versus creative o o Technical writing lacks the emotional impact Technical writing avoids use of rich metaphors and figures of speech. Typically sentence structures are simple and direct. “Technical writing is precise, objective, direct, and clearly defined. ” 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 6

The level of abstraction o Technical writing describes items precisely, i. e. , a low level of abstraction n o o This a low level of abstraction The level of abstraction can be varied n n n o A 33 K ohm, one-watt carbon resistor Resistor Circuit component Electrical Device As the level of abstraction increases the level of precision of detail decreases 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 7

Audience o o Always must consider your audience Quality of writing measure – two metrics n n o How well the reader understands, precisely, the intended meaning How well the understanding fulfills the intended purpose “THERE IS ALWAYS A SPECIFIC REQUIREMENT FOR WHAT IS BEING WRITTEN. ” 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 8

Audience and Purpose o o o Almost always known Typically know who the audience is Typically know why you are writing the document and what the required content is Technical writing is usually very visual With today’s computer assisted writing, inline pictures/figures are expected. 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 9

Technical Definitions o “In technical writing, definition is the process by which one assigns a precise meaning to a term. ” n o Term = Classification + Differentation Example: n A stall is a flight condition in which the lift produced becomes less than the weight of the airplane, and the airplane stops flying. 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 11

Differentiation o Stall has meaning based on the context. n n n In flying the definition was just given In driving, a stall is an operating condition in which a sudden and unexpected loss of power occurs. In farming, a stall is a single, three-sided compartment that is designed to shelter and animal in a barn or stable. 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 12

The audience o o For technical definitions who the audience is matters Consider: n n In water softening, zeolite is an exchange resin that releases sodium ions while gaining calcium and magnesium ions. In water softening, zeolite is a special material that releases sodium into the water while absorbing calcium and magnesium from the water. 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 13

Technical Definition challenges o Often need further definitions n o To define one term introduce several others Circular definition structurre n One term introduces another and so on until you are back at the original term 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 14

Technical definition checklist o o o On Page 34 of the Text All questions here are important Two are common mistakes n n o Define term using the same term Define term using terms that also need definition More information on Technical definitions is contained in the Technical Definition lecture. 9/24/11 - Technical Writing Copyright 2011 - Joanne De. Groat, ECE, OSU 15