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.
Just found out that the powers-that-be WANT to test out the user guide
(which is still in progress) during an informal training session tomorrow.
I want to suggest an effective approach. ANY IDEAS? Here are some of mine,
please let me know what you think:
1. Make the user guide the agenda for the training session. These are the
topics we're going to cover... The instructor should ask himself whether
the organization flows smoothly, are important topics covered, are we at the
right level of detail, is content accurate, are participants' questions and
concerns are covered in the book?, not covered in the book?
2. Before beginning, ask participants to write down as many questions as
they can about the product, how to use it, troubleshooting, etc. Be as
specific as they can. Then I can compile a list of common questions and make
sure they are included in the guide (and maybe include it as an FAQ?).
3. After the session, ask participants what questions/concerns were not
covered in the session and/or in the guide. Make sure these are added in the
guide.
4. At the beginning of the session, ask participants to use the guide to
find specific information about the product, and assess how easily they can
get at the answers.
Do you think these exercises would work well?
Thanks for your time :)
Neha Sharad
Freelance Technical Writer
703-626-3894
_________________________________________________________________
Get your FREE download of MSN Explorer at http://explorer.msn.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
Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.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.
