Re: Release Notes

Subject: Re: Release Notes
From: John Posada <jposada01 -at- yahoo -dot- com>
To: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>, Zen C <zenizenc -at- gmail -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 22 Aug 2007 15:18:42 -0700 (PDT)

When doing release notes, gotta keep something in mind...they're created at the end because they describe changes/discoveries/issues that came too late to get into the documentation.

The more complicated they get, the longer it takes, until you are doing RNs while you are doing regular docs, and that defeats the purpose. It takes us less than a week to create an RN of about 25-30 pages.

> 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.


- New features that didn't make it into the docs
- Known and discovered issues that didn't get fixed in time
- Workarounds
- What was fixed since the last release

John Posada
Senior Technical Writer

"They say everyone needs goals. Mine is to live forever.
So far, so good."

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.


Previous by Author: Re: Monkey Business
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