re: release notes

Subject: re: release notes
From: "Cayenne Woods" <cwoods -at- purplevoice -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 27 Feb 2001 10:07:58 +0000

I was interested to read responses on this topic, and hear how others deal with
this.

I'm sole tech writer as well, and when I started here we had no release notes
(or version numbers, for that matter). It's been a process of communicating
with developers to find out what they're doing. We're using a rather unwieldy
database for reporting bugs, and developers often say 'fixed' with no indication
of what they've done - but at least they mark it, and enter _something_ into the
database, which is a result of me requesting it over and over. So we're getting
there....

I sit in on the developer meetings where the lead usually has printed out
relevant issues to be addressed in the next release, then I go through that on
my own to see what may be coming up, and follow up on whether they're actually
fixed. When I come up with a list I go over it with the lead for the project,
and sometimes query QA and/or test and enter issues myself. (btw, do other
techwriters test software and enter bugs in the database?)

Because we're basically developing what our customers want (no boxed software,
just pockets of installations, but growing) I do put bug fixes, 'cos they're
what customers have asked to be fixed. Also any changesin the interface or how
the software works. But we keep it short, and the amount of detail depends on
the importance of the change. There's no need to list specifics on recording
improvements, for instance, but when there are enough changes to justify it
(when it's sufficiently improved), I'll say 'improvements to sound quality and
file size of recordings' or something similar.

thanks all for the info
Cayenne



**************************************************************
This communication contains information which is confidential
and may also be privileged. It is for the exclusive use of the
intended recipient(s). Please note that any distribution, copying
or use of this communication, or the information in it, is strictly
prohibited. If you have received this communication in error,
please notify us by email or by telephone (+44 20 8848 6644)
and then delete the email and any copies of it.

This communication is from Purple Voice Ltd., whose principal
office is at Dawley Road, Hayes, Middlesex, England.

This footnote also confirms that this email message has been
checked for the presence of computer viruses.
**********************************************************************

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17)
http://www.weisner.com/training/dreamweaver_help.htm 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 www.forehelp.com 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
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: re: word templates vs. layout - wrapup/thanx
Next by Author: Reference: Brown Paper Resources
Previous by Thread: Re: Get a job at a dot.bomb
Next by Thread: Who Wants to Review My Word 2000 Style Sheet Cheat Sheet?


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

Sponsored Ads


Sponsored Ads