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: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
SYNAVANT Inc.
e-mail: jhonore -at- synavant -dot- com
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
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.
