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.
Looks like I left out some details and that led you to believe otherwise.
Apologies.
Steve
From: Keith Hood <klhra -at- yahoo -dot- com>
Sent: Tuesday, March 13, 2018 7:37 PM
To: Janoff, Steven <Steven -dot- Janoff -at- hologic -dot- com>; Erika Yanovich <ERIKA_y -at- rad -dot- com>; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: tech doc - training cooperation
Please, no. The instructor should work from a specialized manual. It's like a movie script - it provides not only the information that is supposed to be imparted to the students, it also provides timing info to know when to do things, and clues on what to look for coming back from the students. Any slides used should be strictly illustrative. They should reinforce what the manual contains and what the instructor says, not replace it.
The student manual should include lots of blank space so the students can take notes. The physical activity and them thinking how to put the infcoming info into their own words reinforces their understanding. The physical layout of the instructor manual should show both the layout of the student manual and provide the necessary directions. That way the instructor always knows where the students are (or at least should be) in their progress through the material, and if they are having obvious problems the instructor knows what they are looking at without having to take the time to decipher how far the students have gone.
Slides are visual aids, not primary material. If you try teaching from slides you wind up with a mutant form of PowerPoint disease. They should be used for emphasis. They're spice, not an entree.
On Monday, March 12, 2018 12:14 PM, "Janoff, Steven" <mailto:Steven -dot- Janoff -at- hologic -dot- com> wrote:
Recommend two separate docs:
(1) Training manual - no slides
(2) Slide deck
Training develops slide deck, you give it once-over for editorial (or PDF shared reviews with larger team as appropriate).
You work with training to develop Training manual -- they provide the info, you develop the doc, PDF shared reviews to larger team, etc. (Or alternate collaborative review method as appropriate.)
In classes, the student uses the Training manual, and the instructor works from the projected slides. The student can be provided hardcopy/ecopy of the slides or a relevant subset of the deck.
You may also be asked to develop an Instructor's manual depending on the topic/industry/company, etc.
HTH,
Steve
On Monday, March 12, 2018 8:20 AM, Erika Yanovich wrote:
The good news is that we had special training for Tech docs and Training to prepare a customer-facing doc and a deck of slides about a complex issue. Although the slides would cover a subset to fit actual training sessions, the subset is large enough for us to consider avoiding duplication of effort between the departments. Is there a way to avoid such duplication and work in parallel?
TIA
Erika
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
