Re: Tracking Documentation History

[Susan Park <su_duncan -at- yahoo -dot- com>]

Could you create a separate set of Release Notes for each release, and let people know where they're available?  At least they'd be accessible for those who want them, and wouldn't be cluttering up the documentation, or be sent to those who don't want/need them.

--- On Thu, 6/26/08, Ronquillo, Michael <mronquillo -at- equitrac -dot- com> wrote:

From: Ronquillo, Michael <mronquillo -at- equitrac -dot- com>
Subject: Tracking Documentation History
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thursday, June 26, 2008, 12:25 PM

Hey all,

 

 

What are your thoughts on tracking the documentation history in the
documentation?

 

For example, you would have a date and software release and have bullets
saying exactly what has been changed/updated. Is this good practice or
does it air out "dirty laundry". Does this have any value to the
customer?

 

I am considering dropping it because it's getting ridiculously long.
Also, it shows our company's mistakes. The only value it has is for our
support team so they know what's updated when answering queries from
customers. Is there a better method for tracking changes internally?

 

I'd love to hear what you guys do.

 

Thanks,

Mike

 

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

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 su_duncan -at- yahoo -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/su_duncan%40yahoo.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 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.