Introduction to

Technical Writing
 Objectives
 􀂄 Understand technical writing problem-
solving process
 􀂄 Identify the key elements of technical
writing
 􀂄 Describe the nature of technical writing
 Objectives (continued)
 􀂄 List the characteristics of excellent
technical writers
 􀂄 List the qualities of excellent technical
writing
 􀂄 Understand the different ways that
professionals function as technical
writers.
 What is Technical Writing?
 􀂄 A problem-solving process involving
these elements/features:
 􀂄 Technical subject matter
 􀂄 Communication problem
 􀂄 Communicator, purpose and audience
 􀂄 Accurate, precise information
 􀂄 Arrangement and presentation of
information
 Technical Writing Elements:
 􀂄 Technical subject matter
􀂄 (i) peculiar to or characteristic of a particular art,
science, trade, technology, or profession
 􀂄 Communication problem

(i) recognized and accurately defined in the

communication context
 􀂄 Communicator, purpose, and audience

(i) once established, these elements are the

beginning of a solution to the communication
problem
 Technical Writing Elements:
(continued)
 Accurate, precise information
(i)discovering information needed to solve
problem through thinking, study,
investigation, observation, analysis,
experimentation and measurement
 Arrangement and presentation of
information
(i) achieving the writer’s purpose in a clear,
useful, purposeful way
 The Nature of Technical
Writing
 􀂄 Purpose: spelled out in the opening
paragraphs
 􀂄 Vocabulary: typically specialized
 􀂄 Sentences: highly specific and fact
filled
 􀂄 Jargon: typically present in specialized
terminology, definitions, signs, symbols,
and formulas
 The Nature of Technical
Writing (continued)
 􀂄 Graphs and tables: reinforces and/or
expands upon surrounding prose
 􀂄 Documentation: appears in text and
bibliographies
 Characteristics of Excellent
Technical Writers
􀂄
 􀂄 Methodical
 􀂄 Organized
 􀂄 Objective
 􀂄 Audience centered
 􀂄 Honest
 􀂄 Critical
 􀂄 Informed
 􀂄 Purposeful
 Technical writers know…
 􀂄 their readers
 􀂄 their objectives
 􀂄 to write simply, directly, and concisely
 Qualities of Technical Writing
 􀂄 Arrives on or before the due date
 􀂄 Impressive when flipped through
 􀂄 Contains necessary front matter
discloses purpose and scope
 􀂄 Provides essential information, clearly
written, free of jargon or padding
 Qualities of Technical Writing
(continued)
 􀂄 Uses tables and graphics to present and
clarify content
 􀂄 Contains a summary or conclusions
 􀂄 Is designed to be read selectively by
readers with diverse interests or needs
 Qualities of Technical Writing
(continued)
 􀂄 Uses a rational, readily discernible plan,
revealed by the table of contents and
headings
 􀂄 Reads coherently and cumulatively
 􀂄 Anticipates and answers readers’
questions
 􀂄 Excellent technical writing
conveys an overall
impression of authority,
thoroughness, soundness,
and honest work.
 Technical Writing or Technical
Communication
 Technical writing describes communication at
the workplace
 Technical writing also refers to information
about technology
 Technology: 1) practical knowledge,
2) tools and appliances
 The modern workplace depends on technology
so much that technical writing is also called
business, professional, or workplace writing
Technology in today’s workplace
 “We live in a world in which many of our
everyday actions depend on complex but
important technical information … Household
appliances, banking systems, online courses,
business negotiations, government
correspondence and affairs, and almost every
other aspect of your daily life is affected by
technologies and technical information” .
What does technical writing do?
 Technical writing helps perform jobs better
 It does it by
 Informing
 Describing
 Instructing
 Persuading
 These goals are achieved through technical
documents
 Examples of Technical
Communication
 Memos and electronic mail (e-mail)—to set meeting
agendas and to ask and answers questions

 Letters—to sell, complain, hire, fire, ask and answer

questions, and explain the contents of attachments

 Reports—to report on job-related travel or incidents, to

study options and recommend action, to report on the
progress of ongoing projects, and to document meeting
minutes

 Proposals—to highlight problems, to suggest solutions,

and to recommend action

 Brochures—to sell and inform, using six-to eight-panel

(back and front) foldouts
 Examples of Technical
Communication (cont.)
 Newsletters—to report on corporate activities to both
employees and stakeholders

 Fliers—to sell and inform, using brief, single-sided

documents

 Resumes—to help you find a job

 Web sites—to sell and inform, using multiscreened,

Internet-based, hypertext-linked communication

 User manuals—to explain the steps in a procedure

 Technical descriptions—to explain the parts of a

mechanism, tool, piece of equipment, or product
Technical Writing is Different from
Academic Writing because
 Technical writing achieves job goals
 It addresses a variety of readers
 Writing at work, you have to make more effort
to persuade your reader to read the document
 Workplace writing creates legal liability for
the writer and the organization
Technical
vs.
Academic
Writing
 Technical versus Academic
 Knowledge  Knowledge

 You are the  You are still a

expert learner
 Technical versus Academic
 Audience  Audience
 Technical  Wide range of
background, academics and
professionals in general audiences
the field
 Technical versus Academic
 Criteria for  Criteria for
Evaluation Evaluation
 Clear and
 Depth, logic,
simple
organization, clarity, unity
 Visually and grammar
appealing and
easy to follow.
 Technical versus Academic
 Graphics,  Graphics, charts,

charts, and and numbers are

numbers are sometimes used to
used very help explain and
demonstrate
frequently to knowledge
support
conclusions
 More characteristics of technical
communication
 Addresses particular readers
 Helps readers solve problems
 Reflects an organization’s goals and culture
(supports the organization’s mission)
 Is produced collaboratively
 Uses design to increase readability
 Consists of words or graphics or both
 Is produced using high-tech tools