Module Technical Writing
Module Technical Writing
TECHNICAL
WRITING
In the most elementary terms, technical writing can be broken down into two parts,
or aspects: (1) the end products, the concrete package that is delivered;(2) the skills that
enter the preparation of the product.
1. Business Letters
2. Instructional Manuals
3. Various kinds of reports
4. Handbooks
5. Articles for technical journals
6. Brochures
7. Abstract
8. Proposals
9. Oral reports
10. Memoranda
11. Graphics aids
12. Specification
The skills which deserve particular attention are the following:
Activity 1: Discuss some ideas by answering the following questions. Explain and/or give
examples.
1. What other types of writing would be considered under technical writing?
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
2. What other considerations can you give before writing a technical paper?
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
3. Are there other properties of writing that you can add to make a technical
writer?
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
4. An effective one? Briefly explain your answer.
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
5. Aside from the purpose given about technical writing can you think of other
purpose which can add to the list?
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
6. Are your more inclined in technical writing or creative writing?
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
______________________________________________________________________________
Activity 2: Reflect on the following situations. What will you do if you are faced with any
one of them? (Do not forget to use the principles of ethical communication)
a. You are the boos of a company. You received a report about missing milk boxes
in the shipment from one of your employees who made an inventory. Your
company ordered 150 boxes, but two boxes were missing.
b. You are in a hurry to submit the proposal for a very important meeting. However,
your fellow employee who is the main proponent forgot to sign the proposal. It is
2:50 PM and the paper has to be submitted by 3:00 PM. What will you do?
c. An attendance sheet is being passed around in the seminar room. You were asked
to write your purpose for attending because it is about professional development.
What will you write?
Let us review some of the things that we know when it comes to the WRITING
PROCESS. There are three basic stages:
Pre-Writing Stage
This is the first stage in the writing process. It is what the writer does before he
writes the first draft. In this stage, the writer composes or supplies information pertaining
to:
a. Purpose of the paper. This is necessary to determine the Content of the paper to
be included, the organization and style of the paper.
b. Choice of topic. A writer has to explain or justify his/her chosen topic.
c. Gathering information. A writer must be able to find sources of information to
enrich his/her topic.
Pre-writing Techniques:
Below are some techniques which will help you get Started in writing: Keep a
writer's journal by recording personal
1. experiences, perceptions, and ideas.
2. Do free writing. Write about whatever comes to mind.
3. Brainstorm by listing ideas as quickly as they occur.
4. Cluster by drawing lines and circles to show connections between ideas. It is
also called webbing or making connections.
5. Ask questions using the news reporter's 5Ws -Who? What? Where? Why? When?
and How?
6. Read with focus. This entails reading efficiently to locate and collect specific
information.
7. Listen with focus. This means listening efficiently to locate and collect specific
information.
8. Observe by noticing details around you through the senses.
9. Imagine. Probe your imagination for ideas, often use a "what if? approach.
Writing Stage
The writing stage is the part where we begin to write our first draft. We know that
not everything that we write is perfect at the first go. Hence, you must remember what
to do and what not to do during this stage.
Activity 3: Write a short essay of about two hundred (200) words about the three reasons
why you have chosen to enroll in your program and elaborate by explaining or
giving examples. Remember the pointers in each writing phase. Use the margins
on your paper to mark which of the pointers you followed in each phase (pre-
writing, writing, and re-writing). You may use another sheet in this activity.
Chapter 2: Exploring Expository Techniques
Lesson 1: Classification
Classification is done by the writer when he/she believes that there are shared
qualities or characteristics about a subject matter. Take for example the passage below:
One way of classifying objects or ideas is to look for Relationships among them
and to organize them into groups. It may either be based on their similarities or
differences.
Try to find the similarities or differences of the words listed below by classifying
them into identifiable categories. Be ready to explain why you grouped the words in
those categories.
Next, write a brief description of the information contained in the diagram. Begin
it this way:
There are times when we are asked by people around to dine or give meaning
to an unfamiliar word. How do you reply? Do you find yourself saying "it is like this..." "it
resembles reply? Do you find that..."it is Similar to...?”
When we define words or unfamiliar terms, we give concise hut exact meanings
of unfamiliar words and special meanings of familiar words. For people of all ages,
definition is a useful technique in oral or written communication. It is particularly a must
for a technical writer to be able to define the terms with multiple meanings and those
that are unfamiliar to the reader.
Species
Example:
Activity 4: In your chosen field, list down five terms and define each term using formal
definition. List another five terms and define each term using informal definition.
Write your answer on a clean sheet of paper.
Lesson 3: Description of Process
There are writing tasks that entail an explanation of how something works, how
something is done, or how something is made. That is why knowing how to describe a
process will enable a technical writer and his/her reader to perform or do something.
There are two separate concepts which we must briefly explain here: "How to
do something'" and How something occurs. The first calls for instructions or procedure; the
second, for sequence.
When describing a process, we use sequence markers to link Sentences like first,
second, then, next, subsequently, finally, at last.
Now, let us read the passage on "How do you make paper from a tree? It is an
article written by Stacy Wonders published in wonderpolis.org.
We may belong to different fields and disciplines but there are Certain
machines or apparatuses that we use to make our work easier, Description of a
mechanism is an explanation of a system or parts or an apparatus. This includes the
characteristics and functions of a piece of the device and the totality of the mechanism.
Below are examples of machines and how they work. Read the passages and
perform the activities that follow.
Activity 6: There are among us visual and imaginative learners. Based on the description
of How the Refrigerator Works and How Rice Cookers Work, draw a diagram to
illustrate how the mechanisms work. Use lines and arrows, if necessary. Add
short descriptions or captions to make each part of the diagram
understandable.
Chapter 3: Writing Effective Business Correspondence
Communication in Business
Effective communication is the key to success in business. That is why business
depends so much on communication. People must communicate to plan products;
hire, train, and motivate workers; coordinate manufacturing and delivery; and bill
them for sale (Locker, 2006).
Communication in business is a two-way process that follows the common
communication process sending and receiving process. However, business
communication differs on the medium for it uses paper, pen, typewriter, or computer
to make message tangible to the receiver.
An organization is comprised of people who are committed to a common goal
and are ready to share information and resources in pursuit of a desired goal.
Communication in organization is relaying messages or information between or
among people inside or outside an organization.
Communication in Organization
There are several written documents needed to run an organization. Every single
document has one or more of the three basic functions of organizational writing which
is to inform, to promote goodwill, or to persuade.
The following internal and external documents are some of the specific
documents needed in an organization ( Adopted from Locker, 2006):
Quotation Letter giving price for a specific Inform; promote goodwill (price
product, fabrication, or service. reasonable)
Business Letters
Business letter is a formal type of written Concerning business transactions and other
business related sues and information. This kind of letter must adhere to certain rules,
restrictions, and format and must use a formal language. In addition, an effective
business letter should sound like a person talking to another person.
The Business Communication page posted eleven (11) comparisons of personal letter
and business letter.
1. Nature: Business letter or impersonal and universal in nature. Personal letter is fully
personal in nature.
2. Purpose: Business letter is exchanging various business-related issues and
information. Personal letter is exchanging personal or family-related affairs and
information.
3. Scope: Business letter scope is wide and contains various types of business
information. Personal letter scope is limited and contains only personal
information.
4. Structure: Business letter follows officially recognized structure. Personal letter does
not follow recognized structure.
5. Formality: Business letter maintains formal rules and procedure. Personal letter is
informal.
6. Size: Busines letter generally is concise in size and avoids irrelevant matter. Personal
letter may be concise or large.
7. Types: Business letter can be categorized differently. Personal letter generally
cannot be categorized.
8. Salutation: Business letter salutation can be Sir, Dear Sir, Dear Mr. X, etc. Personal
letter salutations are Dear Friends, my dear x, dear x, etc.
9. Language: Business letter language should be easy and simple. Personal letter
language may be easy, poetic, emotional etc.
10. Copy: Business letter copy of business letter should always be preserved. Personal
letters copy of personal letter may or may not be preserved.
11. Method: Business letter uses direct and persuasive method. Personal letter uses
only direct method.
The Techniques of Writing Business Letters
To make your letters effective in terms of today's business world, you should
understand and make use of four basic psychological techniques according to
Mager and Mager (1968):
1. Write from the "you attitude. Every person is interested primarily in himself
and thus responds to a letter written from his point of view. To test the
effectiveness of your letter on this point, count the number of I's and you's in
your letter and them compare. A good letter should have a preponderance
of you's and a minimum of ls. But more than this, your letter should have the
reader's viewpoint in mind throughout the text.
Compare:
You: Thank you for your assurance that you had sufficient information for the
completion of your order.
2. Accentuate the positive, even a letter that has to say No can be written
from a positive point of view. Make it an absolute rule never to start or end
your letter with a negative. Whenever possible, avoid words with a negative
connotation, Such as argument, careless, Complaint, disagreeable, error.
neglect, and unfair.
Compare
Positive: Thank you for your order. The merchandise will go out to you as
soon as...
Negative: We regret to inform you that we will not be able to ship your
order until...
3. Make your letters smile. A business letter should leave a pleasant impression.
Get a smile into your letter, a bit of your personality, an atmosphere of good
will. A sour letter, piqued attitude, complaining under tone is comparable to
a surly manner in your conversation.
Some phrases have a built-in smile. Here are some friendly phrases that you
can and should use freely:
4. Make your copy live. The reader should feel what you say, If possible, create
a visual experience. Let the reader see himself doing something-running a
machine, telling his friends about his triumphs, selling more accounts,
reinterpreted the same copy.
Activity 2: Compare and contrast personal and business letters using the Venn diagram
below.
Say: now
Say: before
Say: join to
4. Coherence refers to the smooth flow of ideas in a business letter. The content of a
business letter should be in order and easy to follow. Some of the devices that you
may use to achieve coherence are use of synonyms, use of transitional words, use
of pointers, use of repetition of words, and use of sentence patterns.
5. Clarity refers to readability of information which is easy to understand. We should
bear in our minds that simple Words are more preferred than complex ones.
6. Concreteness refers to the use of specific words not general words.
Example:
Say: profit
Example:
Instead of saying: We are glad to offer you the best services.
Say: You will be pleased to find must-try services
in our branch near you.
9. Consistency refers to the uniformity of the time and style of the writer of a business
letter.
10. Credibility refers to the personality of the writer as himself which might reflect on
his writings.
The sender of the letter is the one who is writing it. It is one of the protocols in
business writing that the receiver of the letter should be known by the sender. The
complete name, position, as well as the address of the receiver should be included in the
letter. The sender or writer must be also knowledgeable in basic grammar, punctuation,
spelling, and mechanics skills so that he might build a good impression to the receiver of
the letter.
Activity 4: Construct your own communication process. You may add more element/s if
necessary.
1. What advice will you suggest to the reader when decoding the message of the
letter?
2. What will your feel if the writer of the letter failed to include your complete name
on the letter?
3. Among the characteristics of a business letter, which do you think is the most
important? Why?
Lesson 4: Basic and Optional Parts of a Business Letter
This part contains the month, day, and year when the business letter was
written. There are certain rules in writing the correct dateline:
a. You should riot use abbreviations when writing the dateline. For
example, 10-13-92 or 10-13-1992 or 10/13/92 or Oct. 13, 1992
b. You should not include st, nd, or th after the day of the month. For
example, September 1st, October '2nd, or November 3rd.
c. You may use the conventional style, January 15, 2007 or the military
style, 15 January 2007.
3. Inside Address
This part consists of three, four or five lines which include the complete
name as well as the job title/s of the receiver on the first line) the complete
position of the receiver on the second line, the complete division or
department of the receiver on the fourth line, and the complete name of the
company or organization followed by the complete address of the company
or organization.
There are certain rules that are worth considering in writing the inside
address:
a. The inside address is like the address written on the envelope.
b. You use Miss when addressing a single woman, Mrs. of married woman.
If the status is not known, use Ms. If the firm is comprised of women; use
Mesdames or its abbreviation Mmes.
c. Use Mr. in addressing a man. You may also use its plural form Messieurs
(French) or its abbreviation Messrs.
d. d. You may abbreviate the title Doctor to Dr.
e. e. The title Reverend should not be abbreviated, and it should be
preceded by The.
f. f. You may or may not abbreviate the title Professor. g. Company or
organization positions such as Supervisor, Manager, Secretary,
Superintendent, Proprietor or even President may either precede or
follow the name of the receiver of the letter.
g. h. The title Honorable is used by Judges of the Court, Members of the
Cabinet Congressmen, Senators or other government officials who hold
an important position and office in the city, province, or country. You
may or may not abbreviate the title Honorable.
4. Salutation
It is composed of the word "Dear" followed by the last name of the receiver
of the letter. Use the colon (American English) at the end of the salutation or
comma (British English).
5. Body of the Letter
This consists the message of the writer.
6. Complimentary Close
This is sometimes called closing, the part where sender says goodbye to the
receiver of the letter in a formal way.
7. Signature Line- This is composed of the complete typewritten name of the
writer and his official designation' or the name of the company.
Or EAG: go
2. Class Records
3. Anecdotal Records
5. Copy Notation
This consists the names or department of other people who also
received the letter.
a. Carbon Copy Notation (cc) -- This notation is indicated on the
original copy and all the duplicate copies.
For example: cc: Mr. John Paolo Sarce
Human Resource Department
b. Blind Carbon Copy Notation (bcc) This is a notation not indicated
on the original copy but indicated on all duplicate copies.
This format uses comma (British Style) or colon (American Style) after
the salutation and uses comma after the complimentary close.
Activity 7: Compare the different styles of business letters by answering the table
below, then answer the questions given.
Full Block Style Modified Block Semi Block Simplified Style Hanging
Style Style Indented Style
1. Which among the different business letter styles is the easiest to use? Why?
2. Which do you think is the most common style that the businessmen are using?
Discuss your answer.
3. If you are going to implement one general format or style in your company, what
will it be and why?
Lesson 6: Types of Business Letters
1. Application Letter
Functional Resume focuses on skills rather than on employment history. This style
is ideal for those who are fresh graduates seeking for their first job.
2. Letter of Inquiry
It is a letter that asks for a particular information or assistance. This type of
business letter is direct, and the questions are constructed to get the information
straightforwardly.
In writing a letter of inquiry consider, the following guidelines:
First Paragraph: Begin with the most important question or a summarizing
statement.
Second Paragraph: This part may contain the explanation or list of questions.
Third Paragraph: The ending should tell the reader what you want to be done
and when.
3. Letter of Response
It is written in response to a letter of inquiry which directly answers all the inquiries
regarding company's products or services. As part of business as usual, most
companies promptly reply to all the inquiries addressed to them.
In writing the letter of response, the following steps may help you:
First Paragraph: (orientation) This is the introduction part where you begin with
the details of the event or any activity. The date, time, and venue should be
also indicated.
Last Paragraph: (Action), Thank the person in charge to promote good will.
5. Letter of Order
It is one type of business letter which is written for the purpose of purchasing
items that are for sale.
An order letter according to Rosales et al (2009) usually contains the following:
a. Name of the item ordered
b. Description of each item, giving size, style, finish, quality, material,
weight, or whatever will help in identifying the article wanted. c.
Catalog number of the item, if it is available
c. Quantity of each item wanted
d. Price of each item and the total price of the order
e. Method of shipment desired by the buyer
f. Address where the goods are to be shipped or delivered
g. Date of shipment
h. Credit references if payment is made from an account
i. Mode of payment
Activity 8: Name your top three dream companies and dream jobs. Write an application
letter for each company. Attach your sample application in this section.
Sample 1:
Sample 2:
Sample 3:
Lesson 7: Writing Memoranda
Memo is one of the most frequently used words in the corporate world.
However, some employees are still confused on what a memo is. Due to lack of
knowledge and background about the definition and contents of the word “memo,”
sometimes, it denotes something negative especially if you will learn that it came from
your superiors.
Memo as defined by Collins Dictionary is a short official note that is sent by one
person to another within the same company or organization to remind the recipient. It is
a clipped or shortened term for memorandum. It is one type of business correspondence
together with business letters, contracts, certifications, and endorsements which is written
for the purpose of effective management.
A memorandum, just like any business correspondence must consist of the following
basic elements:
Heading — most of the time, companies create their own heading
Dateline — the actual date when the memorandum is issued
Number — refers to the frequency of the issued memos
Receiver — the person whom the memorandum is to be sent.
Sender — the person who issued the memo
Subject — the topic or title of the memo
Enclosure — an optional part which includes the attachments
First, you should take some time to prepare and plan for your report. Before
you start writing, identify the audience. Your report should be written and tailored to
the readers' needs and expectations. When planning, ask yourself several questions
to better understand the goal of the report. Some questions to consider include:
The first page of the report needs to have an introduction. Here you will
explain the problem and inform the reader why the report is being made. You
need to give a definition of terms if you did not include these in the title section
and explain how the details of the report are arranged.
4. Body
This is the main section of the report. The previous sections needed to be
written in plain English, but this section can include technical terms or jargon from
your industry. There should be several sections, each clearly labeled, making it
easy for readers to find the information they seek. Information in a report is usually
arranged in order of importance with the most important information coming first.
Alternatively, you might choose to order your points by complexity or time.
5. Discussion
If you wish, this optional section can be included at the end of the main
body to go over your findings and their significance.
6. Conclusion
This is where everything comes together. Keep this section free of jargon as
many people will just read the summary and conclusion.
7. Recommendations
This is where you discuss any actions that need to be taken. In plain English,
explain your recommendations, putting them in order of priority.
8. Appendices
This includes information that the experts in the field will read. It has all the
technical details that support your conclusions.
Four Fundamentals of Report Writing
KISS Principle
It is an acronym for KEEP IT SHORT AND SIMPLE. This concept highlights the use of
simple but concise words rather than the use of jargons and complex words. This
concept emphasizes expressing rather than impressing.
Quoting is the exact copying of a portion of an original text. In doing this, certain
punctuations must be observed In Paraphrasing, you will need to use your own words
in restating author’s idea or words. In doing this, the same number of words like the
original is observed. Summarizing is recapitulating author’s ideas or words. This is
shorter restatement of the original text in your own words. Lastly, these three need to
be documented properly.
Graphic organizers are visual charts and tools used to visually represent and
organize a student's knowledge or ideas. They're often used as part of the writing
process to help students map out ideas, plots, character details and settings before
beginning to write.
Graphic organizers also are useful when brainstorming ideas, especially as part of
a group project or plan. They can be used for a variety of educational purposes,
including sequencing events, analyzing cause and effect, comparing, and
contrasting, and developing concepts in detail.
These are ethical practices used in developing your report. These are the proper
acknowledgement of references, or sources that you used. It is composed of the
author’s last name and the date of publication placed withing parentheses.
1. For you, which among the fundamental concepts in writing a report is the most
important? Why?
2. Why do you think skills in report writing important? Explain your answer.
Lesson 2: Classifications of Technical Report
In the workplace, the report plays an important role, whether you are
preparing one tor your supervisor, the executive staff, board of directors, or clients. It may
be short and simple, in the form of a memorandum or email, or it may be more several
pages long. Whatever its length, content, or destination, is the result is the same: a report
must be informative, factual, understandable, and neatly presented (Oxford Dictionary).
Even though there are several types of business reports, having a standard
business report format, according to Custodio et al. (2013), allows the reader to locate
easily the important information presented. It also enables the writer to organize the
report effectively and logically. Knowing how to write a business report is necessary in the
business world
Article Report - is a simple report which aims to inform the masses. This report
focuses on any general interest. This is like the magazine article we read on
regular days.
a. Introduction
b. Problem
c. Purpose, Objectives, and Scope
d. Review of Literature
e. Materials, Equipment and Facilities
f. Theory, Methods, and Procedure
g. Results, Findings, and Data
h. Discussion, Conclusions, and Recommendations
i. Bibliography
The general format of a research report commonly includes the following:
I. Transmittal Letter
II. Title Page
III. Table of Contents
IV. List of Figures
V. List of Tables
VI. Abstract
VII. Introduction
VIII. Background
IX. Purposes Objectives, and Scope
X. Review of Literature
XI. Machines, Equipment, and Facilities
XII. Theory, Methods, and Procedures
XIII. Results, Findings, Data
XIV. Discussions, Conclusions, and Recommendations
XV. Bibliography
a. Introduction
b. Technical Background
c. Make Comparisons
d. Critical Requirements
e. Conclusions
f. Recommendations
Incident Report- it is written to narrate incidents prior to, during, and after a
situation suddenly occurred. we should bear in mind that incident report is
different from narrative type of essay. The presentation of ideas in an incident
report is systematically arranged and organized using appropriate language.
This kind of report uses simple and clear words and avoids using jargons and
technical terms.
Activity 12: Discuss the importance of each content of research writing report.
1. Introduction
2. Problem
3. Purpose, Objectives, and Scope
4. Review of Literature
5. Materials, Equipment and Facilities
6. Theory, Methods, and Procedure
7. Results, Findings, and Data
8. Discussion, Conclusions, and Recommendations
9. Bibliography
Every company has its own format or template for minutes of the meeting. The
template depends on how the companies use the document. Here are some of the
essential and general parts of the minutes of the meeting.
Heading contains the complete name and address of the company. Every
company has its own template for heading. Sometimes, company contact number and
e-mail address are included in this part.
Title of the Meeting includes the date, date, and starting of the meeting. Also,
the venue or location of the meeting is included.
Attendance is the complete list of names of all the attendees of the meeting.
Most of the time, the attendance of the meeting is listed on a separate sheet of paper
that is being attached to the minutes of the meeting.
Present is the complete list of names of all those who are present at the
meeting.
Regrets is the complete list of names of those wh0 have contacted the
chairman or presider to let them know that they will be unable to attend the
scheduled meeting.
Absent is the complete list of those who are absent at the meeting.
Usually, the attendance of the meeting is being checked, monitored, and
approved by the corporate secretary. The general rule in establishing the quorum of the
meeting is half plus one of the total numbers of the attendees.
Call to Order consists of the exact time of the scheduled meeting. Moreover,
in this part, the complete name and position or designation of the one who set the
meeting is stated. You may refer to the Notice of Meeting for the details needed in this
part.
Business Arising from the Previous Minutes of the Meeting includes some
agenda from the previous meeting that are needed to be reviewed and needed to take
immediate action.
New Business refers to the agenda of the meeting. You may refer to the Notice
of the Meeting to follow the flow of the agenda of the meeting. Other agenda that are
not listed may be added in the other matters. This is the heart of every minutes of the
meeting. This part should be carefully written. Every detail should be included and
specified so that nothing will be overlooked.
Activity 14: Choose and listen of an executive meeting. Write minutes of meeting about
the video you have watch.
Rosales M. J., Galano E., Rivera J. A. (2019). Technical Writing: Resource Guide to Writing
Across Disciplines. Lorimar Publishing INC. ISBN 978-621-8035-56-0