TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: Documenting incremental releases in a What's New
Subject:RE: Documenting incremental releases in a What's New From:"Ben Kovitz" <bkovitz -at- nethere -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 5 Jul 2002 14:42:02 -0700
Rowena Hart wrote:
> For the minor release, should I:
>
> - keep all of the 6.0 information and tack on a
> 6.1 section at the end of the What's New chapter?
> - delete all of the 6.0 information and just
> have 6.1 information in the What's New chapter?
>
> I can think of at least one argument for each
> case. However, it would help me to know how other
> writers would handle this issue.
Here's a possible way to resolve the dilemma:
When 6.1 comes out, will your audience likely be familiar with the new
stuff in 6.0? If so, you could leave it out. If not, you could put it
in.
The risk, of course, is that by making the section longer, you increase
the probability that people will skip it entirely.
Thinking outside the box a moment, if you *really* want the users to
know about certain things that were new in 6.0, you could put those in a
quick reference card along with all the other most-important
information. In that context, you wouldn't have to indicate the version
they came out in, of course.
Ben Kovitz
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Save $600: Create great-looking Help files and software demos with
RoboHelp Deluxe. Get RoboHelp and RoboDemo - our new demo software - for one
low price. OR Save $100 on RoboHelp Office in June with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
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.