Professional Documents
Culture Documents
UNDERSTANDING PURPOSE
Technical communication begins with identifying a problem and thinking about how to
solve it. Because of the variety of problems and solutions in the working world, people
communicate technical information for a number of purposes, many of which fall into
one of two categories:
Communication that helps others learn about a subject, carry out a task, or make a decision. For
instance, administrators with the Department of Health might hire a media production company
to make a video that explains to citizens how to use a website to manage their Medicare
benefits. The president of a manufacturing company might write an article in the company
newsletter to explain to employees why management decided to phase out production of one of
the company’s products. The board of directors of a community-service organization might
produce a grant proposal to submit to a philanthropic organization in hopes of being awarded a
grant. Figure 1.1 shows a screen capture from an online video that explains how to create a
facebook web page.
FIGURE 1.1 A Communication That Helps Others Carry Out a Task
The purpose of this online video is to help viewers carry out the task on how to
create their own web page.
Communication that reinforces or changes attitudes and motivates readers to take
action. A wind energy company might create a website with videos and text intended to
show that building wind turbines off the coast of a tourist destination would have many
benefits and few risks. A property owners’ association might create a website to make
the opposite argument: that the wind turbines would have few benefits but many risks.
In each of these two cases, the purpose of communicating the information is to
persuade people to accept a point of view and encourage them to act — perhaps to
contact their elected representatives and present their views about this public-policy
issue. Figure 1.2 shows an excerpt from a website that promotes the building of wind
turbines off the coast of Massachusetts.
FIGURE 1.2 A Communication That Aims to Change Attitudes
The purpose of this website, created by an energy development company, is
to generate public support for an offshore wind park.
UNDERSTANDING AUDIENCE
When you communicate in the workplace, you have not only a clear purpose — what
you want to achieve — but also a clearly defined audience — one or more people who
are going to read the document, attend the oral presentation, visit the website, or view
the video you produce. Sometimes audience members share the same purpose, but not
always. It’s possible, even likely, that a piece of technical communication will have
multiple audiences with different purposes.
In most of your previous academic writing, your audience has been your instructor, and
your purpose has been to show your instructor that you have mastered some body of
information or skill. Typically, you have not tried to create new knowledge or motivate
the reader to take a particular action — except to give you a “95” for that assignment.
By contrast, in technical communication, your audience will likely include peers and
supervisors in your company, as well as people outside your company. For example,
suppose you are a public-health scientist working for a federal agency. You and your
colleagues just completed a study showing that, for most adults, moderate exercise
provides as much health benefit as strenuous exercise. After participating in numerous
meetings with your colleagues and after drafting, critiquing, and revising many drafts,
you produce four different documents:
a journal article for other scientists
a press release to distribute to popular print and online publications
an infographic for use in doctors’ offices
an animated blog post for your agency to share on social media
In each of these documents, you present the key information in a different way to meet
the needs of particular audience.
The Challenges of Producing Technical Communication
One of the most challenging activities you will engage in as a professional is
communicating your ideas to audiences. Why? Because communication is a higher-
order skill that involves many complex factors.
The good news is that there are ways to think about these complex factors, to
think through them, that will help you communicate better. No matter what document
you produce or contribute to, you need to begin by considering five sets of factors.
AUDIENCE-RELATED FACTORS
What problem or problems is your audience trying to solve? Does your audience know
enough about your subject to understand a detailed discussion, or do you need to limit
the scope, the amount of technical detail, or the type of graphics you use? Does your
audience already have certain attitudes or expectations about your subject that you
wish to reinforce or change? Does your audience speak English well, or should you
present the information in more than one language? Does your audience share your
cultural assumptions about such matters as how to organize and interpret documents,
or do you need to adjust your writing approach to match a different set of
assumptions? Does your audience include people with disabilities (of vision, hearing,
movement, or cognitive ability) who have requirements you need to meet?
PURPOSE-RELATED FACTORS
Before you can write, you need to determine your purpose: what do you want your
audience to know or believe or do after having read your document? Do you have
multiple purposes? If so, is one more important than the others? Although much
technical communication is intended to help people perform tasks, such as configuring
privacy settings in a social-media environment, many organizations large and small
devote significant communication resources to the increasingly vital purpose of
branding: creating an image that helps customers distinguish the company from
competitors. Most companies now employ community specialists as technical
communicators to coordinate the organization’s day-to-day online presence and its
social-media campaigns. These specialists publicize new products and initiatives and
respond to questions and new developments. They also manage all of the
organization’s documents — from tweets to blog posts to Facebook fan pages and
company-sponsored discussion forums.
SETTING-RELATED FACTORS
What is the situation surrounding the problem you are trying to solve? Is there a lot at
stake in the situation, such as the budget for a project, or is your document a more
routine communication, such as technical notes for a software update? What is the
context in which your audience will use your document? Will the ways in which they use
it — or the physical or digital environment in which they use it — affect how you write?
Will the document be used in a socially or politically charged setting? Does the setting
include established norms of ethical behavior? Is the setting formal or informal?
Settings can have a great deal of influence over how audiences think about and use
technical communication.
DOCUMENT-RELATED FACTORS
What type of content will the document include? How will the content aid problem
solving? Does your subject dictate what kind of document (such as a report or a blog
post) you choose to write? Does your subject dictate what medium (print or digital) you
choose for your document? Do you need to provide audiences with content in more
than one medium? If you’re using a document template, how should you modify it for
your audiences and purposes? Does the application call for a particular writing style or
level of formality? (For the sake of convenience, we will use the word document
throughout this book to refer to all forms of technical communication, from written
documents to oral presentations and online forms, such as podcasts and wikis.)
PROCESS-RELATED FACTORS
What process will you use to produce the document? Is there an established process to
support the work, or do you need to create a new one? Do you have sufficient time for
planning tasks, such as analyzing your audience and purpose, choosing writing tools,
and researching and reading background information? Does your budget limit the
number of people you can enlist to help you or limit the size or shape of the document?
Does your schedule limit how much information you can include in the document? Does
your schedule limit the type or amount of document testing you can do? Will the
document require updating or maintenance?
Because all these factors interact in complicated ways, every technical document you
create involves a compromise. If you are writing a set of instructions for installing a
water heater and you want those instructions to be easily understood by people who
speak only Spanish, you will need more time and a bigger budget to have the document
translated, and it will be longer and thus a little bit harder to use, for both English and
Spanish speakers. You might need to save money by using smaller type, smaller pages,
and cheaper paper, and you might not be able to afford to print it in full color. In
technical communication, you do the best you can with your resources of time,
information, and money. The more carefully you think through your options, the better
able you will be to use your resources wisely and make a document that will get the job
done.
END of LESSON
Introduction to lesson 2
At the end of this lesson, you are expected to:
Identify the different types of technical writing;
Reflect on the given example of technical document;
Enumerate the qualities of technical communicator; and
Recognize the basic principles of good technical writing
INTRODUCTION
In the first week of your module, it was clearly discussed what technical communication
is. So, we will just have a recap of its definition. When we say technical writing, it is a
form of written communication – especially in engineering and other applied sciences in
– which scientific, business, and legal ideas, concepts, and data are presented in an
objective, accurate, and logical manner. Is it also defined as the practice of
documenting processes, such as software manuals or instructional materials. In short,
technical writing is a type of writing where the author is writing about a particular
subject that requires direction, instruction, or explanation. With the different definitions
of Technical Writing, we are going to discuss the Types of Writings in Technical
Professions
1.
a. Science and Medical Papers- Research results can be hard to explain, so scientists
collaborate with technical writers to interpret and organize findings. These papers act as
learning resources for practitioners to understand procedures and results. As with any
form of research, technical writers ensure that proper credibility is given in the text.
b. Professional Reports and Review- In addition to writing for scientists and doctors,
technical writers assist in creating reports for business growth and educational
institutions. Examples of professional reports include project and business status
reports, legal case reviews, and personnel activity reports.
2. End-User Documentation- Almost every product you purchase has a written explanation
of operation. These “how-to” pieces are written to help users understand and operate
products correctly. Since end-user documentation requires clear and concise instruction,
it’s important to create content that breaks down technological terms to layman’s
terms.
1.
a. User Help Guides- When software product users have questions that
needs specific answers, they turn to user help guides. These are written
to provide clear and sensible answers to common questions that may
develop as use of software programs continue. User help guides are
broken down into sections depending on the type of ‘help’ needed –
allowing users to read ahead or re-read information to make their
understanding of a product stronger.EXAMPLE:
b. Product Manuals- Product manuals are those small booklets that highlight a product’s
main features, general maintenance, and basic operation. It contains written guidelines
informing the audience how to use a certain product.
EXAMPLE:
c. Assembly Guidelines
- Since assembly guidelines tell users how to physically set up a product, technical
writers are responsible for writing clear and user-friendly, step-by-step instructions. It’s
important for these instructions to be written in a way that ensure users can accurately
assemble products.
EXAMPLE:
3. Technical Marketing Content
-Content marketing is a strategic marketing approach focused on creating and
distributing valuable, relevant, and consistent content to attract and retain a clearly
defined audience — and, ultimately, to drive profitable customer action. The primary
goal of marketing content, is to convince the reader to buy a product or service.
1.
1.
a. Brochures- Brochures take users to a deeper level of understanding and appeal through
clear descriptions, functions, and uses of a product. It is intended to provide customers
with additional information on corporate offerings, and are used by sales personnel to
persuade customers to purchase a product. The brochure – also called a data sheet,
product brief or solution brief – describes the main features of the product, any
specifications for its use and is usually accompanied by either a picture of the product
or an architectural design, illustrating the solution.
EXAMPLE:
1.
1.
1. Always bear in mind a specific reader, real or imaginary, when you are writing a report;
and always assume that he is intelligent but uninformed.
An awareness of who is going to read a user guide, the knowledge gap that the user
guide is filling and the delivery method of the guide all play important roles.
2. Before you start to write, always decide what the exact purpose of your report is; and
make sure that every paragraph, every sentence, every word makes a clear contribution
to that purpose and makes it at the right time.
Before beginning any writing task, the writer analyzes audience and identifies the
purpose for the document. The writer asks following questions about the audience:*
Who will read the document?* What are their biases?* What are technical writer’s
ethical responsibilities when communicating this to audience?
With regard to purpose, technical writers ask: what should this document accomplish?
What should it do? Should it:* Inform* Request* Instruct* Suggest* Order* Report*
Reply* Analyse/ critique* Compare
3. Use language that is simple, concrete, and familiar.
Different types of writing have different audiences, and each audience has its own
linguistic needs, which the writer respects with tone and word choice.
4. At the beginning and end of every section of your report, check your writing according
to this principle: First you tell the reader what you’re going to tell him, then you tell him
what you’ve told him.
5. Make your report attractive to look at.
1.
1.
1.
1. Use passive voice instead of active voice structures.
2. Use third-person point of view by using words like his/her, they, or the user, instead of
the personalized first person point of view like I, We, Me, Ours, and the like.
3. Downplay the subject or personal nature of the text by avoiding the use of emotive
words like dissatisfied, uninteresting, or undignified.
However, some experts with the modern view on technical writing argued that
adopting a modern view of technical writing means humanizing technical writing;
that is, feeling free to use personal pronouns to arouse the readers’ involvement
or interest in what they are reading.
PRACTICAL
Technical writing is practical if it results in a written output that you can apply,
use, or carry out in your day-to-day living. It does not mainly deal with scenarios or
situations that you can just imagine or ponder on, but also tackles up things you can
practice in your everyday life situations like designing, constructing, repairing, selling,
travelling, buying, bidding, inquiring, cooking, painting, and many others.
PROCEDURAL
Being a formal and scientific way of writing whereby rules or conventions
determine the appropriateness of your written output, technical writing adheres to a
particular course of writing acts. It presents facts and information in a systematic or
methodical manner. Here, you act like a scientist following a certain procedure or a
step-by-step method in proving your point about your subject matter. For instance, first
you have to identify and analyse your problem, collect data about it, and present your
conclusions, discoveries, or findings about the object of your study.
SPECIAL
Writing something to cater to a specific set of people rather than to any group of
people using expressions quite understandable and familiar only to this specific set of
readers, not to all kinds of people, is what makes technical writing special. Inclined to
be exclusive and selective of its topic, language, methodology, and readers, this kind of
writing is special, unique, or extra different from the other modes of writing.
DIVERSIONARY
Considering technical writing as on-the-job writing that is prone to extensive
exposure to multicultural clients, co-workers, cross-cultural or multilingual
communication brought about by globalization through the internet or the Email, you
come to think of this kind of writing as one that will lead you to various topic, ideas,
people, methodologies, concerns, purposes, formats, language, etc. It has some
aspects or features that are as diverse or varied as the different kinds of jobs available
to all kinds of people all over the world. Though (Perkins, 2008) argued that
intercultural communication is the “highest art and science of human communication,”
your technical writing acts must always be “sensitive to pitfalls” or hidden dangers
arising from diversities in a multi-cultural environment. (Canavor, 2010)
STRAIGHTFORWARD
A straightforward manner of writing means presenting knowledge or ideas
honestly and directly. Unlike these other ways of writing – literary and expository
writing that permit the writer to hide some meanings through figurative language –
technical writing brings out things in frank, unequivocal, or clear-cut way. Metaphorical,
idiomatic, or circuitous expression of ideas has no place in technical writing because
your immediate purpose as a technical writer is to persuade your readers to say “yes”
instantly to what you have written.
Hence, to realize this objective, the language of your written work has to be
direct, specific, and simple enough to make you and your readers come to terms with
you immediately. The use of complex, highfalutin or pretentious words demands longer
time for the reader to think or decide about the effectiveness of your offer. This
consequently hampers or delays the decision-making power of any person you want to
agree with what you have written.
AUTHORITATIVE
To describe technical writing as authoritative is to think of it as one clothed with
full rights, powers, and influence to do a thing, to command or be obeyed, or to enforce
something on any one. The authority or power that you technical writing may wield
over your reader springs form the fact that the contents of your output does not mainly
come from your our intelligence but also from other people’s expertise, knowledge, and
experience that could command respect or belief.
Proofs of the authoritativeness of your technical paper are the properly cited and
documented ideas of knowledgeable writers of technical writing books in your work,
specifically, the in-text citations, footnotes, and bibliographical entries in your paper.
Another proof is the reality that you are the creator of the paper, and, such as, you
have an idea of the extent of its excellence, and have the full control over the quality,
kind, or extent of ideas to go into your paper, including the way you react to inquiries
about your output.
PRESENTABLE
The physical appearance of a technical writing output somehow mirrors the
person who produced such kind of paper. A dirty-looking technical written work
diminishes its power, influence or authoritativeness. So, if you want your technical
paper to have a strong impact on the reader or to elicit an immediate and positive
response from him, see to it that your written work is free from any grammatical and
typographical errors. Present it nearly whether it is handwritten, typewritten, or
computerized.
The layout, order, or placement of the various parts of your work likewise makes
your work presentable. In addition, focusing your attention on these basic elements of
a written prosaic work; margin, spacing, punctuation marks, size/style of the letter, and
quality/size of the stationery or bond paper contributes a lot to making your entire
composition presentable or capable of getting serious and favourable attention from
your readers.
In view of these properties and principles of technical writing, the technical writer
should possess the following basic qualification:
Introduction
At the end of this module, you are expected to:
This module presents the different properties/characteristics of technical
communication. Each characteristic provides steps on how to achieve a good technical
work in a clear and understandable manner.
These properties or characteristics will surely help you to develop your technical writing
skills towards learning how to write different technical works such as business letters,
application letters, progress reports, among others.
With the goal of this course, that is, to teach you to write quality reports in the future.
Understanding the properties or characteristics of technical communication is really
important in comprehending on how these are used in technical world.
In order to come up with error-free written works, you have to demonstrate a strong
“attention-to-detail” skill. This skill refers to the ability to achieve accuracy and
thoroughness when accomplishing a certain task. For example, during your internship,
your supervisor assigned you to write a report but you submitted your work with a lot of
mistakes. Read and re-read your work before submitting so that your work will
completely devoid of errors. Check mistakes on spelling, grammar and punctuation.
BREVITY
In technical communication, technical papers must be short or brief. It also makes use
of concise expressions. A good technical writer should begin with his/her main points
and then show why it is sound. Emphasizing the highlights of your work, cutting out
irrelevant comments as well as immaterializing excursions and meaningless statements
are highly recommended and observed.
Brevity is considered as the striking feature of any written communication. This feature
can be achieved by avoiding wordiness and repetition; thus, writing enables you to
arrive quickly of what you want to convey in a clear and understandable manner.
Below listed are the ways on how to achieve brevity in writing.
a. Using key words to hold attention
Example: The Office of the Dean of the Student Affairs and Services is in close
proximity to the Good Shepherd Chapel.
Correct: The Office of the Dean of the Student Affairs and Services is near the Good
Shepherd Chapel.
List of lengthy phrases and their corrections:
Coherence also means as “clarity of expression.” Using simple transitions such as in
addition, additionally, furthermore, therefore, thus, on the contrary, by the same token,
at the same time, in other words, etc. is one of the strategies in ensuring coherence in
technical writing.
Other strategies are: 1) write sentences that flow by varying the lengths and structures,
the use of correct punctuation, and broadening your word choices; 2) Repeat your
keywords but be careful of excessive repetition; 3) Repeat sentence structures, which is
used as a rhetorical technique rather than cohesion to highlight parallelism between
sentences; and 4) Start every sentence or paragraph with information that hints at the
content of the next sentence
CONFIDENCE
As a writer or speaker, you have to display a sense of certainty of the things you write
and tell. You must not use “perhaps” and “maybe’s” and other forms of needless
hedging and qualifying since you know more about your subject. If you are hundred
sure, say it; if you are not, then go back and analyze where the problem lies and correct
it.
DIGNITY
In technical communication, as a writer or speaker, you need formality with respect to
words and the way words are used. It refers to the quality of being honored, esteemed
and worthy by using straightforward expression as well as with simplified, summarized
and well-organized information.
Grammatical constructions should be complete. Pronouns like “which” and “that” should
be used.
For example: The CHED Commissioner informs students that classes in higher
education institutions will commence on September 15, 2020 and not The CHED
Commissioner informs students classes in higher education institutions will commence
on September 15, 2020. Contractions like don’t, can’t, won’t, didn’t and others be
avoided.
EMPHASIS
Stressing major points is major role of a technical writer. You should tell your readers
what is important and lead him from point to point by using a straightforward style,
plenty of guideposts and transitional aids.
FACILITY
Facility is making the report easy to read. For facility, report writing should observe
pacing, sequence, arrangement and continuity.
GRAMMATICAL CORRECTNESS
In technical communication, grammatical correctness is a must. As a writer, you need
to make your writing straightforward, logical and clear. Following the basic rules of
grammar is equally important. Below is the technical writing guide of Michigan State
University (2007).
Parallel Structure
Parallel structure means using the same form for words that have the same level
of importance in a sentence or for a list of items that are joined by a coordinating
conjunction, such as “and” or “or.”
The scientist collected, dried, and weighed the samples.
When preparing bulleted or numbered lists use the same word type (i.e., all
nouns, all verbs) and maintain parallel structure. If the listed items complete the
introduction grammatically, place a period at the end of every line. Capitalize the first
word in a bulleted or numbered list.
Subjects and Verbs
It is important for text to flow smoothly. Subject and verb quality and agreement are
essential and allow the reader to move through the text. To ensure the reader
understands the intended meaning, abide by the following subject and verb rules and
use the correct verb tense.
Active and Passive Voice
Take responsibility by writing in active voice; use passive voice only when it is
appropriate for emphasis or when you lack information.
Active voice distinctly identifies the subject and the action taken by the subject. The
passive voice indicates that the subject receives, rather than performs, the action.
The sound’s reverberation struck the walls.
Passive voice changes the position of the previous subject into an indirect object and
focuses the sentence on what receives the action, the walls: The walls were struck by
the sound's reverberation.
When the active voice is appropriate, use it to create concise, energetic text. Only use
the passive voice when it is appropriate to say that an action is done to the subject.
The final project was finished by the team. (passive)
The team finished the final project. (active)
Cases of Pronouns
1. Nominative Pronouns: Used as a subject in the sentence (I, we, you, he, she, it, who,
and they): Mary and I will attend.
The guard who let us in checked our identification.
2. Objective Pronouns: Used as objects of verbs or prepositions (me, us, you, him, whom,
and them): He questioned Susan and me about the copyright. Whom did you ask?
3. Possessive Pronouns: Used to show possession or ownership (my, mine, our, your, his,
her, theirs, its, whose, etc.): The Swartz Company may lose its best customer.
Pronoun and Antecedent Agreement
1. A pronoun and its antecedent must agree in number. Examine the various constructions
of compound antecedents and the proper protocol in the examples below.
The owner is concerned about sales, but they will rebound.
The President or his advisers should devote part of their time to this issue.
3. If the antecedent is a collective noun that refers to a group as a single unit, a singular
pronoun is needed. Company names are generally considered to be collective nouns.
Stein & Smith has sold its Chicago properties.
4. For clarity, make pronoun usage clear and understandable by avoiding vague
references.
I worked hard on the experiment, and it was difficult.
Does the writer want us to consider the experiment as difficult, the work that was
done as difficult, or that it was difficult to work hard?
Compound Words
A compound word conveys a unit that is not as clearly conveyed by separate words.
2. Use a hyphen after the “e” to designate “electronic”: e-mail, e-commerce, e-article
3. Omit the hyphen when words appear in regular order and the omission of the hyphen
causes no confusion in sound or meaning.
Example: palm oil, eye opener, living costs
1. Capitalize the name of a particular person, place, or thing, as well as an adjective that
refers to a specific name.
Canada/Canadian, Tibetan Alpacas
2. Capitalize descriptive names that are substituted frequently for the real proper names.
the Windy City, Honest Abe 10
4. Generally capitalize a noun that is followed by a number or letter used to identify a unit
or division.
Lot 14, Tract 833, Volume III, Chapter 8, Policy No. 12345, Catalog No. 214.
5. Capitalize the names of courses of study only if they are derived from proper nouns.
English, shorthand, history, German, Business Mathematics 121
6. Unless a comma intervenes, capitalize titles that precede names; generally, do not
capitalize those that follow names.
I have never met Congressman Nelson.
I have never met our congressman, Tim Nelson.
Professor Swartz did the research.
8. The names for the points of the compass and their derivatives are capitalized when
used to name regions, but not when used to indicate directions.
This sweater was made in the East. Turn west on M-20.
9. Capitalize the name of a season or the word "nature" only if it is spoken of as if it were
human. Old Man Winter left a foot of snow; our spring suits are on sale.
10. All words except articles (a, an, the), conjunctions, and short prepositions are
capitalized in names or titles that consist of more than one word. Do not capitalize "the"
if it precedes the name of an organization but is not actually a part of that organization's
name.
Official Draft of the NBA; the Eastman Kodak Company
12. Readability studies have shown that text is more easily read when in lower case as
opposed to all caps. When too many words are capitalized, they lose their importance.
Emphasis is achieved more effectively by using various font styles and sizes.
Numbers as Words
2. Unless emphasizing them, spell out indefinite numbers that may be expressed in one or
two words. Approximately thirty appliances were damaged.
3. Spell out a number that introduces a sentence. If the number is long, recast the
sentence to avoid awkwardness. Twenty people attended the lecture.
4. Spell out common fractions that are used alone. However, use figures in writing a mixed
number. He refused to accept his one-fourth share. The hike was 10 ½ miles long.
5. When two numbers come together, express one in figures and the other in words. As a
rule, spell the first number unless the second number is a significantly shorter word; i.e.,
Sixty $5 bills or 500 four-page booklets.
6. When rounding numbers, spell out million or billion to make reading easier. This tax
legislation will increase revenue by $7 million.
Numbers – Text or Digits
2. Use the written form of a number for values 10 and below except to express market
quotations, dimensions, temperature, decimals, street numbers, pages and divisions of
a book, time, weights and measures, and identification numbers.
The experiment had three independent variables staged at 5, 10, and 15 degrees
Kelvin.
Introduction to lesson 4
Lesson 4: The Language of Technical Writing
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:
Shortening words/phrases
Wordy Phrases Shortened Forms
Afford and opportunity Permit
As soon as possible By 8:00 am
At the present time Now
By means of By
Despite the fact that Although
Due to the fact that Because
In the final analysis Finally
In the proximity Near
In the near future Soon
Advantageous Helpful
Alleviate Lessen
Commence Begin
Discontinue Stop
Fabricate Make
Modification Change
Numerous Many
Utilization Use
Avoiding nominalizations or the use of “camouflaged or shun words” (words ending in –
sion or –tion), replace them with active words
Nominalizations Active words
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…
Sentences in active voice stress the doer 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 this clearly recognizes the identity of
the person answerable for the act (Pearsall, 2010). According to Vanhauss (2005),
technical writing should be an “action-oriented style,” rather than be one with a great
deal of “hidden words.”
In addition, active voice should be used when it's important to emphasize the actor,
while passive should be used when it's more important to emphasize the action. Use
active when a particular action is required of someone or when the user/writer is
expected to complete a particular action; use passive when it's less important who or
what completed the action and more important that the action was completed.
Active voice example:
Here’s a short, active voice sentence:
The cat sat on the mat.
actor: The cat
verb: sat
target: the mat
Passive voice example:
By contrast, here's that same sentence in passive voice:
The mat was sat on by the cat.
target: The mat
passive verb: was sat
actor: the cat
3. Use non-sexist instead of sexist language by expressing yourself in the following ways:
a. Use plural pronouns instead of single pronoun
Do not say
Say:
Introduction to lesson 5
Lesson 5: Special Techniques of Technical Communication: Methods of definition
Learning Outcomes:
At the end of this module, you are expected to:
Methods of Definition
Lesson Proper :
WHAT ENTERS YOUR MIND THE MOMENT YOU HEAR THE WORD
DEFINITION?
What is definition?
1. It gives the reader a clearer and easier understanding of the concept or idea enough to
encourage him to read continuously till the end of the text.
2. It explains ideas or concepts behind various innovations, methods, and techniques in
the field of technology.
3. It lessens the gap between technologically expert or “high-tech’ people and “low-tech”
people.
4. It frees a person from any confusing, or wrong understanding of a term.
5. It helps a company member do his job more efficiently towards a certain goal.
6. It makes many technical written work readable to all kinds of audience of readers.
7.
Placement of Definition in the Text
If you are writing a sentence definition or an extended definition, you need to decide
where to put it. The location of definition in a Technical Report is based on the following:
1. The nature of the audience or the readers;
2. The length of the definition;
3. The purpose and lay out;
4. The agreed rules and practices in an area of discipline.
Where in your technical report should you specifically place your definition of terms? A
definition is typically placed in one of these six locations:
1.
1. In the text. The text is an appropriate place for sentence definitions that many or most
of your readers will need and for extended definitions of important terms.
2. In a marginal gloss. Sentence definitions placed in the margin are easy to see, and
they don’t interrupt readers who don’t need them.
3. In a hyperlink. In a web page, definitions can be put in a separate file and
displayed.
4. In a footnote. If definition is short, it should be put in the A footnote is a logical
place for an occasional sentence definition or extended definition. The reader who
doesn’t need it will ignore it. However, footnotes can slow readers down by interrupting
the flow of the discussion. If you think you will need more than one footnote for a
definition on every two to three pages, consider including a glossary.
5. In a glossary. A glossary — an alphabetized list of definitions — can accommodate
sentence definitions and extended definitions of fewer than three or four paragraphs in
one convenient location. A glossary can be placed at the beginning of a document (for
example, after the executive summary in a report) or at the end, preceding the
appendixes.
6. In an appendix. An appendix is appropriate for an extended definition of a page or
more, which would be cumbersome in a glossary or footnote.
Types of Definition
Your audience and purpose will also determine the length and formality of your
definitions. There are three basic types of definitions: parenthetical (Informal), one
sentence logical or Aristotelian (formal), and extended (Expanded or Amplified).
1. Informal Definition
A parenthetical definition is a brief clarification within an existing sentence. Sometimes,
a parenthetical definition is simply a word or phrase that is enclosed in parentheses or
commas or introduced by a colon or a dash. It is a sentence following another sentence.
This type of definition applies to general readers and it is also called a dictionary
definition because the meanings coming in the forms of individual words or phrases
written after the term look like list of words in the dictionary sequentially arranged
opposite in the target term.
In the following examples, the term being defined is shown in italics, and the definition is
underscored:
The computers were infected by a Trojan horse (a destructive program that appears to
be benign).
Before the metal is plated, it is immersed in the pickle: an acid bath that removes scales
and oxides from the surface.
Parenthetical definitions are not meant to be comprehensive; rather, they serve as quick
and convenient ways of introducing terms. But make sure your definition is clear. You
have gained nothing if readers don’t understand it:
Next, check for blight on the epicotyl, the stem portion above the cotyledons.
Readers who need a definition of epicotyl are unlikely to know the meaning of
cotyledons. To solve this problem, think carefully about your readers’ understanding of
your subject before including technical terms specific to that subject.
2. Formal Definition
A sentence definition — Aristotelian and a one-sentence logical definition — is more
formal than a parenthetical definition.
Defining a term in a formal manner requires you to:
2. Historical definition
Historical definition stresses the development of the term. Mentioned in this
definition are people, places, and dates that played significant roles in the
existence of the word.
3. Negation or elimination
A special kind of contrast is negation, sometimes called negative statement. Negation
clarifies a term by distinguishing it from a different term with which readers might
confuse it. The following example uses negation to distinguish the term ambulatory from
ambulance.
An ambulatory patient is not a patient who must be moved by ambulance. On the
contrary, an ambulatory patient is one who can walk without assistance from another
person.
Negation is rarely the only technique used in an extended definition; in fact, it is used
most often in a sentence or two at the start. Once you have explained what something
is not, you still have to explain what it is.
4. Operating principle
Describing the principle of operation — the way something works — is an effective way
to develop an extended definition, especially for an object or a process. It is arranged
based on their time of occurrence and uses connectors such as: first, second, then,
next, soon, previously, lastly, finally, afterwards, before, and so on.
5. Comparison-Contrast
Definition which makes you extend your explanation of a concept or a thing by
pointing out how such thing or concept is similar to or different from another
concept. Using comparison and contrast, a writer discusses the similarities or
differences between the item being defined and an item with which readers are
more familiar.
The following definition of VoIP (Voice over Internet Protocol) contrasts this new
form of phone service to the form we all know
Voice over Internet Protocol is a form of phone service that lets you connect to
the Internet through your cable or DSL modem. VoIP service uses a device
called a telephony adapter, which attaches to the broadband modem,
transforming phone pulses into IP packets sent over the Internet.
VoIP is considerably cheaper than traditional phone service: for as little as $20
per month, users get unlimited local and domestic long-distance service. For
international calls, VoIP service is only about three cents per minute, about a
third the rate of traditional phone service. In addition, any calls from one person
to another person with the same VoIP service provider are free.
However, sound quality on VoIP cannot match that of a traditional land-based
phone. On a good day, the sound is fine on VoIP, but frequent users comment on
clipping and dropouts that can last up to a second. In addition, sometimes the
sound has the distant, tinny quality of some of today’s cell phones.
In this excerpt, the second and third paragraphs briefly compare VoIP and
traditional phone service. Notice that this passage is organized according to the
part-by-part comparison-and-contrast pattern.
6. Analysis by Partitioning
Partitioning is the process of dividing a thing or an idea into smaller parts so that
readers can understand it more easily. The photo below uses partition to define the
components of a roof.
7. Use of examples
Examples are particularly useful in making an abstract or difficult-to-explain term easier
to understand. The paragraph-length definition enumerates the many uses of one
concept in a particular context of life.
8.Explication
The second, third or the succeeding sentences operate to give the meaning of some
difficult expressions used in the previous sentences. Its function is to unlock difficult
words to understand in the sentence.
9.Operational definition
This definition means you explain the indispensable function or use of the thing in the
process, project or activity. This gives the emphasis to the role or use of the thing in a
particular activity.
10. Stipulative definition
It is a way to extend the definition of a term by explaining the word based on a special
condition, a particular purpose, a requirement or a limitation affecting any agreement
between or among people. It assigns meaning to a word, sometimes without regard for
common usage. This term is often used in a pejorative sense to refer to a definition that
appears to be deliberately misleading. Stipulative definitions are also known as Humpty-
Dumpty words or legislative definitions.
A Sample Extended Definition
The figure below is an example of an extended definition addressed to a general
audience.
*** END of LESSON 5***
WEEK 6 LEARNING RESOURCES
Continue
INTRODUCTION
Lesson 6: Description of a Process and Mechanism
1. Description of a Process
Topic: 2. Description of a
Mechanism
DESCRIPTION OF A PROCESS
Process description includes sequence, instructions and procedure. Process is a
description of materials, equipment and procedures. It also uses graphic materials to
show detailed presentation of a process. Technical writers also use sequence markers
such as first, second, then, next, subsequently, finally and at last to link sentences and
to follow the natural or mechanical system.
There are four Types of a Process, these are: 1) How it operates or how it works
process, 2) How to do it process, 3) How it happens process, and 4) How it is organized
process. In the first type of process, this process description focuses on the way things
function or operate. The second type of process gives emphasis on how you do a thing
or perform. This process type occurs in giving directions or instructions.
The third process type stresses the process itself. Some call this type as Process
Analysis. Processes that you can subject to process analysis are food digestion,
earthquakes, water cycle communication process, among others. The fourth type of
process also happens when you write or talk about the way an organization or a schools
assign its faculty to a certain rank or position.
In adapting the description, it is important to consider the needs of the readers. The
writer should avoid many details and emphasize the broad outlines of the process if the
reader is interested only in acquiring a general knowledge of the principles involves and
has no intention to perform the process. A process description is organized as follows:
THE INTRODUCTION
The introduction of the description of a process is a comprehensive answer to
the question, “What are you doing?” An answer to the question can be given by
answering still other questions, principally the following:
DESCRIPTION OF EQUIPMENT AND MATERIALS
With the possible exception of the discussion of equipment and materials, the
introduction to a description is followed directly by a description of the chief steps in the
process. Two problems appear in organizing the description of the chief steps. One is
how to organize the steps; the other is how to organize the material within each
individual step. The organization of the steps can be dismissed at once for it is
chronological in order. The organization within the description of the individual steps
requires more discussion because each individual step constitutes a process in itself.
The individual step should be introduced properly and must be divided into sub-steps.
Its description is essentially a miniature of the description of the process as a whole.
DESCRIPTION OF THE ACTION
In describing the action, the writer must say everything the readers need to know
and understand or even to visualize the process. The omission of a slight detail may be
enough to spoil everything. Care should be taken not only in connection with the details
of what is done but also of how it is done. The content of the description of a process is
governed by the reader’s need to comprehend every step in the action.
STYLE OF USING SENTENCES IN EXPLAINING A PROCESS
A discussion in style in the description of a mechanism however would focus on
the problem of choice of the mood and voice of the predicate, and of the noun or
pronoun used as a subject. A good many possibilities exist, but three are of special
importance: the active voice and indicative mood, the passive voice and indicative
mood, and the active voice and imperative mood. See examples below.
CONCLUSION
The last part of the description of the process is naturally the conclusion. It is not always
necessary to write a formal conclusion. Whether one is desirable depends, of course,
on whether it will help the reader. Sometimes the reader needs help in matters like the
following:
1. Fixing the chief steps in mind (listing them again might help)
2. Recalling special points about equipment or materials
3. Analyzing the advantages and disadvantages of the process.
4. Noting how this process is related to the other processes, or other work that is being
done, or reported on.
DESCRIPTION OF A MECHANISM
GUIDELINES FOR TECHNICAL DESCRIPTION
SAMPLE MECHANISM DESCRIPTIONS
An electric generator is an apparatus for converting mechanical energy into electricity. It
is also called Dynamo and as such, it produces gas or steam. Derived from the Latin
term “generate or generates,” it means to beget or produce. As a source of electricity, it
is used for factory machines, lighting and home appliances. It functions either as direct
current (DC) producing electric current flowing in one direction, or alternating current
(AC) producing electric current that reverses direction periodically. It comes in different
sizes. A small generator is used in some scientific inventions while the large one is for
supplying electricity to the entire city.
-
Engineering and Technology
Babcock, D.
and Morse, L.
The ATM effectively consists of three layers: PHY, ATM and AAL. The first layer, PHY,
is concerned with the physical transmission of data and depends on the medium being
used. There is a different set of standards for each medium. The ATM layer is
concerned with maintaining the cells and their routing through the switching network.
The ATM adaptive layer (AAL) provides standards for the segmentation and
reassembling of data into the cells and vice versa. This is also the layer that is
concerned with the quality of service
-Computers
Long, L.
and Long, N.
1. does your budget limit the number of people you can enlist to help you or
limit the size or shape of the document? Falls under which factors in
technical communication – PROCESS-RELATED FACTOR
2. technical communication encompasses ACTIVITIES that people do to
discover shape, and transmit information
3. a wind energy company might create a website with videos and text
intended to show that building wind turbines off the coast of a tourist
destination would have many benefits and few risks. A property owner’s
association might create a website to make the opposite argument, that
the wind turbines would have few benefits but many risks. This scenario
falls under which category in purpose of technical communication?
COMMUNICATION THAT MOTIVATES READERS TO TAKE ACTION
4. which of the following relates to setting-related factors in technical
communication? WHAT IS THE CONTEXT IN WHICH YOUR AUDIENCE
WILL USE YOUR DOCUMENT?
5. To have zest in technical writing means to view things POSITIVELY
6. In technical writing, improving your communication skills means being
excellent ALL FOUR COMMUNICATION SKILLS
7. In technical writing, forum is required for selling introducing
products/services, using six-to-eight panel foldouts, known as
BROCHURES
8. Trusting in the effectiveness of your report is giving your work the quality
of OBJECTIVENESS
9. if you are writing a set of instructions for installing a water heater and you
want those instruction to be easily understood by people who speak only
Spanish, you will need more time and bigger budget to have document
translated and it will be longer and thus a little bit harder to use, for both
English and Spanish speakers. This is an example of COMPROMISE
10. letting your readers study various graphs or illustrations in your technical
report encourages readers to think INTERPRETATIVELY
11. a well-written technical report or business letter functions to AVOID
INQUIRES
12. Your schedule can limit the type or amount of document testing you can
do is an example of PROCESS-RELATES FACTORS
13. Which of the following is to be constructed when we speak of audience-
related factor in technical communication? DOES YOUR AUDIENCE
SPEAK ENGLISH WELL, OR SHOULD YOU PRESENT THE
INFORMATION IN MORE THAN ONE LANGUAGE
14. Which of the following pertains setting-related factors in technical
communication? BUDGET FOR A PROJECT
15. Which of the following technical wiring theorem is crucial for technical
writing? ALL OF THE CHOICES GIVEN (WRITING SHORT SENTENCE,
CREATING A LOGICAL FLOW, USING PLAN AND SHORT WORDS)
16. WHICH of the following is the definition of journal article? IT PRESENTS
THE MOST RECENT RESEARCH, WRITTEN BY EXPERTS, FOR
EXPORTER MAY BE PUBLISHED IN PRINT OR ONLINE FORMATS,
OR BOTH.
17. Most companies row employ community specialists as technical
communicators to coordinate the organization’s day-to-day online
presence and its social-media campaigns. Which technical communication
factors is described in the statement? PURPOSE-RELATED FACTOR
18. What does chronology refers to? INFORMATION ABOUT THE
RELEVANT SUBJECT
19. The president of a manufacturing company might write an article in the
company newsletter to explain to employees why management decided to
phase out production of one of the company’s products. This scenario falls
under which category in purpose of technical communication?
COMMUNICATION TO HELP OTHER LEARN ABOUT A SUBJECT
20. This term is defined as creating an image that helps customers distinguish
the company from competitors. BRANDING
21. Writing and reading tweets and text messages or participating in webinars
are examples of which one component of technical communication?
PROCESS
22. What writing style is usually used in reports? OBJECTIVE AND
DETACHED
23. The following has to be considered in document-related factors except for
one. WHAT PROBLEM IS YOUR AUDIENCE TRYING TO SOLVE?
24. Technical communication is written in the work environment, for
supervisors, colleagues, and subordinates, which among the following is a
characteristic of a technical documents? QUANTIFIABLE
25. A document that consists of instruction on how to use or troubleshoot
products is known as a HELP GUIDE
26. Choose the correct, clear and concise statement.
NOW THAT WE ARE IN HEALTH CRISIS, WE NEED TO BE AWARE
OF OUR SAFETY
27. Choose the correct, clear and concise statement.
THE SCHEDULE OF THE MIDTERM EXAMINATION HAS BEEN
MOVED.
28. Choose the correct, clear and concise statement.
BECAUSE I WAS NOT HERE YESTERDAY, I CANNOT PRESENT YOU
MY REPORT TODAY.
29. Choose the correct, clear and concise statement.
BASED ON OUR EXPERIENCE, DATA GATHERING IS THE MOST
DIFFICULT PART OF CONDUCTING A RESEARCH STUDY.
30. Choose the correct, clear and concise statement.
OUR CLASS CHAIRPERSON WILL BE RUNNING FOR GOVERNOR
THIS INCOMING DEPARTMENTAL ELECTION.
31. Choose the correct, clear and concise statement.
I WANT TO THANK YOU FOR YOUR TIME IN PROCESSING MY
ENROLMENT DOCUMENTS.
32. Choose the correct, clear and concise statement.
MY THREE-MONTH INTERSHIP HAS PROVIDED ME WAYS ON HOW
TO DEVELOP PROFESSIONALISM.
33. Choose the correct, clear and concise statement.
WE ARE GOING TO EMAIL THE DOCUMENT TOMORROW.
34. Choose the correct, clear and concise statement.
THE UNIVERSITY PRESIDENT PRESIDED OVER THE BOARD
MEETING.
35. Choose the correct, clear and concise statement.
ACCORDING TO THE ADVISORY, OUR ONLINE LEARNING IS
SUSPENDED TOMORROW BECAUSE IT IS A HOLIDAY.
36. Choose the correct, clear and concise statement.
I AM HAPPY TO INFORM YOU THAT YOU ARE PART OF THE
COMPANY.