This is not the document you are looking for? Use the search form below to find more!

Report home > Education

Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy

1.67 (3 votes)
Document Description
Have you ever tried to program a new VCR and given up because the instructions were too difficult to understand? Perhaps you purchased a piece of furniture that you had to put together and wished you hadn't! Everywhere we go in our daily lives, we face a variety of processes and procedures-everything from those "some assembly required" items to pumping gas at the corner gas station. Processes and procedures are part of our lives and we seldom give them much thought until something doesn't work as expected. As technical communicators, we often find ourselves in the position of having to write policies, processes and procedures. Sometimes these types of documents can be very difficult to write. By using basic facts and techniques (such as the ISO 9000 document hierarchy and good old-fashioned audience analysis), you may find it a bit easier to develop a process or procedure in the future.
File Details
Submitter
  • Username: samanta
  • Name: samanta
  • Documents: 1258
Embed Code:

Add New Comment




Related Documents

Application of ISO 9000 Standards to Education and training

by: samanta, 153 pages

Over the last decade the topics Quality , Quality Assurance and (Total) Quality Management have become a central preoccupation of hundreds of thousands of organisations in Europe. It was the ...

WRITING SKILLS AND STRATEGIES

by: shinta, 40 pages

Teaching students to write clearly and stylishly can be as hard on the students as it is on their teachers. Many students have great difficulty writing. Putting words on paper (or a ...

MarketReportsOnline.com - Guide Exploration Ltd. Analysis Across the Oil and Gas Value Chain Report

by: charlesmartin17, 3 pages

"Guide Exploration Ltd." Analysis Across the Oil and Gas Value Chain is an essential source for data, analysis and strategic insight into “Guide Exploration Ltd.”. The report provides key ...

watch Night and the City free online, watch Night and the City online

by: sundus, 1 pages

watch Night and the City free online, watch Night and the City online

Booq Taipan Shadow XS And The Taipan Sneak XS Bags For Apple iPad- David Novak (TheGadgetGUYcolumn.com)

by: ishaan, 3 pages

Booq Taipan Shadow XS And The Taipan Sneak XS Bags For Apple iPad- David Novak (TheGadgetGUYcolumn.com)

Harry Potter and the Philosopher's Stone

by: alfredina, 19 pages

Harry Potter and the Philosopher's Stone by J. K. Rowling. A teachers' study guide

Harry Potter and the Order of the Phoenix

by: gerolt, 19 pages

Everything you need to know about Harry Potter and the Order of the Phoenix

HARRY POTTER AND THE DEATHLY HALLOWS

by: morela, 281 pages

HARRY POTTER AND THE DEATHLY HALLOWS ebook pdf

Harry Potter and the Prisoner of Azkaban Unofficial Strategy Guide

by: inge, 73 pages

This guide covers Harry Potter and the Prisoner of Azkaban for the PC. The PC version of the game is radically different from the version released on the various consoles (PS2, Xbox, GameCube and ...

Pine Bend and The Hamptons at Pine Bend Apartments for Rent Brochure Mobile, AL

by: atsushi, 7 pages

Pine Bend and The Hamptons at Pine Bend Apartments for Rent Brochure Mobile, AL

Content Preview
Writing Processes and Procedures Using Audience Analysis
and the ISO 9000 Document Hierarchy
Tricia Cunat, Mary Craig
Processes and procedures are part of our everyday lives.
The ISO 9000 document hierarchy defines three levels
When we have a problem following a set of instructions
of documents:
or difficulty understanding when we are supposed to
perform a specific task, we realize first-hand the

1. Policies
importance of processes and procedures in our lives.
2. Processes
3. Procedures
In order to develop successful processes and procedures,
we must understand the differences between these two

These documents are defined by ISO as follows:
document types. Processes describe a sequence of tasks
while procedures describe how to perform a specific

Document Type
Description
task.
Policies
Define what we do and why we
However, knowing the differences between processes and
do it. Typically, policies are high-
procedures isn’t enough. We must also use audience
level and apply to an entire
organization.
analysis to ensure the correct document type is
Processes
Define what we do (that is, what
tasks we perform) and the
INTRODUCTION
sequence in which we perform
tasks. (Sometimes processes are
Have you ever tried to program a new VCR and given up
also referred to as procedures.)
because the instructions were too difficult to
Procedures
Define how we perform specific
understand? Perhaps you purchased a piece of furniture
tasks. (Procedures are also
that you had to put together and wished you hadn’t!
referred to as work instructions.)
Everywhere we go in our daily lives, we face a variety of
processes and procedures–everything from those “some
The goal of an ISO audit is to make sure a company,
assembly required” items to pumping gas at the corner
organization, or department follows well-defined
gas station. Processes and procedures are part of our
processes that ensure delivery of a high quality product
lives and we seldom give them much thought until
as the end result.
something doesn’t work as expected.
During an ISO audit, auditors look for evidence that
As technical communicators, we often find ourselves in
employees understand and follow documented
the position of having to write policies, processes and
processes. They are also interested in process metrics
procedures. Sometimes these types of documents can be
that result in continuous process improvement.
very difficult to write. By using basic facts and
Therefore, once a process is developed, it must be
techniques (such as the ISO 9000 document hierarchy
reviewed and updated on a regular basis.
and good old-fashioned audience analysis), you may find
it a bit easier to develop a process or procedure in the
ISO auditors are not concerned with the procedures (or
future.
work instructions) developed to support a process.
Evidence that a process is understood and followed
ISO 9000: CONNECTION TO
usually means effective work instructions are in place.
PROCESSES AND PROCEDURES
As stated in the ISO definition, processes are sometimes
referred to as procedures. While there are similarities
Many companies are required to pass ISO 9000 audits in
between the two, it is important to understand the
order to sell goods or services in countries outside the
differences. Because some level of confusion exists, this
United States. In addition, many of these companies also
paper concentrates on processes and procedures. It does
require their vendors to be ISO certified.
not include information about policies.

AUDIENCE DEFINITION
If the subject applies to more than one audience, you
must determine the tasks that each audience performs.
Based on the ISO definitions for processes and
procedures, you may already have an idea about the type
What is a User/Task Matrix
of document you need to develop. However, let’s put
that aside for a minute. Before deciding whether the
A user/task matrix helps you identify the major tasks and
document should be a process or a procedure, first
potential audiences for a given process or procedure.
examine who is going to use the document. What you
find may change your mind about the type of document
The following example lists a few major tasks and
that is needed.
identifies potential audiences involved in the
development of a user manual:
Defining the audience helps you identify the two key
building blocks of processes and procedures:
Audience
Writer
Illustrator
Editor
Reviewer
• The experience level of the audience–which helps
Task
you determine the appropriate level of detail, the
amount and complexity of examples, and the
Obtain Input
2,3
1
1
vocabulary to be used.

Prepare
2,3
2,3
2,3

The tasks to be performed–which help you
Draft
determine the scope of the document.
Review draft
2
2,3

Who are the Users
Merge
2,3
Comments

The first thing you need to do is determine who will use
Legend
the process or procedure. If you know the subject matter
1 Needs general or conceptual information
2 Needs overall process understanding (What?)
very well, you probably have a good idea who the
3 Needs in-depth procedural understanding (How?)
intended audience is. However, be careful to distinguish
between users and readers. Remember that an audience
Using answers to questions about audience experience,
is a specific group of users with specific knowledge and
job function and preferences, this sample user/task
skills. The users of a process or procedure are your
matrix shows that most of the audiences need either an
primary focus.
overall process understanding or an in-depth procedural

understanding of the defined tasks. You can use this

To further define the audience, ask the following
information to determine the type of document you need
questions:
to write and what level of detail to include.

• What is the education and training level of your
Let’s look at the similarities and differences between
intended audience?
processes and procedures in more detail.
• How much background does your audience already
have on the subject?
PROCESS VS PROCEDURE
• What are the job functions or job descriptions of the
audience? (Senior level? Technical? Professional?)
Now that you know the audience you are writing for and
• What are their preferences and expectations; i.e.
what tasks the users must perform, next you need to
how will the audience use the document?
determine what type of document to write.
You also need to know whether the subject applies to
Knowing the difference between a process and a
more than one audience. If it does, you must consider
procedure is very important in determining the
the different needs of those audiences.
appropriate document type. In some cases, the best
solution may be a combination of process and procedure.
What Tasks do the Users Perform
After determining your audience, use task analysis
techniques to determine what tasks the audience
performs. Task analysis lets you focus on the subject of
the process or procedure.

What is a Process
What is a Procedure
Webster’s dictionary defines a process as:
Webster’s dictionary defines a procedure as:
• A series of actions or operations conducing to
• A particular way of accomplishing something or
an end
of acting
• A continuous operation or treatment especially
• A step in a procedure
in manufacture
• A series of steps followed in a regular definite
order (for example, a surgical procedure)
Processes describe the tasks to be performed (that is,
• A series of instructions for a computer that has
what needs to be done and in what order) and not how to
a name by which it can be called into action
do them.
Procedures describe how to perform specific tasks (for
A process should be written when:
example, how to use a particular tool or a specific
technique).
• The audience is experienced enough to know
how to perform the tasks.
A procedure should be written when:
• The end result is more important than how the
result is accomplished.
• The tasks must be performed in a prescribed
• There are several acceptable ways of
order using exactly the same method every time
accomplishing the tasks and the audience can
(for example, manufacturing instructions).
choose among them.
• The audience is inexperienced and needs more
detail.
Remember to write a process at a high enough level. A
process should give the user enough information so they
Remember to write a procedure with step-by-step
understand what needs to be done and in what order. A
instructions so the user has a sufficient amount of
process does not provide the exact steps to tell the user
information in order to perform a task or series of tasks
how to perform each task.
successfully.
SAMPLE PROCESS
SAMPLE PROCEDURE
1. Obtain input from subject-matter experts.
Perform the following steps to install XYZ
2. Prepare draft.
software:
3. Review draft.
4. Merge comments.
1. Insert the CD into the CD-ROM drive.
5. Test deliverable.
2. If Auto Run is turned on, the setup program
6. Prepare final copy.
automatically starts.
7. Deliver final copy.
If Auto Run is turned off, run the setup
program manually from the CD.
3. Follow the steps on your screen as the
installation wizard guides you through the
installation process.

Comparing Processes and Procedures
A combined process and procedure document should be
written when:
Processes and procedures can often be confused as one
in the same thing when in fact they are very different. It
• The audience needs to be divided into sub-
is important to understand both the similarities and the
audiences, such as experienced versus
differences.
inexperienced users.
• There are multiple procedures that need to be
Processes and procedures are similar in that they
described under a single process.
typically involve a sequence of events or tasks and are
usually time-driven.
Several procedures may support a single process because
there are
The following table highlights some of the major
differences between processes and procedures:
• Multiple users of the same process with
different job responsibilities.
Process
Procedure
• Multiple ways to perform a task depending on
the user’s organization.
Answers “What?”
Answers “How?” questions
questions
For example, you may have a process that describes the
Describes events or a
Describes steps that
tasks involved in backing up computer systems. To
sequence of
someone follows in order
support that process, you may have several procedures:
activities/tasks that
to accomplish a task.
one procedure for system administrators and another for
someone needs to be
computer operators.
aware of.
Usually involves more than
Usually involves a single
PRESENTATION FORMATS
one person.
person (although multiple
people may perform the
You know your audience. You know what tasks they
same steps).
perform. You’ve decided whether you are going to write
Provides an overall
Does not include enough
a process, a procedure, or both. What’s next?
understanding of what
information for one to
happens and in what order.
understand where the task
Both processes and procedures can be presented in a
fits in the bigger picture.
variety of different formats: both paper and online.
Lacks the level of detail
Includes enough detail that
Paper formats may include traditional documents,
required for someone to
a person can complete a
laminated cards, and printed material from an online
understand how to perform
task with little or no
source. Online formats may include Windows Help files,
a task.
additional information.
HTML files, and PDF files.
You may choose to provide a process or procedure in a
Combining Processes and Procedures
single format. Or, you may find that you need to provide
the process or procedure in multiple formats.
Depending on your audience, the reasons for writing the
process or procedure, and your organization’s rules, you
Remember to keep the audience’s environment in mind
may choose to write a combined process and procedure
when determining the best format for your process or
document. When they are combined, procedures
procedure. A traditional paper document may not work
normally support processes, but either can standalone.
in all environments. For example, procedures that are to
be used on a manufacturing floor may need to be
presented on large, laminated cards. Conversely,
processes and procedures for medical professionals may
be more effectively presented as linked PDF files on a
hospital intranet site.

Consider the following when determining a presentation
method:
• Do the users have access to a computer for
online viewing?
• Do the users have access to a company
intranet?
• Can the user easily print a paper version if
online access isn’t always available?
• Does the user need to carry a printed version
from site to site?
• Does the user want to customize a process or
procedure for his or her own use?
Even a well-written process or procedure may be
ineffective if users find it difficult to use in their
environment.
CONCLUSION
All in all, writing processes and procedures is much like
writing technical documents. Success depends on
developing the right document for the right audience.
Tricia Cunat
Information Analyst
Guidant Corporation
4100 Hamline Avenue North
Arden Hills, MN 55112
651-582-5868
tricia.cunat@guidant.com
Tricia Cunat is an STC member. She has a degree in
journalism, an MBA, and a Master of Business
Communications certificate. Tricia has been in technical
communications for over 18 years and has held variety of
positions including responsibilities for ISO documentation
and process development. She is currently an intranet
developer at Guidant Corporation.
Mary Craig
Product Information Manager
Unisys Corporation
2359 Walnut Street
Roseville, MN 55113
651-635-6414
mary.craig@unisys.com
Mary Craig is a senior member of STC. She has a BS
degree in STC from Michigan Technological University
and joined Unisys after graduating in 1982. In her 18
years at Unisys, Mary has held a variety of writing and
management positions including Manager of Corporate
Product Information Procedures. She currently manages
a team of technical communicators.

Download
Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy

 

 

Your download will begin in a moment.
If it doesn't, click here to try again.

Share Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy to:

Insert your wordpress URL:

example:

http://myblog.wordpress.com/
or
http://myblog.com/

Share Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy as:

From:

To:

Share Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy.

Enter two words as shown below. If you cannot read the words, click the refresh icon.

loading

Share Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy as:

Copy html code above and paste to your web page.

loading