RE: release notes question

Subject: RE: release notes question
From: "Kim McGarghan" <kmcgarghan -at- nssolutions -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 22 Feb 2001 17:14:59 -0500


I hope this helps.

I'm the lone writer; I work for a small (but rapidly growing!) startup

I write the release notes based on code changes the developers have made.
In addition to being on their mailing lists, which include check-ins of
changes, they send me a summary of items they have changed. I run
comparison programs between the old and new versions of some of the files.
I also play with the daily builds as they come along so I can see changes
(my product runs on two operating systems and across three interfaces). I
then hack together a preliminary version which the developers check. I edit
according to their additional input and then we post.

I hope to set up decent systems, but for now this is how we're taming this
particular lion.

"If you care enough, you can have an impact." Harry Chapin

Kim McGarghan
Senior Technical Writer
Network Storage Solutions, Inc.
14020 Thunderbolt Place, Suite 500
Chantilly, VA 20151
(703) 834-2234 (work)
(703) 834-2221 (fax)
mailto:kmcgarghan -at- nssolutions -dot- com

-----Original Message-----
From: Joan_Smith -at- ultimatesoftware -dot- com
[mailto:Joan_Smith -at- ultimatesoftware -dot- com]
Sent: Thursday, February 22, 2001 2:42 PM
Subject: release notes question

Hi everyone, I'm a former techwr-l'r from years past and have come back
with a problem I hope you can help me with.

I've been the "Release Note Coordinator" for a few years at my company. At
times, our team of writers have simply
felt like Release Note Writers, because they take precedence over just
about any kind of documentation. We are lucky enough
to have a decent tracking system, using Lotus Notes, where an issue gets
reported and eventually resolved for a particular release,
and the product analyst decides what needs a Note, and what doesn't.

For those of you who work for a company that creates release notes:

* Who writes them, the documention writers or the
* How does your company decide what type of information needs a note or how
can you get
your company to lighten up on the RN load? (we have had releases where we
honestly have over
150 release notes written for different parts of the product). We tend to
get very specific, yet we are not
allowed to use certain words like "fixed" or "bug", believe it or not, due
to Marketing constrictions!

Thanks everyone,

joan_smith -at- usgroup -dot- com

Joan M. Smith
Senior Technical Writer
Ultimate Software Group
(954) 331-7404

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See for more information and free evaluation downloads

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: FW: History of TW resources?
Next by Author: RE: Software For Students (PSP v PS)
Previous by Thread: RE: release notes question
Next by Thread: RE: release notes question

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

Sponsored Ads