TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Michael Seidel wrote:
> Our documentation team needs a way to inform our users of
documentation
updates.......our users are asking for a way of finding out what
specific content has been updated.<
As I demonstrated O/L, we use the Change Bar feature for the revised
data. We track revisions via number and date (ex: "Rev 3, 21 November
2007.
In a Non-Running Footer on the page we insert the latest Revision
number/date. Our methodology is to incorporate several
updates/corrections into one revision, so we don't nickel-and-dime our
customers.
The front matter of a document contains a "List of Effected Pages (LEP)"
which includes: a list of revision numbers/dates; a list showing each
page that has been revised with the current rev number; and a new title
page reflecting the latest revision number/date.
The Rev package includes only the newly updated pages, new LEP, and new
title page. Revision packages are sent to the customers to incorporate
into their own documents.
IHTH
Blessings,
Darren
****************************************
Darren J. Butler
Sr. Technical Writer-Editor, Template Wrangler, Mil-Spec Pharisee
Integrated Data for Maintenance
NG Corp
-----Original Message-----
From:
techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot-
com] On Behalf Of Mseidel -at- triseptsolutions -dot- com
Sent: Tuesday, November 20, 2007 12:34 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Document revisions
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.
</font>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats
or
printed documentation. Features include support for Windows Vista & 2007
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
Darren -dot- Butler -dot- ctr -at- robins -dot- af -dot- mil -dot-
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-
