re: maintaing a list of changes in User Guides between versions.

["Harris, Michael" <Michael -dot- Harris -at- innocon -dot- com>]

Caroline,

Maintaining a list of changes between versions of documentation is
common in military or government documentation.  A reason for this is
that users of equipment who may actually use the documentation need to
know what has changed from one version to the next.  It may not be
cost-effective to always replace entire manuals and people may opt to
redline their existing ones, especially if their own copy is covered
with personal notes already.  My employer is a defense contractor and we
are often required to show changes from one version to the next.
Sometimes we are even required to used good, old-fashioned change bars
within the document.  I don't know if your customer is military or
government, but even if not, whoever has tasked you with the
responsibility may simply be used to seeing changes identified.  I hope
this helps.          

Michael Harris


	Message: 6
	Date: Mon, 5 Feb 2007 14:11:23 +0200
	From: "Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>
	Subject: maintaing a list of changes in User Guides between
versions.
	To: techwr-l -at- lists -dot- techwr-l -dot- com
	Message-ID:
	
<ff2460010702050411geaf44f9jcc726974a17cae19 -at- mail -dot- gmail -dot- com>
	Content-Type: text/plain; charset=ISO-8859-1; format=flowed

	Someone asked us if there is any way that we keep track of
changes
	that are made in our user guides/helps from version to version.

	Is this something that people do?

	Since books are changed as a result of software releases, we
know more
	or less what has been done, but there is no list of changes (or
	history file)

	Is this a requirement in some sections of the communications
industry?

	-- 
	 Caroline Tabach
	Technical/Marcom writer RADCOM
	e-mail: caroline -dot- tabach -at- gmail -dot- com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 &amp; 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 &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.