RE: Tracking Documentation History

[hls_ut -at- comcast -dot- net]

I would also track the source/reason for the change.

Refer to the exact points in any spec documents or 
other source documents.

Refer to the meeting minutes recording the decision 
to make the change.

Even for formatting changes, make a note that the
document was altered to be in compliance with
a particular version of the style guide. 

More butt covering.

--
Heidi
hls_ut -at- comcast -dot- net

 -------------- Original message ----------------------
From: "Ronquillo, Michael" <mronquillo -at- equitrac -dot- com>
> I do agree that changes need to be tracked for internal purposes. But
> what needs to be noted? Obviously the changes themselves, the date, but
> anything else?
> 
> I'd like to hear what format you guys use for tracking documentation
> changes.
> 
> And I agree Deborah, this is for ass covering. =)
> 
> -----Original Message-----
> From: techwr-l-bounces+mronquillo=equitrac -dot- com -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+mronquillo=equitrac -dot- com -at- lists -dot- techwr-l -dot- com] On
> Behalf Of Hemstreet, Deborah
> Sent: Thursday, June 26, 2008 1:18 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Tracking Documentation History
> 
>  Leonard said <<I wouldn't question a customers preferences, but I do
> wonder if anyone
> knows what value is derived from such a list. BTW, this isn't a
> rhetorical question.>>
> 
> =========
> 
> When working with a document with a LONG life-cycle, a lot of changes
> can be entered in. Someone may need to know when a certain change was
> entered, and who authorized that change. (especially if there is a
> complaint based on that change)
> 
> 
> I have worked very little for military related applications/devices, but
> what I do know is this: They want proof of everything. If anything goes
> wrong (and it probably will), they want to make sure that they can trace
> it to something somewhere, and find the person responsible.
> 
> In other industries, it can also be for "but-covering" but not as such a
> paranoid level.
> 
> Finally, it may even depend on what your auditors want. I know of one
> company that got tripped up by auditors for not having document
> histories. So now they keep TWO versions of a released document. One
> with tracked changes, one without. The laugh is - those tracked changes
> included EVERY SINGLE CHANGE from the birth of the document.  The
> document is meaningless, but the auditor is happy - go figure!
> 
> There are many other issues related to this... But I'm sure there are
> others on the list that can add, so I'll get back to work!
> Deborah
> 
> 
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> Create HTML or Microsoft Word content and convert to Help file formats
> or 
> printed documentation. Features include support for Windows Vista & 2007
> 
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
> 
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
> 
> ---
> You are currently subscribed to TECHWR-L as mronquillo -at- equitrac -dot- com -dot- 
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/mronquillo%40equitrac
> .com
> 
> 
> 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
> http://www.techwr-l.com/ for more resources and info.
> 
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> Create HTML or Microsoft Word content and convert to Help file formats or 
> printed documentation. Features include support for Windows Vista & 2007 
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
> 
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
> 
> ---
> You are currently subscribed to TECHWR-L as hls_ut -at- comcast -dot- net -dot- 
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/hls_ut%40comcast.net
> 
> 
> 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
> http://www.techwr-l.com/ for more resources and info.
> 

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.