Pages

Thursday, March 18, 2010

The 5 Basic Techniques in Technical Writing

The 5 Basic Techniques in Technical Writing

Mechanism Description
explains the arrangement and shape of an object in space. Such a description may involve movement, complex motions are better handled with the process description. Typically, the parts of mechanism description answer the following questions in order:

  • What is it?
  • What is its function?
  • What does it look like?
  • How does it work?
  • What are its principal parts?
    • Give a detailed description of each part.
    • Each of these parts may require a mechanism description of its own.

Process Description
explains the arrangement of a sequence in chronological order. In organization, it is similar to mechanism description, except that the "part-by-part" becomes step by step:

  • What is it?
  • What is its function?
  • Where and when does it take place?
  • Who or what performs it?
  • How does it work?
  • What are its principal steps? [2]

Process description includes sequence, instructions and procedure; however, only instruct if you expect your reader to perform the process you describe. Try to keep separate these two concepts: "How to do something" and "How something occurs" The first calls for instructions or procedure; the second, for sequence.

Classification
involves grouping things together (on the basis of similarities) and dividing them (according to differences). Classification assists in the complete consideration of a topic .Note the danger of Faulty Coordination.

Partition
is the act of dividing things into their component parts; very similar to classification, and an inevitable part of mechanism description and process description .Partition could be spatial (how each part looks) or functional (how each part works).

Definition
uses words to fix the meaning of a thing -- to make it "definite". The short definition (a paragraph or a single sentence) is essential to technical writing. For instance, the Mechanism Description and the Process Description each begin with a call for a definition. A definition answers the question "what is it?" Good definitions employ the following formula:

species = genus + differentia thing to be defined = group to which
the thing belongs + specific details that separate it
from other things in its group A batten is a tapered piece of wood that fits into a pocket in the trailing edge
of a sail, helping it hold the shape
that allows it to propel a boat.

Sometimes definitions might be much longer than one sentence, in which case you are still trying to answer "what is it?" but will be using most other patterns to help answer it: you can define by describing

No comments:

Post a Comment