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.
I got quite a few on- and off-line replies with ideas, pros and cons. One of them stated âI know of no one who has effectively eliminated duplication and overlap in developing documentation and training. I do believe it can be done. [â] You are breaking ground here, and it's a very worthwhile effort.â
If so, here is a recap of what is needed and what Iâve done so far.
The task is preparing a customer-facing PDF guide that explains how to install, configure and test an entire network (tech doc dept. job) and PPT-based training sessions that explain pretty much the same (training dept. job). The network functionality showcases the latest and greatest capabilities of the network elements.
1. We (writers and trainer) discussed and aligned outlines and allocated responsibilities for all sections to respective writers.
2. A graphic artist is working on a series of diagrams with the SME.
3. We attended an SME-conducted joint training session that explained the subject matter.
4. Thanked the SME and reminded him we will also need him to review our drafts.
5. Following the training, we understood the outline should be changed, so I scheduled a meeting to discuss the changes and possible changes in responsibilities. We will also discuss deadlines, dealing with product version changes during work and a framework for periodical follow-up meetings.
6. I have set up a shared directory with all the raw materials we have gathered and [partial] drafts of deliverables.
7. Trying to find out what Training is starting with, so that the writers will start covering another area and then we can exchange drafts and benefit from each otherâs work.
My favorite part so far was the training. It was great being trained for the sole purpose of creating the deliverables (this is a high visibility project!) and I enjoyed learning the material (it reminded me why I love this profession.)
Inputs appreciated.
Erika
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
