The School of The Archdiocese of Capiz Roxas City: College of Education Colegio de La Purisima Concepcion
The School of The Archdiocese of Capiz Roxas City: College of Education Colegio de La Purisima Concepcion
The School of The Archdiocese of Capiz Roxas City: College of Education Colegio de La Purisima Concepcion
WEEK 1
Topic: Introduction to Technical Writing
A. Technical Writing: A Definition
B. Characteristics of Technical Writing
C. Functions of Technical Writing
D. Importance of Technical Writing
Introduction
In this lesson, you will be exposed to a type of writing called technical writing. How is this type
of writing similar to or different from the other types of writing?
Poor writing reflects badly on us. It limits the influence we can have on others, and it steals
time away from those who do to decipher what we mean. To avoid these problems, there are a few
commonly accepted principles of writing that we can follow and that will be discussed in this
lesson.
Input
22
What is Technical Writing? (Carmel T. Mosura and Escolastica S. Tenorio, 1999)
a. Basic Characteristics of Technical Writing (Gordon H. Mills and John A. Walter, 1981)
1. Technical writing is characterized by certain formal elements such as:
a. its scientific and technical vocabulary
b. its use of graphic aids
c. its use of conventional format
2. Technical writing is ideally characterized by:
a. the maintenance of the impartiality of and objectivity
b. extreme care to convey information accurately and concretely
c. the absence of any attempt to arouse emotion
3. Technical writing is writing in which there is a relatively high concentration of certain
complex and important writing techniques.
a. definition
b. description of mechanism
c. description of process
d. classification and interpretation.
e. comparison and contrast
23
Facility of work. A modern view of technical writing is to think of this as an act of
communicating what are happening in a workplace. Writing at a workplace, you make all parties
involved in the work get an update of the present, past, or future of the work regardless of their
distance from the place of the main task. Near or far, through a written communication about the
job, all project workers are given the opportunity to be informed of the status of the job and to be
aware of the things that they have to contribute for the perfection and completion of the task. This
is true especially if your technical written work includes graphics and figures to help the project
workers get a clear, specific, and emphatic understanding of the nature of their assigned task.
(McMurray, 2002)
Means of job promotion. It is every workers desire to be promoted to a higher rank for this
would mean higher pay and better working conditions. The vehicle to any job promotion is
technical writing abilities and skills that will make you produce written works reflecting your
thinking prowess, communicative competence, and professional preparations. Shown by your
technical written work, these qualities of yours are your instrument to getting a job promotion.
(Beer, 2005)
24
Involvement
Individual Exam
Directions: This is an example of a technical writing. Point out the unique characteristics of this
writing.
25
1.
2.
3.
4.
5.
Intervention
Expand your understanding about technical writing by reading more through internet.
https://medium.com/technical-writing-is-easy/what-is-technical-communication-
421bf8a2206b#:~:text=Technical%20communication%20is%20not%20o
References
2. Minas, R. M. and Ferianiza M.B.(2008). Technical Writing in the Modern World. Manila;
Mindshapers Co., Inc.
4. google.com
26
WEEK 2
Introduction to Technical Writing
A. Importance of Knowledge in Technical Writing
B. Qualities of Good Reports
Introduction
This week we will be discussing the importance of knowledge in technical writing, qualities
of a technical writer, qualities of good technical reports, and document guidelines.
In your role as a technical writer, it is important that you are both knowledgeable and
skilled in your profession. You can’t do a good job at writing if you don’t know the rules of writing,
the subject matter and how to use writing tools.
Input
Accuracy
Great care should be taken to ensure that the information is presented accurately. Make sure
values are transferred correctly into the report, and calculations are done properly. Since many
27
people proof read right over their own typographical errors, it is often best to have another person
proofread the report. Mistakes may cause the reader to doubt other points of the report and reflect
on the professionalism of the author.
Objectivity
Data must be evaluated honestly and without bias. Conclusions should be done solely from
the facts presented. Opinions and conjecture should be clearly identified if included at all.
Deficiencies in the testing or the results should be noted. Readers should be informed of all
assumptions and probable sources of errors if encountered.
Clarity
The author should work to convey an exact meaning to the reader. The text must be clear
and unambiguous, mathematical symbols must be fully defined, and the figures and tables must be
easily understood. Clarity must be met from the readers’ point of view. Don’t assume that readers
are familiar with previous work or previous reports. When photographs are included in a report, a
scale or some object of standard size should be included in the photograph to help your readers
judge the size of the objects shown. Simply stating the size of the magnification of a photograph can
cause uncertainty since the size of photographs often change in reproduction.
Conciseness
Most people are fairly busy and will not want to spend any more time than necessary in
reading a report. Therefore, technical reports should be concisely written. Include all the details
needed to fully document and explain the work but keep it as brief as possible. Conciseness is
especially important in the abstract and conclusions sections.
Continuity
Reports should be organized in a logical manner so that it is easy for the reader to follow. It
is often helpful to start with an outline of the paper, making good use of headings. The same three
step approach for developing an effective presentation can be used to develop an effective paper.
1. Introduce the subject matter (tell readers what they will be reading about)
2. Provide the detailed information (tell them what you want them to know)
3. Summarize the results and conclusions (re-tell them the main points)
Writing Style
A relatively formal writing style should use when composing technical reports. The
personal style of the writer should be secondary to the clear and objective communication of
information. Writers should, however, strives to make their reports interesting and enjoyable to
read.
Involvement
28
Individual Exam
B. These are the qualities of good technical reports. Identify in 1-2 sentences.
1. Accuracy –
2. Objectivity –
3. Clarity –
4. Conciseness –
5. Continuity -
Intervention
Expand your understanding about technical writing by reading some more about this kind
of writing through internet.
References
2. Minas, R. M. and Ferianiza M.B.(2008). Technical Writing in the Modern World. Manila;
Mindshapers Co., Inc.
4. google.com
29
WEEK 3
Introduction to Technical Writing
A. Technical Writing vs. Other Types of Writing
B. Document Guidelines
Introduction
This week, we will be discussing how technical writing differs from other types of writing.
How do you compare and contrast technical writing with different types of writing? Technical
writing is not meant for entertainment purposes but for knowledge improvement. Basically, to
reveal ideas, views, and feelings about a certain topic is the main objective of all types of writing
regardless of whether the readers respond to the writer’s ideas or not, or of what kind of responses
or reactions the text may get from the readers. The impact of the written work entirely depends on
the reader’s judgment.
Input
For contrastive analysis, technical writing differs from literary writing in some aspects.
-It focuses on man’s life or experience -It focuses on the subject related to business
including the intricacies of the human heart. industry, science and technology.
Language Language
-It makes use of figurative or imaginative -It employs specialized jargon, which
vocabulary or language. includes technical, or scientific
-Words or expressions are beautifully terminologies
interwoven so that they are rhythmically
sounded.
Point of View Point of View
-In treating the subject, the writer may use -In technical writing the preferences is the
either the following points of view: I, He, third person point of view – the researcher,
She, It, We, You or They. the proponent, the writer, author, etc.
Tone Tone
30
b. Differences between Technical Writing and Other Types of Writing
B. Document Guidelines
Strategy
It is important to know your audience’s interests and biases because they will have a
tremendous impact in your communication strategy.
If your audience has a high interest level in your communication you can go directly to the
point without taking much time to arouse their interest. Build a good logical argument. If your
audience has a low interest level, you should use more of a tell/sell style to motivate the reader’s
interest. Keep your message as short as possible; long documents are intimidating and listeners
tend to tune out what seems like rambling.
Word Choice
Overuse of jargon or acronyms in a communication make document hard to read, even of
the primary audience is familiar with them. You should limit the use of jargons and acronyms in a
communication to as few as possible, particularly if your primary or secondary audiences are not s
well versed in their use. You must also watch for confusing or incorrect word choice in your
document
31
Structure
The introduction is an important place to set up the underlying flow or the rest of the
document. An effective introduction accomplishes three aims: It builds readers interest, explains
your purpose for writing, and it provides a preview of the document.
Checking Unity
When we judge the organization of a piece of writing, we generally use two criteria:
unity and coherence. Unity means one oneness, relevancy to some central idea; coherence
means fitting or sticking together. A piece of writing has unity when every section, every
paragraph, every sentence relates to the same central point. Using thesis sentences and
topic sentences will help ensure that you have a clear purpose in mind. Without a sharply
defined purpose, you can hardly your composition’s unity. On the other hand, if each section
of your communication has a clear thesis and each paragraph has a good topic sentence, you
judge unity by measuring everything against them. If something does not fit directly iinto
the topic sentence or thesis sentence, either revise it to make it fit or remove it.
Checking Coherence
In a six paragraph composition, unity means having all six paragraphs relate to the
central idea of the composition. Coherence means having paragraph Two fit smoothly
between paragraphs One and Three and paragraph Five fit neatly between Four and Six,
and so on. Unity does not ensure coherence. In fact, many poorly constructed
communication read like collections of sections all relating to a central idea but having no
further relationship to one another.
The first step toward ensuring coherence is to use clear, logical order. No number of
fancy techniques will make set of instructions coherent if steps are not presented in some
sort of sequential order. The same is true of descriptions, comparisons, of analyses, of any
type of writing for which an effective organizational pattern is available. Even if you are
merely discussing a few ideas that fit into no particular pattern, present them in some sort
of logical order. You may go from most important, least important to most important, most
common to least common, largest to smallest, or any one of many possible orders. Find out
one that make sense, and then use it.
Involvement
A. Describe the format, word choice, and structure of the given texts below.
a.
32
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
b.
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________
Individual Exam
A. Directions: Compare and contrast technical writing with the other types of writing by completing
the grid below with the needed ideas.
1. Purpose or
Objective
2. Audience or
Readers
3. Structure or
Organization
33
4.Style or
Language
b. What is unity? What is coherence? Why are they important in writing? (4-6 sentences)
________________________________________________________________________________________________________________
________________________________________________________________________________________________________________
________________________________________________________________________________________________________________
________________________________________________________________________________________________________________
_________________________________________________________________________________________________________________
Intervention
Expand your understanding about the difference between technical writing and other types
of writing by reading some more about this through internet or books from the library.
References
2. Minas, R. M. and Ferianiza M.B.(2008). Technical Writing in the Modern World. Manila;
Mindshapers Co., Inc.
4. google.com
34
WEEK 4
Introduction to Technical Writing
A. The Language of Technical Writing
At the end of the lesson, you should be able to apply the principles and rules governing the
language of technical writing in your future technical writing reports.
Introduction
Technical Writing is easily distinguished from the other types of writing because of its
language. Giving a particular attention to the language of technical writing is the clearest way to
differentiate this from other types of writing. This week, we will be studying the language of
technical writing – the principles and rules that should be applied in writing technical
communications.
Input
Read not only by company members but by other people as well, any output of technical
writing has to use words that appeal to the intellect and emotions of all its readers. Having effects
on both mind and body of the reader, any technical written work easily reaches its audience. This is
possible through its use of language that is simple, direct, and specific. (Rubens, 2001)
A number of books on technical writing give the following techniques on using the right
language for producing effective technical reports:
1. Practice conciseness. Conciseness which means expressing oneself in the fewest number
of words at the same time retaining completeness in meaning is possible through the following
methods:
a. Shortening words/phrases
Short/simple Short/simple
Long/complex words Long/complex words
words words
35
b. Avoid nominalizations or the use of “camouflaged or shun words” (words ending in –sion
or –tion);replace them with active words.
36
e. Omitting clichés, hackneyed, trite, old-fashioned, worn-out expressions
f. Avoiding expletives or sentences with no true subjects like sentences beginning with
There is, There are, Here is, It is, It has been, and many more.
Don’t say Say
There are many customers at the lobby. Many customers are at …
There is a sharp tool on that table. A sharp tool is on that …
There will be a meeting tomorrow. A meeting will be …
It is requested that you stay. You are requested to …
Here is the answer of Mr. Lee The answer of Mr. Lee is …
37
2. Express your ideas in active voice rather than in passive voice.
Sentences in active voice stress the order of the action; in passive voice, the receiver of the
action. At times, some prefer to use passive voice to prevent the frequent use of “I”because the
repeated use of this personal pronoun somehow indicates self-centeredness, monotony, or
repetitiveness. Between these two voices of verbs, many technical writers find the use of active
voice better because this clearly recognizes the identity of the person answerable for the act
(Pearsal, 2010). According to Vanhauss (2005), technical writing should be an “action-oriented
style,” rather than be one with great deal of “hidden words.”
3. Use non-sexist instead of sexist language by expressing yourself in the following ways:
b. Using 2nd person point of view instead of 3rd person point of view
1. She presented her proposal report 1. Present your proposal report on time.
on time.
2. The customer showed his receipt to 2. Show your receipt to the guard.
the guard.
c. Using expressions like He or She – him or her. Avoid using a slash mark –He/She –him/her.
Others however find He or She – him or her wordy, hence, they prefer using the plural form –
their, or the 2nd person point of view – you.
1. The customer explained her point 1. The customer explained his or her point to
to the manager. the manager.
2. The X-ray technician affixed his 2. The X-ray technician affixed her or her
signature to the document. signature to the document.
3. She is willing to pay any amount for 3. He or she is willing to pay any amount for
his choice. his or her choice.
.
4. Avoid using words that explicitly favor one gender
38
5. Avoid using jargons, gobbledygook, horse-and buggy, or verbal dead words
These expressions are long, pretentious, and high sounding; words that have no
significant or necessary place in the sentence. Appearing complex, they work to hide the true
meaning of the term or make the writer sound learned or professional. Eliminate these vague
expressions by substituting them with simple and easier terms. One good rule of the thumb in
technical writing is: write to express, not to impress. This means that you have to write the
way you speak or use a conversational or casual language you often use in your day-to-day
interactions with people. (Guffey, 2005)
Jargons are technical terms commonly used by people belonging to the same field of
profession. Exclusively used by a specific set of persons like the lawyers, the physicians, the
engineers, or the businessmen, these terms do not sound familiar or understandable to
ordinary persons in society. Seemingly, the use of these terms works to exclude laypersons
from knowing what are happening in a company of experts or specialists or of people
belonging to one field of profession.
Examples:
Legal profession - habeas corpus, subpoena, status quo, preliminary injunction, delicti
Business world - rebate, assets and liabilities, amortization, mortgage, balance sheet,
investment
Medical world - stethoscope, hypertension, differential diagnosis, formaldehyde, silver
nitrate
Computer world - user friendly, on-line adapter, debug, open shop, quick-access storage
Teaching profession- lesson plan, grade sheet, intrinsic motivation, systemic-functional
grammar, communicative competence
6. Give careful attention to words and phrases that are commonly misused and misspelled
Examples:
a. accept – to take something seriously
except - to exclude a rule or statement from a list
- Let him accept those tools except the one with a red mark.
39
g. credible – believable
creditable - quite good; more than just satisfactory
-A creditable company has many business methods and techniques in making their products
credible to all kinds of buyers all over the world.
Involvement
Directions: Answer the following questions intelligently and concisely. (1-2 sentences)
1. Can you easily distinguish technical writing from other types of writing? Why? Why not?
_____________________________________________________________________________________________________________
_____________________________________________________________________________________________________________
2. How do you express yourself in a concise manner?
_____________________________________________________________________________________________________________
_____________________________________________________________________________________________________________
3. Why should you avoid using long, high-sounding, or complex words?
_____________________________________________________________________________________________________________
_____________________________________________________________________________________________________________
4. When do you consider an expression a cliché?
_____________________________________________________________________________________________________________
40
_____________________________________________________________________________________________________________
5. Is this an effective kind of expression: “like for example”? Give reasons for your answers.
_____________________________________________________________________________________________________________
_____________________________________________________________________________________________________________
6. Describe the results of expletives in your technical report.
_____________________________________________________________________________________________________________
_____________________________________________________________________________________________________________
7. Which between the two voices of verbs is better for your report?
_____________________________________________________________________________________________________________
_____________________________________________________________________________________________________________
8. Differentiate sexist from non-sexist language.
____________________________________________________________________________________________________________
____________________________________________________________________________________________________________
9. Have you encountered people using jargons, gobbledygook, or dead words?
____________________________________________________________________________________________________________
____________________________________________________________________________________________________________
10. Do you consider the discussed topic valuable? Support your answer.
____________________________________________________________________________________________________________
____________________________________________________________________________________________________________
Individual Exam
I. Directions: (Pair-work)Thinking of what you have read about the language of technical writing,
improve the following improperly written sentences.
1. An additional package will be forwarded to you by means of LBC in the near future.
________________________________________________________________ ________________________________
2. At this point in time, a modification in the mode of delivery is disadvantageous.
___________________________________________________________________________________________
3. Could I utilize my E-card in order to forward a package to you at a rapid rate?
__________________________________________________________________________________________
4. In the first place, in what specific location will Mr. Cruz forward the package?
_________________________________________________________________________________________
5. Endeavor to deliver the box in accordance with instructions of Mr. Cruz as soon as possible.
_________________________________________________________________________________________________________
1. He came to a conclusion that the investigation of the business firm by Mr. Santos is necessary
for the maintenance of the company’s good reputation.
__________________________________________________________________________________________________________
2. The development of the legal case went so slow that both parties made an agreement to the
termination of the case.
___________________________________________________________________________________________________________
3. Atty. Perez made the announcement of the termination of the case.
___________________________________________________________________________________________________________
4. To give both parties satisfaction, the court gave them permission for the submission of
additional proofs.
__________________________________________________________________________________________________________
5. A careful examination of the additional proofs was the assignment given by the court to the
legal staff.
__________________________________________________________________________
1. According to our records, you worked for DRB Company for five years.
_________________________________________________________________________________________________________
41
2. This is to request your good office of the status of my temporary appointment.
__________________________________________________________________________________________
3. I am thanking you in advance for granting my request.
_________________________________________________________________
4. I would like to take this opportunity to thank you for sending me colorful pictures of your latest
invention.
____________________________________________________________________________________________________________
5. Hoping to receive a copy of the newly formed resolution in the near future.
______________________________________________________________________________________
II. Directions: Rephrase the following sentences by using active voice, non-sexist, simple, and easy
words.
Intervention
It has come to the Engineer’s knowledge that in order to purchase the machine needed for the
accomplishment of his project in the near future, he has to endeavor to obtain the consent of of the
Chairman of the board of Directors for the procurement of the mechanism. It is important , too, that
subsequent to the Chairman’s approval of his request, he has to secure the company treasurer’s nod
for the immediate release of the amount of one million pesos, the cost of the imported machine.
42
Probing questions:
1. Do you find the text easy to read or understand? Why? Why not?
References
4. google.com
43