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.
Subject:Re: Printed vs. Online: What mix? From:Bonni Graham <bonnig -at- IX -dot- NETCOM -dot- COM> Date:Wed, 27 Sep 1995 00:44:48 -0700
Mike Star wrote:
>I'd like to get a feel for how other companies out there blend printed
>and online software documentation. <snip> How do you vote?
>1. Comprehensive printed/comprehensive online
>2. Minimal printed/comprehensive online
>3. Comprehensive printed/minimal online
4. None of the above. I structure my manuals according to four basic
questions:
a) What is it? (descriptive text for each dialog/screen)
b) How do I do it? (procedural text for each process)
c) Why do I do it? (theoretical/background information)
d) Why did it do THAT? (troubleshooting/error message interpretation
text)
The informal research I've done suggests that most people look for a,
abbreviated b and c, and d (when the system isn't crashed) online. They
look for more detailed b and c, and system-crashing d on paper.
It doesn't fit any of the models Mike suggested above, but so far my
clients' users LOVE it.
Bonni Graham
Manual Labour
bonnig -at- ix -dot- netcom -dot- com
