Technical Writing &
Communication Skills for
Engineers
(0700209)
Technical Writing 1
Overview
▪ Definition of Technical Writing.
▪ Importance of Technical Writing.
▪ Popular Technical Writing Fields and Careers.
▪ Characteristics of Effective Technical writing.
▪ Accuracy, Clarity, Descriptiveness, Correctness
Conciseness, Coherence, Appropriateness.
Technical Writing 2
Definition of Technical Writing
▪ “Technical writing refers to straightforward explanations and/or
instructions dealing with a particular technical subject. The
subject being written about may be abstract or tangible.”
OR
Technical Writing 3
Definition of Technical Writing
▪ “Technical writing, a form of technical communication, is a style
of writing used in fields as diverse as computer hardware and
software, engineering, chemistry, the aerospace industry,
robotics, finance, consumer electronics, and biotechnology.
Technical Writing 4
Definition of Technical Writing
▪ Technical writers explain technology and related ideas to
technical and nontechnical audiences. This could mean, for
example, telling a programmer how to use a software library or
telling a consumer how to operate a television remote control.”
Technical Writing 5
Definition of Technical Writing
▪ “Technical Writing is a term that represents an increasingly
broad set of activities that are designed to communicate
understandable information that can help people be productive.”
Technical Writing 6
Importance of Technical Writing
▪ Everyday we hear about new inventions in technology.
▪ we all need to upgrade our tech knowledge in order to
survive in this global world.
▪ Thanks to technical writers who create for us the
how-to guides, manuals, textbooks, instructional
material and explain to us in simple and meaningful
words about the technological inventions, their
purpose and usage.
Technical Writing 7
Importance of Technical Writing
The benefits of good documentation
▪ It’s always worthwhile keeping our communications
objectives clearly in focus. With manuals and
instruction guides, good documentation:
▪ Increases users' confidence in the product
Technical Writing 8
Importance of Technical Writing
The benefits of good documentation
▪ Increases the credibility of the supplier in the eyes
of the customer/user
▪ Reduces support time - in answering user queries, or
correcting errors caused by poor documentation
▪ Reduces frustration caused by ambiguity
Technical Writing 9
Popular Technical Writing Fields and
Careers
Computer Software
▪ Companies are increasingly creating and upgrading
software applications. The development indicates the
significant need of technical writers because with
every new piece of software developed, there is a dire
need to write manuals, marketing materials, training
guides, how-to guides and troubleshooting manuals for
the users.
Technical Writing 10
Popular Technical Writing Fields and
Careers
Computer Software
▪ This technical material is also helpful for the helpdesk
staff as they find it easy to provide solutions and
troubleshooting tips to the customers online and on
phone.
▪ Computer software is an ever evolving field and rarely
stagnant; so there will always be a demand for
technical writers.
Technical Writing 11
Popular Technical Writing Fields and
Careers
Computer Hardware
▪ Manufacturers for computer hardware and equipment
are mostly in search of technical writers who could
create operational manuals, instructional and
troubleshooting guides for end users.
▪ These manuals are not only helpful for the customers
but also those who would use these hardware parts to
create finished products.
Technical Writing 12
Popular Technical Writing Fields and
Careers
IT Technology
▪ We are living in a world where every other thing is
technology based. Take a look at your cell phones,
laptops, television sets, DVD players, electronic
appliances and gadgets; all employ technology in one
way or the other.
▪ Companies making tech based products are always on
the hunt for writers who have penchant for
technology.
Technical Writing 13
Popular Technical Writing Fields and
Careers
IT Technology
▪ As a technical writer, you will be asked to create
product reviews, advantages, disadvantages and
comparisons for websites, blogs and written brochures
and manuals. The job is tricky; but you can easily
handle it once you have ample interest and knowledge
of technologically defined gadgets. IT technology is
one of the most popular technical writing fields.
Technical Writing 14
Popular Technical Writing Fields and
Careers
Medical
▪ Prescriptions, drug manuals, health FAQS, disease
guides are the documents which a technical writer
working in the medical writing field is expected to
produce.
Technical Writing 15
Popular Technical Writing Fields and
Careers
Engineering
▪ Engineering companies seek the expertise of technical
writers to create manuals, presentations, models,
illustrations, reports, design specifications for
engineers and technicians so that they could carry out
their jobs smoothly.
Technical Writing 16
Popular Technical Writing Fields and
Careers
Automobile Industry
▪ Automobile firms are always in search of technical
writers who could describe the steel cabins in a way
that pulls in the target customers.
▪ Technical writers are also required to create
installation manuals of cars for those into the car
repairing and modifying business; and also guide book
for the car owners.
Technical Writing 17
Characteristics of Technical Writing
Accuracy
▪ One of the essential characteristics of technical
writing is maintaining accuracy. If you are writing a
review of a newly launched Nokia mobile phone and you
miss on one important detail, this will convey the
customers that there is nothing special about this
product and they would buy another mobile phone
instead. Technical writing requires that the
information you provide is based on accuracy and
quality content.
Technical Writing 18
Characteristics of Technical Writing
Clarity
▪ Write the technical document in a layman’s tone so
that the customers who are not really techie fans are
also able to understand what the product is all about.
Try cutting down on the use of jargons because again,
this is going to confuse the customers. Keep your
language and expression simple and meaningful. Use of
complicated words may put the readers in a quandary.
Technical Writing 19
Characteristics of Technical Writing
Descriptiveness
▪ Be as descriptive in distinguishing the technical
product as you can. More than half of the customers
come from a non technical background and they need
to have sufficient details otherwise they will not be
able to picture the product correctly. If you are
creating a manual for an electronic product which
explains how to operate it, make sure you cover every
aspect of its functioning.
Technical Writing 20
Characteristics of Technical Writing
Correctness
▪ Technical writing requires that you use correct
grammar and sentence structure. Write down the key
features in the form of headings, sub headings or
bullet points as this will make the manual easy for the
customers to read.
Technical Writing 21
Characteristics of Technical Writing
Conciseness
▪ The Concise document is a piece of writing that
conveys only the needed material.
Technical Writing 22
Characteristics of Technical Writing
Coherence
▪ Coherence is the quality of hanging together and of
providing the reader an easily followed path.
Technical Writing 23
Characteristics of Technical Writing
Appropriateness
▪ The document has to be appropriate to the goals, to
the audience, to the specific institutional contexts in
which is written and read.
Technical Writing 24
