.
EHS InfoLink, Inc.
Making
information work for you.
Simple
tips for…
Writing
effective
technical
documents.
Start
Fresh.
Avoid
the temptation to start
your project with an existing document
that is “close enough” for your needs. Rather, begin
with your own
outline based on
your objectives
and then cut and paste as
appropriate
with
existing information.
Begin
with the end in mind.
Make
sure you
understand what you are setting
out to achieve before
you draft
an outline.
This requires that you understand the project
driver,
your audience(s) and how the information will be used.
Think
like a sculptor.
Chisel away
anything that doesn’t directly support your objectives,
no matter
how attached
you are to it. If you have some parts that are disproportionately
large in detail,
summarize the information in the body
of the report and package
the rest for
an appendix or attachment.
Don’t
stop at technical accuracy.
Technical
accuracy is critical, but don’t underestimate the impact of
typos,
grammar errors and inconsistencies.
Poor attention to these
details can harm
your image.
Plan
a last once-over.
The
oddest things can happen during eleventh-hour
editing.
Make room
in your schedule for a fresh pair of eyes to review
your document—particularly
if it is a
final product.

|