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.
>Dan Goldstein
>
> The form used to review and approve document changes includes a log of
> changes. The level of detail in the log is my judgment call: Sometimes
> I'll just summarize the new or changed text, and other times I'll post
> it verbatim to the log. The form itself has evolved over
> time, based on
> feedback from my reviewers.
>
> This applies only to approved document releases. We don't
> have a log of
> incremental changes in the draft revisions between releases.
Hmm. Maybe I'm the only one who does this...
Obviously, when the new spec for a product revision comes down the
pipe, I make additions/changes/corrections in order to document the
changes to the product.
But...
Often it will happen that I land on a page/topic and read what's
there, and decide that it's not clear (as originally presented,
two years ago or whatever). Or, it's not as complete
as my current knowledge would have it. While fixing that, I naturally
see pointers to other topics... it's classic hypertexting... you
just go where the browsing takes you... ok, where it takes me...
and along the way I tweak and improve and sometimes even catch
outdated stuff that I can remove.
Maybe a bulleted list is easier to grasp when it's converted
into a table, or a diagram. Or maybe one of the SMEs has done
a nifty graphic in a presentation and I see exactly the spot
where I could use that graphic to good effect.
I don't normally keep track of such wandering, pot-luck "improvements".
But I realize that some people do. So I was curious about their
reasons and their methods. And whether tracking even your smallest
tweaks eats into your productive hours.
- KevinThe information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
