Download as pdf or txt
Download as pdf or txt
You are on page 1of 4

DOCUMENTS AT WORK • NO.

Reports
R eports are just like letters and
memos, with one difference –
more layers of information. So
ideas and structure them logically
so that the reader follows you to
your conclusion.
while the general messages about
Your effort will be wasted if the
memos and letters also apply to
report is not clear, concise and
reports, you need to be especially
understandable.
careful in planning the structure.
If you write a report the way you
Have a good reason to write the
would tell a friend a good story,
report. What do you need to
you might find that people actu-
accomplish? What do you want
“I make it a rule your readers to do? Develop clear
ally enjoy reading your reports.

only to believe what


I understand.”
Benjamin Disraeli
Page 2 • Reports

Follow a plan
Starting &
finishing
Before you start to write, ask
yourself these questions:
• Why am I writing?
• Who is my audience? Planning the Mapping the parts
• What do I want them to do? structure In any report of more than, say,
• What information do I need? 10 pages, it is easy to get lost.
Preparation is essential before you
But there are several devices that
Before you send the report, actually begin to write. Plan the
can help the reader step through
answer these questions: structure and sketch an outline of
even complex documents.
the report.
• Do the facts and structure support • Title – Start with a title that
my conclusions? 1 Introduction – Start with a
describes the report and says why
sentence or short paragraph that
• Have I given my readers the the reader will find it important.
clearly describes the reason you
information they need to act? Your report is often competing
are writing.
with others for attention, so the
2 Summary – A report should have
title should carry impact – both
a section near the beginning that
in its layout and in its meaning.
sums up what you are going to say
along with your conclusions. • Table of contents – This serves as
Adding page 3 Sections – Divide the report into
the map of the document. It
describes the subject matter and
numbers logical sections. Avoid covering
the same subject under different
helps the reader locate specific
parts. Make sure it is accurate,
Page numbers help the reader step headings unless you explain why
especially after you have made any
smoothly through your report. you are doing it.
revisions.
They are most helpful when they 4 Appendices – If you have a lot of
are visible at a glance, so keep • Headings – If the contents page is
background material or reference
them on the right-hand margin of the map of a report, then the
data, put it in an appendix.
the page – either at the top or the headings are its signposts. They
bottom. Put actions in the appropriate are powerful tools for navigating
places, perhaps in the summary or through the document.
If you are printing on both sides of
at the end of each section.
the page, remember to alternate Headings must have meaning and
Wherever you put them, make
left and right sides. be relevant.
sure they are clear.
Don’t center the page numbers at Section 3 isn’t helpful, but
the bottom, since they may not be Size of U.S. printer market is.
seen there.
Headings also help the reader
locate information, so the words
15
should match those in the text, the
✔ ✔ ✔ ✘ contents page and any footers.

15 14 15 15
Xerox • Documents at Work • Page 3

Typefaces
Today’s technology tempts us to
put dozens of typefaces onto a
single page. Don’t do it!
Simple is better. Avoid using more
Space is very
than two typefaces in one docu- important
ment. Rather than different type-
faces, use different styles of the Some reports contain so much
same typeface for different effects. information that the reader’s eye
simply can’t take it all in. Space
• Larger or bold for headings can make it accessible.
• Italics for emphasis, a different • Wherever possible, start a major
voice,“quotes”or examples section with a new page.
• AVOID UPPER CASE, WHICH • Make sure the type size is readable for all your readers

IS DIFFICULT TO READ even if it means the document needs more pages.


It is more difficult to read 3 pages of small
• Avoid underlining more than a few text through a large magnifying glass
words, since this is hard to read than to read 4 pages of clear text.

• AND AVOID UNDERLINED • Put enough space between lines,


UPPER CASE, WHICH IS VERY so the text is easier to read.
DIFFICULT TO READ INDEED If you are using 10-point text, use
14-point line spacing.
Show the way • BUT WORSE STILL IS UPPER
CASE TEXT IN A BOX • Separate paragraphs with an
BECAUSE NOW THERE ARE additional space equal to half of
LINES SIMPLY EVERYWHERE your line spacing.
• Put more space between a heading
and the preceding paragraph
than between the heading and the
paragraph to which it refers.
Headers & footers
These references are invaluable in a long report. They If your text size is
10 points, then use:
remind the reader what section they are in and where that
section fits into the report as a whole.
14-point line space
• If the report has only one section, then quote the report: 14 points between
Marketing strategy Page 10 (or more)
Heading
7 points between
• If there is more than one section, quote the name of each:
Publicity campaigns Page 41
7 points between
• Reinforce section numbers:
3 • Publicity campaigns Page 41

• Use footers to record drafts and dates:


Mkt strat • Draft II • 12/12/95 • p 10
Page 4 • Reports

Illustrations, Bullets & numbers


graphics & tables • Use a bullet to define each point in
a list of examples.
Illustrations are powerful tools.
They can lighten the text, explain
Divider tabs • Use numbers where the sequence
a complex set of numbers, empha- Tabs can help separate and iden- is important, otherwise you may
size a key message, and provide tify major sections in large reports imply a priority where none exists.
useful links through a long report. and manuals. • Avoid more than two levels of
They can also make the report a
Avoid arranging letters C bullets, or the structure may
lot more inviting.
vertically – they can be Y become confusing and unclear.
Here are a few pointers: hard to read. C • Be consistent with numbering:
• Make sure the graphic contributes L 1 2 3, i) ii) iii), and a) b) c).
substantially to your report, other- I
wise it may be a waste of space. C

• Illustrations that are intended to


explain should explain. If the
graphic requires its own explana-
tion, find a better graphic.
• If you need to explain numerical
information, consider using a
table. QuickCheck
• Don’t waste 20 minutes on a
■ Is there a good reason for writing your report?
complex computer graphic, when
you could draw a clear illustration ■ Does it contain all the information, and is it correct?
by hand in one minute.
■ Did you include a summary?
■ Is the report structured to make the information clear?
■ Is it concise enough?
■ Have you used graphics or illustrations to help enliven the report?
■ Have you asked someone else to check it?
■ Will your reader take the action you want?

Further reading Further information Further copies


The Chicago Manual of Style, 14th Edition For further information or ideas for future If you want to be included on the mailing
by the University of Chicago Press topics please contact: list or need further copies of any article,
Ann Silvernail at Stamford 8*344-3307 or please contact Kelcey Johns at 8*344-3817
Publication Manual of the American
David Jones at Marlow 8*666-3724. or kelcey_ johns@ea.xerox (or kelcey_ johns
Psychological Association
@ea.xerox :com :xerox from GlobalView).
Documents at Work are written and
Technical Writing by Mills & Walter
designed by a team from Xerox with Electronic versions of Documents at Work
Other related articles in the Documents at Cavendish Consultants in Cavendish UK are available in Adobe Acrobat format.
Work series cover style, grammar, design, and Inside Out Design in New York. Information on retrieving them can be
graphics and tables, and color. Illustrations are by Susan Smith. The arti- found on the World Wide Web at http://
cles are created with QuarkXPress page www.internal.xerox.com/docsatwork.html
layout software and a Xerox 8808 printer.
© 1995 Xerox Corporation

You might also like