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

Subject: Re: maintaing a list of changes in User Guides between versions.
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 5 Feb 2007 11:33:49 -0800

I'm not aware of any industry requirements for a detailed list of document changes from version to version. Preserving the source
and deliverable files for each version has always been sufficient
for every industry I've written in, and if you've done that you can
generate lists of changes fairly easily on the fly with document
comparison tools.

OTOH, if your company is moving toward some sort of knowledge
base repository system, being able to search metadata for a document
release that shows that some specific change was made (for example, changing the "C" release of some reference specification the product was supposed to comply with to the "D" release) would enable a KB user to enter that parameter into a search function and immediately
get a return that identifies that spec change has having taken place in
Rev F of your document.

Gene Kim-Eng



"Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com> wrote in message news:mailman -dot- 3157 -dot- 1170681771 -dot- 22513 -dot- techwr-l -at- lists -dot- techwr-l -dot- com -dot- -dot- -dot-

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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


References:
maintaing a list of changes in User Guides between versions.: From: Caroline Tabach
Re: maintaing a list of changes in User Guides between versions.: From: Beth Agnew

Previous by Author: Re: Ammunition for pay review
Next by Author: Re: The 'user' in User Manual
Previous by Thread: Re: maintaing a list of changes in User Guides between versions.
Next by Thread: Re: maintaing a list of changes in User Guides between versions.


What this post helpful? Share it with friends and colleagues:


Sponsored Ads