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.
Re: Differences between Training guide vs User's Guide
Subject:Re: Differences between Training guide vs User's Guide From:Art Campbell <art -dot- campbell -at- gmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 17 Aug 2005 10:16:52 -0400
Having written both as a course developer and a documenation writer,
I think your feeling that info should not be duplicated is accurate.
The User Guide should document the product and its capabilities.
The Training Guide should document the tasks the user performs
most often. It should consist (I think) mostly of guided exercises
that show the progression from screen to screen. It should refer
to the documentation for any technical discussion or information,
so the users become habituated to using the documentation to
solve problems. The key to this is knowing your audience and
the tasks for which they use the product. Then showing them
how the product and the task intersect.
One book documents the product. The second documents the
way the product is most often used.
Art
On 8/17/05, Daniel Ng <kjng -at- gprotechnologies -dot- com> wrote:
>
> My team and I are beginning to start work on a training guide. They have
> The issue is what are the key differences that a training guide should
> offer.
--
Art Campbell art -dot- campbell -at- gmail -dot- com
"... In my opinion, there's nothing in this world beats a '52 Vincent
and a redheaded girl." -- Richard Thompson
No disclaimers apply.
DoD 358
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
