|
|
|
Definitions |
|
Definitions are a basic part of technical writing. In fact, most technical writing is a kind of definition
 |
Software documentation is a definition of the software.
|
 |
A report on soil run off is a definition.
|
 |
A manual on how to use spectrometer is a definition.
|
Here are some basic ideas on definition:
Why define terms?
 |
Most technical writing involves definition in some form.
|
 |
Jargon turns readers off (unless they know what it means). |
 |
Readers need to know how you are using terms.
 |
Definitions assure readers you and they understand the term in the same way. |
 |
Definitions clarify terms for the general audience. |
 |
Definitions define terms for contractual purposes. |
|
Who is your audience?
 |
Analyze / know your readers’ level of expertise |
 |
Meet your readers’ needs. |
 |
Define terms as needed (consider your purpose). |
What makes a good definition?
-
Meet your readers’ needs: right level of technicality.
-
Use plain English.
 |
Lower the level of technicality. (Don’t use jargon to define jargon.) |
Explain the basic properties:
 |
function
 |
what it does |
 |
how it works |
|
 |
form
 |
what it looks like |
 |
what are the parts |
|
Be objective.
Be accurate
How long should the definition be?
 |
Parenthetical (part of a sentence)
Example:
Larch, larix laricina occidentalli, is a species commonly occurring in North Idaho.
 |
a deciduous conifer, |
 |
a cone bearing tree that looses its needles, |
|
Sentence Definition (might be a couple sentences)
| Term = |
class (genus)
+
(what kind of thing is it?) |
distinguishing features
(be specific: show how it differs from others in the class) |
| “telephone” |
electronic communications device |
Connected through a network |
Extended definition (paragraph, chapter,….)
|
|