Document revisions

Subject: Document revisions
From: Mseidel -at- triseptsolutions -dot- com
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 20 Nov 2007 11:33:40 -0600

Our documentation team needs a way to inform our users of documentation
updates. We have auto-updating dates in the footers of our Frame/RH files,
but our users are asking for a way of finding out what specific content has
been updated.

We essentially need a way to tell them what portion of our documentation was
updated at a given time.

For example, for our upcoming release, we update Step 5 in one document, a
table in another document, and a warning message in yet another document.

Are there any best practices for notifying users of these changes? We think
we might need a separate, master document that outlines the changes.

Do any of you have experience with notifying users of changes in this way?

I look forward to your responses!

-Michael Seidel

<font size="1">
IMPORTANT NOTICE: This message and any attachment may contain privileged and/or confidential information. This transmission is not intended nor may it be construed to create a binding legal obligation in the absence of a writing signed by an authorized officer of the company. If you are not the addressee indicated in this message, (or responsible for its delivery to such person), you may not copy or disseminate this message and any attachment to anyone. In such case, you should destroy this message, any attachment, and all copies and kindly notify us by reply email. We do not assure the security of information electronically transmitted, and your communication with us through such means shall signify your acceptance of such risks. Conclusions and other information in this message that do not relate to the official business of La Macchia Enterprises, Inc and /or its subsidiaries and affiliates are understood as neither given nor endorsed by it.

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.

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

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

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 for more resources and info.


Previous by Author: Re: Asking a question: a controdiction?
Next by Author: Autocorrect SEQ fields disappeared
Previous by Thread: RE: A blog post all of you wrote: Technical Writing in Transition
Next by Thread: Re: Document revisions

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

Sponsored Ads