Techniques of Technical Writing (Definition)

Techniques of Technical Writing (Definition)

Four techniques are of special importance in technical writing: definition, description of a mechanism, description of a process, and classification. These techniques are not types of reports and it is important to remember that these techniques usually appear in a single report. It would be exceptional to find an entire report, even a short one, containing only one of these techniques. For example, two or more techniques might be closely interwoven as a writer described the design, construction, and operation of a mechanism. The intermingling of these techniques, however, does not alter the basic principles of their use. These techniques can be studied most effectively by taking one technique at a time. The treatment of these techniques will stress the practical rather than the theoretical, particularly in the subjects on definition and classification.
In technology, words have precise, specific meanings; therefore there is a need for defining a technical term clearly. The extent to which a term should be defined or the length of a definition depends on the writer's purpose and the knowledge level of the reader. Before going to the problem of "how to define", it is better to "think about what should be defined first." It is not possible of course, to set up an absolute list of terms and ideas that would require definition, not even for a specific body of readers, but it is possible and desirable to clarify the point of view from which the problem of definition should be attacked. The relationships of words to the ideas and things for which they stand can become very complex. However, there is a simple and helpful way of classifying words, as they will appear to your reader. The words will fall into one of the following categories:
1. Familiar words for familiar things2. Familiar words for unfamiliar things3. Unfamiliar words for familiar things4. Unfamiliar words for unfamiliar things

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

The 5 Basic Techniques in Technical Writing Mechanism Description explains the arrangement and shape of an object in space. Such a description may in

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

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

Technical Writing