Você está na página 1de 5

1

Intended for student use only. Not for profitable reproduction |Content acquired/derived from cited sources.

1 TECHNICAL WRITING TEACHERS STUDY NOTES (1
st
SEMESTER SCHOOL YEAR 2014 TO 2015)
WHAT IS TECHNICAL WRITING?

TECHNICAL WRITING is a written communication
about various technical subjects in sciences,
engineering, and technology. It is a specialized,
structured way of writing, where information is
presented in a format and manner that best suits the
cognitive and psychological needs of the readers. It is
ideally characterized by an attitude of impartiality
and objectivity for accuracy and precision of
information.
1
(Emphasis supplied.)

Furthermore, according to Minas et. al
2
, this type of
writing focuses on audience selection; makes
use of precise, economical, and unemotional
language; employs technical jargon; and uses
certain conventional and organizational format.
It also has the characteristics of business. (Emphasis
supplied.)


NATURE OF TECHNICAL WRITING

The essential and remarkable qualities of Technical
Writing, which sets it apart from any other types of
writing, are reiterated in the book entitled
TECHNICAL WRITING IN THE MODERN WORLD
of Minas et. al:

Technical writing is geared to the general
public;

Business utilizes extensively technical writing
for the purpose of communication to the
employees, management, and other
businesses. Products of technical writing
relative to this purpose include training
manuals, employee guidelines or handbooks,

1
Technical Writing for Research, Reports, and Business
Letters by Tendero, Tanuecoz, Bongat, Canare, Garcia, and
Gutierrez
2
Technical Writing in the Modern World by Minas, Ferianiza,
Bermudi, and Yango
and other task-specific technical writing
products ;

Technical writing aims to portray a message
that is clear, concise, and most importantly,
helpful to intended readers or audience
(Emphasis supplied);

Technical writing also anticipates and answers
any questions or problems that may arise;

Technical writing makes transformation of
complex and technical information into a more
easily understood language possible.

Note to self: The abovementioned essential nature and
qualities of technical writing may be considered as some
of the major reasons why technical writing is becoming
an in-demand undertaking. As a result, technical writing
becomes a great option for writers today.


IMPORTANCE OF TECHNICAL WRITING

BENEFITS ON THE PART OF THE WRITER:

A professional who possesses technical writing
skills has an edge in doing his work more
efficiently and in enhancing his career;

Enables a professional to accomplish any work
or task with less effort and more quickly;

Being skilled in technical writing enables any
professional to feel better about himself or his
own capacity. Hence, he gains more self-
confidence as a professional/employee and
acquires more self-esteem;

A professional with knowledge of and skills on
technical writing may also enjoy the feeling of

2
Intended for student use only. Not for profitable reproduction |Content acquired/derived from cited sources.

2 TECHNICAL WRITING TEACHERS STUDY NOTES (1
st
SEMESTER SCHOOL YEAR 2014 TO 2015)
being valued by his employer, as well as
having wage raises and/or promotions;

Since technical writing enables a professional
to perform his work more efficiently, more
quickly, and with less effort; it may also
reasonably reduce work-related stress.


BENEFITS ON THE READERS / AUDIENCES
END:

Technical writing is a vehicle of effective
communication of information to target
readers or audience;

Since Technical writing makes transformation
of complex and technical information into a
more easily understood language possible,
target readers will have an easier time
digesting technical information resources. It
enables these readers acquire the pertinent
knowledge and information they need.


TECHNICAL WRITERS WHO ARE THEY?

Technical writers are not just those professionals who
design, create, maintain, and update technical
documentations. Moreover, technical writers are
those who are tasked to write any writing and
communication that fall under the characteristics of
technical writings such as those professionals and
workers who belong to the engineering, technical,
and medical profession.
3



QUALITIES OF A GOOD TECHNICAL WRITER

Technical Writing authorities, such as Minas et. al,
enumerates some key qualities for a technical
writer:

3
Tindero, et. al

1. Strong writing and analytical skills;

2. Strong people skills, including diplomacy;

3. Active listening skills;

4. A strong technical curiosity, with technology
being a major part of his or her life;

5. Experience working directly with a technical
team; a technical writer who can mesh with
your technical team is the key to a positive
working relationship.


QUALITIES OF A GOOD TECHNICAL REPORT

Technical Writing authorities, such as Minas et. al,
enumerates some key qualities of good technical
reports:

ACCURACY

Rationale: Please see discussion in page 3.

OBJECTIVITY

Rationale: Technical writing or reports must
present data or information without any bias.
Conclusions should be drawn solely from the
facts presented.
4
There is no room for the
authors or writers opinions and thoughts.


CLARITY

Rationale: Texts and photographs contained
in technical reports must be clear and
unequivocal. Analyses and interpretations
must be defined and explained clearly.
Denotative language must be used.

4
Supra note 1

3
Intended for student use only. Not for profitable reproduction |Content acquired/derived from cited sources.

3 TECHNICAL WRITING TEACHERS STUDY NOTES (1
st
SEMESTER SCHOOL YEAR 2014 TO 2015)


CONCISENESS

Rationale: Technical reports must be written
briefly. However, such brevity should not
dispose of all the important details that must
be included in the report or technical writing
document. Remember, a technical writing
must be FACTUALLY MEANINGFUL, YET
SHORT.


CONTINUITY

Rationale: Authors Minas et. al suggest that
reports must be presented in a logical
manner. This way, it shall be easy for the
readers to follow the line of thought of the
technical writer, if not the discussion
presented in the technical report or document
in an uninterrupted manner.


FORMAL WRITING STYLE

Rationale: Technical writing or reports must
be presented pursuant to a prescribed format.


The definition of technical writing provided by Tindero
et.al is also an abundant source of the essential
characteristics of technical writing / report (You may
refer to the definition of Technical Writing in page 1 of
this document). They are:

