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.
RE: maintaing a list of changes in User Guides between versions.
Subject:RE: maintaing a list of changes in User Guides between versions. From:"Harris, Michael" <Michael -dot- Harris -at- innocon -dot- com> To:"Hickling, Lisa \(TOR\)" <lhickling -at- Express-Scripts -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 8 Feb 2007 10:37:29 -0500
Generally, we send a notification letter, with the changes identified in
a tabular format. The notice goes to the main customer along with a
copy (hard or soft, depending on the contract) of the new document. At
other times, we include the table of changes in the front matter. If
editorial changes are significant enough, they get included in the
table. I don't recall ever sending out a single notice with changes
made in archived versions, however we have sent out back-to-back
changes.
Michael
-----Original Message-----
From: Hickling, Lisa (TOR) [mailto:lhickling -at- Express-Scripts -dot- com]
Sent: Thursday, February 08, 2007 8:59 AM
To: Harris, Michael; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: maintaing a list of changes in User Guides between
versions.
Generally, how do you alert your readers to changes in your end-user
documentation? Do you adopt a need-to-know approach (including
notifications for changes that were specifically requested perhaps by
clients while excluding notes for editorial and quality-related changes)
or do you slug it all in there?
More specifically,
***Do you include a change log in your front matter detailing
modifications to the documents since previous publication? If so, what
types of modifications do you document and to what level of minutia?
***Do you also include an archive of changes spanning several
generations of the product?
Lisa H.
******* Confidentiality Notice *******
ESI Canada -- Optimizing the value of drug and dental benefits
This email, its electronic document attachments, and the contents of its
website linkages may contain confidential health information. This
information is intended solely for use by the individual or entity to
whom it is addressed. If you have received this information in error,
please notify the sender immediately and arrange for the prompt
destruction of the material and any accompanying attachments.
******* Avis de confidentialite *******
ESI Canada -- Optimiser la valeur des regimes d'assurance medicaments et
dentaires
Ce courriel ainsi que tout document y etant joint de meme que le contenu
des liens vers des sites Web peuvent reunir des renseignements
confidentiels sur la sante. Cette information s'adresse uniquement a
l'usager ou a l'organisation auxquels elle est destinee. Si vous avez
recu ce message par erreur, veuillez en aviser l'expediteur
immediatement et proceder a la suppression du document et des fichiers
joints sans tarder.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-