RE: User guides to die for

Subject: RE: User guides to die for
From: "egalite" <egalite -at- westnet -dot- com -dot- au>
To: "'Richard Lewis'" <tech44writer -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 11 Oct 2006 08:10:21 +0800

Hi Tony,

Nah, I'm not looking for a methodology, I'm looking for actual files, pages,
etc - examples of real live documents that you can point to and say, "look,
this is a good one!". A manual that "talks the talk and walks the walk", to
use a cliche`.

Trish :)


From: Richard Lewis [mailto:tech44writer -at- yahoo -dot- com]
Sent: Wednesday, 11 October 2006 4:50 AM
To: egalite; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: User guides to die for


If you want concrete specific steps, sorry, I have research this and the
closest thing that I found to my (below) approach is what is discussed in a
book by Edmund Weiss (I think that's his name).

Tony Lewis

egalite <egalite -at- westnet -dot- com -dot- au> wrote:

Thanks, Richard. So are there any links you might like to share?

Trish :)

: From: Richard Lewis
: By far, the main things I look for in documentation are the following:
: * Are the number of skips and jump to's that I need to
: perform to find the info that I need minimized?
: * Are graphics used and used properly? The human mind
: best processes info from the general to the specific. And,
: for info systems, the big picture is best presented via graphics.
: * Is the work properly patitioned into equal size pieces?
: * Are headings, as much as possible, in the end-user's
: terms? I (the end-user) want to use the system to, for
: example, calculate the sales tax. I do not want to roll out
: the circular polarization and adjust the servo modulators. I
: may need to roll out the circular polarization and adjust the
: servo modulators in order to calculate sales tax - but, I
: want my headings to be stated in terms of my goals - not in
: terms of implementation technology.
: Richard Lewis
: egalite wrote:
: So, my question: which user guides do you look at as a
: "best practice"
: example for your own work? Are there any that you just plain
: like for unknown reasons? It can be one you have written, or
: something from somewhere else entirely. What do like most
: about it? Oh, and if it's available online, a link would be nice :)


Do you Yahoo!?
Get on board. You're
eta> invited to try the new Yahoo! Mail.


WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


RE: User guides to die for: From: Richard Lewis

Previous by Author: RE: User guides to die for
Next by Author: RE: User guides to die for - OT
Previous by Thread: RE: User guides to die for
Next by Thread: Re: User guides to die for

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

Sponsored Ads