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:training guide vs. user guide From:"Writer Whirler" <a_whirler -at- hotmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 23 May 2002 12:39:14 -0500
I have been asked to write a training manual for our support department. I
just checked the archives and I read the "training guide vs. user guide
discussion" threads. I know the basic differences between the two.
The general assumption is that a training guide will be used by an
instructor in a classroom-type setting. For our purposes, the support people
will be on the phone with someone, learning about the new features of our
application, with my guide in front of them. They know next-to-nothing
nothing about the application (and neither do I, for that matter.) After the
"training," my guide will be their only written reference about the new
features and enhancements.
I can see the value in presenting information to support in more of a
user-guide fashion, but I'm wondering if this is appropriate. I was told not
to get too detailed, mostly because of time constraints (I have 13 modules
to write about, and about 10 days to do it, and that includes weekends!)
I have more experience writing user guides (and, really, none in writing
training guides...), and my brain seems to want to structure information
primarily in the user guide format. Would I be doing more harm than good in
going with my inclinations? Or should I try to learn a new skill ("How to
Write Training Guides") despite my really, really tight deadline?
Any opinions are welcome. Thanks.
WW
_________________________________________________________________
Join the world?s largest e-mail service with MSN Hotmail.
http://www.hotmail.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.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.
