RE: Do you log your changes?

Subject: RE: Do you log your changes?
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Jan 2010 15:14:21 -0500

The form used to review and approve document changes includes a log of
changes. The level of detail in the log is my judgment call: Sometimes
I'll just summarize the new or changed text, and other times I'll post
it verbatim to the log. The form itself has evolved over time, based on
feedback from my reviewers.

This applies only to approved document releases. We don't have a log of
incremental changes in the draft revisions between releases.

> -----Original Message-----
> From: McLauchlan, Kevin
> Sent: Wednesday, January 20, 2010 3:06 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Do you log your changes?
> Do most people keep a detailed log of changes they make from
> release to release of a document or a Help? (Military style?)
> Or do you just provide a high-level overview of major stuff
> for the QA guys to look for?
> Or.... do you rely on a source management system to preserve
> history and differences?

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.


Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.

Please move off-topic discussions to the Chat list, at:


Do you log your changes?: From: McLauchlan, Kevin

Previous by Author: RE: A Better Technical Writer/Communicator Library
Next by Author: RE: Do you log your changes?
Previous by Thread: RE: Do you log your changes?
Next by Thread: RE: Do you log your changes?

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

Sponsored Ads