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.
Subject:Re: Key Features vs. What's New From:Thom Randolph <thom -at- halcyon -dot- com> To:Alison Tartt <akt -at- att -dot- net>, techwr-l -at- lists -dot- raycomm -dot- com Date:Mon, 17 Jan 2000 20:33:58 -0800
Alison:
The typical method I use is to create the Key Features
section, and include a cute little graphical marker
that proclaims "New in Version 7.3.0.4.2" or whatever.
Of course, explain in the beginning of the section
that there are so darned many great new features that
will make their lives happy....
The cute little graphical marker should be small but
clearly discernible. I tend to use a size that is
inversely proportional to their number. if there are
just a few that are new, they can be slightly larger.
If most of the items in the list are new, they should
be smaller, to not seems excessive.
Hope that helps,
Thom Randolph
thom -at- halcyon -dot- com
At 09:56 PM 1/17/00 -0600, you wrote:
I'm writing the user manual for a software product that has been
considerably revamped since the last version. In working on the sections
"Key Features" and "What's New in This Version" (both sections in the Intro
chapter), I'm having trouble avoiding a lot of repetition (same feature
seems to belong both places).
Has anyone found a way to describe areas of functionality with a dual
approach or emphasis so that they can go into these two different sections?