Re: Examples of good tech writing

Subject: Re: Examples of good tech writing
From: "Jane Bergen" <jbergen1 -at- earthlink -dot- net>
To: "Robert Heath" <rheath -at- eGain -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 3 Dec 1999 20:10:43 -0600

Unfortunately, on this list everyone is very quick to point out the
bad stuff! I have a tendency to do that myself.....but for printed
manuals, I think the FrameMaker 5.0 manual was good, as was one of the
earlier PageMaker manuals (4.0 or 5.0). I also liked the AutoDesk
manual I saw a couple of years was excellent! It gave a quick
view (for those of us who think we know it all..or who are already
somewhat familiar with the program), then more detailed instructions
with the "why" for each step.

One thing I always encouraged my tech writing students to do was to
keep a "clip book" -- a 3-ring binder in which you store various
photocopies of selected pages from manuals that you really like.
Usually less than 5 pages per manual is adequate to really get the
look and feel. Sometimes when you want to be creative, it can help. I
just walked around my company and asked everyone if I look through
their user guides. They had a lot of programs that I wouldn't
necessarily have, so it was very instructive.

Jane Bergen

----- Original Message -----
From: "Robert Heath" <rheath -at- eGain -dot- com>

> The recent thread about best-of-breed help systems got me wondering
how I
> might get a look at examples of best-of-breed hard-copy manuals. As
a rookie
> writer in a rookie publications department, I hunger for examples of
> has worked, as well as examples of different formats and methods of
> organizing content. While I find value in reading books offering
> tips, and tricks on how to make manuals users will enjoy consulting,
I would
> gladly chuck a fair number of those books for one or two actual
manuals that
> do the trick.
> If I can't actually buy the product that comes with the manual, I'll
> the manual from someone anywhere (well, within a reasonable
distance). What
> are some of the best-of-breed manuals out there?
> --Robert Heath

Previous by Author: Assumptions (was: Designing a new help system)
Next by Author: Re: word
Previous by Thread: Re: Examples of good tech writing
Next by Thread: Re: Examples of good tech writing

What this post helpful? Share it with friends and colleagues:

Sponsored Ads