Professional Documents
Culture Documents
5 Key Concepts
5 Key Concepts
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg
Technical writing requires transparency of expression
and therefore a straightforward use of language.
Technical writing requires the recognition of the overall
goal prior to beginning a document.
Writers must have knowledge of the intended audience.
Documents must include certain key concepts so the
information can be easily understood by the intended
readers.
Technical writing is solution based.
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg
Know the intended audience.
Understand the goal of the
document.
Follow the Pyramid Method
of Writing.
Use an active voice when
writing.
Use clear and concise
language.
Use illustrations to help
clarify meaning.
Prepare a draft and then a
final copy.
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg
When a writer knows their
audience they are better positioned
to suggest and implement solutions,
by using appropriate language and
tone.
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg
A summary is
considered the most
important information. It
Summary tells the readers what
will be discussed.
Background
information answers the
Background who, where, when, and
why.
The discussion depicts
each item or topic and
Discussion identifies any actions
required.
The outcome is a
Details/Action general statement of
results and any
recommendations.
Depending on the type
Outcome/Action of document there may
be additional levels of
necessary information.
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg
•Tone is created by the language the writer chooses for the
audience.
Tone
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg
Illustrations include:
Charts
Graphs
Tables
Pictures
Diagrams
Illustrations provide
clarification for readers
Graphs illustrate concepts
Illustrations make a
document more visually
appealing
Graphs need to be simple
and cluttered
Illustrations should only
depict one main point
Illustrations should be
clearly labeled
Kimberly Gilles
Kimberly Gilles
Technical Communications BS310
Dr. Janice Spangenburg