Re: Documentation Usability/Multiple-User Design

Subject: Re: Documentation Usability/Multiple-User Design
From: John Wilcox <john -at- SYNTAX -dot- COM>
Date: Thu, 9 Nov 1995 11:48:16 -0800

> In a message dated 95-11-08 20:22:09 EST, MONFORTO -at- EMUVAX -dot- EMICH -dot- EDU (Margie
> Monforton) writes:

> >I am trying to determine
> >whether anyone has studied the methods of documentation design
> >that can help writers create a layering effect so that both
> >novices and experienced users (of the product or procedure) can
> >access information efficiently.

Recently I did a user's guide for a software product that required
documentation of numerous configuration file directives. Though most of
the directives had defaults that 99% of the world would use, they still
had to be documented. So I divided the descriptions of the various
files into sections flagged BASIC and ADVANCED. I used small caps for
all but the initial letters and set the words in white Copperplate
in a frame with a black background. (I would've used cyan or blue, but
my boss is too cheap to spring for a second color.)

John Wilcox <john -at- syntax -dot- com>
Senior Technical Writer
Syntax, Inc., 840 S. 333rd St., Federal Way, WA 98003-6343 USA
voice 206-838-2626, fax 206-838-9836,

Previous by Author: Re: If it's not Unix...
Next by Author: profane logic
Previous by Thread: Re: Documentation Usability/Multiple-User Design
Next by Thread: Re: Documentation Usability/Multiple-User Design

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

Sponsored Ads