Académique Documents
Professionnel Documents
Culture Documents
Tammy Trocki
Volume 3 Number 5
July 1996
Executive Editor
Suzanne Cooper
Editor
Jacqueline S. Garnier
Krista Kaminski
Production Coordinator
Dorenda Dawn Fisher
The AMS Best Practices Focus Series is a collection of papers that highlight particular methods, techniques, and
considerations related to AMS’s business consulting and system development activities. The series is published
by the Best Practices Program in the Corporate Technology Group. You can access the papers in this series
online in the AMS Best Practices Publications database on the AMS Knowledge Express®. For additional printed
copies or a list of available publications, call the Best Practices Program at 703-AMS-BEST (+703-267-2378).
This document contains confidential and proprietary information of American Management Systems, Inc.
Reproduction, disclosure, or use without the specific written authorization of American Management Systems,
Inc. is prohibited.
AMS, the AMS logo, and LPS are registered trademarks of American Management Systems, Inc. AMS Center
for Advanced Technologies, AMS Knowledge Express, and Achieving Breakthrough Performance are registered
service marks of American Management Systems, Inc.
Lotus Notes is a registered trademark of International Business Machines Corporation. All other products are
trademarks or registered trademarks of their respective companies.
Contents
CONTENTS I
AN EXAMPLE TO EMULATE 16
REFERENCES 17
Good writing is hard work. Good writers say a few things well.
First they set readers’ expectations of what they will say, then
they write clearly, concisely, and engagingly to fulfill those
expectations. Some writers, like our friend to the left,
underestimate the effort.
In this paper, we give you some tips to make your writing easier
to understand and to help you inform and persuade your reader.
These tips fall into three areas:
Build in repetition
with Roman numeral one and fill in headings for the sections
and subsections sequentially until your outline was done.
Then you got out a fresh sheet of paper and, starting again with
Roman numeral one, you were supposed to write paragraphs for
each heading sequentially until your paper was done.
Well, this didn’t work well in seventh grade and it still doesn’t
work well for most writers.
Chances are you are like most writers. Don’t feel bad about your
apparently disorderly process—it is “iterative development” at
its finest. Eventually, you do have to produce a beautiful outline.
Why? Because it will become your table of contents and the
headings within your text. It will embody your organization and
highlight your message to the reader. But you don’t have to
stick to your first attempt. You can let it evolve.
In the table of contents, your reader will scan your headings and
read them if they are informative. Then, in the text itself, your
reader will see your headings repeated, word for word. And
those headings will be emphasized by the format—set off with
white space, in boldface, or a different font. Don’t use ready-
made generic headings such as “Background,” “History,” or
“Overview,” when you can use ones that are so much better.
Generic Informative
Conclusion ➨ AMS Meets or Exceeds All Requirements
Overview ➨ History of Financial Management Modernization
Program
Phase 1 ➨ Phase 1: General Ledger Only
Build in Repetition
Reports deliberately incorporate repetition because readers
need and expect it. The executive summary or management
summary duplicates the main points of the report. The headings
in your table of contents are repeated in the headings in your
text. Then your headings in the text are expanded into
paragraphs of the text itself. Why is this repetition good?
Use Meta-Discourse
If the information that you have to present is the discourse, then
the meta-discourse is the words and phrases that help the
reader see the logical relationships between pieces of
information.
Figure 1. Meta-Discourse
To Signal… Use…
Similarity likewise, just as, in the same way, as, similarly
Coordination in addition, too, also, and
Contrast however, yet, but, nonetheless, although, in spite of,
or, rather, on the other hand
Illustration for example, such as
Consequence therefore, thus, then
Cause for, because, since
Sequence first, second, primary, next, finally, later
Time before, after, since, when, while, until, meanwhile
Condition if, unless
For example, repeat words and phrases that embody your main
ideas. In the last paragraph of the previous section, we repeat
“logical order” three times and “paragraph” twice, since these
phrases reinforce our main idea—that paragraphs should have a
logical order.
Repeat words and phrases when you refer several times to the
same thing. Some writers get the mistaken notion that they
should use synonyms instead. They call a user “the user” in one
place and “the clerk” somewhere else. This makes the reader’s
job harder, since he or she may puzzle over the distinction.
The last two bullets should be rephrased, starting with the same
part of speech as the first two bullets:
Write naturally
Write clearly
Write concisely
Write Naturally
Because readers mentally hear what they read, good writing
sounds like the best of good speaking. It is personal, warm, and
relates its message to its audience. Try to:
Use personal pronouns. You show your reader that you take
responsibility when you say “I” or “we.” (“In Phase 3, we will
prototype the online system,” not “Phase 3 involves the
prototyping of the online system.”) And chances are you will
remember to relate your message to the reader’s perspective
more often if you address the reader as “you.”
Use everyday words. Don’t use big words when little ones
work:
Write Clearly
An anonymous cabinet member under President Warren C.
Harding wrote:
Passive Active
Customer data will be Directory Services will retain
➨
retained for seven years. customer data for seven
years.
In order to achieve the Mr. Smith, our Senior
➨
modernization objectives Architect, will divide approved
within program constraints, subsystems into work
subsystem packaging efforts packages that can be
must take place. completed during the
shortened repair periods.
This task will be performed Jane Doe will supervise this
➨
under the direct supervision task.
of Jane Doe, who will act as
Task Leader.
Define unfamiliar terms before you use them. This advice applies
to most abbreviations. The rule is to spell out the full term and
give its abbreviation the first time you use it in a piece: “The
Federal Trade Commission (FTC) has a project underway …”
Thereafter, use the abbreviation only: “The FTC proposes to
…”
Write Concisely
Get to the point. Here’s a piece from a writer who didn’t follow
this advice:
Most first drafts can be cut by 50 percent. They are swollen with
words and phrases that add nothing and make the reader work
too hard. Edit to make your writing more concise. Here are some
specific tips for writing concisely.
Cluttered Concise
the question as to whether ➨ whether
he is the man who ➨ he
at this point in time ➨ now
until such time as ➨ until
the fact that we had arrived ➨ our arrival
call your attention to the fact ➨ remind you
due to the fact that ➨ because
used for security purposes ➨ used for security
Negative Positive
do not use avoid
➨
did not remember forgot
➨
did not pay attention to ignored
➨
did not have confidence in mistrusted
➨
Avoid “the –tion of” and “the –ment of”. Try a verb or “—ing”
form instead:
Noun Verb
for the preparation of ➨ to prepare
A high fog index means that you are using long sentences and
big words, which usually makes the work hard to understand. A
low fog index indicates shorter, cleaner prose.
AN EXAMPLE TO EMULATE
To show the difference between bad and good writing, George
Orwell once took a passage from the Bible and “translated” it.
REFERENCES
Briere, Rona. Organizing Technical Information. Internal paper of
the Mitre Corporation, 1990.
Strunk, William and E.B. White. The Elements of Style. New York:
New York: MacMillan Publishing Company, 1979.