Re: summary of changes

Subject: Re: summary of changes
From: "Sharlyn D. Avina" <avina -at- CS -dot- HH -dot- AB -dot- COM>
Date: Thu, 13 Jan 1994 09:36:47 -0500

We always put a summary of technical changes at the beginning of all our revised
documents. We also include "change bars" in the margin of the document to
indicate where the changes occur.

Many of our customers receive updates of our products and this helps them as
well as us to see what changes we have made to the product and if they affect
him/her.

From an archiving/support standpoint this system is especially useful because we
can track the progress of the product. For example if a customer has version
"A" of the product we know exactly what features he/she has.

From a reviewer's standpoint this is also helpful because many times an engineer
is pressed for time. With the change bars/summary of changes he/she can review
only the information that has changed in the document rather than the entire
document.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sharlyn Avina Dimick
Technical Communicator

Allen-Bradley Company, Inc.
747 Alpha Drive (216) 646-3127
Highland Heights, Ohio 44143 avina -at- pulsar -dot- cs -dot- hh -dot- ab -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Previous by Author: Re: think ..uh... thing coming (Regional)
Next by Author: homophones
Previous by Thread: Re: summary of changes
Next by Thread: Re: Page to Frame


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


Sponsored Ads