Basic Techniques of Technical Writing

Basic Techniques of Technical Writing There are five distinctive technical writing techniques frequently used in technical and scientific writing. They are definition, classification, partition, description of mechanisms, and description of processes. The discussion on the five special writing techniques is intended to help the student determine how to develop and arrange his data in a way that would best communicate his ideas to his reader. Our report focus on the first technique- DEFINITION. DEFINITION The need for defining occurs when the report uses technical terms which are not familiar to the reader or when common terms are used in a special way. Definitions are classified as: a) Informal- consists of one or more synonymous expressions substituted for the unfamiliar term used. b) Formal-preferred to be used in technical and scientific work; has three parts: term, genus, differentia. Examples: Term A triangle

Genus is a plane figure

Differentia bounded by 3 straight lines having 3 angles

RULES FOR DEFINITION In formulating a formal definition, observe the following: 1) Try to use simple words. Don't define an unfamiliar term by using more difficult terminology which would further confuse the reader. Not this:

A network is anything reticulated or decussated, at equal distances, with interstices between the intersections.

Good:

A network is a complex system of electrical wires or channels that interlace or cross like a fabric of a net.

2) If the term being defined is a noun, the word after 'is' should also be a noun (the name of the class). Don't begin your definition with 'when', 'what' or 'where'.

Not this: or metallic alloy.

Soldering is when metal surfaces are joined by using melted metal

Good: Soldering is the process of joining metal surfaces using melted metal or metallic alloy. 3) In defining a term, avoid using the term itself or any of its derivatives. Not this:

A parallelogram is a quadrilateral with parallel sides.

Good:

A parallelogram is a quadrilateral with opposite sides equal.

4) Don't put the term you are defining in too broad or too narrow a class. Too broad:

A crystal is something that glitters in the sun.

Too narrow: A crystal is a formation of quartz geometrically patterned. Good:

A crystal is a solid piece of matter in which the atoms, molecules or ions composing it are arranged in a definite geometric pattern.

METHODS OF EXPANDING A FORMAL DEFINITION: The one-sentence formal definition usually serves as a topic sentence for a somewhat more extensive explanation of a topic resulting in what is called an amplified, expanded or extended definition. Such definition can be developed by using any of the following methods: 1) Details- A term can be clarified by the addition of related or supporting particulars. To define a mechanism, a vivid description of its various parts will enable the reader to "see" it. 2) Examples or instances- General statements particularly abstract definitions are made more concrete when illustrations are cited. 3) Comparison, contrast and analogy- Analogy cites similarities- The reader is made to understand an unfamiliar object or idea by comparing it with another object or idea more familiar to the reader. Using contrast, the differences of both objects are cited in order to make the idea clear. Comparison combines the two methods of analogy and contrast (pointing out similarities and differences).

4) Word Derivative-Extended definitions may be revealing and interesting because they explain the origin of the term or the idea. Definitions such as these are seldom logically adequate, but they are often extremely useful illustrations for clarification. PLACEMENT OF DEFINITION IN REPORTS The proper location of definitions depends upon how important they are to the text and on the probable knowledge of the readers. Definitions may be placed: 1) In the text itself- when the terms to be defined are not many and synonyms or appositives will suffice to make their meaning clear; 2)In the footnote- when the report is to be read by a mixed group of readers, some of whom may know and some may not know the terms used in the text. 3) In a special section in the introduction- when the terms are of critical importance in understanding the text of the reports; and 4) In the glossary at the end of the report- when the inclusion of two many definitions in the text itself would cause repeated interruptions, thereby causing the reader to lose track of the topic being discussed.

Technological Institute of the Philippines Quezon City

Technical Communication (ENGL293)

Basic Techniques of Technical Writing (Definition)

Prepared by: Jurada, Juan Paulo D. Borjal, Christine Irene O. Garganera, Bryan Carl Reyes, Redon B.

Submitted to: Prof. Lorna R. Dimatatac

Transmittal Letter

July 11, 2011

PROF. LORNA R. DIMATATAC Technological Institute of the Philippines 938 Aurora Blvd.,Cubao,Quezon City

Ma’am: We are submitting to you the report entitled Basic Techniques of Technical Writing, which includes Definition. It was requested to be submitted on July 11, 2011. The content of this report is concerned on the abovementioned technique only. This report also discusses the rules for definition as well as the methods for expanding a formal definition and its placement in reports, which were being tackled on the latter part of this report. If you should have any questions concerning our report, please feel free to contact Christine Irene O. Borjal at +639289065705.

Sincerely, Christine Irene O. Borjal Leader, Group 1 (IE21FB1)

References:

 Technical Writing (Revised Edition 2004) by Vicente, Corazon C. et al.; p.16-21