You are on page 1of 22

LEARNING PACKET

E0023 (BEED 3A)


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.
1
OVERVIEW
This module contains the intended learning outcomes of your subject, topic outline, instructional materials, self-
learning content, activities, exercises, rubrics and assessments. The activities with demonstration and presentation
will be treated as your performance task and the exercises/quizzes will be considered as your written outputs. Please
go through the process religiously as this will help you gain the necessary knowledge, skills, attitude and values that
are required for you to pass the subject in accordance with the given time frame of six weeks. Good luck and Believe
You Can Do It!
Welcome to our class! I hope you have a great day today. I am Eileen Baptista-Dupra, LPT and I am looking
forward to a meaningful semester with you.

LEARNING OUTCOMES:
At the end of this module, you are expected to:
• discuss your understanding on the definition and goal of technical writing;
• write your reaction paper about the nature of technical writing;
• differentiate the features of your examples for each type of technical writing;
• examine the purpose and function of technical writing through collage.
• explain the benefits in observing the principles of good technical writing;
• give your opinion to the question about writing styles;
• prepare your summary on the roles of technical writing;
• compose an acronym about the roles of technical writer;

TOPICS
• Definition and Goal of Technical Writing;
• Nature of Technical Writing;
• Types of Technical Writing;
• Purposes and Functions of Technical Writing;
• Basic Principles of Good Technical Writing;
• Styles in Technical Writing;
• Roles of Technical Writing;
• Roles of the Technical Writer

INSTRUCTIONAL MATERIALS
• Learning Module
• Cloudsourcing Learning Management System(CLMS)
• Internet Connectivity
• Laptop/Computer/Smart Phone
• Bond Paper or Intermediate Pad
• Ballpen/Ballpen

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
INTRODUCTION
Technical writing is a communicative skill different from other forms of academic and professional
writings. It is quite different from literary genres like; prose which recounts the fictional tales of characters,
poetry which expresses deeply felt universal emotions through figurative expressions. It is also not an
expressive essay narrating an occurrence or an expository essay analyzing a topic. Technical writing is not
journalism, written to report the news. In other words, Technical writing does not emphasize poetic images;
it does not recount individual experiences, or the report of a contest. It is however purpose driven. Although
the common notion is that technical writing is synonymous with creating manuals for computer software,
technical writing skills could be applied in any field or industry where complex ideas, concepts, processes
or procedures need to be communicated. Therefore, it relies heavily on a style that is concise and clear, a
style which promotes the synthesizing and explanation of complex concepts and processes for enhanced
comprehension. To this end, it may be worthwhile that in addition to other forms of writings, students at
the tertiary level should be exposed to technical writing skills since this it is a form of writing that would
be required from them once they are introduced to the “world of work”.

ELICITING PRIOR KNOWLEDGE

Give words associated with the term “technical writing” through word mapping. Explain briefly using the
said identified words.

