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.
--- Jean Cooper <Jean -dot- Cooper -at- twtelecom -dot- com> wrote:
> I have just completed a draft of a 70-page technical manual to be
> given to new employees who join an IT team of 10 people. My next step
> is to request that the 10 team members review the manual and offer
> any feedback they have.
> What is the best way to solicit feedback? I'm reluctant to distribute
> an electronic copy because I don't want people making changes to the
> document without checking with me first. If I pass around the hard
> copy, should I just ask people to write their comments/suggestions in
> the margins and write their initials as well?
> I'm new to this process and appreciate any advice you all have!
First, your instincts for getting feedback are good. Since your
audience seems to be new people joining the team, existing team members
should be able to help you.
I don't think you should be reluctant to distribute electronically, as
long as you keep the 'official' draft safe from changes. Each reviewer
can comment or otherwise mark up their copies without messing with your
'official' version. YOU can then control what goes into that and what
doesn't. Have them use DIF marks and different styles in their
comments/changes (in MS Word you can have them use the track changes
feature to handle this part...other programs have similar
Set a reasonable time, but not too long, to get comments. Then plan to
hold a meeting to review/resolve conflicting suggestions, which you
will get. Plan also to follow up individually with reviewers who
'forget' or get 'too busy' to send you comments or participate in the
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
TECH*COMM 2000 Conference, Help Technology Conference, and more http://www.SolutionsEvents.com or 800-448-4230
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.