Basic Techniques of Technical Writing

1. Definition

2. Partition

3. Classification

4. Description of a Process

5. Description of a Mechanism

 Basic Techniques of Technical Writing

 I. Definition

      A. Parenthetical definition is a short clarification usually placed in a sentence.

      A parenthetical definition explains the term in a word or phrase, often as a synonym in parentheses following the term: Word (a word processor) has been updated. (http://ol.scc.spokane.edu/jstrever/tw/resources/define.htm)
 

          1. Word definition

                   The cranes are located on the starboard (right) side of the ships. 

                    Summit Books announced its intention to create a newcolophon
                      (emblem or trademark)

          2. Phrase

                    -Motorboating is permitted in the Jamesport Estuary, the portion

                    of the bay that meets the mouth of the Jamesport River.

                    -Before the metal is plated, it is immersed in the pickle as acid 

                     bath that removes scales and oxides from the surfaces.  

     B. Sentence Definition: A definition may require one or more sentences with this              structure: (1) the item or term being defined, (2) the class (specific group) to which the          term belongs, and the features that differentiate the term from all others in its class.

          Examples:

          Acid rain is secondary pollution that occurs when certain chemicals in  the air                      combine with atmospheric water vapor and fall to the earth as rain.   

         A triangle is a plane figure bounded by three straight lines having three angles.  

   C. Informal definition is a kind of definition which conveys the meaning quickly and does not stress the definition. (Tenorio, Escolastica S. and Carmel T. Mosura. Contemporary Technical Writing Styles and Strategies.)

Example:

     John Locke believed that all knowledge originates in experience. 

 Placement of Definitions in Reports

       1. in the text

       2. in the footnote

       3. in a special section in the introduction

       4. in the glossary at the end of the report

Guidelines in Writing Sentence Definition 

     1. Be specific in writing the category and the distinguishing characteristics.

     2.  Avoid writing circular definitions, that is, definitions, that merely repeat the key words or the distinguishing characteristics of the item being defined in the category. 

    3. Be sure the category contains a noun or a noun phrase rather than a phrase beginning with when, where, what or where.

C. Extended definition is a long, detailed clarification usually one or more paragraphs. 

Techniques :

     1.  Graphics

           -creating some sort of graphics, such as photographs, diagram, a schematic, or a flowchart, and then explain it.

     2. Examples

         - using examples to clarify an object or idea.

    3. Partition

         - is the process of dividing a thing or an idea into smaller parts so that the reader can understand it easily.

    4. Principle of Operation 

         - is an effective way to develop an extended definition, especially that of an object or process.

    5. Comparison and Contrast

        - A rhetorical strategy and method of organization in which a writer examines similarities and/or differences between two people, places, ideas, or things. (http://grammar.about.com/od/c/g/comparison2term.htm)

   6. Analogy

       - the writer comapres the item that is being defined to a similar one, or to an item that in some way completely different but shares some essential characteristics.

    7. Etymology

       - the derivation of a word; it is a popular way to begin a definition of acronyms. which are abbreviations pronounced as words.

    8. History of the term

       - to explain its history. It explains the original use of the term, and then describes how the meaning is changed in response to historical events or technological advances.

     9. Description

        - it calls for a shared understanding of terms but is also filled with descriptions-verbal and visual representatives of objects, mechanics and processes.

    10. Mechanism

       -is a synthetic object consisting of a number of movable, identifiable parts that work together as a system.

     11. Process

      - is a series of steps of an activity that takes place over time.

II. Partition is an analysis that divides a singular item into parts, steps or aspects. 

III. Classification is the arrangement of objects, people or ideas with shared characteristics into classes or groups. It is a method used to organize information into groups and categories.

Rules in Partition and Classification 

      1. It is coordinated.

      2. It is mutually exclusive.

      3. It's complete.

      4. There is no overlapping.

  

IV. Description of Mechanism 

     I. Introduction 

         A. What is

         B. What for 

         C. What it looks like

         D. What the principal parts are

     II. Parts Description

          A. Principal part 1

               1. What is

                2. What for

                3. What it looks like

                4. What the subparts are

                     a. Subpart 1

                          (1) What is

                           (2) What for 

                           (3) What it looks like

                           (4) Describe detailedly

                                 etc.

       III. Conclusion (How mechanism operates)

V. Description of a Process
 

     I. Introduction 

     II. Raw Materials

     III. Equipment

     IV. Description of the Process