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: Documents I'd like to see...or write... From:"Karen E. Black" <kblack_text -at- hotmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 17 Jul 2001 16:53:11 -0400
I've been "borrowed" by a manager to "help" her write a user/training manual
for Customer Service Reps who answer calls from clients about completing an
online order for a direct-mailing service. I had a couple of meetings with
her, spent a day thinking and surfing, and came up with about 30 specific
scenarios that the CSRs may get calls about. Not all calls will require a
complete walk-through for the customer with the CSR.
Her: "Well...no. Just document everything."
Me: "Everything?"
Her: "Yes, this should explain everything that a customer can do that the
CSR might need to help with. I can do it, but you're better at the verbage.
And it has to be in Word, so we can make changes to it when we want."
(BTW, a lot of people here say "verbage." I don't want to tell them that
it's "verbiage," and it means EXCESS prose, something I tend to remove when
I edit someone else's work.)
Documenting everything is much easier, takes 4 times as long, and requires
very little imagination. Oh, well. Imagine a CSR manual that lets him or her
click a link and say, "Here's what you need to do to get to the next step."
Maybe someday....
Karen E. Black
Technical Writer, Verbage Editor and Foilage Whacker
www.dhltd.com
--------------------------------------------
"Higgledy Piggledy, my white hen;
She lays eggs for gentlemen.
You cannot persuade her with gun or lariat
To come across for the proletariat."
--Dorothy Parker
_________________________________________________________________________
Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
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.