Technical Writing 1
Technical Writing 1
e g Expressi
TECHNICAL WRITING ve
- communication written for and about words,
business and industry, focusing on products fictional
and services: charact
a. how to manufacture them, ers,
b. market them, manage them, imagery
c. deliver them, and , and
d. use them plots
- must be understood easily and quickly Expres Narratives, Seubjec
- Includes: memos and e-mail, letters, sive Descriptions tive,
reports, instructions, brochures and Writin based
g on
newsletters, the job search, web pages,
persona
fliers, PowerPoint presentations, graphics.
l
TECHNICAL WRITING IS… experie
a. an instructional manual for repairing nce,
machinery connota
tive and
b. a memo listing meeting agendas
expressi
c. a letter from a vendor to a client
ve
d. a recommendation report proposing a words
new computer system Connota Exposi Comparison/ Objectiv
TECHNICAL WRITING IS NOT… tive and tory contrast, e,
Denotati Writin analysis, connota
a. not literature; it’s neither prose which ve g cause/effect, tive and
recounts the fictional tales of characters argument/per denota
nor poetry which expresses deeply felt, suasion tive
universal emotions through similes and words
metaphor. Journa News stories, Objectiv
b. neither an expressive essay narrating lism features, e,
editorials written
an occurrence nor an expository essay
from
analyzing a topic
factual
c. not journalism, written to report the
observa
news tion,
d. does not focus on poetic images, short
e. describe personal experiences, or sentenc
report who won the basketball game es and
paragra
COMMUNICATION CONTINUUM ph,
Type Examples Traits some
of connota
writin tive but
g more
Connota Creativ Poems, plays, Connot denota
tive/ e stories ative
tive letters, or reports, you won't find a thesis,
words but you'll see a subject line instead.
Denotati Techni Memos, Objectiv - Paragraphs are shorter in technical writing
ve/ cal letters, e,
Objectiv Wiring reports, written 4. STYLE
e instructions, about - Essays and technical writing use different
resumes, web product styles, including word choice, sentence
pages s or
structure, and paragraph length.
services
- Essays typically use longer, more expressive
, short
sentenc words, complex sentences, and detailed
es and paragraphs. In contrast, technical writing
paragra uses shorter, more straightforward words,
ph, simple sentences, and brief paragraphs. It's
denota all about meeting the needs of the audience
tive and the purpose of the writing
words
5. DOCUMENT DESIGN
- Refers to the physical layout of the
correspondence.
- Essays consist of words, words, and more
words, separated by indentations to create
paragraphs. Technical writing, in contrast,
uses highlighting techniques and graphics
for visual appeal to help the reader access
and understand the data
FIVE COMPONENTS OF TECHNICAL WRITING FIVE TRAITS OF TECHNICAL WRITING
1. DEVELOPMENT 1. CLARITY
- process of expanding and enriching your - Achieved through specificity
essays or documents by incorporating - The key to good technical writing is clarity.
traditional methods such as examples, - If your audience reads a memo, letter,
anecdotes, testimony, data, and research. report, or manual and says, "Huh?" it means
These techniques serve to support your the writer hasn't achieved much. If the
ideas, strengthen your arguments, and information isn't clear, readers might either
provide clarity to your writing. call for clarification or just ignore it. In both
cases, the writer's time and the reader's
2. GRAMMAR time are wasted, and the message is lost
- Good grammar is important in essays, but
it's even more crucial in technical writing. Example #1: Your company has written an
installation manual for product. The manual,
unfortunately, is not clear. When the reader
3. ORGANIZATION
fails to understand the content, 3 negatives can
- Essays have topic sentences, transitions
occur:
between paragraphs, and a thesis
statement. In technical writing, like memos,
BAD — The equipment is damaged. This Conciseness achieved through short sentences.
requires the owner to ship the equipment back.
You can shorten a sentence by avoiding:
The company will replace the equipment, costs
accrue, and public relations have been frayed. a. Avoiding Redundancy
- Why say, “The used car will cost the sum of
WORSE — The owner is hurt, leading to pain,
$1,000.00”? It is more concise to say, “The
anxiety, doctor’s bills, and bad public relations.
used car will cost $1,000.00.” In this
EVEN WORSE — The company is sued. The instance, “the sum of” is redundant.
company loses money, the writer of the manual
loses a job, and public relations are severed.
b. Prepositional Phrases
- Prepositional phrases create wordy
sentences. Consider the following examples
2. CONCISENESS (note that the prepositional phrase is in
- Do you understand this letter? bold type):
- Do you remember what you read?
- Did you even finish reading it?
- It is a tool (in technical writing) for the
readers used to accomplish whatever job
they are doing.
- In contrast to traditional essays, effective
technical writing uses short words and
short sentences
- Successful technical writing tries to avoid c. Passive voice
multisyllabic words such as “mul-ti-syl-lab- - Weak for at least two reasons: (1) they are
ic.” wordy and, (2) they replace strong verbs
- Some multisyllabic words cannot be with weak verbs
changed but can be avoided
a. High Tech Peers Communicating ii. Let it sit for a day or a weekend, review.
- know as much about a subject matter as
you. iii. Use peer evaluations, others will see the
- They have the same job title, same errors we miss.
education, same years of experience, and
the same level of expertise. iv. Read it aloud, sometimes we can hear
For example, a medical doctor writing to errors.
another medical doctor would be writing High
Tech to High Tech v. Read it backwards, then you read words
out of context. You cannot anticipate the
next word
b. High Tech and Low Tech Peer
- who work in your company know
something about the subject matter.
- They may not have the same job title,
education, years of experience, or level of
expertise.
3. Any MODIFIER THAT COMES BETWEEN THE CORRECT: Bikers are a threat in that town.
SUBJECT AND VERB OF A SENTENCE DOES INCORRECT: Bikers is a threat in that town.
NOT AFFECT THE SUBJECT-VERB
RELATIONSHIP; single subjects still take 6. When the subject of a sentence is a
singular verbs and plural subjects still take COLLECTIVE NOUN, such as team, majority,
plural verbs. group, committee, and so on, you should
consider how you are using the word and
Examples: make your decision about verbs accordingly.
CORRECT: Skiing or backpacking, two of the If the subject seems to ACT AS A SINGLE
area's most popular sports, is sure to be UNIT, use a singular verb; if you want to
included in the trip. indicate that the INDIVIDUAL PARTS OF THE
INCORRECT: The best one among so many GROUP ARE ACTING SEPARATELY, the verb
options were hard to choose. should be plural.
CORRECT: Each of the participants is eligible for 3. Use a COMMA to set off an introductory
credit. qualifying word or phrase in a sentence.
INCORRECT: Either Davis or Nelson are going.
Examples:
8. The pronouns NONE OR ANY may take Unfortunately, John is not as bright as he
either singular or plural verbs. thinks he is.
On the whole, the crowd took the bad news
Examples: fairly well.
CORRECT: None of the problems is serious.
CORRECT: He decided that none of the 4. Use COMMAS to set off interrupting
contestants were right. phrases or clauses within a sentence
CORRECT: Any of my students is qualified to
write the proposal. Examples:
CORRECT: Are any of the applicants women? Graham, chairman of the board, lives in
Bermuda.
PUNCTUATIONS Mark Twain portrays Merlin, Arthur's court
magician, as a comic figure.
1. Use COMMAS to set off items in a series.
So are TRANSITION WORDS or phrases that
point or qualify.
Example:
The salmon, for instance, is a game fish.
It can be said, however, that Eleanor never
admitted defeat.
Example:
The feast of the Great Pumpkin started on
October 31, 1965.
Classes will begin on Tuesday, September 4.
Wright Morrow, Dean of Humanities, will
address the club. Rose lives at 13
Washington Square, Austin, Texas.
Example:
"Take what you want and pay for it," Max
said.
"Leave that where it is," Clark shouted, "and
get out."
3 WRITING PROFESSIONAL experience, the EDUCATION SECTION is
COMMUNICATIONS: RESUMES often placed above the work section.
RESUMES
- Purpose:
a. to serve as an overview or quick summary
of your skills, experience, and education as
they relate to your career objective;
b. to function as a marketing tool that
conveys your personal brand
b. REFERENCES
- Simply include a references page with your
resume, it may save an interested employer
the trouble of having to ask in the first
place
- a PROACTIVE IMPRESSIVE STRATEGY would
be to create a single-page document that
includes the following information
i. Header (that matches the resume
header) to include your name,
address, and contact information
ii. Reference’s name
iii. Reference’s company and title
iv. Reference’s relationship to you
(e.g., manager, peer)
v. Reference’s contact information,
including e-mail address and phone
number
4 WRITING PROFESSIONAL WHEN IS E-MAIL NOT AN APPRROPRIATE
COMMUNICATIONS: EMAILS FORM OF COMMUNICATION TO USE?
5. Proofread