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.
>I'm looking at combining some very technical material with a user guide.
Both are fairly small (less than 100 pages). Previously we used two
separate documents, but I'm considering integrating the material. I want
to do it in a way that neither intimidates less technical users nor
"turns off" the techies. Has anyone else done this successfully? If so,
how?<
Jane,
Have you considered constructing modules each task, starting with the
step-by-step info and "peeling the onion" into more and more technical
detail? That way, novice users can get immediately to the stuff they
need, intermediate users can get a bit more detail, and advanced users
can keep reading for the "techie" stuff. HP developed a strategy like
that for information delivery several years ago, and it worked pretty
well.
Readers will quickly learn your structure and be able to find the level
of detail they need.
==================================================================
Art Elser (303) 965-4825
Information Developer, U S WEST aelser -at- uswest -dot- com
There is no such thing as a problem without a gift for you
in its hands. You seek problems because you need their gifts.
Illusions Richard Bach
===================================================================
