Re: Best Practices in Indicating Versions

Subject: Re: Best Practices in Indicating Versions
From: "Subash" <subash_tc -at- speedpost -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 23 Jul 2003 21:38:21 -0800

Joe [jsokohl -at- mac -dot- com] asked:

> So, anyone have research on best practices on indicating changed
> documents?

I haven't researched on this, but can tell you about some practices that
I have seen in documentation departments.

In one of the methods, the documents have a Revision History section,
which has two tables in it. The first table has the following column

o Version number
o Review date
o Name of the reviewer
o Revision date
o Reason for revision

This table has a separate row for each version. The second table with the
title, List of Changes, has the following headings:

o New sections
o Changed sections
o Deleted sections

This table contains the details of changes in the latest version of the

Subash Babu
subash_tc -at- speedpost -dot- net

-- - Consolidate POP email and Hotmail in one place


sourcing tool for FrameMaker that lets you easily publish your content
online. No macro language required!

Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: Re: Partnumbers
Next by Author: Re: Touch-screen terms
Previous by Thread: Best Practices in Indicating Versions
Next by Thread: Best Practices in Indicating Versions

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

Sponsored Ads