Technical writing

Tips and Uses

Dr. Javid Hussain

Assistant Professor
Dept. Environmental Sciences, BUITEMS
Email: [email protected]
Cell: 0306-1055006
Technical writing
 Technical writing is a type of writing where the
author is writing about a particular subject that
requires direction, instruction, or explanation.
 This style of writing has a very different purpose
and different characteristics than other writing
styles such as creative writing, academic writing
or business writing.
 Technical writing lacks the emotional impact
 Technical writing is straightforward, easy to
understand explanations and/or instructions
dealing with a particular subject.
 It is an efficient and clear way of explaining
something and how it works.
 Technical writing is the writing of those involved
in the technical fields, i.e., science and
engineering.
 The information is organized, presented and
communicated in a specific format.
 The writing is concise, clear and accurate.
 The writing takes into account the audience’s needs,
biases and prior understanding.
 The writing presents information to help readers solve a
problem or gain a better understanding of a situation.
 The writing conveys technical, complex, or specialized
information in a way that is easy for a non-technical
reader to understand.
 Technical writing is a natural partner to academic
writing. It is descriptive, creative, and expository,
but the format is different and the standards are
higher.
 Technical writing requires 100% accuracy.
 Uses for Technical Writing
 Some examples of technical writing include:
 Instruction manuals
 Policy manuals
 Process manuals
 User manuals
 Reports of analysis
 Instructions for assembling a product
 A summarization of a long report that highlights and
shortens the most important elements
 Tips for Good Technical Writing
 Regardless of the type of document which is
written, technical writing requires the writer to
follow the properties of knowing their audience,
writing in a clear, non-personal style and doing
extensive research on the topic. By including these
properties, the writer can create clear instructions
and explanations for the reader.
 Tips for Good Technical Writing
1. Know your audience. An expert in the field will understand
certain abbreviations, acronyms, and lingo that directly applies
to such a field. The novice will not understand in the same
manner and, therefore, every detail must be explained and
spelled out for them.
2. Use an impersonal style. Write from a third person perspective,
like a teacher instructing a student. Any opinions should be
omitted.
3. The writing should be straightforward, to the point, and as
simple as possible to make sure the reader understands the
process or instruction. This at times may appear as simply a list
of steps to take to achieve the desired goal or may be a short or
lengthy explanation of a concept or abstract idea.
4. Know how to research. Gather information from a
number of sources, understand the information gathered
so that it can be analyzed thoroughly, and then put the
information into an easy to understand format to instruct
those who read it. The more inexperienced your audience,
the more information you will need to gather and explain.
5. Be thorough in description and provide enough detail to
make your points; but, you also have to consider that you
need to use an economy of words so that you do not bore
your reader with gratuitous details.
6. A good technical writer can make a difficult task easy and
can quickly explain a complex piece of information.
Some other examples of Technical Writing
• Job Application • Position Paper
• Job Description • Proposal
• Lesson Plan • Questionnaire
• Letter of Inquiry • Test
• Letter of Recommendation • Product Comparison
• Magazine/Newspaper Article
• Marketing Plan
• Memo
• Meeting Minutes
• Newsletter
• Observation Report
• Performance Evaluations
• Research Report
• Résumé/Portfolio
• Scientific Paper/Report
• Survey
• Work Order
• Persuasive Proposal
End