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:Hybrid document: user guide & training workbook From:"Catherine Dexter" <Catherine_Dexter -at- picis -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 18 Nov 2004 14:21:33 +0100
Does anyone have experience not only merging documentation and training
groups but also merging deliverables? I mean one document that serves
the purpose of a user guide and training workbook.
Background:
My company merged the documentation group with the training group to
remediate a dire shortage of training materials without hiring new
staff. To cover the need for both documentation (manuals and help files)
and training materials (presentation slides, classroom workbooks,
exercises), a hybrid deliverable was conceived: a slide presentation
with a workbook that combines classroom material with detailed product
information, with an index and TOC. The document also serves as a source
file for the online help system. Units replace chapters roughly and each
unit can be presented alone, combined with others for a specific
training event, or bundled with all others to produce an all-inclusive
workbook that takes the place of the user guide for the product.
We create a slide presentation and create a workbook around it,
inserting an image of a slide at the start of the corresponding topic.
Underneath we put documentation content (background information, tips,
warnings, procedures, index markers), plus classroom activities and
exercises, notes to the instructor, cross references. There is a lot of
conditional text. We're using FrameMaker 6 and mifToGo.
I'm struggling mightily to create a source file that serves three
purposes. Experiences that help answer the following questions would be
greatly appreciated:
-Does the deliverable work well for both audiences?
-Any tips on information design that works for both audiences?
-Where can I learn how to do this more effectively?
-Is this an effective way of single-sourcing?
ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!
RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo
---
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.