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.
Preference: One Big Manual or a Bunch of Smaller Ones?
Subject:Preference: One Big Manual or a Bunch of Smaller Ones? From:Kevin_Feeman -at- HILL-ROM -dot- COM Date:Wed, 28 Apr 1999 10:52:46 -0400
All:
I got a legacy document that was over 300 pages with a lot of information. It
was once called a Theory, Installation, and Maintenance Manual. It has just
about every type of information that could ever be needed including user guide
stuff, part numbers, troubleshooting, etc. It was horribly written, designed,
and IMHO, has way to much data to be digested by an end user, in this case, it
would be a nurse or similiar type person in a healthcare facility.
After trying to figure out what this original TIM was supposed to be, I decided
to break it out into four smaller manuals: an installation manual, user's guide,
system design guide, and a troubleshooting/maintenance manual.
My question is this: Would an end user rather have a large document that
contains lots of information in a format that is hard to use and find the
necessary data, or would a user prefer to have smaller documents where the
information is easily accessible? My assumption is that the user would rather
have something that is useful, hence the small documents. Has anyone else had
experience in this, I am sure you are out there! It seems like a common problem,
at least in my experience that companies try to cram way too much information
into manuals. But I don't have the access to end users to do a usability study
on this issue. Any thoughts, opinions, ideas?