TWB Reviewer
TWB Reviewer
subjects and about various technical subjects message. This is especially useful for busy people
associated with the sciences. who need to make quick decisions and act on the
Technical writing is characterized by certain circumstance or situation.
formal elements, such as its scientific and technical
vocabulary, its use of graphic aids, and its use of Memorandum - inter-office written communication
conventional report forms. used to disseminate information.
Technical writing is ideally characterized by the
maintenance of an attitude of impartiality and BUSINESS PROPOSAL TEMPLATE
objectivity, by extreme care to convey information
accurately and concisely, and by the absence of Title Page
any attempt to arouse. Executive Summary
Technical writing is writing in which there is Company Overview
relatively high concentration of certain complex and Products and Services Offerings
important writing techniques, in particular Competitive and Market Analysis
description of mechanisms description of process, Sales and Marketing Plan
definition, classification, and interpretation. Ownership Structure and Management Plan
Operating Plan
PRODUCTS OF TECHNICAL WRITING Financial Plan
Appendix
Business letter - is a type of written
communication. It is written using formal language Important principles in good technical writing
and follows formal elements of letter writing. People (ENUMERATION)
usually write business letters to communicate with 1. Always have in mind a specific reader, real or
companies, organizations or individuals with the imaginary, when you are writing a report. Always
purpose of applying for a job, making requests, assume that he is intelligent but uninformed.
seeking appointments, etc.
2. Before you start to write, always decide what the
Contract - is a written agreement between two exact purpose of your report is, and make sure that
people under mutually agreed term. every paragraph, every sentence, every word
makes a clear contribution to that purpose.
Monograph - is a detailed essay or book on a very
specific topic. It is usually written by professionals 3. Use language that is simple, concrete, and
or academicians on topics of interest concerning familiar.
their specific fields.
4. At the beginning and end of every section of your
Proposal - are written suggestions on how to make report, check your writing according to this
the company or organization more productive and principle: "First you tell the reader what you're
successful. Most companies and organizations going to tell him, then you tell him what you’ve told
require this before an agreement is reached. him”.
Brochures - are pamphlets or flyers that endorse a 5. Make your report attractive.
product in such a way that the potential customer
will be convinced that the product is effective and Purpose of technical writing
eventually avail of the product. 1. It serves as basis for management decision
2. It furnishes needed information.
Instructional manuals – are written to guide the 3. It gives instructions
readers on how to assemble, maintain, and operate 4. It records business transactions through
an apparatus, machine or gadget. proposals.
5. It procures business proposals
Printed action memo - Printed action memo is a 6. It serves as basis for public relations
ready-format memorandum that only requires a 7. It provides report to stockholders of companies
Properties of technical writing Persuasive writing - depends on emotional
appeal. Its goal is to change one's attitudes or
The following properties of technical writing are motivate him/her to action.
also known as "considerations" when writing
technical reports. Expressive writing - is a subjective response to a
personal experience--journals and diaries--whereas
Subject Matter - In writing technical papers, you technical writing might be objective observations of
must ask the question, "What will I write about? The a work-related experience or research.
subject matter is an essential element in technical
report writing. Some examples of this are Technical writing vs. Creative
description of a process, writing about a theory, or TECHNICAL CREATIVE
submitting a policy Content Factual, Imaginative,
straightforward metaphoric or
Audience - When thinking about the audience, ask symbolic
"Whom am I writing for? Or who are my intended Audience specific general
readers?” This is a property which pertains to a Purpose Inform, instruct, Entertain,
particular reader of a technical literature. persuade provoke,
captivate
Style Formal, standard, Informal,
Expression - This property refers to two basic
academic artistic,
modes in which a technical report has to be
figurative
delivered-writing it or reading it. Your expression of
Tone objective subjective
the content will depend on your awareness of your Vocabulary specialized General,
audience’s/ reader's psychology and your style in evocative
writing to be able to reach your audience's/reader's organization Sequential, Arbitrary,
understanding. systematic artistic
Style - This refers to how the material is written. A Qualities of a good report (TRUE OR FALSE)
technical writer uses clear, specific point of view,
objective, impartial, and unemotional style in writing 1. A good technical report is available on the date
objective. that it is due.
2. Creates a good impression if it is picked up and
Arrangement of Materials - Arrangement of read through.
materials. This pertains to how ideas should be 3. Has the important preliminaries to identify the
organized in chronological, spatial or logical order, report and disclose its purpose and scope.
from general to specific or specific to general, and 4. Has a body that provides the necessary
use illustrations to present the information. information and that is written clearly without jargon
or padding.
Basic types of writing (ENUMERATION) 5. Has a summary or conclusions that reveal the
results obtained.
Technical writing - conveys specific information 6. Is so designed that it can be read and
about a technical subject to a specific audience for understood selectively: for instance, by some
a specific purpose. users, only the abstract, by other users, only the
Creative writing - fiction--poetry, short stories and introduction and conclusions and by still other users
novels--and far different from technical writing. the entire report.
7. Has a rational and readily discernible plan which
Expository writing - "exposes" a topic analytically is revealed in the table of contents and a series of
and objectively, such as news reports. Like headings throughout the report.
technical writing, the goal of expository writing is to 8. Reads coherently and cumulatively from
explain or reveal knowledge, but expository writing beginning to end.
does not necessarily expect a response or action 9. Answers reader’s questions as these questions
from the reader. arise in their minds.
10. Conveys an overall impression of authority,
thoroughness, soundness and honest work.
LESSON 2
Summary
CHARACTERISTICS OF A BUSINESS LETTER
1. Consistency- being the same in behavior or
Clear and Concise - To achieve clarity, a letter performance
must be able to convey relevant information by 2. Credibility - being trusted and believed in
answering what, who, when, why, and how, or any 3. Coherence - logical and consistent, making
combination of these using the least number of ideas or arguments easy to understand.
words. Conciseness, on the other hand, is the 4. Conciseness - brief and to the point, without
expression of ideas in the fewest possible words unnecessary details
without sacrificing its meaning. In order to be sure 5. Clarity - clear and easy to understand
that a letter is clear, you should be able to have 6. Completeness - containing all necessary parts
clear ideas first written in an outline form so that not or information
any single important detail will be missed. An 7. Correctness - being free from errors or mistakes
effective letter contains only the relevant idea and 8. Consideration- showing thoughtfulness and
wastes no words by using trite expressions and respect.
jargons 9. Courteousness - being polite and respectful
10. Concreteness – specific and detailed rather
Correct and Complete - All important information than abstract.
should be included and should be written correctly.
Correctness here refers to the choice of the THE COMMUNICATION PROCESS
stationery, format of the letter, grammar, (IDENTIFICATION)
punctuation marks, spelling and others while
completeness refers to the inclusion of all pertinent Sender: This is the person that is delivering a
data regarding the subject matter. message to a recipient.
Courteous and considerate - Courtesy, according Message: This refers to the information that the
to Romero, et al. (1997), is recognizing and having sender is relaying to the receiver.
respect for the value and worth of other people by
being considerate, friendly, and willing to serve. Channel of communication: This is the
Use polite language. Avoid words with negative transmission or method of delivering the message.
connotations implying annoyance, exasperation,
denial, ill temper or unhappy or unpleasant Decoding: This is the interpretation of the
situations, or statements which accuse, belittle or message. Decoding is performed by the receiver.
unnerve people.
Receiver: The receiver is the person who is getting
Concreteness and coherence - Concrete words or receiving the message.
are words that create in the mind of the reader a
picture of what really, they are by the use of specific Feedback: In some instances, the receiver might
words. To achieve this characteristic, choose words have feedback or a response for the sender. This
that show exactly what you mean. Avoid using starts an interaction.
abstract words which refer to concepts or
generalities; instead, focus on words you can see, SENDER
touch, smell, and feel. Be specific with your words. FEEDBACK
ENCODING
MESSAGE
Consistency & Credibility – Since your letter CHANNEL NOISE
reveals your confidence, sensitivity, language RECEIVER
knowledge, breeding and reasoning, be consistent DECODING
and credible. Do not copy from model forms
instead, try to develop your own individuality.
and effect, classification, example, and other
rhetorical functions.
There are situations when an extended
WRITING STRATEGIES TO EFFECTIVELY definition is needed in order to ensure the reader's
COMMUNICATE understanding of the term or idea.
The one-sentence formal definition usually
Read serves as a topic sentence for a more extensive
Target your audience explanation of the subject.
Use an outline
Open Strong Ex. The simplest form of drift meter consists of a
Answer the 5 Ws and H circular plate of heavy glass set in the floor of the
Be simple and direct cockpit in front of the pilot. The plate maybe rotated
Use strong verbs within a ring on which degrees of angle are marked
Limit adjectives & adverbs to the left and right of a zero mark. This zero point
Consider the 3 appeals is in the direction of the forward end of the
Revise, edit, & proofread longitudinal axis of the plane. The plate has a
series of parallel lines ruled on it. With the plane in
LESSON 3: EXPOSITORY TECHNIQUES level flight, the pilot can look down through the
plate and rotate it until objects on the ground are
Exposition is a writing technique used by a writer moving parallel to the lines. Under these conditions,
when his/her intention is to explain something, to the lines on the plate will be in the direction of the
analyze an idea, to classify a thing, to give the track being made good, and the angle between the
correct definition of a term, to make others follow heading and this track may be immediately read on
directions, to point out similarities or differences, to the scale.
clarify causes and effects, to present data, to
interpret research work, and others. 2. Description of Mechanism - Description of a
mechanism is an explanation of a system or parts
1. Definition - When we define unfamiliar terms, of an apparatus. This includes the characteristics
we give concise but exact meanings and special and functions of a piece of the device and the
meanings of familiar words. For people of all ages, totality of the mechanism.
definition is a useful technique in oral and written It also explains the arrangement and shape
communication. It is particularly a must for a of an object in space. The three fundamental
technical writer to be able to define the terms with divisions of the description are the introduction, part
multiple meanings and those that are unfamiliar to by part description, and the conclusion.
the reader. Reinforcing the textual explanation with
pictures and photographs showing the physical
Methods of defining terms appearance of the mechanism would make the
technical description more concrete.
1. Simple definition / Formal definition - A simple
definition could be formulated by bearing in mind its 3. Description of a Process - In describing a
three parts: the term/species, genus, and process, a writer explains the arrangement of a
differentia. This method of definition is commonly sequence in chronological order. As it is used in
used in technical writing. technical writing, the process is akin to mechanism
description. Here, process description includes
Ex. A drift meter is an instrument used in air sequence, instructions, and procedure.
navigation to measure the angle between the When we describe a process or procedure,
heading of a plane and the track. we often use the present passive tense: is/are + v +
ed. For example: is manufactured, is controlled,
2. Expanded definition / Informal Definition - To etc. Also, use sequence markers to link sentences
make sure the technical writer is understood, he like first, second, then, next, subsequently, finally, at
extends a definition beyond a single sentence. This last.
is done by stipulation, operation, explication, cause
But this is different from instructions
because it only gives description and not tells the ETHICS - consists of the individual standards of
readers to do something. behavior you exhibit in your personal and
professional lives. It establishes the levels of
honesty, empathy, trustworthiness, and other
Classification - Classification is dividing something virtues that identify your personal behavior and
into groups, classes, categories, etc. This is your public reputation.
normally done in accordance with several criteria
(standards or principles on which judgments are ETHICAL CONSIDERATIONS:
based). • Responsibility
Classification is done by the writer when • Integrity
he/she believes that there are shared qualities or • Trust
characteristics about a subject matter. • Transparency
• Justice
The effectiveness of classification depends • Equity
upon the following principles: • Regulations
• Citations
1.Classify consistently on a single basis which
points to the fundamental distinction among the Professional Ethics - guides the conduct by which
members of the class. Make clear what is being technical writers abide by laws, regulations, and
classified by defining the subject or asking the policies. Professional ethics means respecting the
reader to be familiar with the topic to be classified. rights of stakeholders and the communities in which
they live. Professional ethics centers on principles
2.The basis of classification should further the of good conduct through civil, social, economic,
purpose controlling it. Choose and use a simple environmental, and lawful actions.
basis of classification. Your basis will determine the
classes to be discussed. Librarians for instance, Approaches for examining ethical nature
classify books by subjects, not color or size. 1. Integrity- is unity between what we say and
Engines may be classified according to the maker, what we do. Being a professional of integrity means
to its use, to its speed or to the number of cylinders consistently striving to be the best person you can
each one has. be in all your interactions with others. It means you
practice what you do based upon reasoning, laws,
3.Classification should not overlap. Be sure that morality, and justice. Approaches for examining
each specie is distinct and separate form all the ethical nature Although ethics are an individual
others. Classify reports according to their style, choice, in the professional world, ethical choices by
formal and informal or according to frequency of employees often define the success of an
issue, monthly, quarterly, semi-annually, and organization. Some professions, such as
annually. The classification must be mutually engineering, journalism, and medicine have
exclusive. This is clearly necessary for the main traditional codes of ethics. Essentially, a code of
purpose of the classification is to list the individual ethics is a commitment to treat with honesty and
member of a group or class. integrity customers, clients, employees, and others
affiliated with a profession. The Hippocratic Oath,
4.Make your classification reasonably complete. for example, is embraced by most professionals in
Name all species according to a given basis. health care today as an appropriate standard
Complete classification means presenting every always owed to patients by physicians, nurses, and
known specie. others in the field. This obligation traces its
etymology to ancient Greece and the physician
5.Introduce sub-classes as needed. Make sure that Hippocrates.
in a subclassification, you discuss characteristics
peculiar to one classification only. 2. Social Responsibility- represents the interaction
and collaboration with stakeholders to reflect the
LESSON 4: Laws & Ethical Considerations
concerns of communities which an organization Copyright- includes items whose distribution is
serves. protected by law (books, movies, or software). The
• Practices that are inclusive and diverse copyright symbol is shown with a ©. Copyright is
• Activities that help local communities and different from plagiarism in that it is a legal issue.
stakeholders Only the copyright holder, the person/organization
who owns the protected item, can copy it.
Legal and ethical compliance call for Copyright Law – covers the protection of the rights
different standards of behavior. What is legal isn't of the author. In general, it is wrong to use written
always ethical. The purpose of a law is to establish material, printed material, software, or photographs
and maintain a functioning society. Compliance with without expressed permission.
these legal standards is strictly mandatory: If we
violate these standards, we are subject to Trademark Law – The author explains that
punishment. Therefore, compliance in terms of registered trademarks should only be used with
professional ethics generally refers to the extent by proper icons (usually ©, or ®) and should always be
which an organization conducts its operations in used as adjectives instead of nouns.
accordance with applicable regulations, statutes,
and laws. Contract Law – covers written warranties or their
implied warranties. The author states that contracts
Aristotle’s concept of Phronesis are about agreements between two parties. The
important part of the agreement is often the
Phrónēsis is a type of practical wisdom that warranty of a product or service. That warranty may
enables us to act virtuously. The concept of be implied or express.
practical wisdom dates back to Aristotle, who
considered phronesis, which can also be defined as Liability Law – pertains to responsibilities or
prudence, to be a key intellectual virtue. Phronesis obligations of writers who claims they made on their
enables people to make ethically sound judgments. paper. This branch of law leads to the
documentation often found in packages that tells us
Plagiarizing- is misrepresenting the source or not to use products for any purpose not intended by
facts, most commonly when you claim the ideas the manufacturer.
you are writing about are yours.
Do’s
Attribution- refers to acknowledging and • Abide by relevant laws.
recognizing the source of information used in • Abide by the appropriate corporate or professional
writing, ideas, concepts, and creations. Depending code of conduct.
on the creation, the attribution is valid in various • Tell the truth.
forms. • Be clear.
• Avoid discriminatory language.
Patents and trademarks- are company names, • Acknowledge assistance from others
logos, processes or slogans that belong to a person
or company. None of these things can be used Don’t’s
without proper recognition of or approval from the • False Implications - assuming the outcome of a
appropriate company or individual involved. A project or making sweeping generalizations.
company uses a to show something is trademarked • Exaggerations expressing situations in extreme
or an ® for something registered with the U.S proportions.
Patent and Trademark Office. An example would be • Euphemisms - writing about situations in
Nike and their famous swoosh symbol. seemingly good conditions even though they are
not.
• Don't mislead your readers. general interest. This is like the magazine article we
read on regular days.
Ethical Infractions in Professional Writing
2. Laboratory Report - Is a comprehensive report
An ethical infraction is a decision that results in an written to communicate laboratory works and
ethical and moral breach. In business, the following observations to the management. It also focuses on
breaches pertain to business writing and the question, “How did we do it?”
communication.
Confidentiality does not mean that employees The following are the common parts of a
should not reveal a company’s unethical behavior. laboratory report:
Whistle Blower laws are in place to assist workers
who report unethical business behavior. a. Abstract. This part shows the outline of the
entire experiment.
The Ethical Sin of Commission and Omission
b. Introduction. This part presents the objectives
Sin of Commission - refer to unethical actions that and importance of the experiment. Sometimes, the
include manipulating or changing information to background of the report often includes theoretical
benefit a person or business a person represents. predictions for what the results should be.
To avoid using misleading or manipulating words
and phrases, it is important to be open to c. Procedures. This part is sometimes called
alternative viewpoints; conduct an audience methods or steps for it presents the step-by-step
analysis. methods on how the experiment is done.
Sin of Omission - refer to withholding or using d. Results and Discussion. This part presents the
inaccurate information in order to benefit a person discussion of the experiment as well as the results
or company a person represents. Do not use false which are composed of tables and figures.
or skewed facts or argue from such premises
because you may deceive the reader(s) and cause e. References. This part includes the sources and
them to make an uninformed decision. references used in conducting the experiment.
LESSON 5: Classification of Technical Reports f. Conclusions. This part summarizes the results of
the experiment.
In the workplace, the report plays an
important role, whether you are preparing one for i. Appendices. This part is composed of raw data,
your supervisor, the executive staff, board of calculations, graphs, figures, pictures,
directors, or clients. communication and so on that you have not
It may be short and simple, in the form of a included in the report itself.
memorandum or email, or it may be more several
pages long. 3. Information Report - The main function of this
Whatever its length, content, or destination, report is based from the title itself, to inform. This
the end result is the same: a report must be report includes periodic and annual report.
informative, factual, understandable, and neatly
presented. a. Periodic Report - Is a type of information report
Business report is broad in scope and written by the employees or subordinates which
covers numerous written documents necessary in they submit daily, weekly or monthly to their
doing business such as incident report, superiors to note information of interest to the
accomplishment report, recommendation report, organization to show comparison and tendencies.
financial report, and so on.
b. Annual Report - Is a type of information report
1. Article Report - It is a simple report which aims which includes the listing of activities, projects, and
to inform the masses. This report focuses on any events of an organization during whole year round
to show progress, financial status, and general f. Theory, Methods, Procedures. These tell the
state of affairs. This can be classified as public or reader how the report writer conducted the
private. research. These include the processes involved in
the completion of the report.
4. Special Information Report - Is composed of
three subcategories which are preliminary report, g. Results, Findings, and Data. These present the
progress report, and final report. outcome of the research with the use of tables,
figures, and charts. The tables, figures, and charts
a. Preliminary Report - Is a type of special are interpreted and explained by the researcher.
information report that collects information about a
proposed project which includes the costing, h. Discussion, Conclusions, and
designs, and other elements. Recommendations. This includes the conclusions
based from the findings and the recommendations
b. Progress Report - Is a type of special are in turn based on the conclusions.
information report that records the history of an
activity from the time it has started up to the i. Bibliography. This is the list of all the sources
present date of writing. and references used by the report writer in
accomplishing the research report.
c. Final Report - Is a type of special information
report that report submitted after completing a The general format of a research report
project to show how plans were delivered. commonly includes the following:
7. Recommendation Report - Is written to answer There are more common types of reports
questions which are somehow critical to decide on. such as feasibility reports, inventory reports, staff
It shows options or choices so that a good decision utilization reports, travel reports, study reports,
can be drafted. justification reports, and so on.
The following elements are the typical contents of a 10. Business Proposals - A proposal, in the
recommendation report: technical sense, is a document that tries to
persuade the reader to implement a proposed plan
a. Introduction or approve a proposed project. Most businesses
b. Technical Background rely on effective proposal writing to ensure
c. Make Comparisons successful continuation of their business and to get
d. Critical Requirements new contracts.
e. Conclusions The writer tries to convince the reader that
f. Recommendations the proposed plan or project is worth doing (worth
the time, energy, and expense necessary to
8. Incidental Report - Is written to narrate implement or see through) that the author
incidents prior to, during, and after a situation represents the best candidate for implementing the
suddenly occurred. We should bear in mind that idea, and that it will result in tangible benefits.
incident report is different from narrative type of
essay. The presentation of ideas in an incident Business proposals have two objectives: To
report is systematically arranged and organized persuade and to protect.
using appropriate language. This kind of report
uses simple and clear words and avoids using 1. Persuasion comes from the wording of the
jargons and technical terms. proposal. By definition, a proposal is an offer that
needs to be accepted by the reader in order to
There are things to consider in writing an incident succeed. If the proposal is not persuasive, you will
report: not get what you want.