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: Requests for changes in documentation From:Paul Hanson <PHanson -at- Quintrex -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 8 Mar 2001 07:23:40 -0600
Forget about a 'form' it'll just create a process people will ignore. Have
your sys admin create a "documentation -at- synavant -dot- com" address. Put a mailto:
link in your .hlp file to open up your user's email software that completes
the subject line with "Help needs Help" (or something equally indicative of
the email's contents). You could set up a rule, at least in Outlook you can,
where any email from 'documentation -at- synavant -dot- com' will go to a specific
folder. If, at some point, you are getting hundreds of emails a day on a
consistent basis, then look at setting up a 'formal' procedure.
And for print manuals, have the users fax/photocopy/email you with specific
page numbers and text that needs to be changed.
I have a mailto link in each of my .hlp files and a statement that says to
send help changes to documentation -at- quintrex -dot- com -dot-
my $.02.
Paul
> -----Original Message-----
> From: "Honoré, Jo" [SMTP:]
> Sent: Thursday, March 08, 2001 5:14 AM
> To: TECHWR-L
> Subject: Requests for changes in documentation
>
> 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...).
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.