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: Technical Reviews of On-line Help From:Jeff Hanvey <jewahe -at- yahoo -dot- com> To:Cathy Arthur <carthur -at- ndigital -dot- com> Date:Thu, 18 May 2000 07:30:49 -0700 (PDT)
I think the reviews should be an ongoing part of the
process. Correct the problems during each stage,
rather than trying to tackle it all at once. Also,
reviewing in stages lets the reviewers focus on one
thing rather than everything. I would follow this
process:
1. Check the accuracy of the information. Don't do
anything else until you are certain that this is the
best structure for the help, and that you're giving
the correct information.
2. Check the intergration of the help with the
program.
If you search yesterday's archives, I posted a summary
of how to track reviewer comments. Some of the methods
there might work for you (especially the binder
method). I'll forward you a copy privately.
For the first step, I would split things up: have some
reviewers use paper and others use on-line. There may
be some problems that show up on the screen
(formatting especially) that won't on paper, and vice
versa.
Obviously, the second step can only be done on the
computer. As they go through the program, make sure
they take notes. Have them write up their notes in a
formal document and cross-reference them with topic
titles (or page #'s - or whatever method you're using
to keep track of the pages). Again, the binder method
might come in handy for keeping track of these
changes.
HTH!
=====
Jeff Hanvey
Memphis, TN
__________________________________________________
Do You Yahoo!?
Send instant messages & get email alerts with Yahoo! Messenger. http://im.yahoo.com/