Re: Technical Writing, QA, and Training

Subject: Re: Technical Writing, QA, and Training
From: Mike Stockman <stockman -at- jagunet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 09 Mar 2001 15:55:04 -0500

At 02:30 PM 3/9/2001 -0500, Mark -dot- Eichelberger -at- Aftech -dot- Fiserv -dot- com wrote:

Do any Technical Writers on the list have experience in both
training and technical writing and are they called upon to perform both

1) Training users in person is the best and most effective way to test your knowledge and how you explain the concepts in the product. Teaching classes and training colleagues has improved my writing no end, because I tend to use the same phrases and structure in training that I do on paper/screen. If I say something and get blank looks from the "class," I know immediately that I have to stop saying it like that in my writing. I can then try other words, phrases, and concepts until the light bulb goes on, and then remember to use that in my writing as well.

2) In the course of writing doc, you'll encounter bugs and UI issues, which I feel obligated to share with the QA department, whether I'm a part of the same "structure" as they are or not. It doesn't take much time to report problems, and it makes the product better. Also, if it's not a bug or if I'm misunderstanding the UI issues, it improves my doc to know this.

Ultimately, you're all working toward the same goals: good products that help your company. If they're asking you to participate in tasks that lead you closer to that goal, why not do it?



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.

Previous by Author: Re: How formal or informal?
Next by Author: RE: Technical Writing, QA, and Training
Previous by Thread: Re: Technical Writing, QA, and Training
Next by Thread: RE: Technical Writing, QA, and Training

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

Sponsored Ads