Technical Writing Notes

Download as pdf or txt
Download as pdf or txt
You are on page 1of 3

UNIT I UNDERSTANDING THE NATURE OF TECHNICAL Proposals 7. It provides reporttostockholdersof companies.

WRITING - written suggestions on how to make the company


Technical Writing or organization more productive and successful Properties of Technical Writing
-Is writing about scientific subjects and about various Memoranda
technical subjects associated with the sciences. - inter-office written communication used to 1. Subject matter
-Is characterized by certainformal elements, such as its disseminate information 2. Audience
scientific and technical vocabulary, use of graphic aids, 3. Expression (writing/reading)
and the use of conventional report forms. 4. Style (how the material is written)
-high concentrationof certain complex and important writing 5 Important Principles in Good Technical Writing 5. Arrangement of Materials
techniques, in particular description
1. Always have in mind a specific reader, real or 5 Basic Types of Writing
Business Letter imaginary, when you are writing a report. Always
- a type of written communication using formal assume that he is intelligent, but uninformed. 1. Technical Writing
language and follows formal elements of letter 2. Creative Writing
writing 2. Before you start to write, always decide what the 3. Expressive Writing
exact purpose of your report is, and make sure that 4. Expository Writing
Contract every paragraph, sentence, and word makes a 5. Persuasive Writing
- a written agreement between two people under clear contribution to that purpose.
mutually agreed terms Differences of Technical & Creative Writing
3. Use language that is simple, concrete, and familiar.
Monograph
- a detailed essay or book on a very specific topic 4. At the beginning and end of every section of your
report, check your writing according to this
Printed action memo principle. “First, you tell the reader what you’re
- a ready-format memorandum that only requires a going to tell him, then you tell him what you’ve been
checkmark on the appropriate box that contains the told him.”
message
Graphic aids 5. Make your report attractive.
- drawings, sketches and illustrations that aid the
readers in understanding the present data Purposes of Technical Writing
Instructional manuals
- written to guide the readers on how to assemble, 1. It servesasbasis formanagement decision.
maintain, and operate an apparatus, machine or 2. It furnishesneededinformation.
gadget 3. It gives instructions.
Brochures 4. It recordsbusiness transactions through proposals.
- pamphlets or flyers that endorse a product 5. It procuresbusinessproposals.
6. It servesasbasis forpublicrelations.
Lesson 2 Principles of Ethical Communication UNIT 2 EXPLORING EXPOSITORY TECHNIQUES

Copyright Do’s of Technical Communication LESSON1 EXPOSITORY TECHNIQUES:


- Law covers the protection of the rights of the author - Abide by relevant laws. CLASSIFICATION
- Abide by the appropriate corporate or professional
- Philippine copyright law is enshrined in the code of conduct. Classification
Intellectual Property Code of the Philippines, - Tell the truth. - Is Dividing something into
officially known as Republic Act No. 8293. - Be clear. ● Groups
- Avoid discriminatory language. ● Classes
Fair Use Policy - Acknowledge assistance from others. ● Categories
- Section 185 of the Intellectual Property Code - Normally doneby several criteria (standards or
provides for fair use of copyrighted material. Dont’s of Technical Communication principles on which judgments arebased)
- Done by the writer when he/she believes that there
Copyright Infringement False Implications are shared qualities or characteristics about a
- The use of works protected by copyright without - assuming the outcome of a project or making subjec tmatter.
permission for its usage where such permission is sweeping generalizations. -
required, thereby infringing certain exclusive rights LESSON 2 EXPOSITORY TECHNIQUES: DEFINITION
granted to the copyright. Exaggerations
- expressing situations in extreme proportions. - is a useful technique in oral or written
Trademark Law communication
- Pertains to federal protection (different from Euphemisms - It is amust for a technical writer tobe able todefine
registered trademarks) - writing about situations in seemingly good terms with multiple meanings and those that are
conditions even though they are not. unfamiliar to the readers.
Contract Law -
- covers written warranties or their implied warranties -Don’t mislead your readers. Methods of Defining Terms
a promise enforceable by law. (The making of a Lesson 3 Writing Process
contract requires the mutual assent of two or more Simple Definition
persons, one of them ordinarily making an offer and Could be formulated by bearing in mind its three
another accepting. parts: the species, genus, and differentia. This
method of definition is commonly used in technical
Liability Law writing whether formally, semi-formally, or
- Pertains to the responsibilities and obligations of non-formally.
writers specially claims they made on their paper
Note: Denotation
Species or the word to be defined may be introduced by a - is the basic literal meaning or the dictionary - The first calls for instruction or procedure; the
determiner Genus or class/ category where the term meaning of words second, for sequence.
belongs is always connected to the species by a linking
verb. Both species and genus can be introduced by a Connotation Process description includes
determiner. To make the definition complete, a differentia is - is the additional shade of meaning that words imply - SEQUENCE
written to give the characteristics of the term that make it aside from their dictionary meaning - INSTRUCTIONS
different from other terms belonging to the same genus. - the positive or negative associations of a word - PROCEDURE
naturally carries
We often use the present passive tense: is/are + v + ed
Pointers when defining Terms For example:
- is manufactured
1. Never give definitions of a term that include any of - Is controlled
its derivatives. -
For example: We use sequence markers to link sentences like:
Definitionis the act ofdefining. - first
2. Do not use “is where” or “is when” to define a term. - second
-Don’t say “Christmas is when Jesus Christ is born” - then
or - next, subsequently, finally, at last.
-“A classroom is where you will find students.”
3. Use the simplepresent tense (active andpassive LESSON 4 EXPOSITORY TECHNIQUES: DESCRIPTION
voice). OF A MECHANISM
4. Often, we use relative clauses to give additional
information. - An explanation of a system or parts of an
apparatus.
Lesson 3 - This includes the characteristics and functions of a
EXPOSITORY TECHNIQUES: DESCRIPTION OF A piece of the device and the totality of the
PROCESS mechanism
- also explains the arrangement and shape of an
Describing the Process object in space. In writing a description of a
Informal Definition
- The writer explains the arrangement of a sequence mechanism, the writer may be guided by the
- does not follow a pattern. The only objective is to
in chronological order. following questions:
give meaning to an unfamiliar word or explain the
- The process is a kin to mechanism description. • What is it (equipment, machine, device, apparatus)?
special meaning of a familiar word.
- There are two separate concepts which we must •What is its function?
- word meanings enter informal definition by
briefly explain here: •What does it look like?
providing denotative or connotative meaning.
“How to do something” •How does it work?
“How something occurs” •What are the principal parts?

You might also like