Re: document revision history

Subject: Re: document revision history
From: "Christensen, Kent" <lkchris -at- sandia -dot- gov>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 12 Jan 2001 08:36:10 -0700

In our instance producing military manuals, a manual when first written is
reviewed and agreed to by both parties. We are the hardware/software
designers, and the military are the (hopefully never) users and (always
diligent) maintainers. For any (any) change to a manual to occur, agreement
of all parties is again required. I believe but am not certain that
military personnel get some sort of "credit" for discovering errors or
suggesting better ways to work and seeing them through to correction or
implementation. Sometimes we find our own mistakes or a better way and
propose changes ourselves, but agreement of all parties is still required
before the change is made.

Each manual features an original issue date and includes a special page that
lists the issue date for each individual page within the manual. If a
change occurs on a particular page, a vertical bar is placed in the page
margin next to the affected line or lines, and the date for that particular
page is changed on the summary page. Sometimes we need to create a page 12a
(and 12b perhaps lableled "intentionally blank") or the like. New pages are
sent to all holders of the manual--we keep records who they are. We make a
lot of changes simply because the name of the general or admiral on the
authorization page changes as these folks are rotated to new assignments,
retire, etc. Even these changes are approved, but it's reather perfunctory
obviously. We save all the correspondence related to an implemented
changed. A manual could be completely revised just for "cleanup" to
eliminate change bars, inserted pages, etc. In this case (once approved)
the manual simply receives a new issue date.

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. or toll-free 877/278-2131.

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: Web application help?
Next by Author: RE: Value of design documents (was: New TECHWR-L Poll Question)
Previous by Thread: Re: document revision history
Next by Thread: RE: document revision history

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

Sponsored Ads