Professional Documents
Culture Documents
6 Steps To Better Business Documentation
6 Steps To Better Business Documentation
6 Steps To Better Business Documentation
mapping
making information work
n
ir af
a
pptoi
n
6 STEPS
to better business
communications
information
mapping
making information work
n
ir af
a
pptoi
n
This Guide provides six simple steps to follow as you write, assess or revise your
organizations business communications. The steps are distilled from the
principles of the Information Mapping Method, a proven, research-based
structured authoring methodology that makes information easy to access,
understand and use.
OVERVIEW
information
mapping
making information work
n
ir af
a
pptoi
n
One of the most common mistakes writers make is to create documents and
reference materials in a one size fits all fashion without considering the needs
of different audiences. This leads to problems for readers, because one size
rarely, if ever, fits all.
STEP 1: AUDIENCE
information
mapping
making information work
TIP
n
ir af
a
pptoi
n
n
ir af
a
pptoi
n
information
mapping
making information work
Information Types
Information Type
Procedure
Process
Principle
Fact
Concept
Structure
Description
A set of steps that a person performs to accomplish a
task.
A series of events or stages that occurs over time and
has a specific result.
A statement that dictates behavior, such as a rule,
policy, or guideline.
A statement that is assumed to be true.
An abstract idea that needs to be defined or explained.
A physical representation of parts and boundaries,
including charts, diagrams, pictures, and graphical
representations of relationships.
STEP 2: PURPOSE
information
mapping
making information work
TIP
n
ir af
a
pptoi
n
information
mapping
making information work
n
ir af
a
pptoi
n
Now that you have broken down your information into its components, you are
ready to organize and sequence it based on what readers need to do and what
they need to know in order to be successful.
For example:
If employees must wear safety goggles when performing a metal grinding
procedure, you should bring that requirement to their attention early in the
document, and make sure that its placed prominently, where it wont be
missed. This is important information that belongs right up front, not buried in
dense text or left until late in the procedure.
STEP 3: ORGANIZATION
information
mapping
making information work
TIP
n
ir af
a
pptoi
n
information
mapping
making information work
n
ir af
a
pptoi
n
Decide on the terms you want to use, and apply them consistently. For
example, an illustration should not later be called a graphic.
Decide on a standard way to present each type of information. For
example, every procedure should follow the same format.
Once you have defined an acronym, continue to use that acronym. For
example, after introducing Department of Energy (DOE), use DOE
throughout the document.
If you have typically presented a certain type of information in a table
format, do not later present that information as a graph, simply to add
variety.
STEP 4: CONSISTENCY
information
mapping
making information work
TIP
n
ir af
a
pptoi
n
information
mapping
making information work
n
ir af
a
pptoi
n
Ask employees where they go to find information, and observe them to see
how long it takes them to get answers to their questions. Do you see excessive
use of sticky-notes, bookmarks, and copies of controlled documents? Are
supervisors and help desks being flooded with questions?
When employees cannot find the information they need, it is often because
necessary details have been relegated to appendices or stuck in other places
where they may be missed.
Make information easier to find with access aids such as a table of contents, an
index, titles and labels, and hyperlinks. Charts, tables, graphics and bulleted
lists also make important information stand out.
STEP 5: ACCESSIBILITY
information
mapping
making information work
TIP
n
ir af
a
pptoi
n
information
mapping
making information work
n
ir af
a
pptoi
n
Creating content in small, modular units allows you to easily reuse the content
for multiple purposes without losing the integrity of the information.
For example:
Research has shown that creating content in small, well-defined units also
makes information easier to find and remember, aids comprehension, and
significantly reduces the time it takes to update and revise documents. If your
documents arent structured into small, well-defined information modules that
are grouped together into meaningful topics, it will be difficult to ensure
compliance and productivity.
STEP 6: REUSABILITY
information
mapping
making information work
TIP
n
ir af
a
pptoi
n
n
ir af
a
pptoi
n
information
mapping
making information work
Its important to plan baking times carefully so that the bagels do not remain on
the racks for more than four hours after thawing. Bagels that are left on the
racks for more than four hours must be discarded. After placing the bagels on
the thawing trays, place the trays on every other shelf of the rack and do not
close the covers. This will thaw the bagles in 1 to 2 hours. To thaw them in 4
hours, place the trays on every shelf on the rack, then close the covers. To thaw
them between 4 and 24 hours, place them on every shelf of the rack, close the
covers, and place them in the refrigirator.
1 to 2 hours
4 hours
4 to 24 hours
B&A
information
mapping
making information work
n
ir af
a
pptoi
n
When you improve the quality of your documentation, you help improve
productivity and reduce corporate risk.
Ask these questions to determine the quality of your documentation.
CHECKLIST
information
mapping
making information work
n
ir af
a
pptoi
n
www.informationmapping.com
CONTACT