TW1
TW1
Skill in writing technical reports is an invaluable asset not The following are the primary purposes of technical writing:
only in college but also in the professions. As the country’
1. To inform. Technical writing is done to make
industrialization program grows space, skill in this type of
another person understand or do something. It is designed
writing will be a highly vital personal asset, not only in
to fulfill a need to tell and a need to know.
business and industry, but also in science and technology as
well as the in the government service. 2. To analyze events and their implications. Technical
writing aims to explain how certain systems failed. These
For instance, engineers submit reports on the progress of
systems may be education, socio-economic, political, and
their projects they are undertaking to their superiors.
within the technical article, the recommended change or
Architects attach explanations with their design plans for the
changes.
information to their stockholders. So, to be an effective
professional, one should have enough knowledge on making 3. To persuade and influence decisions. Technical
technical reports, for him to communicate with his writing seeks to show how a business or an industry
superior.” (Manalo, 2008) succeeds.
Technical writing presents and explains a subject matter in a 8. To serve as a basis for public relation.
clear, objective, accurate, concise, and unemotional manner.
9. To provide report to stockholders of companies.
Technical writing uses a relatively high concentration on
10. To develop a product.
certain complex and important writing techniques,
particularly description of a mechanism, description of 11. To provide service.
12. record business through proposals. A good technical writer emphasizes the facts and the
important data. An effective technical writer practices the
13. To procure business through proposals.
impersonal style of writing. He presents the facts, figures,
Basic Principles of Effective Technical Writing and statistics supporting the subject matter or the central
theme and writes it in an impersonal manner.
1. Understanding the reader.
Using Correct Format
2. Knowing the purpose of teach article or report.
The readers’ attention is initially on the format and style of a
3. Knowing the subject matter.
report. Most companies require neatly-typed
4. Organizing the material. communication, reports, and project proposals and
feasibility studies. It is the common and apt trend to require
5. Writing objectively.
a computerized or typed report.
6. Using correct format.
Adopting Ethical Standards
7. Adopting ethical standards.
A technical writer must undergo comprehensive research
Understanding the Reader work to gather the needed data through interviews, surveys,
Knowing the target audience is one of the basic things to referrals and related publications. He must present the
consider in technical writing. A technical writer must learn required facts and figures gathered and must use only those
to adapt his way of writing and to learn specific that are relevant to the report. An effective technical writer
terminologies according to the type of the intended audience acknowledges the hard work and the help from sources and
or readers. Technical terms which may be deemed difficult cites them as references.
by the readers must be carefully defined throughout the text, Style in Technical Writing
for the reader to thoroughly and easily understand the
Style is the writer’s way of writing, a manner in which he
information being conveyed by the writer. The writer fails in
expresses his thoughts and feelings in a language. Below
his mission to inform if the reader also fails to understand
are the guidelines for clear technical writing.
what he’s reading. The writer should be aware of the
reader’s importance. The target audience and readers would 1. Be selective, focus on the essential information and
help the writer to know what to write about and how to go significant detail.
about writing it.
2. Develop a clean, direct style; avoid inflated
Knowing the Purpose of Each Technical Report language and scrambling sentences.
A technical paper must focus on a central theme. The reader 3. Use examples and comparisons to clarify
should be aware of the main purpose of the text after reading descriptions and explanations.
it. The purpose may be to describe a thing, to report on a
4. Repeat words and phrases for clarity or emphasis
specific problem or project or to analyze and solve a
or to ease transitions, but avoid needless repetition.
problem.
5. Delete unnecessary words and phrases, but avoid
Knowing the Subject Matter
short cuts that sacrifice meaning.
A technical writer must have a complete knowledge of the
subject that he or she must write about. For example, if the
report is regarding the result of a technical experiment, the Sentence Structure and Length
technical writer must explain what the problem is all about,
Technical writing does not require a unique style. Instead,
what causes the problem and how the problem is solved.
technical writing uses the natural word order, simple
Writing Objectively sentence structure and well-written short sentences.
Although the technical subject matter requires the use of 3. Is it fact and not opinion?
complex, technical vocabulary and the expression of
4. Do I have all the facts?
complex ideas, it would prove beneficial for the reader and
his understanding of the subject matter if the writer uses 5. Are they up to date?
shorter words and sentences and simple structure.
6. Is the generalization verifiable? Would I get the
Paragraph Structure and Length same result if I do it again?
should incorporate all the evidences from which the write it.
The technical writer must be aware of when not to research and primary services.
overwrite. As a writer of the materials, he should know what 7. Write a first draft.
to present, what to emphasize, what to rewrite and what to
8. Revise and rewrite as often as necessary.
amplify.
To be certain that you have followed ground rules and not 3. informative
“jumping to conclusions”, test the validity of your data and
4. factual
samples. Here is the suggested checklist by Nem Singh and
Calixihan (1994). 5. efficient
2. Can I show the direct bond between the facts and The Role of the Technical Writer
generalizations?
A good technical writer possesses insights, perceptiveness, as doubts over the whole text. A writer should always aim
is quick to determine probabilities, and has the ability to to be understood.
adapt to requirements. He must have the ability to identify
Brevity
developments that may affect his project.
Being brief is a courtesy to the reader. The reader should
The technical writer must understand the nature of his work.
find it easy to group the main idea of the report. In the same
He should be able to help his principals attain the target
manner, accuracy of the statements can easily be
objectives. He must not only possess the technical writing
maintained. The reader can get the essence of your thinking
ability and technical expertise, but he must also have the
in a compressed form.
capability to grasp, to analyze and to interpret unexpected
events and situations that may occur throughout the writing Confidence
of the technical report.
A good report writer must have the quality of self-
The technical writer should have the ability to state facts confidence. He cannot only communicate but he has to be
clearly and accurately, to organize a variety of elements into also decisive or sure what he is writing about. After
a unified structure, and to describe logical generalizations. finishing the last page of his report, he is an authority.
The hallmarks of an effective technical writer is represented Dignity is courtesy to your readers as professionals. This is
by this acronym REPORTER (Mosura and Tenorio, 1999) an ethical standard. The writer must be certain that all
grammatical constructions are correct. In report writing,
R - Resourceful
you need to be formal with words and how these words are
E - Energetic used. You should be sure that the ideas or information are
well-organized, simplified, summarized, and expressed in
P - Patient
straightforward manner.
O - Observant
Facility
R - Responsible
This refers to the devices used by the writer, to make his
T - Trustworthy report easy to read and understand. In most cases, report
writing depends more on pacing, sequence, arrangement,
E - Evaluative
and continuity of ideas as well as information. A
R - Responsive grammatical correction is important. He should make his
writing straightforward, logical and clear. The thought from
one part to another should be clearly established, illustrated
The Wholistic Guide to Technical Writing or stated.
A report writer must be tactful in the recording of data, step, directs the reader to the right way and gives him the
statement or calculating mathematical figures. He must reason for stopping at a particular portion.
Sentences carry the full weight of the meaning in a report. 1. Technical Report. This provides useful information
The sentence to be employed must be limited to only one about a complete program of work, for reference and
idea or to closely related ideas. To avoid monotony, vary permanent record.
your sentence structure and employ appropriate transitional
2. Contract. This is a formal agreement between two
devices. By employing such devices, there will be a smooth
or more persons; organization or parties to do something on
transition from sentence to sentence. They will show the
mutually agreed terms.
readers the writer’s thoughts leading him to what the writer
wants to communicate. 3. Feasibility Report. This represents facts and
information intended to make the reader realize that the
Thoroughness
proposed project or plan is financially, economically, and
The writer should treat well his subject matter. The writer technically, significant as well as beneficial.
should check the thoroughness of his report from initial
4. Business Letter. This is a written communication or
thinking to final submission. The writer is obliged to go over
message used to transact business, which cannot be
the subject, analyze and investigate it, organize and interpret
conveniently conducted orally.
the results and draw conclusions whether it is positive or
negative. 5. Brochure. This is a pamphlet or printed information
material given to a customer in order to convince or
Unity
persuade him to take action on the company’s services,
A report is unified when everything is clearly relevant to the ideas or products offered.
main point under discussion. Nothing should be left
6. Abstract. This is a summarized form of resume of a
hanging. No question should be left unanswered. After all,
long piece of writing.
the main objective of a unified report is to let the readers
feel that they have read everything essential to the subject 7. Instructional Manual. This contains directions for
undertaken. work procedure or policies, or for the use of technical
equipment or appliances. Instruction relies on clear, specific,
Viewpoint
complete directions presented in sequential order. Directions
A report is written from a certain viewpoint: that of a of complicated step-bystep procedures should be
reporter, proponent, researcher or an author. The viewpoint accompanied by graphic illustration.
is established in the first sentence and should be maintained
8. Proposal. This contains suggestions for actions,
consistently throughout the report. Voice unity should also
usually involving change or performance. It may be to solve
be observed.
problem, suggest a new project site, revise a policy or
Word Choice initiate a researcher report project or terminate a project.
The writer should choose the words that are fit to the 9. Progress Report. This contains an account of what
reader’s undertaking. Avoid words that are difficult to has been accomplished on a project over a specific period of
understand. time and what may be expected in the next period.
20. Technical Paper. A research paper written for a However, not all communications go in one direction.
professional journal or magazine. Technical papers usually Sometimes, the readers can be combined. For instance, if
describe a theory or new development. They resemble one publishes a technical article in a research journal, the
technical reports in most respects. The main difference lies communication goes outward, as well as upward. To
on the fact that the audience for a technical paper is wider analyze the readers, one must be sure to know the direction
and more diverse. of the communication.
Direction of Communication