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: reviewing user manuals From:"Gerry Loiacono" <gerry -dot- loiacono -at- aztec-it -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 31 Jan 2003 20:26:30 +1000
The support people should review the procedures. Ideally, if an unfinished
'beta' or draft of the manual could be distributed to them, so they could
begin using it, they could make meaningful suggestions for changes. I don't
see as much of an advantage in expecting them to necessarily sit down and
dedicate a block of time to reviewing the manual.
The marketing people may want to make changes to some of the overview
information. Perhaps the overview sections relevant to them could be
highlighted or made available separately. Of course, just how much marketing
material is included in the manual should be determined by a higher source
within the company (not by the marketing people themselves).
Just my thoughts; YMMV.
Regards,
Gerry Loiacono
Aztec IT Services
www.aztec-it.com.au
-----Original Message-----
[mailto:bounce-techwr-l-115247 -at- lists -dot- raycomm -dot- com]On Behalf Of mark
Dsouza
Sent: Friday, 31 January 2003 4:13 PM
Subject: reviewing user manuals
Hi all,
In our company we have a 500 page user manual which was prepared by the
developers. I am new to this company. Since I am the lone documentation guy,
it seems I would have to review these documents (which means rewriting it
totally). I am wondering who all should be invloved in the review process.
We have customer support guys here, developers and the marketing team. It is
the customer support who is directly interacting with the cusomers. My
feeling is the marketing guys should not be invloved since we have seperate
documents for them, like product description documents. Any views on this
approach?
Regards,
Mark
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -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.
