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: training guide vs. user guide From:"walden miller" <wmiller -at- vidiom -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 23 May 2002 11:49:55 -0600
...
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.
...
If you only have 10 days, I would punt the user guide strategy and go
straight to a training "slide" strategy.
Leveraging your ability to organize and structure info, write an in-depth
outline of the course.
This is the slide show that the trainer will talk about.
Once this is done...
THEN go back and take the "conceptually hardest" information nuggets that
exist and work on fleshing them out in the outline. Work on a nugget by
nugget basis until your time is up. Just make sure the outline fully scopes
the course so that those who take the course can take extensive notes in
your outline.
Whatever is done in 10 days is done.
Finish the job after the 10 days is over and field replace the training
manuals.
just my .02
walden
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
