RE: Release Notes

Subject: RE: Release Notes
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: "Zen C" <zenizenc -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 22 Aug 2007 14:59:14 -0600

Zen C wrote:

> The person reviewing my release notes came up with this suggestion.
> Add screen shots for items that have one. For example if
> printing options are changed for something, explain the way
> it is done and add screen shots as it would be in the help
> file. I know you point them to the Help system, which is
> great, but they are lazy.
> Any suggestions on this comment ? Do release notes usually go
> out with a lot of details or is a brief outline of what is
> changed only?

All together, now: "It depends!" :-)

We include screen shots when they serve to quickly explain something
that would otherwise require lots of words. A new printing option
wouldn't qualify; it would just be mentioned in a bullet list or table.
A new dialing restriction feature does qualify, because a good picture
of the interface pretty well explains the feature.

But we provide a fair amount of detail because a couple of big customers
wanted it. What do your customers want?

For new releases of existing products, almost everyone expects to see a
table of resolved issues (bug fixes) and a table of unresolved issues,
along with their workarounds.


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom


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.


Release Notes: From: Zen C

Previous by Author: RE: laurentiu.stoica,AVCP_Bethel mail system error bounce
Next by Author: RE: The technologically challenged?
Previous by Thread: Re: Release Notes
Next by Thread: Re: Release Notes

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

Sponsored Ads