Technical
[

Writing

You got it! Proceed now to the interaction part of your self-learning packet.
Goodluck!

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
II. INTERACTION

Lesson 1: Definition and Goal of Technical Writing


Reference:Nancy, E. (2020). THE NATURE AND ROLE OF TECHNICAL WRITING. Www.Academia.Edu.
https://www.academia.edu/23211348/THE_NATURE_AND_ROLE_OF_TECHNICAL_WRITING

Definition
• Technical writing is a form of descriptive writing which expresses or explains complicated concepts
or processes in understandable terms. It is generally a method of researching and creating
information about technical processes or products.
• The term technical writing is seen from two major perspectives: educational and business
perspectives. These have influenced the definition given to it by the different fields of endeavour;
In educational field, technical writing is that form of writing embarked upon by researchers and other
professionals. Such documents communicate a given concept or theory. It also reports an educational
research or discusses current trends in a given field. It is a highly skilled form of writing which requires
the writer to come up with a proposal that is understandable, comprehensive and readable. Such writing
should be able to speak to the audience without the writer trying to make verbal explanations. To write a
good technical paper, the writer must be familiar with the purpose of writing and the audience; the question
to be addressed at this point is, to what extent is the writer knowledgeable about the topic of discourse.
In the business community however, technical writing is viewed as a kind of communication written for
and about business and industry, it focuses on products and services- how to manufacture, market, manage,
deliver and use such products. They are of the view that technical writing is a kind of document written in
the work place (within the organization) to supervisors, colleagues, subordinates, vendors, and customers
or a written document related to a given job. It is also the ability of the writer to make the process of
installing a product “user friendly”,
The society for technical communication, on their part, view technical writing as any form of
communication that exhibits one or more of the following characteristics:
(1) communicating about technical or specialized topics such as computer applications, medical
procedures, or environmental regulations;
(2) Communicating through technology such as web pages, help files, or social media sites;
(3) providing instructions about how to do something, regardless of the task's technical nature”.
Notable amongst writers who view technical writing from this perspective are Gerson, M.S. (2000); for
him, Technical writing is seen as:
an instructional manual for repairing machinery
a memo listing meeting agendas

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
a letter from a vendor to a client
a recommendation report proposing a new computer system.

The goal of technical writing

The major goal of a good technical writing is to present hardcore technical information to the non-
technical people in a way that they will easily comprehend. This involves the construction of relevant,
useful and accurate information geared to specifically targeted audiences to influence and persuade them to
act in a particular way for the achievement of a pre-defined goal, assisting them take appropriate decisions
by giving those facts and figures that would enable them analyze situations. Responses to a technical writing
may be assessing a research proposal, a research study, using a software application, operating industrial
equipment, preventing accidents, safely consuming a packaged food, assessing a medical condition,
complying with a law, coaching a sports team, or any of an infinite range of possible activities. Technical
writing is mandatory once an activity requires expertise or skill.

ACTIVITY 1!

Direction: Discuss your understanding about the definition and goal of technical writing. Submit
your output with a minimum of 300 words, computerize, double space, and bond paper to be
attached to your activity page of your module and Microsoft word for Online to be submitted in
the CLMS.

Congratulations! You learn the fundamental of technical writing. Continue to explore in


learning the subject for Technical Writing by moving on to the next lesson prepared for you.
Goodluck and have fun!

Rubrics Points Score


Content 5
Organization 5
Relevance 5
Grammar 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
Lesson 2: Nature of Technical Writing

Technical writing is a major form of writing in fields with specialized vocabularies, such as
Sciences, Engineering, Technology, and the Health sciences. Fearing, B.E., & Sparrow, K.W. (1989) opined
that technical writing is singled out as being practical. This is also supported by Eko, E. (2005) that
“technical writing is so immediately functional”. She reiterates that “confusing directions accompanying an
essential device in a jet plane may result in disaster, bad writing elsewhere can have as its extreme effect;
mere boredom” This suggests that technical writing is primarily concerned with getting things done with
efficient and effective actions. Achieving this goal implies that an effective technical writing must be
specific and concise especially in writing instructions. It must be written in simple language devoid of
grammatical errors and punctuation mistakes. The effect will be the creation of a text that laymen would
understand and implement. It is also important to note that technical writing must be thorough, and
comprehensive in providing information. This is done through the use of descriptive language to clearly
outline each step and the use of appropriate format and standards.

Technical writing according to Markel, M. (2012) covers many genres and writing styles depending
on the information and audience. Although it is the sole purview of technical writers to produce technical
documents, anyone who works in a professional setting should be able to produce technical documents of
some sort. See diagram adapted from ASM International (2001)

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
Nature of Technical Writing
https://www.scribd.com/doc/80457026/Nature-of-
• Technical-writing introduce you to some of the most important aspects of writing in the world of
science, technology, and 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.
• To learn how to write effectively for the world of work, you'll study common types of reports,
special format items such as lists and headings, simple techniques for putting graphics into
reports, and some techniques for producing professional- looking final copy.
• However, the focus for technical-writing is not necessarily career as a technical writer but an
introduction to the kinds of writing skills you need in practically any technically oriented
professional job. No matter what sort of professional work you do, you're likely to do lots of
writing—and much of it technical in nature. The more you know about some basic technical-
writing skills, which are covered in this guide and in technical-writing courses, the better job of
writing you're likely to do. And that will be good for the projects you work on, for the
organizations you work in, and—most of all—good for you and your career.

ACTIVITY 2!

Direction: Make a reaction paper about the Nature of Technical Writing in relation to your chosen
profession. Submit a minimum of 300 words, computerize, double space, and bond paper to be
attached to your activity page of this module and ms word for Online to be submitted in the CLMS.

Congratulations! Be connected with then nature of technical writing for you to get ready to your
writing exercises. Continue to explore in learning the subject for Technical Writing by moving on to
the next lesson prepared for you. Goodluck and have fun!

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
Rubrics for Reaction paper Points Score
The paper contains the required 5
components
The major points are stated clearly 5
The paper is grammatically correct 5
The purpose is communicated 5
clearly

Lesson 3:Types of Technical Writing


https://www.academia.edu/23211348/THE_NATURE_AND_ROLE_OF_TECHNICAL_WRITING

The following are some examples of technical writing:

1. Proposal: Usually, the starting point for every project is a proposal. This is a document which
describes the purpose of a project, the tasks it will accomplish, the methods to be employed in
carrying out the project, and finally the cost of the project. Proposals could either be written by
technical writer, outlining the cost of installing a new computer system, a teacher detailing how a
new Biology class will be structured or a research fellow discussing the research problem(s),
purpose, significance, the research questions, conceptual framework and hypotheses and describing
the instruments for data collection, data collection procedure and the method for presentation of
findings.
• Technical report: it is a document written by a researcher detailing the results of a project and
submitted to the sponsor of that project. They may be published before the corresponding journal
literature. Their content may be more detailed than the corresponding journal literature which may
have less background information since such information has been provided to the sponsor.
Technical reports are usually not peer reviewed unless the report is separately published as journal
literature. It is essential to note that classified and export controlled reports have restricted access.
Usually, obscure acronyms and codes are employed in technical reports. However, it may be
advisable that such obscured jargons, terminologies and acronym be adequately explained to
enhance comprehension. Technical reports could come in different forms, these are discussed
below;
• Primary research reports; these are technical reports which present findings and interpretation from
laboratory or field research. It deals with the skills for collecting primary data by the researcher.
Effective primary research reports are usually written after the researcher would have gained enough
insight on the research topic by conducting preliminary search into the study by reviewing or
analysing secondary and primary data. Some of the common methods of data collection are
questionnaires, direct observations

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
• Recommendation, feasibility, evaluation reports; these categories of technical report are used to
compare several options against a set of requirements and recommending the most preferred
alternative; it evaluates an idea (plan, project) "feasibility," in line with its technical and economic
requirements, social justification and based on these, recommendations are made on its worth or
value.
• Standard Operating Policies and Procedures; these are organizational operating documents
containing rules and regulations on how the organization and its members are expected to perform.
Policies and Procedures are more or less instructions however, the Standard Operating Procedures
(SOPs) relate specifically to procedures for carrying out a process. For example, designing and
developing a training programme, conducting an in-depth diagnostic study of an Organization or
conducting a need assessment survey of on any of the sectors of the nation’s economy.
• Technical background reports; these form of technical reports focus on a technical topic and provide
background on the topic for target readers with specific needs who may be willing to pay for such
services. These types of report neither supplies instructions nor recommendations in any systematic
way, it does not report new and original data. Example, solar energy, global warming, CD-ROM
technology, a medical problem, or U.S. recycling activity.
• Technical guides and handbooks; these are the most common forms of documentation in the
business environment. They may be in electronic forms, stored on a corporate intranet or in hard
copies. Irrespective of the form they appear, they are used for instructions and guidelines on
technical procedures, corporate policies and for relaying any other information needed for reference
purposes. They serve as on- the- job training documents and liability lawsuits.
• Business Plans; this type of report deals with the development of a proposal to start a business. It is
a formal statement of goal, plans and the reasons for attainment of a business. A business plan may
provide background information about the organization or team attempting to reach the goals. It is
written to either target changes in perception of a business and branding by customers, when the
existing business is to undertake a major change or when planning a new business project.
• Technical Specifications; This type of report presents descriptive and operational details on a new
or updated product. It describes the detail of either all or specific parts of a design, such as;

- The signature of an interface, including all data types/structures required (input data
types, output data types, exceptions);
- Detailed class models including all methods, attributes, dependencies and
associations;
- The specific algorithms that a component employs and how they work; and
- Physical data models including attributes and types of each entity/data type.
• Instructions and procedures these are documents that enable either developers or end users to operate
or configure a device or programmes. These include user manuals and troubleshooting guides for
computer programmes, household products, medical equipment, and automobiles.

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.
9
2. Web sites: this is a virtual location on WWW which contains numerous educational and
organizational related webpages and data files accessed through the browser. Every website has a
peculiar web address (uniform resource locator) reached through an internet connection. The
opening page of a website is known as a homepage. It contains hyperlinks to other pages on the
same or other site(s). A single web server may support multiple websites and a single website may
reside on multiple web servers, this could be hundreds of miles apart. A good quality website
enhances the chances of getting the most from the marketing of an organization’s product. In most
cases, it is the responsibility of the technical writer to author pages on the websites. To do this, the
writer needs to be skillful with web development tools. Examples of pages on website are “About
Us” or product pages.
3. The E-mails, Memoranda and Letters: In organisations, the E-mails, memoranda (often called
memo) and letters appear to be the most commonly written documents in a business. The objectives
of these forms of technical writing may be either to relay information to the receiver or persuade the
receiver to carry out a task. It is important to understand that the major difference between a memo
and a letter is that while letters are used to communicate with external customers, memos are meant
for the consumption of internal customers (employee) and are written using appropriate
terminologies.
4. White paper: over time, the word white paper has been defined from different perspectives. This
is because it is a document that although evolved from the field of politics, it has been adapted by
the business world to communicate with the customers. Generally speaking, this is a persuasive,
authoritative, in-depth report or a guide on a given topic which presents a problem and a solution to
the problem. It informs a reader in a concise manner about a complex issue and presents a body of
philosophy on the matter. This is primarily designed to help readers understand an issue, solve a
problem, or make a decision. For the politicians, a white paper is a legislatives document which
explains and supports a particular political solution. For the technological group, it is used to
describe the theory behind a new piece of technology while in the business world, varied definitions
abound. In business, the definition may be product centred or not. Marketers use whitepapers to
educate customers about a particular issue or to explain and promote a particular methodology.
White papers are used as an advanced problem-solving guide. To effectively use the white paper,
an email address may be necessary for capturing leads or clues to the solution of the problem.
5. Press Release: this is a public relations announcement issued to the news media and other targeted
publications for the purpose of letting the public know of an organization’s developments. It is aimed
at creating awareness for organizational activities. The technical language used in highly
denotative.

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.
10
6. Specifications: these are the outlines of a design detailing the structure; parts, packaging, and
delivery of an object or process in a concise and comprehensive manner to ensure that audience
make sense of the intended message. A specification could be that of a car, laptop, desktop, palmtop,
galaxy tab or any other product.
7. Descriptions: they are brief explanations of the procedures and processes that enable the reader
understand functionality of something; it could be about gas emission, it could also be about how a
car’s shock absorber works.
8. Résumés: it is a self-marketing tool designed with one purpose in mind - to "sell" the writer’s skills,
knowledge, and experience to an employer in order to attract an invitation to attend an interview for
a job offer. An effective resume speaks to the employer's needs and requirements and demonstrates
a match between what the writer has to offer in relation to the job requirements. It stimulates interest
in the writer by summarizing information on his unique qualities, well developed skills, relevant
work or academic experiences, or accomplishments that clearly differentiates him from others.
9. Job application: in most government agencies and other organizations, written application is the
primary document used in evaluating qualifications. The presentation of an application is a
prerequisite for obtaining an interview. Regardless of the fact that the resume contains almost all
the information to be supplied in the application, it is still mandatory for the individual to present
an application. This is because it is an official document often required for job placement, legal
issues, data processing, and employer convenience reasons.

ACTIVITY 3!

Direction: Distinguish the components/parts of your example for each type of technical writing.
Submit your outputs in computerize, double space, and bond paper to be attached to your
activity page of the Module and upload msword for Online in the CLMS.

Congratulations! Be familiar with the different writing styles in preparation for your succeeding
activities in technical writing. Continue to explore in learning the subject for Technical Writing
by moving on to the next lesson prepared for you. Goodluck and have fun!

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.
11
Rubrics Points Score
Content 5
Organization 5
Relevance 5
Grammar 5
Lesson 4: Purposes and Functions of Technical Writing
https://www.scribd.com/doc/80457026/Nature-of-
Purposes of technical writing.
Technical writing presents and explains a subject matter in a clear, objective, accurate, concise, and
unemotional manner. Technical writing uses a relatively high concentration of certain complex and
important writing techniques particularly description of a mechanism, description of process,
clarification, cause and effect, comparison and contrast, analogy and interpretation. Technical writing
highly utilizes technical vocabulary. It utilizes tables, graphs and figures to clarify and support textual
discussion. It uses the conventional report forms.
1. To inform - It is written to make another person understand or to do something. It is designed to
fulfill a need to tell and a need to know.
2. To analyze events and their implications - It will explain how certain systems failed. This system
may include education, socioeconomic, political and the needed change.
3. To persuade and influence decisions -It will show how a business or an industry succeeds. Technical
writing is ideally characterized by the maintenance of impartiality and objectivity, by extreme care to
convey information accurately and concisely and by the absence of any attempt to arouse emotions.

Functions of Technical Writing


1. To serve as a basis for management decision
2. To furnish needed information.
3. To give instructions
4. To explain techniques
5. To report achievements
6. To analyze problem areas
7. To determine design and system requirements
8. To serve as a basis for public relation
9. To provide report to stockholders of companies
10. To develop a product
11. To provide service
12. To record business through proposals
13. To procure business through proposals

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.
12
ACTIVITY 4!
Direction: Analyze the purposes and functions of Technical Writing through a collage. Then,
explain your output. Answer this activity using separate bond (modular), minimum of 300 words,
and double space for both correspondence and on-line learning modality to be attached in the
activity page of your module and upload in msword for Online in the CLMS.

Congratulations! Knowing the purpose and function in technical writing would surely make
you as good technical writer. Continue to explore in learning the subject Technical Writing
by moving to your next lesson Goodluck and keep safe always! guide

Rubrics for collage Points Score


Content 5
Organization 5
Relevance 5
Creativity 5
Grammar 5

Lesson 5: Basic Principles of Good Technical Writing


1. Understanding the reader
2. Knowing the purpose of each article or report
3. Knowing the subject matter
4. Writing objectively
5. Using correct format
6. Adopting ethical standards
Understanding the Reader
A basic consideration in technical writing is to know the target audience. The technical writer should
know how to adapt his writings and terminologies of the type of the intended audience or readers. Difficult
technical terms used must be carefully defined so that the reader will easily understand the information
being presented. If the reader fails to understand what he reads, the writer fails in his mission. The

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.
13
technical writers should know how important his readers are. The target readers help the writer to know
what to write about and how to write it.
Knowing the Purpose of Each Technical Report
The technical paper must be organized around a central theme. The reader should understand the main
purpose after reading the paper. The purpose maybe is to describe a thing, to report on a specific problem
or project, or to analyze and solve a problem.
Knowing the Subject Matter
A technical writer must have a thorough knowledge of the subject he is to write about. If the report is on
the result of a technical experiment, the writer who writes the report should explain what the problem is
all about, what causes the problem and how the problem is solved.
Writing Objectively
A good technical writer must emphasize the facts and the data. The impersonal style is basic to an
effective technical writer. He represents facts, figures and statistics skillfully woven around the subject
matter or central theme and written in an impersonal manner.
Using Correct Format
The format and style of a report attract the attention of the readers first. Companies require neatly-typed
communications, reports and project proposals and feasibility studies. The current trends require that
such communication be computerized or typed.
Adopting Ethical Standards
A technical writer should undertake comprehensive research work; accumulate the required data through
interviews, surveys, referrals and related publications. He must have to present facts and figures as
gathered and required, using only those that are pertinent to the report. A good technical writer also
acknowledges the help he receives from others and cities sources of reference materials.

ACTIVITY 5!

Direction: Discuss the benefits can be derived in observing the principles of good technical
writing. Submit a minimum of 2-3 paragraph , computerize, double space, and bond paper to be
attached to your Module and Microsoft word for Online to be submitted in the CLMS.

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.
14
Congratulations! May you flourish in your own writing styles or continue to be inspired honing
your prowess in writing your master piece as you face the 21st century world of work. Continue
to explore in learning the subject Technical Writing by moving to your next lesson Goodluck and
keep safe always!

Rubrics Points Score


Content 5
Organization 5
Relevance 5
Grammar 5

Lesson 6:Styles in Technical Writing


Style is the writer’s way of writing, a manner in which he expresses his thoughts and feelings in a
language. Below are guidelines for clear technical writing.
1. Be selective, focus on the essential information and the significant details.
2. Develop a clean, direct style; avoid inflated language and scrambling sentences.
3. Use examples and comparisons to clarify descriptions and explanations.
4. Repeat words and phrases for clarify or emphasis or to ease transitions, but avoid needless
repetitions.
5. Delete unnecessary words and phrases, but avoid short cuts that sacrifice meaning.

Sentence Structure and Length


Technical writing should use the natural word order, simple sentence structure and good short sentences.
Since technical subject matter requires the use of complex, technical vocabulary and the expression of
complex ideas, the use of shorter words and sentences, simple in structures, will help a lot in the
readability of difficulty material.

Paragraph Structure and Length


In technical writing, the topic sentence should come first in the paragraph or at the very latest part after
whatever transitional sentences appear. Sometimes the writer does the opposite by giving the details at
the beginning and then concludes by stating the main idea. The use of one or more very short
paragraphs achieves an especially forceful effect. Scientific Attitude
Judicious weighing of evidence is very important in a technical report. The best evidence is one which is
the most ample, the most pertinent and the simplest in explaining the facts with the least additional

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.
15
evidence and most in harmony with the rest of the available evidence. The conclusion or recommendation
should include all evidences in which the judgement is made.
The technical writer must know when he would say enough, and not overwrite. As a writer of his
materials, he should know what to present, what to amplify, what to rewrite and what to emphasize.
Generalization
When the technical writer makes generalizations, he is giving probable conclusions derived from the
observation of factors. Since the report is based on generalizations, it is necessary to describe the
circumstances surrounding the report. Provide enough evidence, data and samples to enable the reader to
evaluate the generalizations for himself.
To be certain that you have followed ground rules and not “Jumping to conclusions”, test the
validity of your data and samples. Here is the suggested checklist (Nem Singh and Calixihan 1994)
1.Can I prove its accuracy?
2.Can I show the direct bond between the facts and generalizations?
3.Is it fact and not opinion?
4.Do I have all the facts?
5.Are they up to date?
6.Is the generalization verifiable? Would I get the same result it I do it again?
7.Is it significant?
The principles to be observed in organizing the material as cited by Alvarez (1980) are as follows:
1. To organize the material of a subject, first break it down into the component aspects.
2. To organize a report or paper, choose a suitable approach and make an outline that implements it.
3. The basic unit of organization is the paragraph.
4. Use these paragraphs to present related data, graphs to show trends and visual to clarify
description.
5. Plan a report or paper thoroughly before starting to write it.
6. Gather the necessary data through basic library research and primary services.
7. Write a first draft.
8. Revise and rewrite as often as necessary
9. Write a final draft
10. Place footnotes to acknowledge references and include a bibliography at the end of a report or
paper.

Other attributes of good technical report writing are:


1. appropriateness
2. functional
3. informative
4. factual

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.
16
5. efficient
6. correct

ACTIVITY 6!
Direction: In your own opinion, which is better to follow other’s style in writing or have your
own writing styles? Submit a position paper with a minimum of 300 words, computerize, double
space, and bond paper to be attached to your activity page of your Module and Microsoft word
for Online to be submitted in the CLMS.

Congratulations! May you flourish in your own writing styles or continue to be inspired honing
your prowess in writing your master piece as you face the 21st century world of work. Continue
to explore in learning the subject Technical Writing by moving to your next lesson Goodluck and
keep safe always!

Rubrics Points Score


Content 5
Organization 5
Relevance 5
Grammar 5

Lesson 7:ROLES of Technical Writing


Technical writing plays an important role both in business and academic fields. In the academic
field, the inclusion of technical writing in the curriculum has helped immensely in producing more
competent engineers, accountants, system analysis etc. Technical writing has also contributed to the
development of writing skills of would-be researchers. Savage, G. (2013) while discussing the rational for
adding technical writing to the Illinois State University English Department’s graduate curriculum posited
that “the course had two purposes: … to strengthen the professional credentials of master’s and doctoral
degree students preparing for academic careers”. In essence, it has assisted them in producing clear,
comprehensive, accessible, concise and correct write ups particularly in the course of writing research

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.
17
proposals, reporting research findings and discussing their methods for data collection and analysis.
Furthermore, exposure to technical writing skills has helped students in professional courses to writing
effective sentences and paragraphs using appropriate sentence Styles, organization of their thoughts into
coherent paragraphs. Above all, students are better placed to analyze their writing situations- audience and
purpose.
In the field of business, technical writing has also played an important role. This is evident in a
number of different applications which will be discussed below;
• Through technical writing, new products or ideas are pitched; this involves the use of clear and
concise language to persuade the audience to patronize a product or “buy into” their idea. To
successfully pitch a new product or idea, the writer must have a good knowledge of the product or
idea. He must also possess high degree of technical writing skill.
• Adhering strictly to the rules of Technical Writing has necessitated the production of clear and
concise documents which enables the factory workers to apply for the acquisition of a machine or a
product, giving detailed information on the purpose as well as the specifications of such product or
machine; the dimensions, individual parts, power source demonstrating the purpose for the
acquisition of the new machine or the introduction of a new product. Such documents would have
been very difficult for the desk officers to comprehend; however, the concise and simplified format
used in technical writing affords the reader the comprehension of the write up.
• It has also resulted in the development of an efficient and effective document for investors and
Management. An example of such documents is a manual for unveiling of new products. This is
particularly helpful for the end users, or home consumers. The role of technical writing in providing
manuals for various products is a major breakthrough in business. For example, putting together a
bicycle, pieces of furniture, or installing appliances may take some level of expertise. Without
proper directions, this may result in irreparably damage to the product. Technical writing simplifies
the process by providing a concise and systematic approach to this task.
• Technical Writing has also helped in the reduction of downtime or loss of man- hour. Through
the development of technical documents on the working processes of machines and equipment, loss
of man-hour is reduced.
• Technical Writing conveys information with a high degree of precision thereby persuading and
influencing the audience and spurring them to actions which ordinarily would have been very
difficult to engage in.
• Technical Writing facilitates the comprehension of hitherto complex ideas on professional writings
such as lab reports, projects, instructions, and diagrams, Memos, letters, reports, instructions,
résumés, web- pages, fliers, Power - Point presentations, e-mails, instructions, brochures and
newsletters.
• Technical Writing provides an impetus for the functionality and application of products and services
within each industry thereby enabling the engineers to carry out activities such as designing audio
equipment, electronic equipment and reporting in a more effective and efficient manner.

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.
18
• Technical Writing provides information on how to use a product. This enables the user to understand
the functioning of the product, placing him in a better position to handle, maintain, repair and
dispose the product correctly and safely.
• Technical Writing provides all the necessary safety information needed to use any product. This is
one of the most important roles played by technical writing in the field of business. It provides a
context to products and processes and allows them to be used safely and as intended.
• Technical Writing has also helped in the creation of online training for diverse learners through the
explanation of technologies, processes, and products in many formats, including print, online, and
other electronic means.

ACTIVITY 7!
Direction: Summarize the roles of technical writing through a graphic organizer. Submit your
computerize output, double space, and bond paper to be attached to your activity page of your
module and upload msword for Online in the CLMS.

Congratulations! Your able to make your summary through your graphic organizer and embrace
the roles of technical writing in advancing to your future career. Continue to explore in learning
the subject Technical Writing by moving to your next lesson Goodluck and keep safe always!

Lesson 8:Roles of the Technical Writer


A good technical writer possesses insights, perceptiveness, quick to determine probabilities and the
ability to adapt to requirements. He can identify developments that may affect his project.
The technical writer must understand the nature of his work. He should be able to help his principals
attain the target objectives. He must not only possess the technical writing ability and technical expertise,
he must also have the capability to grasp, analyze and interpret unexpected events and situations that
occurred during the writing of the technical report.
The technical writer should have the ability to state facts clearly and accurately to organize a variety of
elements into a unified structure, and to describe logical generalizations.

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.
19
Hallmarks of an Effective Technical Writer
The hallmarks of an effective technical writer is represented by this acronym REPORTER (Mosura and
Tenorio, 1999)
R - Resourceful
E - Energetic
P - Patient
O - Observant
R - Responsible
T - Trustworthy
E - Evaluative

ACTIVITY 8!

Direction: Based on the lesson, make your personal acronym about the role of the technical
writer. Submit a reflection paper with a minimum of 300 words, computerize, double space,
and bond paper to be attached to your Module and Microsoft word for Online to be submitted
in the CLMS.

Congratulations! Your able to accomplish your personal acronym and remember these roles
for your guide in developing your technical writing skills. Continue to explore in learning the
subject Technical Writing by moving to your next module. Goodluck and keep safe always!

Rubrics for acronym Points Score


Grammar 5
Content 5
Structure 5
Relevance 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.
20
III. INTEGRATION

ACTIVITY 1!

Direction: Discuss your realizations about the topics in relation to your chosen field. What life lessons
and values have you realized and learned from this module? Submit your output in a separate bond
(modular), minimum of 500 words, computerizeEssay and double space for both correspondence and on-
line learning modality to be attached to your activity page of your Module and Microsoft word for
Online to be submitted in the CLMS.

Rubrics Points Score


Content 5
Organization 5
Relevance 5
Grammar 5

Warm Congratulations! Thank you for reading your self-learning content and
for answering your activities. Till the next module!

Summary:

Technical Writing is a functional and result oriented form of writing which requires a lot of care.
Unlike the other forms of writing which derive their aesthetic value from the richness of the writer’s deftness
in the use of literary devices. Technical writing is more concerned with how best to put across a piece of
information to the reader. This is evident because technical writing is an applied communicative skill which
is used in relaying information relevant to any field or industry where complex ideas, concepts, processes
or procedures need to be communicated. It has been established that the ultimate goal of any technical
writing is to present information and thought in such a way that a sizable number of the audience would
accurately perceive what the writer had in mind. The good news though is that it is a rewarding exercise
because once a technical write up is effective, tangible results will be recorded.

Thank you! Now you are ready for the next module. Congratulations!

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.
21
REFERENCES:

Books:
Alcantara, Rebecca D. and Espina, Felicidad P. (2003). Technical Writing for Filipino Students. Makati
City: Katha Publishing Co…, Inc.
Casela, Nerisa C. and Cuevas, George Jeffrey M. (2010). Developing Technical Writing Towards Meeting
Academic Challenges. Mandaluyong City: Books Atbp. Publishing Corp.

Website:
Nancy, E. (2020). The Nature and Role of Technical Writing retrieved from
https://www.academia.edu/23211348/THE_NATURE_AND_ROLE_OF_TECHNICAL_WRITING

White, G. (2020). Characteristics of Technical Writing. Grammar.Yourdictionary.Com. Retrieved from


https://grammar.yourdictionary.com/style-and-usage/characteristics-of-technical-writing.html

Estanislao, M. (2019). Nature of Technical Writing. Scribd. Retrieved from


https://www.scribd.com/doc/80457026/Nature-of-

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.
22

You might also like