Welcome to COM4441'01

1
(No Transcript)
2
COM3461.01Technical Writing

• Chapter 7
• Other Technical Documents
• (The User Manual)

3
The User Manual

• Learning outcomes for this Unit

• As a result of studies in this chapter, you will
  be able to
• Explain the difference between informational
  and directional process analysis.
• Identify the four major parts of a user manual.
• Perform a task analysis.
• Group and label the tasks.
• Write the steps for each task.
• Develop a Troubleshooting section.

4
The Nature of Process Analysis

• Process analysis is a mode of expository writing
  that answers the critical questions of how
• How does something work?
• How did it happen in the past?
• How do they do it?
• How does it work?
• How can it be used?
• How do I work it?

5
Types of Process Analysis

• The two types of process analysis
• Informational Process Analysis
• an explanation of steps in a procedure
  that anticipates only the readers understanding

6
Types of Process Analysis

• The two types of process analysis
• Directional Process Analysis
• an explanation of steps in a procedure
  that anticipates the readers performance

7
Organization of Process Analysis

• Place the most important mode first.
• Place the least important mode last.

8
The User Manual

• The Four Major Units of the User Manual

• Summary
• Product description
• Operating procedure
• Troubleshooting procedure

9
The User Manual

• The Four Major Units of the User Manual

• Summary

briefly describes the product and its
main purpose
10
The User Manual

• The Four Major Units of the User Manual

• Product Description

identifies each part and describes its
components
11
The User Manual

• The Four Major Units of the User Manual

• Operating Procedures

write in terms of the users perspective How
to do something vs. What can be done with it
12
The User Manual

• The Four Major Units of the User Manual

• Operating Procedures

Identify the audience. Perform a task analysis.
(List what the audience may want to do with
the product.) Group and label tasks. Write the
steps.
13
The User Manual

• The Four Major Units of the User Manual

• Troubleshooting Procedures

Anticipate the most likely problems,
failures, or irregularities. Group and
label them according to categories of
problems. Describe the failure or problem,
and then provide an enumerated list of steps
for correcting it.
14
The User Manual

• Some Stylistic Suggestions

• Use declarative sentences to describe.
• Use imperative sentences (commands) to direct.
• Use numbered rather than bulleted lists to
  isolate each sequential task.
• Use headings, subheadings, and graphic aids to
  isolate and to clarify tasks.
• Follow the principles of parallel construction in
  developing a layout.

15
The User Manual

• Some Stylistic Suggestions

• Use simple, brief sentences to direct a task
  (like this).
• Use active rather than passive voice in your
  verb choice.
• Write to the level of the audience.
• Use words rather than graphics to direct a task.

16
The User Manual

• Some Stylistic Suggestions

• Avoid ambiguity (multiple meanings).
• Avoid weak words (could, would, might,
  etc.)
• Avoid generalities and vagueness (give specific
  details, figures, measurements).
• Avoid interrupting a list of tasks with
  extraneous, only loosely related asides or
  commentary.
• Avoid merely stylistic directions.

17
(No Transcript)