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

EL 108 TECHNNICAL WRITING PRELIMS

TECHNICAL WRITING Document design


Technical Writing uses highlighting
Communication written for and about techniques, such as graphics, headings,
business and industry, focusing on products subheadings, various fonts, white space,
and services: how to manufacture them, bullets, etc.
market them, manage them, deliver
them, and use them. Essays (not a factor)

technical writing is:


COMMUNICATION CONTINUUM
—an instructional manual for repairing
machinery. What is communication?
—a memo listing meeting agendas process of transmitting or exchanging
—a letter from a vendor to a client information.
—a recommendation report proposing
a new computer system What is Continuum?
-borrowed from Medieval Latin word
TECHNICAL WRITING VS. ESSAY “Continuus” or CONTINUOUS.
-something that keeps on changing slowly
Development over time
Technical Writing and Essay
Uses examples, Communication continuum
anecdotes, testimony, -the range of communication methods and
data, research channels used
-useful tool to categorized and understand the
Grammar type of communication we use.
Both important
Type of writing
Organization  Creative Writing
Technical Writing provides an introduction, The art of making things up (POEMS,
body and conclusion. PLAYS, STORIES)
-uses a subject line vs. a thesis and  Expressive Writing
itemization of point vs. transitional words Individuals write about their thoughts
-Uses topic sentences only when needed, and feelings (NARRATIVES &
dependent upon the type and length of DESCRIPTIONS)
correspondence  Expository Writing
Seeks to explain or expose
Essays provides an introduction, thesis (COMPARISON & CONTRAST,
statement, body paragraphs, transitional ANALYSIS, CAUSE & EFFECT,
words, and topic sentences ARGUMENTS, AND PERSUASION)
 Journalism
Style Used to report news stories in a
Technical Writing uses short, denotative variety of media formats
words; short sentences;  Technical Writing
and short paragraphs Type of writing about a particular
subject
Essay uses longer connotative words; longer
sentences; and longer paragraphs \
5 Components of Technical Writing Uses of Technical Writing
 Development
 Grammar • Technical Writing for Instructing
 Organization It is used to instruct people.
 Style • Technical Writing for
 Document Design Communication
It makes communication smoother possible
because it simplifies all the points.
NATURE OF TECHNICAL WRITING • Ensuring Consistency
It is used to secure consistency in operations.
The Society of Technical Communications • Promoting Products and Services
(STC) defines technical communication as a It is often used in marketing materials like
broad field that includes any form of brochures and flyers to promote products and
communication that is about technical or services
specialized topics, that uses technology such • Persuading Audiences
as web pages or help files, or that It persuades audiences to take action or
provides instruction about how to do support a particular idea or project.
something. • Technical Writing for arguing
to make valid arguments is to have the
“TECHNICAL” refers to specialized ultimate power in your hand
knowledge that is held by experts and
specialists.
5 TRAITS OF TECHNICAL WRITING
Characteristics of Technical Writing
CLARITY
CLARITY In writing, clarity refers to how easy it is to
Technical document must convey a single understand something. Among the five traits
meaning that the reader can understand. of technical writing, clarity is the most
important.
ACCURACY
Unclear writing can cause many problems Two Ways to Attain Clarity In Technical
and even inaccuracy in the report. Slightest Writing (Gerson, 2013)
error can confuse or even annoy the reader of
the report. 1. Reporter’s Questions:
Who: Audience
COMPREHENSIVENESS What: Action
When writing technically, all the information When: Timetable or Schedule
should be provided, its background must be Where: Place
described and clear description of any Why: Rationale
process, or method of carrying out a specific How: Process
work, should also be given 2. Specificity

ACCESSIBILITY CONCISENESS
It means the ease with which the readers can Being clear and does not include
locate the information they seek unnecessary or vague words or language.

CONCISENESS Ways To Achieve Conciseness


Free from excess verbiage • Use short words.
• Use short sentences.
• Avoid redundancy, prepositional
phrases, and passive voice.
ACCESSIBILITY 5-TRAIT RUBRIC
The ease of which the readers can locate the
information they seek.

AUDIENCE RECOGNITION
Effective technical writers understand that
they can only attain clarity by recognizing
their audiences. Basically, you will write to
either High Tech Peers, Low Tech Peers, or
Lay Readers. Writing effectively to these
three types of audience levels requires
different techniques.

High Tech Peers know just as much about a


subject as you do. They have the same
education, same job title, same level of
expertise, and the same years of experience.

Low Tech Peers who work inside your


company know something about the subject.
They may not have the same education, job
title, level of expertise, or years of
experience.

Lay Readers are your customers. They are


completely out of the loop.

ACCURACY
Successful technical writing must be
accurate, whether grammatically,
electronically, etc.
• Use your computer’s spell check—
remember, however, that a spell
check will not catch from if you mean
form, too if you mean to, or accept if
you mean except.
• Let it sit—for days or weeks. When
your document is icy, you are more
objective about your own writing.
• Use peer evaluations—others will
see the errors you miss.
• Read it aloud—sometimes, you can
hear errors.
• Read it backward—then you read
words out of context. You cannot
anticipate the next word

You might also like