Requests for changes in documentation

Subject: Requests for changes in documentation
From: "Honoré, Jo" <JHonore -at- synavant -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 8 Mar 2001 12:13:46 +0100

We deliver documentation and tutorials for our -internally used- software programs. Documentation consists of on-line help files, user manuals, technical reference manuals, and system administration guides. We also deliver separate papers providing more background on concepts and design, or on specific items that affect several modules.
The Quality Assurance department wants us to include (or refer to) a form allowing the users to return comments on the documentation. The users are technical people.
The purpose is to standardize and enhance the process of documentation reviews by getting feedback on inaccurate procedures (missing steps in a particular environment) or missing features, and to integrate support instructions (what to do if...). Personally, I would also like to add the point "difficulties in finding information", which could lead to reviewing goals for action, indexes and even the structure of a (legacy) document.
My questions are:
Does anyone have experience with this kind of forms?
What fields should be available in the form to obtain significant information?

Jo Honore
Manager, Learning Solutions
e-mail: jhonore -at- synavant -dot- com


Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30) or 800-646-9989.

IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.

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 for more resources and info.

Next by Author: Title for a Document about bugs
Previous by Thread: Re: "Ideal" help system was task-orientated vs. reference help
Next by Thread: RE: Requests for changes in documentation

What this post helpful? Share it with friends and colleagues:

Sponsored Ads