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