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: Additional new features From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 6 Oct 2008 10:51:52 -0700
The only reason I can think of would be if that information
was readily available to users in some other form. If the
product is a high-level administration tool with a printed
manual that is in the hands of its only user, printed might
be preferable, especially if the user is likely to study the
printed manual before installing or using the tool. But if
the tool is some sort of multi-user system where users
log in remotely and may never see the actual printed
manual that is in the hands of the top-level administrator,
then where else are you going to put the information that
doesn't require someone who logs in and immediately
says "WTF is all this new stuff?" to go hunting for that
elusive book or signing up for bulletins or online KBs?
----- Original Message -----
From: "Ronald Schwarz" <RSchwarz -at- cosmocom -dot- com>
> 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.
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. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-