Scribd
Upload
5 views

Technical Writing (2)

Technical writing is designed to communicate complex information from experts to non-experts, primarily through instructions and user manuals. It emphasizes clarity, conciseness, and the use of active voice, while incorporating elements such as definitions, descriptions, and processes. Effective technical writing also considers the audience's background and includes necessary safety precautions and warnings.

Uploaded by

Khushboo Lakhani
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
5 views

Technical Writing (2)

Technical writing is designed to communicate complex information from experts to non-experts, primarily through instructions and user manuals. It emphasizes clarity, conciseness, and the use of active voice, while incorporating elements such as definitions, descriptions, and processes. Effective technical writing also considers the audience's background and includes necessary safety precautions and warnings.

Uploaded by

Khushboo Lakhani
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 43

Technical Writing

What is Technical Writing


Technical writing is content
written by experts for non-
experts.

Technical writing is includes


instructions- the step-by-step
explanations of how to do things:
assemble something, operate
something, repair something, or
do routine maintenance on
something.
Writing User Instructions
Examples of instructional documents
include user manuals and
troubleshooting guides for computer
programs, computer hardware,
household products, medical
equipment mechanical products and
automobiles.

Instructions are always written in


active voice.
Description
Picture in Words
Elements
Definition / principles
Process / Uses/Application/
Working
Do’s / Don’ts (optional)
Safety rules (optional)
Conclusion
For Description and Explanation
You should
know the capabilities and
background of your reader
be aware of the purpose and
limits of description
select and arrange the material in
the best way
For Description and Explanation
You should
choose the words correctly
be concise in expression
be free from ambiguity
present the material in an interesting
manner
Elements ( contd.)
Diagrams ( Compulsory)

Full
Split
Part
Writing Definitions
by class and
differentiation
by form and function
by etymology
by analysis
Writing Definitions
list of properties
use of synonyms
use of abbreviations
and acronyms
inserting definitions in
the text
expanding definitions
Class and Differentiation
Banjo Instrument neck, body four or five strings

Musical Long neck and a drum-like


Instrument body with four or five strings

Long neck similar to a guitar’s


Stringed and a drum-like body similar to
Musical a tambournine’s. There are
Instrument usually four or five strings,
plucked with a pick
Class and Differentiation

Assign the item to a class


Distinguish it from others in the
class
• What are it’s salient features?
• How is it different?
Form and Function
An axe is an instrumentfor hewing,
clearing,or chopping trees.It has
asquarish head fixedby a socket on a
handle.
Form and Function

Assign the object to a category


Distinguish it from all others
What does it look like?
How does it work?
Etymology
Thermometer – derived from the Greek
word therme, which means ‘heat’ and
metron, which means ‘to measure’
Analysis
Two types of thermometers are:
Clinical thermometers
Electric thermometers
List of Properties

Expand a general definition


with the list of properties or
characteristics.
Use of synonyms

eg. Patients who experience shortness of


breath or chest pain (angina) at least a
month before their first heart attack have an
elevated risk of dying from a second heart
attack.
Use of abbreviations and acronyms

Abbreviation - letters NGO


Acronym - word RISC

Eg. Reduced Instruction Set


Computer (RISC) architecture
provides a great deal of
computing power for a
relatively small capital outlay.
Use of abbreviations andacronyms
GOOGLE - Global Organization Of Oriented Group Language
Of Earth

YAHOO - Yet Another Hierarchical Officious Oracle.

WINDOWS- Wide Interactive Network Development for Office work Solution.


•
COMPUTER- Common Oriented Machine Particularly United and used under
Technical and Educational Research.

VIRUS - Vital Information Resources Under Siege


INSERTING DEFINITIONS IN
THE TEXT
dashes, commas, or, called,
knownas etc.

E.g. Downsizing- moving all or part of an application to a


smaller, often lower- cost computer system – has
certain advantages.
Expanding definitions :
contrast, comparison, example

eg.Killing traps destroyanimals and rodents.Enclosing


traps, incontrast catch creatureswithout hurting them
Explanation of a process
Addressed to the readers who
may be unlikely to perform the
process
Appears in a report article or
proposal
Used to judge the reliability,
practicality or efficiency
Elements

Introduction
Materials/ tools/ apparatus
Description
Conclusion
Introduction
Definition of the process
Why, where, when and by whom
Materials, tools, apparatus needed
Special skills or training needed
Requirements of time
Special conditions e.g. temperature, ventilation etc.
Preparations before the process
Description of the Process
Theory or principle
Listing of the main steps
Try to make five to six steps
Name them in chronological order
Number them if required
Base the main divisions on the
completion of a stage
Steps and explanation of the process
Conclusion
Not needed when
process is a part of a
longer paper
Summarize the process
Evaluate the process of
the results
Indicate the importance
Example
Poor

First the form is filled with mix


and then the mix is tamped with
a 1/2 inch rod 25 times, which
leaves room for more mix.
Conclusion

Don’t add a new point in


conclusion
Instructions
Instructions are
directions
Types of Instructions
Oral
written
Oral Instructions
Know the background of your
audience
Give the instructions at a suitable
time
Use words which are easy to
understand and remember
confirm that the instructions are
‘received and understood’
Oral Instructions contd.
Use demonstrations and
illustrations
Use the techniques or
careful repetition to
ensure absorption of
information
Written Instructions

Written by those who know


for those who don’t know
Tell the reader how to carry
out a technical procedure
Foresightedness
Written Instructions
Written by those who know for those who
don’t know
The writer should tell the reader how to
carry out a technical procedure
Foresightedness
The writer should answer possible
questions first
The writer should put himself/ herself in
the reader’s place and examine the work
ruthlessly
Written Instructions
1. Introduction
Specific tasks or procedure to be explained and the
scope of coverage
Prerequisites in terms of knowledge and background
A general idea of the procedure and its
accomplishment
Conditions when they can or cannot be used
An overview of the contencts or instructions
Written Instructions Contd.
Precaution, Note, Caution,
Warning, Danger
Technical background and
theory
Equipment and supplies
Discussion of steps
Discussion of Steps
Fixed order of steps
Variable- order of steps
Alternate steps
Nested steps
Writing Instructions Contd.

Make good use of headings


Lists
Special notices
Numbers, abbreviations, and symbols
Techniques
Know the background of your
auidience
Write complete instructions
Make correct assumptions
Don’t be ambiguous
Don’t use words with more than one
meanings
Use correct sequence for faultless
operations
Wording of Warnings
NOTE: Background points or important
information necessary to perform
a task effectively.

CAUTION: Where equipment or property


could be damaged.
WARNING: The potential for serious
personal injury
DANGER: The potential for death.
Style
Imperative:
E.g. ‘the casting is removed from the mould by
the operator, who then places it...

Indirect:
E.g. ‘the operator removes the casting from the
mould. He then places it in...
Style
Direct:
E.g. ‘you remove the casting from the mould.
You then place it in...’

Impersonal
E.g. ‘remove the casting from the mould. Then
place it in...’

You might also like