Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Technical Writing - MODULE 1

Download as pdf or txt
Download as pdf or txt
You are on page 1of 8

Technical Writing

MODULE 1

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
1
Learning Outcomes:

At the end of this module, you are expected to:


a. appreciate the importance of technical writing through an activity titled
“Draw up in writing;
b. distinguish technical texts from literary texts;
c. provide examples of technical texts and literary texts;
d. reflect on the learning acquired from the lessons presented through
completing the given chart; and
e. gain adequate concepts on the nature, purpose, scope, requirements,
and ABC’s of technical writing through a 2 or 3-paragraph essay.”
Topics:

1. Fundamentals of Technical Writing


A. Nature, Scope, Purpose, and Requirements of Technical Writing
B. Principles of Technical Writing
C. ABC’s of Technical Writing
D. Audience Analysis

INTERACTION
Topic 1: Nature, Scope, Purpose, & Purpose of Technical Writing

Take a look on the key points below:

Technical Writing –a written communication about various technical subjects in


sciences, engineering, and technology
–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
–ideally characterized by objectivity for accuracy and precision of information
(Tendero, 2010)

Are there other definitions that you read? Please don’t hesitate to share during our online
web conference.

NATURE OF TECHNICAL WRITING


It introduces you to some of the most important aspects of writing in the world of
science, technology, ad business –in other words, the kind of writing that scientists, nurses,
doctors, computer specialists, government officials, engineers, and other such people do as a
part of their regular work. (For online reference, search for
https://www.scribd.com/doc/80457026/Nature-of-Technical-Writing)

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
2
According to Alcantara (2003), the following are the Purpose of Technical Writing:

a. To inform–it is written to make another person understand or to do something.


Moreover, it is designed to fulfill a need to tell and a need to know.

Example: Technical Writing gives information on what to do during an earthquake, how to use safety
devices to avoid fire and burns, and how to operate new pieces of equipment, like the latest model of a
computer.

ONLINE REFERENCE:

https://tse3.mm.bing.net/th/id/OIP.dibwDQHpCPS1IWogcx6JnwAAAA?w=115&h=180&c=7&o=
5&dpr=1.05&pid=1.7

b. To analyze events and their implications –it explains how certain


systems failed. This system may include education, socio-economic, political,
and the needed change.
Example: How to save dying rivers of the country, in particular, the Pasig River Laguna Lake,
and the Lingayen Gulf.

c. To persuade and influence decisions –it shows how a business or an


industry succeeds because of just and fair treatment of labor.
Example: 1. An agency like NAPOCOR can improve the energy situation and save money.
2. How the educational system can be enhanced through the implementation of the
recommendations of the Educational Commission to Survey Philippine Education
(EDCOM).

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
3
SCOPE/SUBJECT MATTER OF TECHNICAL WRITING

 Its content includes objective information that is accurately and


clearly presented
 It tells the reader exactly what to do, how to do it, and under what
conditions to do it
 It records data in business, science, engineering, industry, and in all
formal aspects of professional areas
 Can be analyzed logically and evaluated scientifically
These pieces of information are according to Alcantara (2003)

Requirements for Technical Writing


1. Facility with technology
2. Ability to write clearly
3. Patience
4. Talent in showing ideas graphically
5. Ability to interact with Subject Matter ://en.m.wikiversity.org
https://en.m.wikiversity.org/wiki/Technical_writing/Overview
The table below shows the differences of Technical Writing and
Literary Writing
ttps://en.m.wikiversity.org/wiki/Technical_writing/Overview
Point of Contrast Technical Writing Literary Writing
1. Subject Scientific/Technical Generally about Life
2. Readership Specific General
3. Format Formal Informal
4. Purpose Informative/Instructional Informative-Entertaining
5. Language Literal/Direct/Denotative Figurative/Indirect/Connotative
6. Style Impersonal/Simple Personal/Elaborated
7. Tone Serious/Unemotional Light/Conversational
8. Content Objective/Neutral Subjective/Opinionated
Tendero (2010, page 3)

“Technical Writing” leaves its readers specific


Let’s Explain! knowledge while “Creative Writing” leaves a powerful
feeling or emotion. (Alcantara, 2003 page 3)

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
4
Topic 2 Principles of Technical Writing

Its Characteristics and Technical Style

CHARACTERISTICS of Technical Writing

 Objectivity –lack of favoritism toward one side or another


 Accuracy –correctness/freedom from mistake or error
 Clarity –clearness
 Conciseness –marked by brevity of expression or statement
 Simplicity –uncomplicated
 Formality –compliance with formal or conventional rules
Casela (2010, page 4)

TECHNICAL STYLE
 Simple English –a controlled language, created by Charles Kay Ogden, which only
contains a small number of words

 Grammaticality –refers to the conformity of a sentence to the rules defined by a


specific grammar of a language.
 Vocabulary/appropriate word choice –use of rich, colorful, precise language that
communicates not just in a functional way, but in a way that moves and enlightens the
reader
 Scientific/Technical terms –are specialized words that can only be mastered of one
has a thorough knowledge of the domain
Casela (2010, page 5)

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
5
Topic 3 The ABC’s of Technical Writing

The ABC (abstract, body, and conclusion) format can be used when writing a first draft
of some document types. The abstract describes the subject, so that the reader knows what the
document covers. The body is the majority of the document and covers topics in depth. On rthe
other hand, one may also ask, what are the ABC of technical writing? What’s your stand
regarding this topic?

Take a glimpse on the key points below:

1. Accuracy –accurate reporting of your findings, presentation of the facts, representation


of your findings, in accordance with the methods you've used. Make sure you clearly
indicate where you've expressed an opinion, rather than a certain outcome of your
investigation. As far as possible, give specific information rather than generalisations.

2. Brevity –try to keep the document as short as possible

3. Clarity -use familiar vocabulary and constructions (make sure you've thought about who
will read your report and be prepared to explain potentially unfamiliar words, perhaps as
a glossary, footnote or endnote)

4. Simplicity –this is about expressing your thoughts with simplicity, not simplifying your
work. Remember your readers: you want to show them the value of your work, not what a
good writer you are.

https://EzineArticles.com/3859050

\\\\

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
6
Topic 4 Audience Analysis

How do you define audience analysis? What do you know about it? Are you familiar with
what audience analysis is? Read the key points below and learn more things about it.

Audience Analysis –the process of identifying the characteristics of a target


audience
https://simplicable.com/en/audience-analysis

What is the significance of audience analysis?

 It guides the students in writing technical reports, business correspondences, and


research paper effectively.
 It determines the main purpose of the paper.

Here are the tips in analysing the audience or readers:


1. Identify the target audience
2. Specify the defined audience
3. Determine the audience’s needs
4. Anticipate the audience queries
5. Analyse the audience answers

THREE (3) Kinds of Audience


1. Layman –“not of a particular profession”
2. Executive –people who make business, economic, administrative, legal
governmental, political decisions about the products of the experts and
technicians
3. Expert –may be the most demanding audience in terms of knowledge, presentation,
and graphics or visuals
–document formats are often technical; style and vocabulary may be
specialized; source citations are reliable and up-to-date; and documentation is
accurate

What kind of audience are you?

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
7
Based on the topics presented, what are the things that you acquired?
Summary

Technical Writing serves as a guide to analyze authentic texts to acquire knowledge and
familiarity necessary to produce effective technical papers. Generally, technical writing adheres
to the principles of unity, coherence, and emphasis.

References
Books

 Alcantara, Rebecca D. and Espina, Felicidad P. (2003). Technical Writing for Filipino
Students. Makati City: Katha Publishing Co., Inc.
 Casela, Neliza C. and Cuevas, George Jeffrey M. (2010). Developing Technical Writing
Towards Meeting Academic Challenges. Mandaluyong City: Books Atbp. Publishing
Corp.
 Tendero, Edwin V. et al (2010). Technical Writing for Research, Reports, and Business
Letters. Malabon City: Mutya Publishing House, Inc.

Websites
 https://en.m.wikiversity.org/wiki/Technical_writing/Overview
 https://www.scribd.com/doc/80457026/Nature-of-Technical-Writing

Prepared by:

SHAMPAINE DIANA ROSE R. ANDAYA, LPT, CSPE

Instructor

THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS
STRICTLY PROHIBITED.
8

You might also like