atw: Your thoughts on documentation maintenance?
- From: "Deborah Cross" <Deborah.Cross@xxxxxxxxxx>
- To: <austechwriter@xxxxxxxxxxxxx>
- Date: Wed, 13 Dec 2006 09:25:15 +1100
Greetings All,
I am getting quite a few enquiries from clients on how they ensure that
their documentation is kept up to date. Particularly in relation to
procedures and instructions.
When I build a procedural template, I always put a description or prompt
in that asks the reader to have the document updated if they find
anything wrong (and how to go about getting the document updated).
After a while these sort of messages get ignored - a bit like
advertising and images on web sites.
I also advise people to have regular reviews and consider putting expiry
dates on their documentation. When the review or expiry date arrives
the owner should look over the document and make any changes needed or
remove it from circulation. This sounds fine in theory, but the
scheduled reviews are often ignored because other work is more important
and without an automated system to prompt about expiry dates they often
pass unnoticed.
I'm curious to know if anyone has had any success in getting owners to
keep their documentation up to date and how you achieved it?
_
(_) MERRY CHRISTMAS!
/ \
/ \ Deborah Cross
/_____\ Enterprise Systems Program
(`_______`) Division of Information
// . . \\
(/(__O__)\) The Australian National University
|'-' = '-'| Canberra ACT 0200
| | ANU CRICOS# 00120C
/\ /\
/ '. .' \
/_/ '-' \_\
{__}###[_]###{__} E-mail: deborah.cross@xxxxxxxxxx
(_/\_________/\_)
|___|___|
jgs |--|--|
(__)'(__)
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
Other related posts:
- » atw: Your thoughts on documentation maintenance?