PRECISION

IMPARTIALITY

Rationale: There must be treatment of
different views or opinions equally and fairly.
5


5
Wordweb


ACCURACY VS. PRECISION

Commonly, accuracy and precision are used
interchangeably. Technically, each of these words
possesses a different and significant meaning.

As discussed in the webpage of North Carolina State
University
6
, accuracy is defined as closeness of a
measured value to a standard or known value. For
example, if in lab you obtain a weight measurement
of 3.2 kg for a given substance, but the actual or
known weight is 10 kg, then your measurement is not
accurate. In this case, your measurement is not close
to the known value.
7


Meanwhile, in the same webpage, precision is defined
as the closeness of two or more measurements to
each other. Using the example above, if you weigh a
given substance five times, and get 3.2 kg each time,
then your measurement is very precise. Precision is
independent of accuracy.
8


Note to self: You can be very precise but inaccurate,
as described above. You can also be accurate but
imprecise. For example, if on average, your
measurements for a given substance are close to the
known value, but the measurements are far from each
other, then you have accuracy without precision.
9

Hence, accuracy can only be determined if there is a
PARAMETER or STANDARD to which values or
calculations may be compared.



6
North Carolina State University. (URL:
http://www.ncsu.edu/labwrite/Experimental%20Design/accu
racyprecision.htm). Last visited: 6/24/2014 at 6:51 PM
7
Ibid
8
Ibid
9
Ibid

4
Intended for student use only. Not for profitable reproduction |Content acquired/derived from cited sources.

4 TECHNICAL WRITING TEACHERS STUDY NOTES (1
st
SEMESTER SCHOOL YEAR 2014 TO 2015)
TECHNICAL WRITING VS. LITERARY
WRITING

The differences of Technical Writing and Literary
writing may be determined by examining the
following points of contrast:

SUBJECT MATTER

Technical Writing usually deals with engineering,
science, business, and technology, while literary
writing deals with light and non-technical subjects like
life, love, emotions, relationships, etc. Technical
writing does not dwell on human life and experiences,
or even the intricacies of the human heart.
10


PURPOSE

Technical writing provides useful information, gives
instructions or directions, directly conveys the writers
ideas or messages, and serves as a basis for decision-
making. Unlike literary writing, it does not entertain
the readers, imparts a life lesson, or influence the
readers with the authors personal message or
opinion.


LANGUAGE

Technical Writing uses literal, direct, or denotative
language. Writing must be exact and precise, as well
as objective and neutral. Unlike literary writing, it
does not admit figurative, indirect, or connotative
language and/or interpretation.


FORMAT

Technical writing always comes in a formal form. It
always deals with serious subject matters and its
target readers are professionals. These are as

10
Technical Writing in the Modern World by Minas,
Ferianiza, Bermudi, and Yango
opposed to Literary writing, which is always written
informally.


STYLE

Unlike literary writing that is written in an elaborated
style and with a conversational tone, technical writing
must be written SIMPLY.

TONE

Unlike literary writing that is written in a
conversational tone, technical writing is always
written in a serious and UNEMOTIONAL manner.


CONTENT

Technical Writing contains only objective and neutral
data, facts, or information. This is to avoid ambiguity
and provide the target readers the freedom to
analyse correctly. This is as opposed to literary
writing, which contains only insights, thoughts, and
opinions.


BASIC PRINCIPLES OF TECHNICAL WRITING

According to Mills and Walter (1982), Technical
Writing has the following basic principles:

1. Technical writing is written for a specific
person or group of people, real or
imaginary, and they are assumed to be
intelligent but uninformed.

This means there must be a target audience
or reader. An example would be a case study
about Heparin toxicity. The target readers of
said material are professionals in the field of
medicine (i.e. medical doctors and medicine
students.). Therefore, the concent of such
study will greatly interest these groups of
people. Consequently, applied physics may

5
Intended for student use only. Not for profitable reproduction |Content acquired/derived from cited sources.

5 TECHNICAL WRITING TEACHERS STUDY NOTES (1
st
SEMESTER SCHOOL YEAR 2014 TO 2015)
not pay as much interest because they do not
belong in the medical field.

2. Technical writing is written for a
purpose. All words in the sentence all
sentences in a paragraph, and all
paragraphs in the composition must
contribute to the intended purpose.

Hence, any words, phrases, or sentences that
only duplicate an idea already mentioned in a
technical report must be deleted.

3. Technical Writing uses simple, concrete,
and familiar language.

Clarity, coherence, and simplicity are keys to
good technical writing. While the writer may
not avoid using technical terms or jargons,
yet, he must not bombard any report with
highfalutin words.

Simple, clear, concrete, and familiar language
allows readers more understanding and saves
them the trouble of deciphering the meaning
of the reading material.

4. Technical writing should always have
the three parts: introduction, contents,
and conclusion.

In order to achieve coherence, a technical
writer must always adhere to the
abovementioned parts. This enables him to
establish logical sequence and coherence in
his technical report or document.

5. Technical writing must be presentable
and attractive. (self-explanatory)



---------------NOTHING FOLLOWS -------------

REFERENCE MATERIALS:

TECHNICAL WRITING IN THE MODERN
WORLD by Rebecca M. Minas, MA Ed.,
Marilyn B. Ferianiza, Pedrito Jose V. Bermudo,
Ph. D., Antonio Jan Yango, Ph. D.

TECHNICAL WRITING FOR RESEARCH,
REPORTS, AND BUSINESS LETTERS by
Edwin V. Tendero, Natialia C. Tanuecoz,
Dolores N. Bongat, Flora D. Canare, Carina B.
Garcia, Romulo S. Gutierrez

Você também pode gostar