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:RE: Types of documentation? From:PHILA -at- Mail -dot- VIPS -dot- com To:techwritermw -at- altavista -dot- com, techwr-l -at- lists -dot- raycomm -dot- com Date:Fri, 28 Jan 2000 09:46:16 -0500
Our lead trainer and I are working collaboratively at this stage: she uses
the documentation as the foundation for her training classes (a little extra
incentive for the users to pick up the manuals afterward: they're already
familiar territory). Meanwhile, she draws up procedural and conceptual
exercises, practice assignments and tests based on the documentation. As
she's on the road an increasing percentage of the time, this benefits us
both: she doesn't need to duplicate my work, and I get user feedback based
on what I write.
-----Original Message-----
From: Mr Smith [mailto:techwritermw -at- altavista -dot- com]
Sent: Thursday, January 27, 2000 2:16 PM
To: TECHWR-L
Subject: Types of documentation?
Hi,
Thanks to everyone for being so helpful on my previous post.
I have another general question about types of documentation, and then I'll
probably fade back into LurkerLand for several months. :-)
How do writers typically differentiate training
documentation from user documentation? My thoughts are that training
documentation is designed around the training process (more examples and
more handholding?), whereas user documentation should be used to use the
hardware/software etc (in my mind, with a task-oriented approach).
My statements here are oversimpification...can anyone
confirm/deny my beliefs? I'm sending this email because I'm trying to
explain the difference to my boss, but I'm having a hard time being
succinct.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sponsored by Weisner Associates Inc., Online Information
Services
Training & consulting for RoboHELP, Dreamweaver, HTML, and
HTML-Based Help.
More info at http://www.weisner.com/train/ or mailto:training -at- weisner -dot- com -dot-
Register now for a Professional Technical Writing
Certificate at
www.online-learning.com/index1.html. An ideal professional
development
opportunity, PTW begins February 15, 2000 and lasts 4
months.
---
You are currently subscribed to techwr-l as:
phila -at- mail -dot- vips -dot- com
To unsubscribe send a blank email to
leave-techwr-l-20566Q -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.
