-
7/30/2019 Techniques and Strategies
1/15
Technical WritingStrategies and
Techniques
-
7/30/2019 Techniques and Strategies
2/15
Strategy versus Technique
Strategy an elaborate and systematicplan of action
Technique A practical method or artapplied to some particular
task.
-
7/30/2019 Techniques and Strategies
3/15
Technical Writing Strategies
Many experts who specialize in effectivetechnical writing have
their own methodof creating technical documents, but there
are several general practices that typicallyshould be
followed.
-
7/30/2019 Techniques and Strategies
4/15
Strategies: Audience Analysis
Audience Analysis one of the most
important aspects of any technicalwriting.
-
7/30/2019 Techniques and Strategies
5/15
Strategies : Documentation
Documentation - Effective technical
writing also consists of prose that is easyto read and
consume.
-
7/30/2019 Techniques and Strategies
6/15
Strategies : Documentation
Avoid Jargons - helps the reader
understand the information in simpleterms.
Write in active voice - helps the writerexpress concepts in a
clear, organizedmanner when creating technicaldocuments.
-
7/30/2019 Techniques and Strategies
7/15
Strategies : Content
Content Organization - technical writer
must be able to create and organizecontent in an effective
manner.
-
7/30/2019 Techniques and Strategies
8/15
Strategies : Content
Bullet points Creating lists of necessary
pieces of information Strong headings include headings that
flow
alongside the thought process of thedocument.
Image descriptions a short description ofthe image should be
included
Boldfaced terms highlight important terms
Outcome expectations - include a sectionabout what readers can
expect
-
7/30/2019 Techniques and Strategies
9/15
Technical Writing Techniques
There are five basic techniques in
technical writing. Mechanism description
Process description
Classification
Partition
Definition
-
7/30/2019 Techniques and Strategies
10/15
Technique: Mechanism Description
Mechanism Description explains the
arrangement and shape of an object inspace. This technique
answers the ff: What is it? What is its function?
What does it look like? How does it work? What are its principal
parts? Give a detailed description of each part. Each of these
parts may require a mechanismdescription of its own.
-
7/30/2019 Techniques and Strategies
11/15
Technique: Process Description
Process Description explains the
arrangement of a sequence in achronological order. What is
it?
What is its function?
Where and when does it take place?
Who or what performs it?
How does it work?
What are its principal steps?
-
7/30/2019 Techniques and Strategies
12/15
Technique: Classification
Classification - involves grouping thingstogether (on the basis
of similarities) and
dividing them (according to differences).
-
7/30/2019 Techniques and Strategies
13/15
Technique: Partition
Partition - is the act of dividing things intotheir component
parts
-
7/30/2019 Techniques and Strategies
14/15
Technique: Definition
Definition - uses words to fix the meaning
of a thing -- to make it "definite". A definition answers the
question "what is it?"Good definitions employ the following
formula:
species = genus + differentia + group to which
the thing belongs + specific details that separateit from other
things in its group
-
7/30/2019 Techniques and Strategies
15/15
Technique: Definition
Example
A batten is a tapered piece of wood that fitsinto a pocket in
the trailing edgeof a sail, helping it hold the shape
that allows it to propel a boat.
