Sunday, July 20, 2008  

4 principles of document revision management

One of the things we like to use this blog for is to share some of the good practice processes that we've identified through working with clients. These can help projects run better and avoid the cost and time impacts of poor document management.

The control and revision of documents is one area where establishing good procedure between participants can really help a project. Areas to focus on include the numbering, revision and status of documents, the control of transmittals, and the maintenance of a document issue register.

Use of an online document management system can ensure a best practice approach to the generation and management of document registers. We've identified four principles of good revision management that should be agreed between the collaborating parties - whether or not an online document management tool is being used.

  1. The document numbering system should be agreed at the start of the project
    Clients may insist on implementing their own document numbering system, or participating organizations may combine to create a new system. Whichever way is chosen it is important to make a clear statement about the system and to ensure all parties are aware of it and use it.
  2. The revision coding system should be agreed as part of the above numbering system
    The most common revision systems are based on a numeric (1, 2, 3 ...) or alphabetic sequence (A, B, C ... AA, AB, AC ...). In some cases, numbers are used for revisions up to the 'For Construction' issue of documents, with letters used for revisions from that point on. Alternatively, letters and numbers can be combined, with the sequence reverting to a letter at agreed points in the revision process (A1, A2, A, B1, B2, B, C1...). Some organizations develop more complex coding to reflect their own internal review stages (e.g. A1-01, A1-02, A2-01...).
  3. The revision code must continue sequentially from the first issue of a document through its entire life
    This allows all participants, including those not involved in the creation of a document, to understand how versions of documents relate to each other. There can be exceptions to this rule if predefined. For example, the revision code may revert back to A or 1 at the completion of each stage of a project. This is a complicated requirement and requires careful management and quality control.
  4. Revisions must be clearly identified within a document
    In the case of a drawing, there will normally be a revision cloud around the area of change, with a revision letter placed inside a triangle attached to the cloud. CAD drawings would have this on a revision cloud layer, with a new layer created for each cloud.

We see these four principles as being essential for effective document revision management. Let us know if there is anything you think should be added to this list.

Labels:

Comments:
Dear Rob,

One good and important practice document control but is often left out in Projects EPIC is the ability to trace back the originator of the document revision changes.

DS
 
Those 4 principals are great but, what I'm really trying to ascertain is the best practice when a single document number covers both a document and a drawing. If the document changes revision, should the drawing remain synchronized with base document revision or remain independent.
 
Dear Phil,

It is often a challenge for document control to know exactly how to manage a document that is actually a collection of separate documents! An Equipment Manual or a Project Execution Plan should be viewed as a volume of separate documents and revved up whenever changes are made to any of those separate documents contained within. From an EDMS perspective establish a master doc profile for the cover document and then linked indices to separate document profiles for the supporting documents contained within.
 
This is a great point, and it is always a challenge of doc management to intelligently group documents (using tags or other meta data). I expect to see collaboration systems getting better at this over the next year or so.
 
I reckon a document register should support the natural actions of its users, and this would include marking up or otherwise annotating or amending a document. When more than one user modifies the same version of a document we no longer have a linear progression of document versions, but sibling versions in a tree which may require 'integration' back to the main 'trunk' version of the document.

When a document is published in different languages it is necessary to be able to 'label' various versions of the document (points in the tree) as forming part of a consistent set or 'release' of the document group (the same mechanism is useful for keeping track of separate document components such as diagrams).

These 'use cases' are not well supported by a simple multi-part sequential numbering system e.g. A01.03 C02.01.01 etc.. Some source code version control tools support this sort of stuff.
 
What do you think of changing the revision of only the pages that are subject to changes and point out in these pages the changes? You end up with having one revision per page. You have on the first page a revision control box indicating the revision of each page.

What is your say on this practice?
 
Post a Comment



<< Back to home