Understanding The Nature of Technical Writing Lesson 1 To 3

You might also like

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 3

1 | Technical Writing Reviewer (CHAPTER 1)

Understanding the Nature of Technical Writing  Instructional manuals are written to guide the
readers on how to assemble, maintain, and operate
LESSON 1: What is Technical Writing? an apparatus, machine or gadget.

According to Mills and Walter (1981)  Brochures are pamphlets or flyers that endorse a
product in such a way that the potential customer
Technical writing will be convinced that the product is effective and
eventually avail of the product.
o is writing about scientific subjects and about various
technical subjects associated with the sciences.  Proposals are written suggestions on how to make
the company or organization more productive and
o characterized by certain formal elements, such as its successful. Most companies and organizations
scientific and technical vocabulary, its use of require this before an agreement is reached.
graphic aids, and its use of conventional report
forms.  Memoranda are inter-office written communication
used to disseminate information.
o characterized by the maintenance of an attitude of
impartiality and objectivity, by extreme care to FIVE IMPORTANT PRINCIPLES in GOOD
convey information accurately and concisely, and by TECHNICAL WRITING
the absence of any attempt to arouse emotion.
1. Always have in mind a specific reader, real or
o there is relatively high concentration of certain imaginary, when you are writing a report. Always
complex and important writing techniques, in assume that he is intelligent, but uninformed.
particular description of mechanisms, description of 2. Before you start to write, always decide what the
process, definition, classification, and interpretation. exact purpose of your report is, and make sure that
every paragraph, every sentence, every word makes
These are the products of technical writing: a clear contribution to that purpose.
3. Use language that is simple, concrete, and familiar.
 A business letter is a type of written 4. At the beginning and end of every section of your
communication. It is written using formal language report, check your writing according to this
and follows formal elements of letter writing. People principle: "First you tell the reader what you're going
usually write business letters to communicate with to tell him, then you tell him what you've told him."
companies, organizations or individuals with the 5. Make your report attractive.
purpose of applying for a job, making requests,
seeking appointments, etc. Purposes of technical writing

 Contract is a written agreement between two people 1. It serves as basis for management decision.
under mutually agreed terms. 2. It furnishes needed information.
3. It gives instructions.
 Monograph is a detailed essay or book on a very 4. It records business transactions through proposals.
specific topic. It is usually written by professionals 5. It procures business proposals.
or academicians on topics of interest concerning 6. It serves as basis for public relations.
their specific fields. 7. It provides report to stockholders of companies.

 Printed action memo is a ready-format


memorandum that only requires a checkmark on the Properties of technical writing/considerations when
appropriate box that contains the message. This is writing technical reports
especially useful for busy people who need to make
quick decisions and act on the circumstance or 1. Subject matter. In writing technical papers, you
situation. must ask the question, "What will I write about?"

 Graphic aids are drawings, sketches and The subject matter is an essential element in technical
illustrations that aid the readers in understanding the report writing. Some examples of this are description of
presented data. a process, writing about a theory, or submitting a policy.

2. Audience. When thinking about the audience, ask


"Whom am I writing for? Or who are my intended
2 | Technical Writing Reviewer (CHAPTER 1)

readers?" This is a property which pertains to a 2. Trademark law pertains to federal protection
particular reader of a technical literature. (different from registered trademarks).
3. Contract law warranties. covers written warranties
3. Expression. This property refers to two basic or their implied
modes in which a technical report has to be 4. Liability law pertains to responsibilities or
delivered-writing it or reading it. Your expression of obligations of writers especially claims they made
the content will depend on your awareness of your on their paper.
audience's reader's psychology and your style in
writing to be able to reach your audience's/ reader's Principles of Ethical Communication
understanding.
Do's of Technical Communication
4. Style. This refers to how the material is written. A
technical writer uses clear, specific point of view,  Abide by relevant laws.
objective,  Abide by the appropriate corporate or professional
5. impartial, and unemotional style in writing. code of conduct.
 Tell the truth.
6. Arrangement of materials. This pertains to how  Be clear.
ideas should be organized in chronological, spatial  Avoid discriminatory language.
or logical order, from general to specific or specific
 Acknowledge assistance from others
to general, and use illustrations to present the
information.
Don'ts of Technical Communication

Five basic types of writing:


 False implications - assuming the outcome of a
project or making sweeping generalizations.
 Technical writing conveys specific information
 Exaggerations proportions. expressing situations
about a technical subject to a specific audience for a
in extreme
specific purpose.
 Euphemisms writing about situations in seemingly
 Creative writing is fiction-poetry, short stories,
good conditions even though they are not.
plays, and novels and far different from technical
 Don't mislead your readers.
writing.
 Expressive writing is a subjective response to a
LESSON 3: WRITING PROCESS.
personal experience journals and diaries whereas
technical writing might be objective observations of
Three basic stages:
a work-related experience or research.
 Expository writing "exposes" a topic analytically
 Pre-Writing Stage
and objectively, such as news reports. Like technical
writing. the goal of expository writing is to explain
This is the first stage in the writing process. It is what
or reveal knowledge, but expository writing does not
the writer does before he writes the first draft.
necessarily expect a response or action from the
reader.
In this stage, the writer composes or supplies
 Persuasive writing depends on emotional appeal. information pertaining to:
Its goal is to change one's attitudes or motivate
him/her to action. Technical Creative Writing
Writing
Differences between Technical Writing and Creative
Writing Content factual, straight- imaginative,
forward metaphoric or symbolic

Audience specific general

LESSON 2: Legal and ethical considerations relevant Purpose inform, instruct, entertain, provoka,
to technical writing persuade captivate

Style formal standard, informal, artistic,


Legal and ethical considerations when preparing
academic figurative
technical papers.
Tone objective subjective
1. Copyright law covers the protection of the rights of
the author Vocabulary specialized general, evocative

Organizatio sequential, arbitrary, artistic


n systematic
3 | Technical Writing Reviewer (CHAPTER 1)

 here is organization and coherence in the


A. Purpose of the paper. This is necessary to arrangement of the ideas, and
determine the content of the paper to be included,  grammar and mechanics are clearly observed
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:

1. Keep a writer's journal by recording personal


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

Do's and Don'ts of Writing a First Draft

 Don't overanalyze your writing.


 Do feel free to follow the flow of ideas where it is
leading you, even if it is not what you initially
planned.
 Don't exaggerate details.
 Do work on the details as much as possible to keep
the story fresh in your mind.
 Don't worry yet about how good your writing is.
 Do have fun!

 Re-Writing Stage

This stage is also known as the "revision" stage. We


revise to ensure that:

 the content of the paper is relevant;

You might also like