Re: Additional new features

Subject: Re: Additional new features
From: "Janet Swisher" <jmswisher -at- gmail -dot- com>
To: "Ronald Schwarz" <RSchwarz -at- cosmocom -dot- com>
Date: Mon, 6 Oct 2008 12:08:59 -0500

On Mon, Oct 6, 2008 at 11:48 AM, Ronald Schwarz <RSchwarz -at- cosmocom -dot- com> wrote:
> My Product manager wrote the official Documentation Plan for the new product release. He included What Additional Features are Available in one of the user documents. In my ten years of experience in other companies, this was put either in the Release Notes or the installation document.
> What are some good reasons for not putting such a section in a user document? The main output will be online help. The print version will be a secondary distribution. It seems this "what's new" section will hardly ever be read by someone using online help to solve a problem in the use of the product.

I can think of reasons for putting it in, rather than reasons for
leaving it out. The end user might not be the person who decided to
get the upgrade, and might not be the person who installed it. Even if
they do know what's new, they may want an introduction to using those
new features. One way to put the information in front of the user
would be to design the software to bring up that topic the first time
the user starts the new version (with a "Don't show me this again"
check box"). Even if it's too late to add that, a "What's New in 2.0"
section with links to the topics that actually describe the new
features would save the end user from having to guess where those
topics are.

Visit my blog at:

ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

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.

Additional new features: From: Ronald Schwarz

Previous by Author: off topic: cannot get account changed - my apologies if you get bounces from my account
Next by Author: Re: Injecting a little whimsy into grey text
Previous by Thread: Re: Additional new features
Next by Thread: Re: Additional new features

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

Sponsored Ads