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.
Don't make the customer look for anything. Or wonder. Or be angry or
frustrated. There are options that will satisfy the customer and, if
not satisfy, pacify your boss.
Customers must have happy thoughts when using your widget. Frustration
2x/year is two too many. Not to mention what your customer support
people are going to have to say!
I think I need a sanity check. I'm going around in circles in a dis-
cussion with my boss, and I want to get some feedback on my
Background: I'm revising an operating manual for our product. The
current manual is a three-volume set, about 525 pages total
(including appendices). It's not really well organized from a user's
point of view, various level tasks are mixed in with each other. As
an example, there is no single place in the book where you can
find the basic step-by-step info for a novice user to do a basic
machine operation. The data -is- all in there....somewhere. I agree
that a major reorganization is required.
In addition to this reorganization, we're issuing a major software
release in a couple of months. Everything in the operating system
will look different.
We're splitting the book up so that tasks are grouped by the user's
ability level. Level one is a basic operator, level four is an expert.
We'll publish a book with all level one and two procedures, a book
of all level three procedures, and a book of level four procedures.
(I've over simplified a bit, but please bear with me). So far, so
The boss is all hot on getting the Level 1 & 2 book out, and has ini-
tiated work on the Level 4 book. But the Level 3 stuff is being
intentionally back-burnered. We probably won't issue a level 3
book until at least 6 months (maybe longer) after the software
release. The level 3 procedures total about 265 out of those 525
Based on the software release schedule, I should be able to
update all the pages, so that's not the problem. The boss has "big-
ger and better" plans for the Level 3 work (including troubleshoot-
ing data that has never been developed), and he doesn't want to
release the book until all this "vision" stuff is ready. I say that we're
doing the customer a disservice by releasing software and deliber-
ately choosing to omit significant procedures. His argument:
"That's the stuff they only do a couple of times each year. It's not
So, what's the Techwhirler's reactions?
rlippinc -at- bev -dot- etn -dot- com