TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> 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, http://www.syntax.com
